diff --git a/python_sdk/.buildinfo b/python_sdk/.buildinfo new file mode 100644 index 00000000..b70c2565 --- /dev/null +++ b/python_sdk/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 3ff48c3d1df897816f9240c192bade79 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/python_sdk/_images/coverage.svg b/python_sdk/_images/coverage.svg new file mode 100644 index 00000000..321ee2ee --- /dev/null +++ b/python_sdk/_images/coverage.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + coverage + coverage + 76% + 76% + + diff --git a/python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png b/python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png new file mode 100644 index 00000000..55ec0ccc Binary files /dev/null and b/python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png differ diff --git a/python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png.map b/python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png.map new file mode 100644 index 00000000..6bbf570c --- /dev/null +++ b/python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png.map @@ -0,0 +1,4 @@ + + + + diff --git a/python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png b/python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png new file mode 100644 index 00000000..b1d1ba2a Binary files /dev/null and b/python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png differ diff --git a/python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png.map b/python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png.map new file mode 100644 index 00000000..721fbb00 --- /dev/null +++ b/python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png.map @@ -0,0 +1,4 @@ + + + + diff --git a/python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png b/python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png new file mode 100644 index 00000000..dfe9c00b Binary files /dev/null and b/python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png differ diff --git a/python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png.map b/python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png.map new file mode 100644 index 00000000..e4b2da2c --- /dev/null +++ b/python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png.map @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png b/python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png new file mode 100644 index 00000000..99534e14 Binary files /dev/null and b/python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png differ diff --git a/python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png.map b/python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png.map new file mode 100644 index 00000000..0ccf3232 --- /dev/null +++ b/python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png b/python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png new file mode 100644 index 00000000..b62b8ed9 Binary files /dev/null and b/python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png differ diff --git a/python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png.map b/python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png.map new file mode 100644 index 00000000..5e5e1d72 --- /dev/null +++ b/python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/python_sdk/_sources/api.rst.txt b/python_sdk/_sources/api.rst.txt new file mode 100644 index 00000000..cd685526 --- /dev/null +++ b/python_sdk/_sources/api.rst.txt @@ -0,0 +1,256 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +API Reference +************* + +This section is a reference for the Open GoPro Python Package API. The BLE / Wifi API's that +this package implements can be found in the Open GoPro documentation linked from :ref:`package summary` + +.. note:: + Not everything is exposed here. This section should only consist of the interface + information that a user (not a developer) of the Open GoPro module should care about. + +For a higher-level summary / usage, see the :ref:`usage` section + +.. warning:: + This documentation is not a substitute for the Open GoPro BLE and WiFi + `specifications `_. That is, this interface shows how to use the various + commands but is not an exhaustive source of information for what each command does. The Open GoPro specs + should be used simultaneously with this document for development. + +GoPro Client +============ + +There are two top-level GoPro client interfaces - Wireless and Wired: + +Wireless +-------- + +.. code-block:: python + + from open_gopro import WirelessGoPro + +.. inheritance-diagram:: open_gopro.gopro_wireless.WirelessGoPro + :parts: 1 + +.. autoclass:: open_gopro.gopro_wireless.WirelessGoPro + :inherited-members: + +Wired +----- + +.. code-block:: python + + from open_gopro import WiredGoPro + +.. inheritance-diagram:: open_gopro.gopro_wired.WiredGoPro + :parts: 1 + +.. autoclass:: open_gopro.gopro_wired.WiredGoPro + :inherited-members: + +Open GoPro API +============== + +These are both the base types that are used to implement the API (BLE Setting, Ble Status, etc.) and the +version-specific API's themselves. + +These should not be imported directly and instead should be accessed using the relevant properties (`ble_command`, +`wifi_setting`, etc.) of a GoPro(:class:`open_gopro.gopro_base.GoProBase`) instance. + +.. autoclass:: open_gopro.api.ble_commands.BleCommands + :show-inheritance: + +.. autoclass:: open_gopro.api.ble_commands.BleSettings + :show-inheritance: + +.. autoclass:: open_gopro.api.ble_commands.BleStatuses + :show-inheritance: + +.. autoclass:: open_gopro.api.http_commands.HttpCommands + :show-inheritance: + +.. autoclass:: open_gopro.api.http_commands.HttpSettings + :show-inheritance: + +Base Types +---------- + +GoPro Enum +^^^^^^^^^^ + +.. autoclass:: open_gopro.enum.GoProEnum + +.. autoclass:: open_gopro.enum.GoProIntEnum + +BLE Setting +^^^^^^^^^^^ + +.. inheritance-diagram:: open_gopro.api.builders.BleSettingFacade + :parts: 1 + +.. autoclass:: open_gopro.api.builders.BleSettingFacade + :exclude-members: get_name, get_capabilities_names + +BLE Status +^^^^^^^^^^ + +.. inheritance-diagram:: open_gopro.api.builders.BleStatusFacade + :parts: 1 + +.. autoclass:: open_gopro.api.builders.BleStatusFacade + +HTTP Setting +^^^^^^^^^^^^ + +.. inheritance-diagram:: open_gopro.api.builders.HttpSetting + :parts: 1 + +.. autoclass:: open_gopro.api.builders.HttpSetting + +Method Protocols +^^^^^^^^^^^^^^^^ + +.. autoclass:: open_gopro.api.builders.BuilderProtocol + +Message Bases +^^^^^^^^^^^^^ + +These are the base types that are used to implement version-specific API's. These are published for reference +but the end user should never need to use these directly. + +.. autoclass:: open_gopro.communicator_interface.Message + :show-inheritance: + +.. autoclass:: open_gopro.communicator_interface.HttpMessage + :show-inheritance: + +.. autoclass:: open_gopro.communicator_interface.BleMessage + :show-inheritance: + +.. autoclass:: open_gopro.communicator_interface.Messages + :show-inheritance: + +.. autoclass:: open_gopro.communicator_interface.BleMessages + :show-inheritance: + +.. autoclass:: open_gopro.communicator_interface.HttpMessages + :show-inheritance: + +.. autoclass:: open_gopro.communicator_interface.MessageRules + +Parameters +---------- + +All of these parameters can be accessed via: + +.. code-block:: python + + from open_gopro import Params + +.. automodule:: open_gopro.api.params + :undoc-members: + +Responses +========= + +Generic common response container: + +This can be imported via: + +.. code-block:: python + + from open_gopro import GoProResp + +.. autoclass:: open_gopro.models.response.GoProResp + +Data Models +----------- + +These are the various models that are returned in responses, used in commands, etc. They can be imported with: + +.. code-block:: python + + from open_gopro.models import *** + +.. autopydantic_model:: open_gopro.models.media_list.MediaMetadata + +.. autopydantic_model:: open_gopro.models.media_list.PhotoMetadata + :show-inheritance: + +.. autopydantic_model:: open_gopro.models.media_list.VideoMetadata + :show-inheritance: + +.. autopydantic_model:: open_gopro.models.media_list.MediaItem + +.. autopydantic_model:: open_gopro.models.media_list.GroupedMediaItem + :show-inheritance: + +.. autopydantic_model:: open_gopro.models.media_list.MediaFileSystem + +.. autopydantic_model:: open_gopro.models.media_list.MediaList + +.. autopydantic_model:: open_gopro.models.general.TzDstDateTime + +.. autopydantic_model:: open_gopro.models.general.CameraInfo + +.. autopydantic_model:: open_gopro.models.general.WebcamResponse + +.. autopydantic_model:: open_gopro.models.general.SupportedOption + +Constants +========= + +These can be imported as: + +.. code-block:: python + + from open_gopro import constants + + +.. automodule:: open_gopro.constants + :undoc-members: + :exclude-members: CmdType, GoProEnumMeta, GoProFlagEnum, ProducerType, ResponseType, enum_factory + +Exceptions +========== + +.. automodule:: open_gopro.exceptions + :undoc-members: + +Common Interface +================ + +.. autoclass:: open_gopro.gopro_base.GoProBase + +.. autoclass:: open_gopro.communicator_interface.GoProBle + +.. autoclass:: open_gopro.communicator_interface.GoProHttp + +.. autoclass:: open_gopro.communicator_interface.GoProWifi + +.. autoclass:: open_gopro.communicator_interface.GoProWiredInterface + +.. autoclass:: open_gopro.communicator_interface.GoProWirelessInterface + +.. autoclass:: open_gopro.communicator_interface.BaseGoProCommunicator + + +BLE Interface +============= + +.. automodule:: open_gopro.ble.controller + +.. automodule:: open_gopro.ble.client + +BLEServices +----------- + +.. automodule:: open_gopro.ble.services + +WiFi Interface +============== + +.. automodule:: open_gopro.wifi.controller + +.. automodule:: open_gopro.wifi.client diff --git a/python_sdk/_sources/authors.rst.txt b/python_sdk/_sources/authors.rst.txt new file mode 100644 index 00000000..21a9f8bd --- /dev/null +++ b/python_sdk/_sources/authors.rst.txt @@ -0,0 +1,15 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +======= +Credits +======= + +Development Lead +---------------- + +* Tim Camise + +Contributors +------------ + +* Ben Freeland diff --git a/python_sdk/_sources/changelog.rst.txt b/python_sdk/_sources/changelog.rst.txt new file mode 100644 index 00000000..b72ad215 --- /dev/null +++ b/python_sdk/_sources/changelog.rst.txt @@ -0,0 +1,290 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +========= +Changelog +========= + +All notable changes to this project will be documented in this file. + +The format is based on `Keep a Changelog `_, +and this project adheres to `Semantic Versioning `_. + +0.16.0 (April-9-2024) +--------------------- +* Refactor all network operations to operate on common Message class +* Add PUT Operation support +* Add Custom Preset Update +* Update Bleak to 0.21.1 + +0.15.1 (December-6-2023) +------------------------ +* Fix livestream demo. + +0.15.0 (December-6-2023) +------------------------ +* Add alpha support for COHN (Camera-on-the-Home-Network) + * A real implementation is going to require a major rearchitecture to dynamically add connection types. +* Remove TKinter GUI. Will be replaced with Textual TUI in the future +* Improve wifi SSID matching +* Fix unhashable pydantic base models + +0.14.1 (September-21-2023) +-------------------------- +* Fix BLE notifications not being routed correctly +* Don't hardcode media directory. Also append directory to filenames in media list. +* Fix malformed Set Setting HTTP url + +0.14.0 (September-13-2023) +-------------------------- +* NOTE! This is a major update and includes massive API breaking changes. +* Move to asyncio-based framework +* Add HERO 12 support +* Move from generic response to per-command typed response +* Improve video viewer latency +* Improve BLE and HTTP setting documentation +* Add media list and metadata pydantic models + +0.13.0 (February-24-2023) +------------------------- + +* Allow for GUI dependencies to be optional (with "gui" extras) +* Add English language verification for Wifi Driver +* Documentation fixes missed from 0.12.0 +* Update dependencies (including bleak to 0.19.5) + +0.12.0 (December-16-2023) +------------------------- +* Add USB support + + * Introduces breaking changes of top level interface (i.e. GoPro --> WirelessGoPro / WiredGoPro) + * Includes mDNS discovery of GoPro's +* Add run-time python version verification +* Improve error messaging and documentation around wifi interface issues +* Add livestream demo +* Add webcam demo +* Add message rules for Commands / Settings / Statuses (Fastpass, etc) + +0.11.2 (November-9-2022) +------------------------ +* Update bleak to 0.19.0 +* Improve Bluetooth Scan delays +* Add support for Hero 11 Mini + +0.11.1 (October-18-2022) +------------------------ +* Improve Mac Wifi connection robustness +* Fix BLE can ignoring timeout and retry args + +0.11.0 (September-14-2022) +-------------------------- +* Add Hero 11 Support +* Add Presets Control Demo +* Refactor all commands to be variadic +* Add API GUI MVC framework +* Protobuf command bug fixes +* Improve API doc generation and docstring verification +* Drop Python 3.8 support + +0.10.0 (July-14-2022) +--------------------- +* Add sudo password argument to Wifi Controller and expose through CLI demos via stdin +* Add more protobuf commands and missing protobuf ID parsing functionality +* Add livestream demo GUI +* Change preview stream demo to be a GUI +* Add support for fragmenting long data packets when sending BLE data + +0.9.2 (June-16-2022) +----------------------- +* Remove use of importlib.metadata as it was complicating pyinstaller use of this package + +0.9.1 (May-27-2022) +----------------------- +* Improve non-main thread and asyncio exception handling +* Add pydocstyle verification + +0.9.0 (February-7-2022) +----------------------- +* Move to Poetry-based development environment +* Fix docstring inconsistencies + +0.8.0 (February-3-2022) +----------------------- +* Improve BLE connection Robustness +* Deprecate support for Open GoPro Versions other than 2.0 +* Add set / date time commands +* Implement remaining protobuf commands and fix protobuf parsing +* Add hilight commands +* Implement common UUID type +* Add video performance mode +* Remove deprecated status and setting ID's + +0.7.2 (January-3-2022) +---------------------- +* Allow for WiFi adapter to specify interface +* Clean up Wifi adapter +* Bump test package versions + +0.7.1 (December-16-2021) +------------------------- +* Add global behaviors commands and camera control status +* Add register / unregister all for settings and statuses +* Add max lens setting +* Improve API documentation + +0.7.0 (October-27-2021) +------------------------- +* Add video performance mode functionality + +0.6.3 (October-7-2021) +------------------------- +* Decouple response accumulating from parsing + +0.6.2 (September-28-2021) +------------------------- +* Fix setup.py entrypoints for demo programs + +0.6.1 (September-20-2021) +------------------------- + +* make parsers available at instantiation +* use GoPro specific enums to handle invalid parameter cases +* handle HTTP GET errors +* add Construct typing +* update Construct parsers to return actual enum's so identity checks can be used + +0.6.0 (September-2-2021) +------------------------ + +* Major refactor to support multiple Open GoPro API versions and different BLE / WiFi adapters +* Improve BLE connection robustness by ensuring disconnects +* Implement Open GoPro Version 2.0 +* Major documentation updates +* Add end-to-end testing and improve test coverage +* Upgrade bleak +* Add connect WiFi demos + +0.5.8 (August-10-2021) +---------------------- + +* Add option to start GoPro communication without WiFi (i.e only use BLE) +* Add battery logging example + +0.5.7 (June-7-2021) +------------------- + +* Fix wifi driver for Windows + +0.5.6 (May-26-2021) +------------------- + +* Minor documentation updates + +0.5.5 (May-26-2021) +------------------- + +* Documentation link updates + +0.5.4 (May-6-2021) +------------------ + +* Update documentation to coexist with jekyll on Github pages + +0.5.3 (April-15-2021) +--------------------- + +* Documentation updates +* Move into Open GoPro repo + +0.5.2 (April-2-2021) +-------------------- + +* Add entrypoints for video, photo, and stream +* Updates to response interface for usability +* Fix Ubuntu Wifi driver scanning + +0.5.1 (April-1-2021) +-------------------- + +* Add photo, video, and stream entry points +* Change active accumulating response to a dict indexed by UUID's to handle simultaneous active responses + +0.5.0 (March-30-2021) +--------------------- + +* Add support for Ubuntu 20.04 +* Upgrade to bleak 0.11.0 + +0.4.6 (March-29-2021) +--------------------- + +* Fix bug where multiple simultaneous sync responses weren't handled + +0.4.5 (March-29-2021) +--------------------- + +* Infrastructure updates: + - Move from flake8 to pylint in order to catch missing args in docstrings + - Implement a lot of pylint suggestions + +0.4.4 (March-27-2021) +--------------------- + +* Infrastructure updates: + - Add Github actions for CI / CD + - Fix all mypy and flake8 errors + +0.4.3 (March-26-2021) +--------------------- + +* Make BLE interface controller-agnostic + +0.4.2 (March-25-2021) +--------------------- + +* Fix line endings that were causing PyPi failures + +0.4.1 (March-25-2021) +--------------------- + +* Fix install error by adding protobuf requirement + +0.4.0 (March-25-2021) +--------------------- + +* Merge BLE and WiFi classes into one GoPro class +* Automatically periodically send keep alive +* Run pydocstyle on docstrings + +0.3.3 (March-22-2021) +--------------------- + +* Add support to wait for encoding and system ready statuses in BLE +* Add protobuf framework (not being sent yet) +* Fix Wi-Fi SSID corner cases + +0.3.2 (March-15-2021) +--------------------- + +* Handle case where BLE parameter has length 0 +* Doc updates + +0.3.1 (March-12-2021) +--------------------- + +* Add automatic VLC opening + +0.3.0 (March-11-2021) +--------------------- + +* Wrote documentation and did some refactoring + +0.2.0 (March-10-2021) +--------------------- + +* first usable Beta package. +* Should work on Windows and Mac + +0.1.x (March-10-2021) +--------------------- + +* open_gopro created. Incremental updates until the package could actually install diff --git a/python_sdk/_sources/contributing.rst.txt b/python_sdk/_sources/contributing.rst.txt new file mode 100644 index 00000000..92d7faef --- /dev/null +++ b/python_sdk/_sources/contributing.rst.txt @@ -0,0 +1,136 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +============ +Contributing +============ + +Contributions are welcome, are greatly appreciated, and credit will always be given. + +Types of Contributions +---------------------- + +Report Bugs +~~~~~~~~~~~ + +Report bugs at https://github.com/gopro/OpenGoPro/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +Fix Bugs +~~~~~~~~ + +Look through the GitHub issues for bugs. Anything tagged with "bug" +and "help wanted" is open to whoever wants to implement it. + +Implement Features +~~~~~~~~~~~~~~~~~~ + +Look through the GitHub issues for features. Anything tagged with "enhancement" +and "help wanted" is open to whoever wants to implement it. + +Write Documentation +~~~~~~~~~~~~~~~~~~~ + +Open GoPro could always use more documentation, whether as part of the +official Open GoPro docs, in docstrings, or even on the web in blog posts, +articles, and such. + +Submit Feedback +~~~~~~~~~~~~~~~ + +The best way to send feedback is to file an issue at +https://github.com/gopro/OpenGoPro/issues. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. + +Get Started! +------------ + +Ready to contribute? Here's how to set up Open GoPro for local development. + +Minimal Requirements +~~~~~~~~~~~~~~~~~~~~ + +* Python (>= 3.9, < 3.12) +* `Poetry `_ : Needed to install dependencies / development tasks + +Additional Optional Requirements: + +* `protoc `_ to build protobuf python files from .proto's +* `graphviz `_ to build diagrams in sphinx + +Steps +~~~~~ + +#. Fork the Open GoPro repo on GitHub. +#. Clone your fork locally: + + .. code-block:: console + + $ git clone git@github.com:your_name_here/OpenGoPro.git + +#. Enter the sdk_wireless_camera_control directory: + + .. code-block:: console + + $ cd OpenGoPro/demos/python/sdk_wireless_camera_control + +#. Create a branch for local development, originating from the `main` branch: + + .. code-block:: console + + $ git checkout -b name-of-your-bugfix-or-feature main + +#. Install your local copy into a virtual environment. + + .. code-block:: console + + $ poetry install --all-extras + +#. Make your changes locally. When you're done making changes, check that your changes are: + + * formatted + * pass type checking + * pass linting + * pass unit tests + * pass docstring tests + + .. code-block:: console + + $ poetry run poe all + + Note that each of these checks can be run individually. For more information, see: + + .. code-block:: console + + $ poetry run poe --help + +#. Commit your changes, push your branch to GitHub, and submit a pull request into `main`. Once the Pull Request is made, + Github Actions will test the changes across multiple OS's and Python versions. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +#. If the pull request adds functionality, the docs should be updated. The docs can be build locally via: + + .. code-block:: console + + $ poetry run poe docs + +#. Modify the ``CHANGELOG.rst``. +#. The pull request should work for Python 3.8 - 3.12 on the following platforms: + + - Windows 10, version 16299 (Fall Creators Update) and greater + - Linux distributions with BlueZ >= 5.43 + - OS X / macOS >= 10.11 + +#. Feel free to add your name as a contributor to the ``AUTHORS.rst`` file! \ No newline at end of file diff --git a/python_sdk/_sources/future_work.rst.txt b/python_sdk/_sources/future_work.rst.txt new file mode 100644 index 00000000..2c300f91 --- /dev/null +++ b/python_sdk/_sources/future_work.rst.txt @@ -0,0 +1,18 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +=========== +Future Work +=========== + +See the Github `Issues `_ page for tickets tagged with "Python SDK" +and "Enhancement." +`Here `_ is a +sample search. + +Known issues +************ + +See the Github `Issues `_ page for tickets tagged with "Python SDK" +and "bug." +Here is a sample +`search `_. diff --git a/python_sdk/_sources/index.rst.txt b/python_sdk/_sources/index.rst.txt new file mode 100644 index 00000000..21302fdc --- /dev/null +++ b/python_sdk/_sources/index.rst.txt @@ -0,0 +1,98 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +Open GoPro Python SDK +===================== + +.. figure:: https://raw.githubusercontent.com/gopro/OpenGoPro/main/docs/assets/images/logos/logo.png + :alt: GoPro Logo + :width: 50% + +.. image:: https://img.shields.io/badge/License-MIT-blue.svg + :target: https://lbesson.mit-license.org/ + :alt: MIT License + +.. image:: https://img.shields.io/github/actions/workflow/status/gopro/OpenGoPro/python_sdk_test.yml + :target: https://github.com/gopro/OpenGoPro/actions/workflows/python_sdk_test.yml + :alt: Build and Test + +.. image:: https://img.shields.io/pypi/v/open-gopro + :target: https://pypi.org/project/open-gopro/ + :alt: PyPI + +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Black + +.. image:: _static/coverage.svg + :alt: Coverage + +Summary +------- + +Welcome to the Open GoPro Python package documentation. This is a Python package that provides an +interface for the user to exercise the Open GoPro Bluetooth Low Energy (BLE) and Wi-Fi / USB HTTP API's as +well as install command line interfaces to take photos, videos, and view video streams. + +This package implements the API as defined in the `Open GoPro Specification `_ . +For more information on the API, see the relevant documentation: + +- `BLE API `_ +- `HTTP API `_ + +.. warning:: + This package requires Python >= version 3.9 and < 3.12 + +Features +-------- + +- Top-level GoPro class interface to use BLE, WiFi, and / or USB +- Cross-platform (tested on Windows 10, and Ubuntu 20.04, and >= MacOS Big Sur) + + - BLE controller implemented using `bleak `_ + - Wi-Fi controller provided in the Open GoPro package (loosely based on the `Wireless Library `_ ) +- Supports all wireless commands, settings, and statuses from the `Open GoPro API `_ +- Automatically handles connection maintenance: + + - manage camera ready / encoding + - periodically sends keep alive signals +- Includes detailed logging for each module +- Includes demo scripts installed as command-line applications to show BLE, WiFi, and USB functionality such as: + + - Take a photo + - GUI to send all commands and view the live / preview stream + - Configure and view a GoPro webcam stream + - Take a video + - Start a livestream + - View the GoPro as a webcam + - Log the battery + +Getting Started +--------------- + +Here is a suggested procedure for getting acquainted with this package (it is the same as reading through +this document in order): + +#. :ref:`Install` the package +#. Try some of the :ref:`demos` +#. Implement your own example, perhaps starting with a demo, with :ref:`usage` information +#. If you need more detailed implementation reference, see the Interface :ref:`documentation` + +Development +----------- + +#. Set up the :ref:`development environment` +#. Open a :ref:`Pull Request` + +.. toctree:: + :maxdepth: 4 + :caption: Contents: + + installation + quickstart + usage + api + troubleshooting + contributing + authors + changelog + future_work diff --git a/python_sdk/_sources/installation.rst.txt b/python_sdk/_sources/installation.rst.txt new file mode 100644 index 00000000..903f4d9f --- /dev/null +++ b/python_sdk/_sources/installation.rst.txt @@ -0,0 +1,83 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +============ +Installation +============ + +Stable release +-------------- + +This is the preferred method to install Open GoPro, as it will always install the most recent stable release +from `PyPi `_ . + +If you don't have `pip`_ installed, this `Python installation guide`_ can guide +you through the process. + +.. _pip: https://pip.pypa.io +.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ + +Minimal Install +^^^^^^^^^^^^^^^ + +To minimally install Open GoPro (to use the library and CLI demos), run this command in your terminal: + +.. code-block:: console + + $ pip install open-gopro + +Additional GUI Install +^^^^^^^^^^^^^^^^^^^^^^ + +To additionally install the extra dependencies to run the GUI demos: + +.. code-block:: console + + $ pip install open-gopro[gui] + + +External Dependencies +^^^^^^^^^^^^^^^^^^^^^ + +In order to use any of the Webcam API's, ensure first that your system is setup to +`Use the GoPro as a Webcam `_ + + +From sources +------------ + +The sources for Open GoPro can be downloaded from the `Github repo`_. + +You can either clone the public repository: + +.. code-block:: console + + $ git clone https://github.com/gopro/OpenGoPro + +Or download the `zip`_: + +.. code-block:: console + + $ curl -OL https://github.com/gopro/OpenGoPro/archive/refs/heads/main.zip + +Once you have a copy of the source, you can install it: + +First, enter the directory where the source code exists + +.. code-block:: console + + $ cd OpenGoPro/demos/python/sdk_wireless_camera_control + +Then install the package + +.. code-block:: console + + $ pip install . + +.. _Github repo: https://github.com/gopro/OpenGoPro +.. _zip: https://github.com/gopro/OpenGoPro/archive/refs/heads/main.zip + +For Developers +^^^^^^^^^^^^^^ + +The above installation will not install Open GoPro in editable mode. If you want to modify the package so that +you can change it, for i.e. development, see :ref:`Contribution`. diff --git a/python_sdk/_sources/quickstart.rst.txt b/python_sdk/_sources/quickstart.rst.txt new file mode 100644 index 00000000..51fe45af --- /dev/null +++ b/python_sdk/_sources/quickstart.rst.txt @@ -0,0 +1,229 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +================ +QuickStart Guide +================ + +.. warning:: This section assumes you have successfully :ref:`installed` the package. + +Open GoPro installs with several demos to demonstrate BLE and Wi-Fi. The source code for these examples +can be found on `Github `_ +or locally in `$INSTALL/open_gopro/demos` where $INSTALL can be found with: + +.. code-block:: console + + $ pip show open-gopro + +Note that the GUI demos will only be available if OpenGoPro was installed with the additional GUI option. +See the :ref:`installation` steps for more informatoin. + +Command Line Interface (CLI) Demos +================================== + +All of the CLI demos have command-line help via the `--help` parameter. All demos will log to the console as well +as write a more detailed log to a file (this file can be set with the `--log` parameter). The detailed log +is very helpful for diagnosing BLE / WiFi inconsistencies. + +Photo Demo +---------- + +The `photo` demo will discover a GoPro camera, connect to it, take a photo, and then download the +photo to your local machine. It defaults to connecting to a wireless camera but can connect to a wired camera +by setting the `wired` option. To run, do: + +.. code-block:: console + + $ gopro-photo + +For more information, do: + +.. code-block:: console + + $ gopro-photo --help + usage: gopro-photo [-h] [--output OUTPUT] [--wired] [--log LOG] [--identifier IDENTIFIER] [--wifi_interface WIFI_INTERFACE] [--password] + + Connect to a GoPro camera, take a photo, then download it. + + options: + -h, --help show this help message and exit + --output OUTPUT Where to write the photo to. If not set, write to 'photo.jpg' + --wired Set to use wired (USB) instead of wireless (BLE / WIFI) interface + --log LOG Location to store detailed log + --identifier IDENTIFIER + Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first + discovered GoPro will be connected to + --wifi_interface WIFI_INTERFACE + System Wifi Interface. If not set, first discovered interface will be used. + --password Set to read sudo password from stdin. If not set, you will be prompted for password if needed + +Video Demo +---------- + +The video demo will discover a GoPro camera, connect to it, take a video for a given amount of time, and then +download the photo to your local machine. It defaults to connecting to a wireless camera but can connect to a +wired camera by setting the `wired` option.To run and capture a 2 second video, do: + +.. code-block:: console + + $ gopro-video 2 + +For more information, do: + +.. code-block:: console + + $ gopro-video --help + usage: gopro-video [-h] [-o OUTPUT] [--wired] [--log LOG] [--identifier IDENTIFIER] [--wifi_interface WIFI_INTERFACE] [--password] + record_time + + Connect to a GoPro camera, take a video, then download it. + + positional arguments: + record_time How long to record for + + options: + -h, --help show this help message and exit + -o OUTPUT, --output OUTPUT + Where to write the video to. If not set, write to 'video.mp4' + --wired Set to use wired (USB) instead of wireless (BLE / WIFI) interface + --log LOG Location to store detailed log + --identifier IDENTIFIER + Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first + discovered GoPro will be connected to + --wifi_interface WIFI_INTERFACE + System Wifi Interface. If not set, first discovered interface will be used. + --password Set to read sudo password from stdin. If not set, you will be prompted for password if needed + +WiFi Demo +----------- + +The `wifi` demo will discover a GoPro camera, connect to it, enable the camera'a WiFi AP, and then connect +to it via WiFi. This is useful if you want to send HTTP commands to it from some external source such as curl. + +Note that this demo will run, thus maintaining the WiFi connection, until exited by pressing enter. + +.. code-block:: console + + $ gopro-wifi + +For more information, do: + +.. code-block:: console + + $ gopro-wif --help + usage: gopro-wifi [-h] [-l LOG] [-i IDENTIFIER] [-w WIFI_INTERFACE] [-p] + + Connect to a GoPro camera's Wifi Access Point. + + optional arguments: + -h, --help show this help message and exit + -l LOG, --log LOG Location to store detailed log + -i IDENTIFIER, --identifier IDENTIFIER + Last 4 digits of GoPro serial number, which is the last 4 digits of the + default camera SSID. If not used, first discovered GoPro will be + connected to + -w WIFI_INTERFACE, --wifi_interface WIFI_INTERFACE + System Wifi Interface. If not set, first discovered interface will be + used. + -p, --password Set to read sudo password from stdin. If not set, you will be prompted + for password if needed + +Battery Demo +------------ + +This demo will continuously read the battery level (either via polling or registering fro notifications as +configured per the command line argument) and write +the results to a .csv file. To run, do: + +.. code-block:: console + + $ gopro-log-battery + +For more information, do: + +.. code-block:: console + + $ gopro-log-battery --help + usage: gopro-log-battery [-h] [-p POLL] [-l LOG] [-i IDENTIFIER] + + Connect to the GoPro via BLE only and continuously read the battery (either by polling or + notifications). + + optional arguments: + -h, --help show this help message and exit + -p POLL, --poll POLL Set to poll the battery at a given interval. If not set, battery level + will be notified instead. Defaults to notifications. + -l LOG, --log LOG Location to store detailed log + -i IDENTIFIER, --identifier IDENTIFIER + Last 4 digits of GoPro serial number, which is the last 4 digits of the + default camera SSID. If not used, first discovered GoPro will be + connected to + + +Graphical User Interface (GUI) Demos +==================================== + +Wired Webcam Demo +----------------- + +The `webcam` demo will configure a GoPro (identified via serial number) as a webcam, start the webcam, and use +`OpenCV `_ to start a viewer to display the stream. + +.. code-block:: console + + $ gopro-webcam + +For more information, do: + +.. code-block:: console + + $ gopro-webcam --help + usage: gopro-webcam [-h] [-i IDENTIFIER] [-l LOG] + + Setup and view a GoPro webcam. + + options: + -h, --help show this help message and exit + -i IDENTIFIER, --identifier IDENTIFIER + Last 3 digits of GoPro serial number, which is the last 3 digits of the default camera SSID. If not specified, first + GoPro discovered via mDNS will be used + -l LOG, --log LOG Location to store detailed log + +Livestream Demo +--------------- + +The `livestream` demo will connect via BLE to the camera, connect the camera to a Wifi AP, configure / start +livestream, then use `OpenCV `_ to start a viewer to display the stream. + +.. code-block:: console + + $ gopro-webcam + +For more information, do: + +.. code-block:: console + + $ gopro-livestream --help + usage: gopro-livestream [-h] [--min_bit MIN_BIT] [--max_bit MAX_BIT] [--start_bit START_BIT] [--resolution {4,7,12}] [--fov {0,4,3}] + [--log LOG] [--identifier IDENTIFIER] + ssid password url + + Connect to the GoPro via BLE only, configure then start a Livestream, then display it with CV2. + + positional arguments: + ssid WiFi SSID to connect to. + password Password of WiFi SSID. + url RTMP server URL to stream to. + + options: + -h, --help show this help message and exit + --min_bit MIN_BIT Minimum bitrate. + --max_bit MAX_BIT Maximum bitrate. + --start_bit START_BIT + Starting bitrate. + --resolution {4,7,12} + Resolution. + --fov {0,4,3} Field of View. + --log LOG Location to store detailed log + --identifier IDENTIFIER + Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first + discovered GoPro will be connected to diff --git a/python_sdk/_sources/troubleshooting.rst.txt b/python_sdk/_sources/troubleshooting.rst.txt new file mode 100644 index 00000000..ad835647 --- /dev/null +++ b/python_sdk/_sources/troubleshooting.rst.txt @@ -0,0 +1,56 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +=============== +Troubleshooting +=============== + +This section will provide some information on how to debug the Open GoPro package. + +Logging +------- + +There is a lot of logging sprinkled throughout using the standard Python logging module. + +Furthermore, there is a help function in `util.py` that will enable logging with some default modules / levels. +All of the demos use this and here is an example: + +.. code-block:: python + + from pathlib import Path + + from open_gopro import WirelessGoPro + from open_gopro.util import setup_logging + + logger = setup_logging(__name__, Path("my_log.log")) + + async with WirelessGoPro() as gopro: + logger.info("I'm logged!") + +There are several other logging-related functions that extend and / or offer finer logging control. + +Here is a guide for the levels: + +=================== ======================= + Logging Level Module use +=================== ======================= +logging.TRACE Custom logging level with even more information then debug. You should not need this. +logging.DEBUG Maximum amount of information. Byte level tx / rx. +logging.INFO String-level tx / rx. This is very readable. +logging.WARNING Things that shouldn't have happened but won't break anything +logging.ERROR This is bad and unrecoverable. +logging.CRITICAL Not used. +=================== ======================= + + +Bluetooth Characteristics +------------------------- + +There is a utility in the GoPro class to dump the discovered BLE characteristics to a +CSV file. This can be done as such: + +.. code-block:: python + + from open_gopro import WirelessGoPro + + with WirelessGoPro() as gopro: + gopro._ble.gatt_db.dump_to_csv() diff --git a/python_sdk/_sources/usage.rst.txt b/python_sdk/_sources/usage.rst.txt new file mode 100644 index 00000000..851db2f6 --- /dev/null +++ b/python_sdk/_sources/usage.rst.txt @@ -0,0 +1,492 @@ +:github_url: https://github.com/gopro/OpenGoPro/tree/main/demos/python/sdk_wireless_camera_control + +Usage +***** + +This section will describe some high level information of how to use the Open GoPro module. For more detailed +information, see the :ref:`Interfaces` section. For just running the demos, see the +:ref:`QuickStart` section. + +Overview +======== + +There are two top-level interfaces to communicate with a GoPro camera: + + - :class:`~open_gopro.gopro_wired.WiredGoPro` to communicate with the GoPro via USB HTTP + - :class:`~open_gopro.gopro_wireless.WirelessGoPro` to communicate with the GoPro via BLE and optionally WiFi HTTP + +An individual instance of one of the above classes corresponds to a (potentially not yet) connected GoPro +camera resource. The general procedure to communicate with the GoPro is: + +1. Identify and :ref:`open` the connection to the target GoPro +2. :ref:`Send Messages` and :ref:`Receive Responses` via BLE / HTTP +3. Gracefully :ref:`close` the connection with the GoPro + +.. tip:: There is a lot of useful logging throughout the Open GoPro package. See + :ref:`troubleshooting ` for more info. + +Asyncio +======= + +This package is `asyncio `_-based which means that its awaitable +methods need to be called from an async coroutine. For the code snippets throughout this documentation, assume that this +is accomplished in the same manner as the demo scripts provided: + +.. code-block:: python + + import asyncio + + async def main() -> None: + # Put our code here + + if __name__ == "__main__": + asyncio.run(main()) + +Opening +======= + +Before communicating with a camera, the camera resource must be "opened". This can be done either with or without +the context manager. See the below sections for opening information specific to Wired / Wireless. + +Wireless Opening +---------------- + +The Wireless GoPro client can be opened either with the context manager: + +.. code-block:: python + + from open_gopro import WirelessGoPro + + async with WirelessGoPro() as gopro: + print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!") + # Send some messages now + +\...or without the context manager: + +.. code-block:: python + + from open_gopro import WirelessGoPro + + gopro = WirelessGoPro() + await gopro.open() + print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!") + # Send some messages now + +In either case, the following will have occurred before the camera is ready to communicate: + +#. scan for camera +#. connect to camera via BLE +#. enable notifications +#. pair (if needed) +#. discover characteristics +#. initialize (register for internal status notifications) +#. discover Open GoPro version +#. connect via WiFi (unless specified not to via argument) + +.. note:: While a BLE connection is always needed, the WiFi connection is optional. To configure this (and other + instance arguments) see the API Reference for :class:`~open_gopro.gopro_wireless.WirelessGoPro` + +Wired Opening +------------- + +The Wired GoPro client can be opened either with the context manager: + +.. code-block:: python + + from open_gopro import WiredGoPro + + async with WiredGoPro() as gopro: + print("Yay! I'm connected via USB, opened, and ready to send / get data now!") + # Send some messages now + +\...or without the context manager: + +.. code-block:: python + + from open_gopro import WiredGoPro + + gopro = WiredGoPro() + await gopro.open() + print("Yay! I'm connected via USB, opened, and ready to send / get data now!") + # Send some messages now + +If, as above, an identifier is not passed to the `WiredGoPro`, the mDNS server will be queried during opening to search +for a connected GoPro. + +Common Opening +-------------- + +The GoPro's state can be checked via several properties. + +- :meth:`~open_gopro.gopro_base.GoProBase.is_ble_connected` +- :meth:`~open_gopro.gopro_base.GoProBase.is_http_connected` +- :meth:`~open_gopro.gopro_base.GoProBase.is_open` + +API Version +^^^^^^^^^^^ + +One of the steps during the opening sequence is to query the camera's Open GoPro API version. This SDK only +supports Open GoPro API Version 2.0 so will raise an `InvalidOpenGoProVersion` if the connected camera is +using anything else. + +The version string can be accessed via the :meth:`~open_gopro.gopro_base.GoProBase.version` property. + +Camera Readiness +^^^^^^^^^^^^^^^^ + +A message can not be sent to the camera if it is not ready where "ready" is defined as not encoding and not +busy. These two states are managed automatically by the `WirelessGoPro` instance such that a call to any +message will block until the camera is ready. They are combined into the following ready state: + +- :meth:`~open_gopro.gopro_base.GoProBase.is_ready` + +For example, + +.. code-block:: python + + async with WirelessGoPro() as gopro: + # A naive check for it to be ready + while not await gopro.is_ready: + pass + +To reiterate...it is not needed or recommended to worry about this as the internal state is managed automatically +by the `WirelessGoPro` instance. Just know that most commands will be (asynchronously) blocked until the camera is ready. + +Sending Messages +================ + +Once a `WirelessGoPro` or `WiredGoPro` instance has been :ref:`opened`, it is now possible to send +messages to the camera (provided that the camera is :ref:`ready`). Messages are accessed +by transport protocol where the superset of message groups are: + +.. list-table:: + :widths: 50 50 50 50 + :header-rows: 1 + + * - Message Group + - WiredGoPro + - WirelessGoPro (WiFi Enabled) + - WirelessGoPro (WiFi Disabled) + * - :meth:`~open_gopro.gopro_base.GoProBase.http_command` + - ✔️ + - ✔️ + - ❌ + * - :meth:`~open_gopro.gopro_base.GoProBase.http_setting` + - ✔️ + - ✔️ + - ❌ + * - :meth:`~open_gopro.gopro_base.GoProBase.ble_command` + - ❌ + - ✔️ + - ✔️ + * - :meth:`~open_gopro.gopro_base.GoProBase.ble_setting` + - ❌ + - ✔️ + - ✔️ + * - :meth:`~open_gopro.gopro_base.GoProBase.ble_status` + - ❌ + - ✔️ + - ✔️ + +In the case where a given group of messages is not supported, a `NotImplementedError` will be returned when +the relevant property is accessed. + +All messages are communicated via one of two strategies: + +- Performing synchronous :ref:`data operations` to send a message and receive a GoPro Response +- Registering for :ref:`asynchronous push notifications` and getting these after they are enqueued + +.. note:: For the remainder of this document, the term (a)synchronous is in the context of communication with the camera. + Do not confuse this with `asyncio`: all operations from the user's perspective are awaitable. + +Both of these patterns will be expanded upon below. But first, a note on selecting parameters for use with messages... + +Selecting Parameters +-------------------- + +Whenever a parameter is required for a message, it will be type-hinted in the method definition as either a standard Python type +or an Enum from the :ref:`Params` module. + +Here is a full example for clarity: + +.. code-block:: python + + from open_gopro import WirelessGoPro, Params + + with WirelessGoPro() as gopro: + gopro.ble_command.set_shutter(Params.Toggle.ENABLE) + +.. tip:: The message signature can also be found from the API Reference. For example, here is the documentation + of the above message: :meth:`~open_gopro.api.ble_commands.BleCommands.set_shutter` + + +Synchronous Data Operations +--------------------------- + +.. note:: Unless explicitly specified in the :ref:`Asynchronous` section, + all messages are synchronous messages. + +This section refers to sending commands, getting settings / statuses, and setting settings. In all cases here, +the method will await until a :ref:`response` is received. + +Commands +^^^^^^^^ + +Commands are callable instance attributes of a Messages class instance +(i.e. :class:`~open_gopro.api.ble_commands.BleCommands` or +:class:`~open_gopro.api.http_commands.HttpCommands`), thus they can be called directly: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + await gopro.ble_command.set_shutter(shutter=Params.Toggle.ENABLE) + await gopro.http_command.set_shutter(shutter=Params.Toggle.DISABLE) + +.. warning:: Most commands specifically require `keyword-only arguments `_. You can + not optionally use positional arguments in such cases as this will affect functionality. + +Statuses +^^^^^^^^ + +Statuses are instances of a BleStatus(:class:`~open_gopro.api.builders.BleStatusFacade`). They can be read +synchronously using their `get_value` method as such: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + is_encoding = await gopro.ble_status.encoding_active.get_value() + battery = await gopro.ble_status.int_batt_per.get_value() + +It is also possible to read all statuses at once via: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + statuses = await gopro.ble_command.get_camera_statuses() + +.. note:: + HTTP can not access individual statuses. Instead it can use + :meth:`~open_gopro.api.http_commands.HttpCommands.get_camera_state` + to retrieve all of them (as well as all of the settings) at once + +Settings +^^^^^^^^ + +Settings are instances of a BleSetting(:class:`~open_gopro.api.builders.BleSettingFacade`) +or HttpSetting(:class:`~open_gopro.api.builders.HttpSetting`). They can be interacted synchronously in several +ways. + +Their values can be read (via BLE only) using the `get_value` method as such: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + resolution = await gopro.ble_setting.resolution.get_value() + fov = await gopro.ble_setting.video_field_of_view.get_value() + +It is also possible to read all settings at once via: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + settings = await gopro.ble_command.get_camera_settings() + +.. note:: + HTTP can not access individual settings. Instead it can use + :meth:`~open_gopro.api.http_commands.HttpCommands.get_camera_state` + to retrieve all of them (as well as all of the statuses) at once. + +Depending on the camera's current state, settings will have differing capabilities. It is possible to query +the current capabilities for a given setting (via BLE only) using the `get_capabilities_values` method as such: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + capabilities = await gopro.ble_setting.resolution.get_capabilities_values() + +Settings' values can be set (via either BLE or WiFI) using the `set` method as such: + +.. code-block:: python + + async with WirelessGoPro() as gopro: + await gopro.ble_setting.resolution.set(Params.Resolution.RES_4K) + await gopro.http_setting.fps.set(Params.FPS.FPS_30) + +Asynchronous Push Notifications +------------------------------- + +This section describes how to register for and handle asynchronous push notifications. This is only relevant for BLE. + +It is possible to enable push notifications for any of the following: + +- setting values via :meth:`~open_gopro.api.builders.BleSettingFacade.register_value_update` +- setting capabilities via :meth:`~open_gopro.api.builders.BleSettingFacade.register_capability_update` +- status values via :meth:`~open_gopro.api.builders.BleStatusFacade.register_value_update` + +Firstly, the desired settings / ID must be registered for and given a callback to handle received notifications. + +:meth:`~open_gopro.communicator_interface.BaseGoProCommunicator.register_update`. + +Once registered, the camera will send a push notification when the relevant setting / status changes. These +responses will then be sent to the registered callback for handling. + +It is possible to stop receiving notifications by issuing the relevant unregister command, i.e.: + +- setting values via :meth:`~open_gopro.api.builders.BleSettingFacade.unregister_value_update` +- setting capabilities via :meth:`~open_gopro.api.builders.BleSettingFacade.unregister_capability_update` +- status values via :meth:`~open_gopro.api.builders.BleStatusFacade.unregister_value_update` + +Here is an example of registering for and receiving FOV updates: + +.. code-block:: python + + async def process_battery_notifications(update: types.UpdateType, value: int) -> None: + if update == constants.StatusId.INT_BATT_PER: + ... + elif update == constants.StatusId.BATT_LEVEL: + ... + + async with WirelessGoPro() as gopro: + await gopro.ble_status.int_batt_per.register_value_update(process_battery_notifications) + await gopro.ble_status.batt_level.register_value_update(process_battery_notifications) + +.. note:: The `register_XXX_update` methods also return the current value / capabilities. + +.. warning:: The coupling of command ID to command is not obvious. This is a temporary solution and will be improved upon + in a future release. + +It is also possible to register / unregister for **all** settings, statuses, and / or capabilities +via one API call using the following commands: + +- register for all setting notifications via :meth:`~open_gopro.api.ble_commands.BleCommands.register_for_all_settings` +- register for all status notifications via :meth:`~open_gopro.api.ble_commands.BleCommands.register_for_all_statuses` +- register for all capability notifications via :meth:`~open_gopro.api.ble_commands.BleCommands.register_for_all_capabilities` +- unregister for all setting notifications via :meth:`~open_gopro.api.ble_commands.BleCommands.unregister_for_all_settings` +- unregister for all status notifications via :meth:`~open_gopro.api.ble_commands.BleCommands.unregister_for_all_statuses` +- unregister for all capability notifications via :meth:`~open_gopro.api.ble_commands.BleCommands.unregister_for_all_capabilities` + +Handling Responses +================== + +Unless otherwise stated, all commands, settings, and status operations return a `GoProResp` +(:class:`~open_gopro.models.response.GoProResp`) which is a container around a JSON serializable dict with some helper +functions. + +Response Structure +------------------ + +A `GoProResp` has the following relevant attributes / properties for the end user: + +- | :meth:`~open_gopro.models.response.GoProResp.identifier`: identifier of the completed operation. + | This will vary based on what type the response is and will also contain the most specific identification information. + + - UUID if a direct BLE characteristic read + - CmdId if an Open GoPro BLE Operation + - endpoint string if a Wifi HTTP operation +- :meth:`~open_gopro.models.response.GoProResp.protocol`: the communication protocol where the response was received +- :meth:`~open_gopro.models.response.GoProResp.status`: the status returned from the camera +- :meth:`~open_gopro.models.response.GoProResp.data`: JSON serializable dict containing the responded data +- :meth:`~open_gopro.models.response.GoProResp.ok`: Is this a successful response? + +The response object can be serialized to a JSON string with the default Python `str()` function. Note that +the `identifier` and `status` attributes are appended to the JSON. + +For example, first let's connect, send a command, and then store the response: + +.. code-block:: console + + >>> gopro = WirelessGoPro() + >>> await gopro.open() + >>> response = await (gopro.ble_setting.resolution).get_value() + >>> print(response) + +Now let's print the response (as JSON): + +.. code-block:: console + + >>> print(response) + { + "id" : "QueryCmdId.GET_SETTING_VAL", + "status" : "ErrorCode.SUCCESS", + "protocol" : "Protocol.BLE", + "data" : { + "SettingId.RESOLUTION" : "Resolution.RES_4K_16_9", + }, + } + +Now let's inspect the responses various attributes / properties: + +.. code-block:: console + + >>> print(response.status) + ErrorCode.SUCCESS + >>> print(response.ok) + True + >>> print(response.identifier) + QueryCmdId.GET_SETTING_VAL + >>> print(response.protocol) + Protocol.BLE + +Data Access +----------- + +The response data is stored in the `data` attribute (:meth:`~open_gopro.models.response.GoProResp.data`) and its type +is specified via the Generic type specified in the corresponding command signature where the response is defined. + +For example, consider :meth:`~open_gopro.api.ble_commands.BleCommands.get_hardware_info`. It's signature is: + +.. code-block:: python + + async def get_hardware_info(self) -> GoProResp[CameraInfo]: + ... + +Therefore, its response's `data` property is of type :meth:`~open_gopro.models.general.CameraInfo`. Continuing the +example from above: + + +.. code-block:: console + + >>> gopro = WirelessGoPro(enable_wifi=False) + >>> await gopro.open() + >>> response = await gopro.ble_command.get_hardware_info() + >>> print(response.data) + { + "model_number" : "62", + "model_name" : "HERO12 Black", + "firmware_version" : "H23.01.01.09.67", + "serial_number" : "C3501324500702", + "ap_mac_addr" : "2674f7f66104", + "ap_ssid" : "GP24500702", + } + +Closing +======= + +It is important to close the camera resource when you are done with it. This can be done in two ways. If the context +manager was used, it will automatically be closed when exiting, i.e.: + +.. code-block:: python + + with WirelessGoPro() as gopro: + # Do some things. + pass + # Then when finished... + # The camera resource is closed now!! + +Otherwise, you will need to manually call the `close` method, i.e.: + +.. code-block:: python + + gopro = WirelessGoPro() + await gopro.open() + print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!") + # When we're done... + await gopro.close() + # The camera resource is closed now!! + +The `close` method will handle gracefully disconnecting BLE and Wifi. + +.. warning:: + If the resource is not closed correctly, it is possible that your OS will maintain the BLE connection after + the program exits. This will cause reconnection problems as your OS will not discover devices it is + already connected to. \ No newline at end of file diff --git a/python_sdk/_static/_sphinx_javascript_frameworks_compat.js b/python_sdk/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 00000000..8549469d --- /dev/null +++ b/python_sdk/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/python_sdk/_static/autodoc_pydantic.css b/python_sdk/_static/autodoc_pydantic.css new file mode 100644 index 00000000..994a3e54 --- /dev/null +++ b/python_sdk/_static/autodoc_pydantic.css @@ -0,0 +1,11 @@ +.autodoc_pydantic_validator_arrow { + padding-left: 8px; + } + +.autodoc_pydantic_collapsable_json { + cursor: pointer; + } + +.autodoc_pydantic_collapsable_erd { + cursor: pointer; + } \ No newline at end of file diff --git a/python_sdk/_static/basic.css b/python_sdk/_static/basic.css new file mode 100644 index 00000000..4e9a9f1f --- /dev/null +++ b/python_sdk/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/python_sdk/_static/coverage.svg b/python_sdk/_static/coverage.svg new file mode 100644 index 00000000..321ee2ee --- /dev/null +++ b/python_sdk/_static/coverage.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + coverage + coverage + 76% + 76% + + diff --git a/python_sdk/_static/css/badge_only.css b/python_sdk/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/python_sdk/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/python_sdk/_static/css/fonts/Roboto-Slab-Bold.woff b/python_sdk/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/python_sdk/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/python_sdk/_static/css/fonts/Roboto-Slab-Bold.woff2 b/python_sdk/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/python_sdk/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/python_sdk/_static/css/fonts/Roboto-Slab-Regular.woff b/python_sdk/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/python_sdk/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/python_sdk/_static/css/fonts/Roboto-Slab-Regular.woff2 b/python_sdk/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/python_sdk/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/python_sdk/_static/css/fonts/fontawesome-webfont.eot b/python_sdk/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/python_sdk/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/python_sdk/_static/css/fonts/fontawesome-webfont.svg b/python_sdk/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/python_sdk/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/python_sdk/_static/css/fonts/fontawesome-webfont.ttf b/python_sdk/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/python_sdk/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/python_sdk/_static/css/fonts/fontawesome-webfont.woff b/python_sdk/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/python_sdk/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/python_sdk/_static/css/fonts/fontawesome-webfont.woff2 b/python_sdk/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/python_sdk/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/python_sdk/_static/css/fonts/lato-bold-italic.woff b/python_sdk/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-bold-italic.woff differ diff --git a/python_sdk/_static/css/fonts/lato-bold-italic.woff2 b/python_sdk/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/python_sdk/_static/css/fonts/lato-bold.woff b/python_sdk/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-bold.woff differ diff --git a/python_sdk/_static/css/fonts/lato-bold.woff2 b/python_sdk/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-bold.woff2 differ diff --git a/python_sdk/_static/css/fonts/lato-normal-italic.woff b/python_sdk/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-normal-italic.woff differ diff --git a/python_sdk/_static/css/fonts/lato-normal-italic.woff2 b/python_sdk/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/python_sdk/_static/css/fonts/lato-normal.woff b/python_sdk/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-normal.woff differ diff --git a/python_sdk/_static/css/fonts/lato-normal.woff2 b/python_sdk/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/python_sdk/_static/css/fonts/lato-normal.woff2 differ diff --git a/python_sdk/_static/css/theme.css b/python_sdk/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/python_sdk/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/python_sdk/_static/doctools.js b/python_sdk/_static/doctools.js new file mode 100644 index 00000000..527b876c --- /dev/null +++ b/python_sdk/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/python_sdk/_static/documentation_options.js b/python_sdk/_static/documentation_options.js new file mode 100644 index 00000000..b57ae3b8 --- /dev/null +++ b/python_sdk/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/python_sdk/_static/file.png b/python_sdk/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/python_sdk/_static/file.png differ diff --git a/python_sdk/_static/graphviz.css b/python_sdk/_static/graphviz.css new file mode 100644 index 00000000..19e7afd3 --- /dev/null +++ b/python_sdk/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/python_sdk/_static/jquery-3.6.0.js b/python_sdk/_static/jquery-3.6.0.js new file mode 100644 index 00000000..fc6c299b --- /dev/null +++ b/python_sdk/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

API Reference

+

This section is a reference for the Open GoPro Python Package API. The BLE / Wifi API’s that +this package implements can be found in the Open GoPro documentation linked from package summary

+
+

Note

+

Not everything is exposed here. This section should only consist of the interface +information that a user (not a developer) of the Open GoPro module should care about.

+
+

For a higher-level summary / usage, see the usage section

+
+

Warning

+

This documentation is not a substitute for the Open GoPro BLE and WiFi +specifications. That is, this interface shows how to use the various +commands but is not an exhaustive source of information for what each command does. The Open GoPro specs +should be used simultaneously with this document for development.

+
+
+

GoPro Client

+

There are two top-level GoPro client interfaces - Wireless and Wired:

+
+

Wireless

+
from open_gopro import WirelessGoPro
+
+
+
Inheritance diagram of open_gopro.gopro_wireless.WirelessGoPro
+ + + + + + + + +
+
+class WirelessGoPro(target: Optional[Pattern] = None, wifi_interface: str | None = None, sudo_password: str | None = None, enable_wifi: bool = True, **kwargs: Any)
+

The top-level BLE and Wifi interface to a Wireless GoPro device.

+

See the Open GoPro SDK for complete documentation.

+

This will handle, for BLE:

+
    +

  • discovering target GoPro device

    • +

  • establishing the connection

    • +

  • discovering GATT characteristics

    • +

  • enabling notifications

    • +

  • discovering Open GoPro version

    • +

  • setting the date, time, timezone, and DST

    • +

  • transferring data

    • +
+

This will handle, for Wifi:

+
    +

  • finding SSID and password

    • +

  • establishing Wifi connection

    • +

  • transferring data

    • +
+

It will also do some synchronization, etc:

+
    +

  • ensuring camera is ready / not encoding before transferring data

    • +

  • sending keep alive signal periodically

    • +
+

If no target arg is passed in, the first discovered BLE GoPro device will be connected to.

+

It can be used via context manager:

+
>>> async with WirelessGoPro() as gopro:
+>>>     print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!")
+>>>     # Send some messages now
+
+
+

Or without:

+
>>> gopro = WirelessGoPro()
+>>> await gopro.open()
+>>> print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!")
+>>> # Send some messages now
+
+
+
+
Parameters:
+
    +

  • target (Pattern, Optional) – A regex to search for the target GoPro’s name. For example, “GoPro 0456”). +Defaults to None (i.e. connect to first discovered GoPro)

    • +

  • wifi_interface (str, Optional) – Set to specify the wifi interface the local machine will use to connect +to the GoPro. If None (or not set), first discovered interface will be used.

    • +

  • sudo_password (str, Optional) – User password for sudo. If not passed, you will be prompted if a password +is needed which should only happen on Nix systems.

    • +

  • enable_wifi (bool) – Optionally do not enable Wifi if set to False. Defaults to True.

    • +

  • kwargs (Dict) – additional parameters for internal use / testing

    • +
+
+
+

# noqa: DAR401

+
+
Raises:
+

InterfaceConfigFailure – In order to communicate via Wifi, there must be an available # noqa: DAR402 + Wifi Interface. By default during initialization, the Wifi driver will attempt to automatically + discover such an interface. If it does not find any, it will raise this exception. Note that + the interface can also be specified manually with the ‘wifi_interface’ argument.

+
+
+
+
+property ble_command: BleCommands
+

Used to call the BLE commands

+
+
Returns:
+

the commands

+
+
Return type:
+

BleCommands

+
+
+
+ +
+
+property ble_setting: BleSettings
+

Used to access the BLE settings

+
+
Returns:
+

the settings

+
+
Return type:
+

BleSettings

+
+
+
+ +
+
+property ble_status: BleStatuses
+

Used to access the BLE statuses

+
+
Returns:
+

the statuses

+
+
Return type:
+

BleStatuses

+
+
+
+ +
+
+async close() → None
+

Safely stop the GoPro instance.

+

This will disconnect BLE and WiFI if applicable.

+

If not using the context manager, it is mandatory to call this before exiting the program in order to +prevent reconnection issues because the OS has never disconnected from the previous session.

+
+ +
+
+async configure_cohn(timeout: int = 60) → bool
+

Prepare Camera on the Home Network

+

Provision if not provisioned +Then wait for COHN to be connected and ready

+
+
Parameters:
+

timeout (int) – time in seconds to wait for COHN to be ready. Defaults to 60.

+
+
Returns:
+

True if success, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+async connect_to_access_point(ssid: str, password: str) → bool
+

Connect the camera to a Wifi Access Point

+
+
Parameters:
+
    +

  • ssid (str) – SSID of AP

    • +

  • password (str) – password of AP

    • +
+
+
Returns:
+

True if AP is currently connected, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+property http_command: HttpCommands
+

Used to access the Wifi commands

+
+
Returns:
+

the commands

+
+
Return type:
+

HttpCommands

+
+
+
+ +
+
+property http_setting: HttpSettings
+

Used to access the Wifi settings

+
+
Returns:
+

the settings

+
+
Return type:
+

HttpSettings

+
+
+
+ +
+
+property identifier: str
+

Get a unique identifier for this instance.

+

The identifier is the last 4 digits of the camera. That is, the same string that is used to +scan for the camera for BLE.

+

If no target has been provided and a camera is not yet found, this will be None

+
+
Raises:
+

GoProNotOpened – Client is not opened yet so no identifier is available

+
+
Returns:
+

last 4 digits if available, else None

+
+
Return type:
+

str

+
+
+
+ +
+
+property is_ble_connected: bool
+

Are we connected via BLE to the GoPro device?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_cohn_provisioned: bool
+

Is COHN currently provisioned?

+

Get the current COHN status from the camera

+
+
Returns:
+

True if COHN is provisioned, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_http_connected: bool
+

Are we connected via HTTP to the GoPro device?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_open: bool
+

Is this client ready for communication?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_ready: bool
+

Is gopro ready to receive commands

+
+
Returns:
+

yes if ready, no otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+async keep_alive() → bool
+

Send a heartbeat to prevent the BLE connection from dropping.

+

This is sent automatically by the GoPro instance if its maintain_ble argument is not False.

+
+
Returns:
+

True if it succeeded,. False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+async open(timeout: int = 10, retries: int = 5) → None
+

Perform all initialization commands for ble and wifi

+

For BLE: scan and find device, establish connection, discover characteristics, configure queries +start maintenance, and get Open GoPro version..

+

For Wifi: discover SSID and password, enable and connect. Or disable if not using.

+
+
Raises:
+
    +

  • Exception – Any exceptions during opening are propagated through

    • +

  • InvalidOpenGoProVersion – Only 2.0 is supported

    • +
+
+
Parameters:
+
    +

  • timeout (int) – How long to wait for each connection before timing out. Defaults to 10.

    • +

  • retries (int) – How many connection attempts before considering connection failed. Defaults to 5.

    • +
+
+
+
+ +
+
+property password: str | None
+

Get the GoPro AP’s password

+
+
Returns:
+

password or None if it is not known

+
+
Return type:
+

str | None

+
+
+
+ +
+
+register_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]], update: Union[SettingId, StatusId, ActionId]) → None
+

Register for callbacks when an update occurs

+
+
Parameters:
+
    +

  • callback (types.UpdateCb) – callback to be notified in

    • +

  • update (types.UpdateType) – update to register for

    • +
+
+
+
+ +
+
+property ssid: str | None
+

Get the GoPro AP’s WiFi SSID

+
+
Returns:
+

SSID or None if it is not known

+
+
Return type:
+

str | None

+
+
+
+ +
+
+unregister_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]], update: Optional[Union[SettingId, StatusId, ActionId]] = None) → None
+

Unregister for asynchronous update(s)

+
+
Parameters:
+
    +

  • callback (types.UpdateCb) – callback to stop receiving update(s) on

    • +

  • update (types.UpdateType | None) – updates to unsubscribe for. Defaults to None (all +updates that use this callback will be unsubscribed).

    • +
+
+
+
+ +
+
+property version: str
+

The API version that the connected camera supports

+

Only 2.0 is currently supported

+
+
Returns:
+

supported version

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+

Wired

+
from open_gopro import WiredGoPro
+
+
+
Inheritance diagram of open_gopro.gopro_wired.WiredGoPro
+ + + + + + +
+
+class WiredGoPro(serial: str | None = None, **kwargs: Any)
+

The top-level USB interface to a Wired GoPro device.

+

See the Open GoPro SDK for complete documentation.

+

If a serial number is not passed when instantiating, the mDNS server will be queried to find a connected +GoPro.

+
+
This class also handles:
    +

  • ensuring camera is ready / not encoding before transferring data

    • +
+
+
+

It can be used via context manager:

+
>>> async with WiredGoPro() as gopro:
+>>>     print("Yay! I'm connected via USB, opened, and ready to send / get data now!")
+>>>     # Send some messages now
+
+
+

Or without:

+
>>> gopro = WiredGoPro()
+>>> await gopro.open()
+>>> print("Yay! I'm connected via USB, opened, and ready to send / get data now!")
+>>> # Send some messages now
+
+
+
+
Parameters:
+
    +

  • serial (Optional[str]) – (at least) last 3 digits of GoPro Serial number. If not set, first GoPro +discovered from mDNS will be used. Defaults to None

    • +

  • kwargs (Any) – additional keyword arguments to pass to base class

    • +
+
+
+
+
+property ble_command: BleCommands
+

Used to call the BLE commands

+
+
Raises:
+

NotImplementedError – Not valid for WiredGoPro

+
+
+
+ +
+
+property ble_setting: BleSettings
+

Used to access the BLE settings

+
+
Raises:
+

NotImplementedError – Not valid for WiredGoPro

+
+
+
+ +
+
+property ble_status: BleStatuses
+

Used to access the BLE statuses

+
+
Raises:
+

NotImplementedError – Not valid for WiredGoPro

+
+
+
+ +
+
+async close() → None
+

Gracefully close the GoPro Client connection

+
+ +
+
+async configure_cohn(timeout: int = 60) → bool
+

Prepare Camera on the Home Network

+

Provision if not provisioned +Then wait for COHN to be connected and ready

+
+
Parameters:
+

timeout (int) – time in seconds to wait for COHN to be ready. Defaults to 60.

+
+
Returns:
+

True if success, False otherwise

+
+
Return type:
+

bool

+
+
Raises:
+

NotImplementedError – not yet possible

+
+
+
+ +
+
+property http_command: HttpCommands
+

Used to access the USB commands

+
+
Returns:
+

the commands

+
+
Return type:
+

HttpCommands

+
+
+
+ +
+
+property http_setting: HttpSettings
+

Used to access the USB settings

+
+
Returns:
+

the settings

+
+
Return type:
+

HttpSettings

+
+
+
+ +
+
+property identifier: str
+

Unique identifier for the connected GoPro Client

+
+
Raises:
+

GoProNotOpened – serial was not passed to instantiation and IP has not yet been discovered

+
+
Returns:
+

identifier

+
+
Return type:
+

str

+
+
+
+ +
+
+property is_ble_connected: bool
+

Are we connected via BLE to the GoPro device?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_cohn_provisioned: bool
+

Is COHN currently provisioned?

+

Get the current COHN status from the camera

+
+
Returns:
+

True if COHN is provisioned, False otherwise

+
+
Return type:
+

bool

+
+
Raises:
+

NotImplementedError – not yet possible

+
+
+
+ +
+
+property is_http_connected: bool
+

Are we connected via Wifi to the GoPro device?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_open: bool
+

Is this client ready for communication?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_ready: bool
+

Is gopro ready to receive commands

+
+
Returns:
+

yes if ready, no otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+async open(timeout: int = 10, retries: int = 1) → None
+

Connect to the Wired GoPro Client and prepare it for communication

+
+
Parameters:
+
    +

  • timeout (int) – time (in seconds) before considering connection a failure. Defaults to 10.

    • +

  • retries (int) – number of connection retries. Defaults to 1.

    • +
+
+
+

# noqa: DAR401

+
+
Raises:
+
+
+
+
+ +
+
+register_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]], update: Union[SettingId, StatusId, ActionId]) → None
+

Register for callbacks when an update occurs

+
+
Parameters:
+
    +

  • callback (types.UpdateCb) – callback to be notified in

    • +

  • update (types.UpdateType) – update to register for

    • +
+
+
Raises:
+

NotImplementedError – not yet possible

+
+
+
+ +
+
+unregister_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]], update: Optional[Union[SettingId, StatusId, ActionId]] = None) → None
+

Unregister for asynchronous update(s)

+
+
Parameters:
+
    +

  • callback (types.UpdateCb) – callback to stop receiving update(s) on

    • +

  • update (types.UpdateType | None) – updates to unsubscribe for. Defaults to None (all +updates that use this callback will be unsubscribed).

    • +
+
+
Raises:
+

NotImplementedError – not yet possible

+
+
+
+ +
+
+property version: str
+

The Open GoPro API version of the GoPro Client

+

Only Version 2.0 is currently supported.

+
+
Returns:
+

string version

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+
+

Open GoPro API

+

These are both the base types that are used to implement the API (BLE Setting, Ble Status, etc.) and the +version-specific API’s themselves.

+

These should not be imported directly and instead should be accessed using the relevant properties (ble_command, +wifi_setting, etc.) of a GoPro(open_gopro.gopro_base.GoProBase) instance.

+
+
+class BleCommands(communicator: CommunicatorType)
+

Bases: BleMessages[BleMessage]

+

All of the BLE commands.

+

To be used as a delegate for a GoProBle instance to build commands

+
+
+async cohn_clear_certificate() → GoProResp[None]
+

Clear the current SSL certificate on the camera that is used for COHN

+
+
Returns:
+

was the clear successful?

+
+
Return type:
+

GoProResp[None]

+
+
+
+ +
+
+async cohn_create_certificate(*, override: bool = False) → GoProResp[None]
+

Create an SSL certificate on the camera to use for COHN

+
+
Parameters:
+

override (bool) – Should the current cert be overwritten?. Defaults to True.

+
+
Returns:
+

certificate creation status

+
+
Return type:
+

GoProResp[None]

+
+
+
+ +
+
+async cohn_get_certificate() → GoProResp[ResponseCOHNCert]
+

Get the current SSL certificate that the camera is using for COHN.

+
+
Returns:
+

the certificate

+
+
Return type:
+

GoProResp[proto.ResponseCOHNCert]

+
+
+
+ +
+
+async cohn_get_status(*, register: bool) → GoProResp[NotifyCOHNStatus]
+

Get (and optionally register for) the current COHN status

+
+
Parameters:
+

register (bool) – whether or not to register

+
+
Returns:
+

current COHN status

+
+
Return type:
+

GoProResp[proto.NotifyCOHNStatus]

+
+
+
+ +
+
+async cohn_set_setting(*, mode: Toggle) → GoProResp[None]
+

Set a COHN specific setting.

+
+
Parameters:
+

mode (open_gopro.api.params.Toggle) – should camera auto connect to home network?

+
+
Returns:
+

status of set

+
+
Return type:
+

GoProResp[None]

+
+
+
+ +
+
+async custom_preset_update(icon_id: int | None = None, title: str | int | None = None) → GoProResp[ResponseGeneric]
+

Update a custom preset title and / or icon

+
+
Parameters:
+
    +

  • icon_id (proto.EnumPresetIcon.ValueType | None) – Icon ID. Defaults to None.

    • +

  • title (str | proto.EnumPresetTitle.ValueType | None) – Custom Preset name or Factory Title ID. Defaults to None.

    • +
+
+
Raises:
+
    +

  • ValueError – Did not set a parameter

    • +

  • TypeError – Title was not proto.EnumPresetTitle.ValueType or string

    • +
+
+
Returns:
+

status of preset update

+
+
Return type:
+

GoProResp[proto.ResponseGeneric]

+
+
+
+ +
+
+async enable_wifi_ap(*, enable: bool) → GoProResp[None]
+

Enable / disable the Wi-Fi Access Point.

+
+
Parameters:
+

enable (bool) – True to enable, False to disable

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_ap_entries(*, scan_id: int, start_index: int = 0, max_entries: int = 100) → GoProResp[ResponseGetApEntries]
+

Get the results of a scan for wifi networks

+
+
Parameters:
+
    +

  • scan_id (int) – ID corresponding to a set of scan results

    • +

  • start_index (int) – Used for paging. 0 <= start_index < NotifStartScanning.total_entries. Defaults to 0.

    • +

  • max_entries (int) – Used for paging. Value must be < NotifStartScanning.total_entries. Defaults to 100.

    • +
+
+
Returns:
+

result of scan with entries for WiFi networks

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_camera_capabilities() → GoProResp[dict[Union[open_gopro.constants.SettingId, open_gopro.constants.StatusId], Any]]
+

Get the current capabilities of each camera setting

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_camera_settings() → GoProResp[dict[Union[open_gopro.constants.SettingId, open_gopro.constants.StatusId], Any]]
+

Get all of the camera’s settings

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_camera_statuses() → GoProResp[dict[Union[open_gopro.constants.SettingId, open_gopro.constants.StatusId], Any]]
+

Get all of the camera’s statuses

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_date_time() → GoProResp[datetime]
+

Get the camera’s date and time (non timezone / DST version)

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_date_time_tz_dst() → GoProResp[TzDstDateTime]
+

Get the camera’s date and time with timezone / DST

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_hardware_info() → GoProResp[CameraInfo]
+

Get the model number, board, type, firmware version, serial number, and AP info

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_last_captured_media() → GoProResp[ResponseLastCapturedMedia]
+

Get the last captured media file

+
+
Returns:
+

status of request and last captured file if successful

+
+
Return type:
+

GoProResp[proto.ResponseLastCapturedMedia]

+
+
+
+ +
+
+async get_open_gopro_api_version() → GoProResp[str]
+

Get Open GoPro API Version

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_preset_status(*, register: list[int] | None = None, unregister: list[int] | None = None) → GoProResp[NotifyPresetStatus]
+

Get information about what Preset Groups and Presets the camera supports in its current state

+

Also optionally (un)register for preset / group preset modified notifications which will be +sent asynchronously as open_gopro.constants.ActionId.PRESET_MODIFIED_NOTIFICATION

+
+
Parameters:
+
    +

  • register (list[open_gopro.api.proto.EnumRegisterPresetStatus], Optional) – Types of preset modified +updates to register for. Defaults to None.

    • +

  • unregister (list[open_gopro.api.proto.EnumRegisterPresetStatus], Optional) – Types of preset modified +updates to unregister for. Defaults to None.

    • +
+
+
Returns:
+

JSON data describing all currently available presets

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_wifi_password() → GoProResp[str]
+

Get the Wifi password.

+
+
Returns:
+

command status and password

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_wifi_ssid() → GoProResp[str]
+

Get the Wifi SSID.

+
+
Returns:
+

command status and SSID

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async load_preset(*, preset: int) → GoProResp[None]
+

Load a Preset

+

The integer preset value can be found from the get_preset_status command

+
+
Parameters:
+

preset (int) – preset ID to load

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async load_preset_group(*, group: int) → GoProResp[None]
+

Load a Preset Group.

+

Once complete, the most recently used preset in this group will be active.

+
+
Parameters:
+

group (open_gopro.api.proto.EnumPresetGroup) – preset group to load

+
+
Returns:
+

response as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async power_down() → GoProResp[None]
+

Power Down the camera

+
+
Returns:
+

status of command

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_for_all_capabilities(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Register push notifications for all capabilities

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

command status and current value of all capabilities

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_for_all_settings(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Register push notifications for all settings

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

command status and current value of all settings

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_for_all_statuses(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Register push notifications for all statuses

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

command status and current value of all statuses

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_livestream_status(*, register: list[int] | None = None, unregister: list[int] | None = None) → GoProResp[NotifyLiveStreamStatus]
+

Register / unregister to receive asynchronous livestream statuses

+
+
Parameters:
+
    +

  • register (Optional[list[open_gopro.api.proto.EnumRegisterLiveStreamStatus]]) – Statuses to register +for. Defaults to None (don’t register for any).

    • +

  • unregister (Optional[list[open_gopro.api.proto.EnumRegisterLiveStreamStatus]]) – Statues to +unregister for. Defaults to None (don’t unregister for any).

    • +
+
+
Returns:
+

current livestream status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async release_network() → GoProResp[None]
+

Disconnect the camera Wifi network in STA mode so that it returns to AP mode.

+
+
Returns:
+

status of release request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async request_wifi_connect(*, ssid: str) → GoProResp[ResponseConnect]
+

Request the camera to connect to a WiFi network that is already provisioned.

+

Updates will be sent as open_gopro.constants.ActionId.NOTIF_PROVIS_STATE

+
+
Parameters:
+

ssid (str) – SSID to connect to

+
+
Returns:
+

Command status of request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async request_wifi_connect_new(*, ssid: str, password: str) → GoProResp[ResponseConnectNew]
+

Request the camera to connect to a WiFi network that is not already provisioned.

+

Updates will be sent as open_gopro.constants.ActionId.NOTIF_PROVIS_STATE

+
+
Parameters:
+
    +

  • ssid (str) – SSID to connect to

    • +

  • password (str) – password of WiFi network

    • +
+
+
Returns:
+

Command status of request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async scan_wifi_networks() → GoProResp[ResponseStartScanning]
+

Scan for Wifi networks

+
+
Returns:
+

Command status of request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_camera_control(*, camera_control_status: int) → GoProResp[None]
+

Tell the camera that the app (i.e. External Control) wishes to claim control of the camera.

+
+
Parameters:
+

camera_control_status (open_gopro.api.proto.EnumCameraControlStatus) – Desired camera control.

+
+
Returns:
+

command status of request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_date_time(*, date_time: datetime) → GoProResp[None]
+

Set the camera’s date and time (non timezone / DST version)

+
+
Parameters:
+

date_time (datetime.datetime) – Date and time to set (Timezone will be ignored)

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_date_time_tz_dst(*, date_time: datetime, tz_offset: int, is_dst: bool) → GoProResp[None]
+

Set the camera’s date and time with timezone and DST

+
+
Parameters:
+
    +

  • date_time (datetime.datetime) – date and time

    • +

  • tz_offset (int) – timezone as UTC offset

    • +

  • is_dst (bool) – is daylight savings time?

    • +
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_livestream_mode(*, url: str, window_size: int, minimum_bitrate: int, maximum_bitrate: int, starting_bitrate: int, lens: int, certs: list[pathlib.Path] | None = None) → GoProResp[None]
+

Initiate livestream to any site that accepts an RTMP URL and simultaneously encode to camera.

+
+
Parameters:
+
    +

  • url (str) – url used to stream. Set to empty string to invalidate/cancel stream

    • +

  • window_size (open_gopro.api.proto.EnumWindowSize) – Streaming video resolution

    • +

  • minimum_bitrate (int) – Desired minimum streaming bitrate (>= 800)

    • +

  • maximum_bitrate (int) – Desired maximum streaming bitrate (<= 8000)

    • +

  • starting_bitrate (int) – Initial streaming bitrate (honored if 800 <= value <= 8000)

    • +

  • lens (open_gopro.api.proto.EnumLens) – Streaming Field of View

    • +

  • certs (list[Path] | None) – list of certificates to use. Defaults to None.

    • +
+
+
Returns:
+

command status of request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_shutter(*, shutter: Toggle) → GoProResp[None]
+

Set the Shutter to start / stop encoding

+
+
Parameters:
+

shutter (open_gopro.api.params.Toggle) – on or off

+
+
Returns:
+

status of command

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_third_party_client_info() → GoProResp[None]
+

Flag as third party app

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_turbo_mode(*, mode: Toggle) → GoProResp[None]
+

Enable / disable turbo mode.

+
+
Parameters:
+

mode (open_gopro.api.params.Toggle) – True to enable, False to disable.

+
+
Returns:
+

command status of request

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async sleep() → GoProResp[None]
+

Put the camera in standby

+
+
Returns:
+

status of command

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async tag_hilight() → GoProResp[None]
+

Tag a highlight during encoding

+
+
Returns:
+

status of command

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async unregister_for_all_capabilities(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Unregister push notifications for all capabilities

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async unregister_for_all_settings(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Unregister push notifications for all settings

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async unregister_for_all_statuses(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Unregister push notifications for all statuses

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+ +
+
+class BleSettings(communicator: GoProBle)
+

Bases: BleMessages[BleSettingMessageBase]

+

The collection of all BLE Settings.

+

To be used by a GoProBle delegate to build setting messages.

+
+
Parameters:
+
    +

  • communicator (GoProBle) – Adapter to read / write settings

    • +

  • params – (type[Params]): the set of parameters to use to build the settings

    • +
+
+
+
+
+anti_flicker: BleSettingFacade[AntiFlicker]
+

Anti Flicker frequency.

+
+ +
+
+auto_off: BleSettingFacade[AutoOff]
+

Set the auto off time.

+
+ +
+
+bit_depth: BleSettingFacade[BitDepth]
+

System Video Bit depth.

+
+ +
+
+bit_rate: BleSettingFacade[BitRate]
+

System Video Bit Rate.

+
+ +
+
+camera_ux_mode: BleSettingFacade[CameraUxMode]
+

Camera controls configuration.

+
+ +
+
+fps: BleSettingFacade[FPS]
+

Frames per second.

+
+ +
+
+framing: BleSettingFacade[Framing]
+

Video Framing Mode

+
+ +
+
+hindsight: BleSettingFacade[Hindsight]
+

Hindsight time / disable

+
+ +
+
+hypersmooth: BleSettingFacade[HypersmoothMode]
+

Set / disable hypersmooth.

+
+ +
+
+led: BleSettingFacade[LED]
+

Set the LED options (or also send the BLE keep alive signal).

+
+ +
+
+max_lens_mode: BleSettingFacade[MaxLensMode]
+

Enable / disable max lens mod.

+
+ +
+
+maxlens_mod_type: BleSettingFacade[MaxLensModType]
+

Max lens mod? If so, what type?

+
+ +
+
+maxlens_status: BleSettingFacade[Toggle]
+

Enable / disable max lens mod

+
+ +
+
+media_format: BleSettingFacade[MediaFormat]
+

Set the media format.

+
+ +
+
+multi_shot_easy_aspect_ratio: BleSettingFacade[EasyAspectRatio]
+

Multi shot easy aspect ratio

+
+ +
+
+multi_shot_field_of_view: BleSettingFacade[MultishotFOV]
+

Multi-shot FOV.

+
+ +
+
+multi_shot_nlv_aspect_ratio: BleSettingFacade[EasyAspectRatio]
+

Multi shot NLV aspect ratio

+
+ +
+
+photo_duration: BleSettingFacade[PhotoDuration]
+

Interval between photo captures

+
+ +
+
+photo_easy_mode: BleSettingFacade[PhotoEasyMode]
+

Night Photo easy mode.

+
+ +
+
+photo_field_of_view: BleSettingFacade[PhotoFOV]
+

Photo FOV.

+
+ +
+
+photo_horizon_leveling: BleSettingFacade[HorizonLeveling]
+

Lock / unlock horizon leveling for photo.

+
+ +
+
+photo_interval: BleSettingFacade[PhotoInterval]
+

Interval between photo captures

+
+ +
+
+photo_mode: BleSettingFacade[PhotoMode]
+

Photo Mode

+
+ +
+
+resolution: BleSettingFacade[Resolution]
+

Resolution.

+
+ +
+
+star_trail_length: BleSettingFacade[StarTrailLength]
+

Multi shot star trail length.

+
+ +
+
+system_video_mode: BleSettingFacade[SystemVideoMode]
+

System video mode.

+
+ +
+
+timelapse_mode: BleSettingFacade[TimelapseMode]
+

Timelapse Mode

+
+ +
+
+video_aspect_ratio: BleSettingFacade[VideoAspectRatio]
+

Video aspect ratio

+
+ +
+
+video_easy_aspect_ratio: BleSettingFacade[EasyAspectRatio]
+

Video easy aspect ratio

+
+ +
+
+video_easy_mode: BleSettingFacade[int]
+

Video easy mode speed. It is not feasible to maintain this setting without code generation so just read as int.

+
+ +
+
+video_field_of_view: BleSettingFacade[VideoFOV]
+

Video FOV.

+
+ +
+
+video_horizon_leveling: BleSettingFacade[HorizonLeveling]
+

Lock / unlock horizon leveling for video.

+
+ +
+
+video_mode: BleSettingFacade[VideoMode]
+

Video Mode (i.e. quality)

+
+ +
+
+video_performance_mode: BleSettingFacade[PerformanceMode]
+

Video Performance Mode.

+
+ +
+
+video_profile: BleSettingFacade[VideoProfile]
+

Video Profile (hdr, etc.)

+
+ +
+
+wifi_band: BleSettingFacade[WifiBand]
+

Current WiFi band being used.

+
+ +
+ +
+
+class BleStatuses(communicator: GoProBle)
+

Bases: BleMessages[BleStatusMessageBase]

+

All of the BLE Statuses.

+

To be used by a GoProBle delegate to build status messages.

+
+
Parameters:
+
    +

  • communicator (GoProBle) – Adapter to read / write settings

    • +

  • params – (type[Params]): the set of parameters to use to build the statuses

    • +
+
+
+
+
+acc_mic_stat: BleStatusFacade[ExposureMode]
+

Microphone Accessory status.

+
+ +
+
+active_preset: BleStatusFacade[int]
+

Currently Preset (ID).

+
+ +
+
+analytics_rdy: BleStatusFacade[AnalyticsState]
+

The current state of camera analytics.

+
+ +
+
+analytics_size: BleStatusFacade[int]
+

The size (units??) of the analytics file.

+
+ +
+
+ap_ssid: BleStatusFacade[str]
+

Camera’s WIFI SSID. On BLE connection, value is big-endian byte-encoded int.

+
+ +
+
+ap_state: BleStatusFacade[bool]
+

Is the Wifi radio enabled?

+
+ +
+
+app_count: BleStatusFacade[int]
+

The number of wireless devices connected to the camera.

+
+ +
+
+band_5ghz_avail: BleStatusFacade[bool]
+

Is 5GHz wireless band available?

+
+ +
+
+batt_level: BleStatusFacade[int]
+

Rough approximation of internal battery level in bars.

+
+ +
+
+batt_ok_ota: BleStatusFacade[bool]
+

Is the internal battery charged sufficiently to start Over The Air (OTA) update?

+
+ +
+
+batt_present: BleStatusFacade[bool]
+

Is the system’s internal battery present?

+
+ +
+
+camera_control: BleStatusFacade[CameraControl]
+

Camera control status ID

+
+ +
+
+camera_lens_type: BleStatusFacade[MaxLensMode]
+

Camera lens type (reflects changes to setting 162).

+
+ +
+
+capt_delay_active: BleStatusFacade[bool]
+

Is Capture Delay currently active (i.e. counting down)?

+
+ +
+
+control_allowed_over_usb: BleStatusFacade[bool]
+

Is control allowed over USB?

+
+ +
+
+creating_preset: BleStatusFacade[bool]
+

Is the camera in the process of creating a custom preset?

+
+ +
+
+current_time_ms: BleStatusFacade[int]
+

System time in milliseconds since system was booted.

+
+ +
+
+dig_zoom_active: BleStatusFacade[bool]
+

Is Digital Zoom feature available?

+
+ +
+
+digital_zoom: BleStatusFacade[int]
+

Digital Zoom level (percent).

+
+ +
+
+download_cancel_pend: BleStatusFacade[bool]
+

Is download firmware update cancel request pending?

+
+ +
+
+encoding_active: BleStatusFacade[bool]
+

Is the camera currently encoding (i.e. capturing photo / video)?

+
+ +
+
+exposure_type: BleStatusFacade[ExposureMode]
+

Liveview Exposure Select Mode.

+
+ +
+
+exposure_x: BleStatusFacade[int]
+

Liveview Exposure Select for y-coordinate (percent).

+
+ +
+
+exposure_y: BleStatusFacade[int]
+

Liveview Exposure Select for y-coordinate (percent).

+
+ +
+
+first_time: BleStatusFacade[bool]
+

Is the camera currently in First Time Use (FTU) UI flow?

+
+ +
+
+flatmode_id: BleStatusFacade[Flatmode]
+

Current flatmode ID.

+
+ +
+
+gps_stat: BleStatusFacade[bool]
+

Does the camera currently have a GPS lock?

+
+ +
+
+in_context_menu: BleStatusFacade[bool]
+

Is the camera currently in a contextual menu (e.g. Preferences)?

+
+ +
+
+int_batt_per: BleStatusFacade[int]
+

Internal battery level (percent).

+
+ +
+
+last_hilight: BleStatusFacade[int]
+

Time since boot (msec) of most recent hilight in encoding video (set to 0 when encoding stops).

+
+ +
+
+lcd_lock_active: BleStatusFacade[bool]
+

Is the LCD lock currently active?

+
+ +
+
+linux_core_active: BleStatusFacade[bool]
+

Is the system’s Linux core active?

+
+ +
+
+live_burst_rem: BleStatusFacade[int]
+

How many Live Bursts can be captured before sdcard is full?

+
+ +
+
+live_burst_total: BleStatusFacade[int]
+

Total number of Live Bursts on sdcard.

+
+ +
+
+locate_active: BleStatusFacade[bool]
+

Is locate camera feature active?

+
+ +
+
+logs_ready: BleStatusFacade[bool]
+

Are system logs ready to be downloaded?

+
+ +
+
+media_mod_mic_stat: BleStatusFacade[MediaModMicStatus]
+

Media mod State.

+
+ +
+
+media_mod_stat: BleStatusFacade[MediaModStatus]
+

Media Mode Status (bitmasked).

+
+ +
+
+mobile_video: BleStatusFacade[bool]
+

Are current video settings mobile friendly? (related to video compression and frame rate).

+
+ +
+
+mode_group: BleStatusFacade[int]
+

Current mode group (deprecated in HERO8).

+
+ +
+
+multi_count_down: BleStatusFacade[int]
+

The current timelapse interval countdown value (e.g. 5…4…3…2…1…).

+
+ +
+
+next_poll: BleStatusFacade[int]
+

The min time between camera status updates (msec). Do not poll for status more often than this.

+
+ +
+
+num_group_photo: BleStatusFacade[int]
+

How many group photos can be taken with current settings before sdcard is full?

+
+ +
+
+num_group_video: BleStatusFacade[int]
+

Total number of group videos on sdcard.

+
+ +
+
+num_hilights: BleStatusFacade[int]
+

The number of hilights in encoding video (set to 0 when encoding stops).

+
+ +
+
+num_total_photo: BleStatusFacade[int]
+

Total number of photos on sdcard.

+
+ +
+
+num_total_video: BleStatusFacade[int]
+

Total number of videos on sdcard.

+
+ +
+
+orientation: BleStatusFacade[Orientation]
+

The rotational orientation of the camera.

+
+ +
+
+ota_stat: BleStatusFacade[OTAStatus]
+

The current status of Over The Air (OTA) update.

+
+ +
+
+pair_state: BleStatusFacade[PairState]
+

What is the pair state?

+
+ +
+
+pair_state2: BleStatusFacade[int]
+

Wireless Pairing State.

+
+ +
+
+pair_time: BleStatusFacade[int]
+

Time (milliseconds) since boot of last successful pairing complete action.

+
+ +
+
+pair_type: BleStatusFacade[PairType]
+

The last type of pairing that the camera was engaged in.

+
+ +
+
+photo_presets: BleStatusFacade[int]
+

Current Photo Preset (ID).

+
+ +
+
+photos_rem: BleStatusFacade[int]
+

How many photos can be taken before sdcard is full?

+
+ +
+
+preset_modified: BleStatusFacade[int]
+

Preset Modified Status, which contains an event ID and a preset (group) ID.

+
+ +
+
+presets_group: BleStatusFacade[int]
+

Current Preset Group (ID).

+
+ +
+
+preview_enabled: BleStatusFacade[bool]
+

Is preview stream enabled?

+
+ +
+
+quick_capture: BleStatusFacade[bool]
+

Is quick capture feature enabled?

+
+ +
+
+remote_ctrl_conn: BleStatusFacade[bool]
+

Is the remote control connected?

+
+ +
+
+remote_ctrl_ver: BleStatusFacade[int]
+

What is the remote control version?

+
+ +
+
+scheduled_capture: BleStatusFacade[bool]
+

Is Scheduled Capture set?

+
+ +
+
+scheduled_preset: BleStatusFacade[int]
+

Scheduled Capture Preset ID.

+
+ +
+
+sd_rating_check_error: BleStatusFacade[bool]
+

Does sdcard meet specified minimum write speed?

+
+ +
+
+sd_status: BleStatusFacade[SDStatus]
+

Primary Storage Status.

+
+ +
+
+sd_write_speed_error: BleStatusFacade[int]
+

Number of sdcard write speed errors since device booted

+
+ +
+
+sec_sd_stat: BleStatusFacade[SDStatus]
+

Secondary Storage Status (exclusive to Superbank).

+
+ +
+
+space_rem: BleStatusFacade[int]
+

Remaining space on the sdcard in Kilobytes.

+
+ +
+
+streaming_supp: BleStatusFacade[bool]
+

Is streaming supports in current recording/flatmode/secondary-stream?

+
+ +
+
+system_busy: BleStatusFacade[bool]
+

Is the camera busy?

+
+ +
+
+system_hot: BleStatusFacade[bool]
+

Is the system currently overheating?

+
+ +
+
+system_ready: BleStatusFacade[bool]
+

Is the system ready to accept messages?

+
+ +
+
+timelapse_presets: BleStatusFacade[int]
+

Current Timelapse Preset (ID).

+
+ +
+
+timelapse_rem: BleStatusFacade[int]
+

How many min of Timelapse video can be captured with current settings before sdcard is full?

+
+ +
+
+timewarp_speed_ramp: BleStatusFacade[TimeWarpSpeed]
+

Time Warp Speed.

+
+ +
+
+total_sd_space_kb: BleStatusFacade[int]
+

Total space taken up on the SD card in kilobytes

+
+ +
+
+turbo_mode: BleStatusFacade[bool]
+

Is Turbo Transfer active?

+
+ +
+
+usb_connected: BleStatusFacade[bool]
+

Is the camera connected to a PC via USB?

+
+ +
+
+video_hindsight: BleStatusFacade[bool]
+

Is Video Hindsight Capture Active?

+
+ +
+
+video_low_temp: BleStatusFacade[bool]
+

Is the camera getting too cold to continue recording?

+
+ +
+
+video_presets: BleStatusFacade[int]
+

Current Video Preset (ID).

+
+ +
+
+video_progress: BleStatusFacade[int]
+

When encoding video, this is the duration (seconds) of the video so far; 0 otherwise.

+
+ +
+
+video_rem: BleStatusFacade[int]
+

How many minutes of video can be captured with current settings before sdcard is full?

+
+ +
+
+wap_prov_stat: BleStatusFacade[PairType]
+

Wifi AP provisioning state.

+
+ +
+
+wap_scan_state: BleStatusFacade[PairType]
+

State of current scan for Wifi Access Points. Appears to only change for CAH-related scans.

+
+ +
+
+wifi_bars: BleStatusFacade[int]
+

Wifi signal strength in bars.

+
+ +
+
+wireless_band: BleStatusFacade[WifiBand]
+

Wireless Band.

+
+ +
+
+wireless_enabled: BleStatusFacade[bool]
+

Are Wireless Connections enabled?

+
+ +
+
+wlan_ssid: BleStatusFacade[str]
+

Provisioned WIFI AP SSID. On BLE connection, value is big-endian byte-encoded int.

+
+ +
+
+zoom_encoding: BleStatusFacade[bool]
+

Is this camera capable of zooming while encoding (static value based on model, not settings)?

+
+ +
+ +
+
+class HttpCommands(communicator: CommunicatorType)
+

Bases: HttpMessages[HttpMessage]

+

All of the HTTP commands.

+

To be used as a delegate for a GoProHttp to build commands

+
+
+async add_file_hilight(*, file: str, offset: int | None = None) → GoProResp[None]
+

Add a hilight to a media file (.mp4)

+
+
Parameters:
+
    +

  • file (str) – the media to add the hilight to

    • +

  • offset (int | None) – offset in ms from start of media

    • +
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async delete_all() → GoProResp[None]
+

Delete all files on the SD card.

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp[None]

+
+
+
+ +
+
+async delete_file(*, path: str) → GoProResp[None]
+

Delete a single file including single files that are part of a group.

+
+
Parameters:
+

path (str) – path to file to delete

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp[None]

+
+
+
+ +
+
+async delete_group(*, path: str) → GoProResp[None]
+

Delete all contents of a group. Should not be used on non-group files.

+
+
Parameters:
+

path (str) – path to first file in the group.

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp[None]

+
+
+
+ +
+
+async download_file(*, camera_file: str, local_file: pathlib.Path | None = None) → GoProResp[Path]
+

Download a video from the camera to a local file.

+

If local_file is none, the output location will be the same name as the camera_file.

+
+
Parameters:
+
    +

  • camera_file (str) – filename on camera to operate on

    • +

  • local_file (Path | None) – Location on computer to write output. Defaults to None.

    • +
+
+
Returns:
+

Path to local_file that output was written to

+
+
Return type:
+

Path

+
+
+
+ +
+
+async get_camera_info() → GoProResp[CameraInfo]
+

Get general information about the camera such as firmware version

+
+
Returns:
+

status and settings as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_camera_state() → GoProResp[dict[Union[open_gopro.constants.SettingId, open_gopro.constants.StatusId], Any]]
+

Get all camera statuses and settings

+
+
Returns:
+

status and settings as JSON

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_date_time() → GoProResp[datetime]
+

Get the date and time of the camera (Non timezone / DST aware)

+
+
Returns:
+

current date and time on camera

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_gpmf_data(*, camera_file: str, local_file: pathlib.Path | None = None) → GoProResp[Path]
+

Get GPMF data for a file.

+

If local_file is none, the output location will be the same name as the camera_file.

+
+
Parameters:
+
    +

  • camera_file (str) – filename on camera to operate on

    • +

  • local_file (Path | None) – Location on computer to write output. Defaults to None.

    • +
+
+
Returns:
+

Path to local_file that output was written to

+
+
Return type:
+

Path

+
+
+
+ +
+
+async get_last_captured_media() → GoProResp[MediaPath]
+

Get the last captured media file.

+
+
Returns:
+

path of last captured media file

+
+
Return type:
+

GoProResp[MediaPath]

+
+
+
+ +
+
+async get_media_list() → GoProResp[MediaList]
+

Get a list of media on the camera.

+
+
Returns:
+

Media list JSON structure

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_media_metadata(*, path: str) → GoProResp[MediaMetadata]
+

Get media metadata for a file.

+
+
Parameters:
+

path (str) – Path on camera of media file to get metadata for

+
+
Returns:
+

Media metadata JSON structure

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_open_gopro_api_version() → GoProResp[str]
+

Get Open GoPro API version

+
+
Returns:
+

Open GoPro Version

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_preset_status() → GoProResp[dict[str, Any]]
+

Get status of current presets

+
+
Returns:
+

JSON describing currently available presets and preset groups

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_screennail__call__(*, camera_file: str, local_file: pathlib.Path | None = None) → GoProResp[Path]
+

Get screennail for a file.

+

If local_file is none, the output location will be the same name as the camera_file.

+
+
Parameters:
+
    +

  • camera_file (str) – filename on camera to operate on

    • +

  • local_file (Path | None) – Location on computer to write output. Defaults to None.

    • +
+
+
Returns:
+

Path to local_file that output was written to

+
+
Return type:
+

Path

+
+
+
+ +
+
+async get_telemetry(*, camera_file: str, local_file: pathlib.Path | None = None) → GoProResp[Path]
+

Download the telemetry data for a camera file and store in a local file.

+

If local_file is none, the output location will be the same name as the camera_file.

+
+
Parameters:
+
    +

  • camera_file (str) – filename on camera to operate on

    • +

  • local_file (Path | None) – Location on computer to write output. Defaults to None.

    • +
+
+
Returns:
+

Path to local_file that output was written to

+
+
Return type:
+

Path

+
+
+
+ +
+
+async get_thumbnail(*, camera_file: str, local_file: pathlib.Path | None = None) → GoProResp[Path]
+

Get thumbnail for a file.

+

If local_file is none, the output location will be the same name as the camera_file.

+
+
Parameters:
+
    +

  • camera_file (str) – filename on camera to operate on

    • +

  • local_file (Path | None) – Location on computer to write output. Defaults to None.

    • +
+
+
Returns:
+

Path to local_file that output was written to

+
+
Return type:
+

Path

+
+
+
+ +
+
+async get_webcam_version() → GoProResp[str]
+

Get the version of the webcam implementation

+
+
Returns:
+

version

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async load_preset(*, preset: int) → GoProResp[None]
+

Set camera to a given preset

+

The preset ID can be found from open_gopro.api.http_commands.HttpCommands.get_preset_status

+
+
Parameters:
+

preset (int) – preset to load

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async load_preset_group(*, group: int) → GoProResp[None]
+

Set the active preset group.

+

The most recently used Preset in this group will be set.

+
+
Parameters:
+

group (open_gopro.proto.EnumPresetGroup) – desired Preset Group

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async remove_file_hilight(*, file: str, offset: int | None = None) → GoProResp[None]
+

Remove a hilight from a media file (.mp4)

+
+
Parameters:
+
    +

  • file (str) – the media to remove the hilight from

    • +

  • offset (int | None) – offset in ms from start of media

    • +
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_camera_control(*, mode: CameraControl) → GoProResp[None]
+

Configure global behaviors by setting camera control (to i.e. Idle, External)

+
+
Parameters:
+

mode (open_gopro.api.params.CameraControl) – desired camera control value

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_date_time(*, date_time: datetime, tz_offset: int = 0, is_dst: bool = False) → GoProResp[None]
+

Update the date and time of the camera

+
+
Parameters:
+
    +

  • date_time (datetime.datetime) – date and time

    • +

  • tz_offset (int) – timezone (as UTC offset). Defaults to 0.

    • +

  • is_dst (bool) – is daylight savings time?. Defaults to False.

    • +
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_digital_zoom(*, percent: int) → GoProResp[None]
+

Set digital zoom in percent.

+
+
Parameters:
+

percent (int) – Desired zoom as a percentage

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_keep_alive() → GoProResp[None]
+

Send the keep alive signal to maintain the connection.

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_preview_stream(*, mode: Toggle, port: int | None = None) → GoProResp[None]
+

Start or stop the preview stream

+
+
Parameters:
+
    +

  • mode (open_gopro.api.params.Toggle) – enable to start or disable to stop

    • +

  • port (int) – Port to use for Preview Stream. Defaults to 8554 if None. Only relevant when starting the stream.

    • +
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_shutter(*, shutter: Toggle) → GoProResp[None]
+

Set the shutter on or off

+
+
Parameters:
+

shutter (open_gopro.api.params.Toggle) – on or off (i.e. start or stop encoding)

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_third_party_client_info() → GoProResp[None]
+

Flag as third party app

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set_turbo_mode(*, mode: Toggle) → GoProResp[None]
+

Enable or disable Turbo transfer mode.

+
+
Parameters:
+

mode (open_gopro.api.params.Toggle) – enable / disable turbo mode

+
+
Returns:
+

Status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async update_custom_preset(*, icon_id: int | None = None, title_id: str | int | None = None, custom_name: str | None = None) → GoProResp[None]
+

For a custom preset, update the Icon and / or the Title

+
+
Parameters:
+
    +

  • icon_id (proto.EnumPresetIcon.ValueType | None) – Icon to use. Defaults to None.

    • +

  • title_id (str | proto.EnumPresetTitle.ValueType | None) – Title to use. Defaults to None.

    • +

  • custom_name (str | None) – Custom name to use if title_id is set to +proto.EnumPresetTitle.PRESET_TITLE_USER_DEFINED_CUSTOM_NAME. Defaults to None.

    • +
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async webcam_exit() → GoProResp[WebcamResponse]
+

Exit the webcam.

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async webcam_preview() → GoProResp[WebcamResponse]
+

Start the webcam preview.

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async webcam_start(*, resolution: open_gopro.api.params.WebcamResolution | None = None, fov: open_gopro.api.params.WebcamFOV | None = None, port: int | None = None, protocol: open_gopro.api.params.WebcamProtocol | None = None) → GoProResp[WebcamResponse]
+

Start the webcam.

+
+
Parameters:
+
+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async webcam_status() → GoProResp[WebcamResponse]
+

Get the current status of the webcam

+
+
Returns:
+

command status including the webcam status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async webcam_stop() → GoProResp[WebcamResponse]
+

Stop the webcam.

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async wired_usb_control(*, control: Toggle) → GoProResp[None]
+

Enable / disable wired usb control

+
+
Parameters:
+

control (params.Toggle) – enable or disable

+
+
Returns:
+

command status

+
+
Return type:
+

GoProResp

+
+
+
+ +
+ +
+
+class HttpSettings(communicator: GoProHttp)
+

Bases: HttpMessages[HttpSetting]

+

The collection of all HTTP Settings

+
+
Parameters:
+

communicator (GoProHttp) – Adapter to read / write settings

+
+
+
+
+anti_flicker: HttpSetting[AntiFlicker]
+

Anti Flicker frequency.

+
+ +
+
+auto_off: HttpSetting[AutoOff]
+

Set the auto off time.

+
+ +
+
+bit_depth: HttpSetting[BitDepth]
+

System Video Bit depth.

+
+ +
+
+bit_rate: HttpSetting[BitRate]
+

System Video Bit Rate.

+
+ +
+
+camera_ux_mode: HttpSetting[CameraUxMode]
+

Camera controls configuration.

+
+ +
+
+fps: HttpSetting[FPS]
+

Frames per second.

+
+ +
+
+framing: HttpSetting[Framing]
+

Video Framing Mode

+
+ +
+
+hindsight: HttpSetting[Hindsight]
+

Hindsight time / disable

+
+ +
+
+hypersmooth: HttpSetting[HypersmoothMode]
+

Set / disable hypersmooth.

+
+ +
+
+max_lens_mode: HttpSetting[MaxLensMode]
+

Enable / disable max lens mod.

+
+ +
+
+maxlens_mod_type: HttpSetting[MaxLensModType]
+

Max lens mod? If so, what type?

+
+ +
+
+maxlens_status: HttpSetting[Toggle]
+

Enable / disable max lens mod

+
+ +
+
+media_format: HttpSetting[MediaFormat]
+

Set the media format.

+
+ +
+
+multi_shot_easy_aspect_ratio: HttpSetting[EasyAspectRatio]
+

Multi shot easy aspect ratio

+
+ +
+
+multi_shot_field_of_view: HttpSetting[MultishotFOV]
+

Multi-shot FOV.

+
+ +
+
+multi_shot_nlv_aspect_ratio: HttpSetting[EasyAspectRatio]
+

Multi shot NLV aspect ratio

+
+ +
+
+photo_duration: HttpSetting[PhotoDuration]
+

Interval between photo captures

+
+ +
+
+photo_easy_mode: HttpSetting[PhotoEasyMode]
+

Night Photo easy mode.

+
+ +
+
+photo_field_of_view: HttpSetting[PhotoFOV]
+

Photo FOV.

+
+ +
+
+photo_horizon_leveling: HttpSetting[HorizonLeveling]
+

Lock / unlock horizon leveling for photo.

+
+ +
+
+photo_interval: HttpSetting[PhotoInterval]
+

Interval between photo captures

+
+ +
+
+photo_mode: HttpSetting[PhotoMode]
+

Photo Mode

+
+ +
+
+resolution: HttpSetting[Resolution]
+

Resolution.

+
+ +
+
+star_trail_length: HttpSetting[StarTrailLength]
+

Multi shot star trail length.

+
+ +
+
+system_video_mode: HttpSetting[SystemVideoMode]
+

System video mode.

+
+ +
+
+timelapse_mode: HttpSetting[TimelapseMode]
+

Timelapse Mode

+
+ +
+
+video_aspect_ratio: HttpSetting[VideoAspectRatio]
+

Video aspect ratio

+
+ +
+
+video_easy_aspect_ratio: HttpSetting[EasyAspectRatio]
+

Video easy aspect ratio

+
+ +
+
+video_easy_mode: HttpSetting[int]
+

Video easy mode speed.

+
+ +
+
+video_field_of_view: HttpSetting[VideoFOV]
+

Video FOV.

+
+ +
+
+video_horizon_leveling: HttpSetting[HorizonLeveling]
+

Lock / unlock horizon leveling for video.

+
+ +
+
+video_mode: HttpSetting[VideoMode]
+

Video Mode (i.e. quality)

+
+ +
+
+video_performance_mode: HttpSetting[PerformanceMode]
+

Video Performance Mode (extended battery, tripod, etc).

+
+ +
+
+video_profile: HttpSetting[VideoProfile]
+

Video Profile (hdr, etc.)

+
+ +
+
+wifi_band: HttpSetting[WifiBand]
+

Current WiFi band being used.

+
+ +
+ +
+

Base Types

+
+

GoPro Enum

+
+
+class GoProEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+ +
+
+class GoProIntEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+ +
+
+

BLE Setting

+
Inheritance diagram of open_gopro.api.builders.BleSettingFacade
+ + +
+
+class BleSettingFacade(communicator: GoProBle, identifier: SettingId, parser_builder: Union[Construct, type[open_gopro.enum.GoProIntEnum], BytesParserBuilder])
+

Wrapper around BleSetting since a BleSetting’s message definition changes based on how it is being operated on.

+
+
Parameters:
+
    +

  • communicator (GoProBle) – BLE communicator that will operate on this object.

    • +

  • identifier (SettingId) – Setting Identifier

    • +

  • parser_builder (QueryParserType) – Parses responses from bytes and builds requests to bytes.

    • +
+
+
+
+
+class BleSettingMessageBase(uuid: BleUUID, identifier: open_gopro.constants.SettingId | open_gopro.constants.QueryCmdId, setting_id: SettingId, builder: BuilderProtocol)
+

Actual BLE Setting Message that is wrapped by the facade.

+
+
Parameters:
+
    +

  • uuid (BleUUID) – UUID to access this setting.

    • +

  • identifier (SettingId | QueryCmdId) – How responses to operations on this message will be identified.

    • +

  • setting_id – (SettingId): Setting identifier. May match identifier in some cases.

    • +

  • builder (BuilderProtocol) – Build request bytes from the current message.

    • +
+
+
+
+ +
+
+async get_capabilities_values() → GoProResp[list[ValueType]]
+

Get currently supported settings capabilities values.

+
+
Returns:
+

settings capabilities values

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async get_value() → GoProResp[ValueType]
+

Get the settings value.

+
+
Returns:
+

settings value

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_capability_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Register for asynchronous notifications when a given setting ID’s capabilities update.

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

Current capabilities of respective setting ID

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_value_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Register for asynchronous notifications when a given setting ID’s value updates.

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

Current value of respective setting ID

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async set(value: ValueType) → GoProResp[None]
+

Set the value of the setting.

+
+
Parameters:
+

value (ValueType) – The argument to use to set the setting value.

+
+
Returns:
+

Status of set

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async unregister_capability_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Stop receiving notifications when a given setting ID’s capabilities change.

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

Status of unregister

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async unregister_value_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[None]
+

Stop receiving notifications when a given setting ID’s value updates.

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

Status of unregister

+
+
Return type:
+

GoProResp

+
+
+
+ +
+ +
+
+

BLE Status

+
Inheritance diagram of open_gopro.api.builders.BleStatusFacade
+ + +
+
+class BleStatusFacade(communicator: GoProBle, identifier: StatusId, parser: Union[Construct, type[open_gopro.enum.GoProIntEnum], BytesParserBuilder])
+

Wrapper around BleStatus since a BleStatus’s message definition changes based on how it is being operated on.

+
+
Parameters:
+
    +

  • communicator (GoProBle) – BLE communicator that will operate on this object.

    • +

  • identifier (StatusId) – Status identifier

    • +

  • parser (QueryParserType) – Parser responses from bytes

    • +
+
+
Raises:
+

TypeError – Attempted to pass an invalid parser type

+
+
+
+
+class BleStatusMessageBase(uuid: BleUUID, identifier: open_gopro.constants.StatusId | open_gopro.constants.QueryCmdId, status_id: StatusId, builder: Callable[[Any], bytearray])
+

An individual camera status that is interacted with via BLE.

+
+
Parameters:
+
    +

  • uuid (BleUUID) – UUID to access this status.

    • +

  • identifier (StatusId | QueryCmdId) – How responses to operations on this message will be identified.

    • +

  • status_id (StatusId) – Status identifier. May match identifier in some cases.

    • +

  • builder (Callable[[Any], bytearray]) – Build request bytes from the current message.

    • +
+
+
+
+ +
+
+async get_value() → GoProResp[ValueType]
+

Get the current value of a status.

+
+
Returns:
+

current status value

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async register_value_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp[ValueType]
+

Register for asynchronous notifications when a status changes.

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

current status value

+
+
Return type:
+

GoProResp

+
+
+
+ +
+
+async unregister_value_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]]) → GoProResp
+

Stop receiving notifications when status changes.

+
+
Parameters:
+

callback (types.UpdateCb) – callback to be notified with

+
+
Returns:
+

Status of unregister

+
+
Return type:
+

GoProResp

+
+
+
+ +
+ +
+
+

HTTP Setting

+
Inheritance diagram of open_gopro.api.builders.HttpSetting
+ + + + +
+
+class HttpSetting(communicator: GoProHttp, identifier: SettingId)
+

An individual camera setting that is interacted with via Wifi.

+
+
+build_url(**kwargs: Any) → str
+

Build the endpoint from the current arguments

+
+
Parameters:
+

kwargs (Any) – run-time arguments

+
+
Returns:
+

built URL

+
+
Return type:
+

str

+
+
+
+ +
+
+async set(value: ValueType) → GoProResp
+

Set the value of the setting.

+
+
Parameters:
+

value (ValueType) – value to set setting

+
+
Returns:
+

Status of set

+
+
Return type:
+

GoProResp

+
+
+
+ +
+ +
+
+

Method Protocols

+
+
+class BuilderProtocol(*args, **kwargs)
+

Protocol definition of data building methods

+
+ +
+
+

Message Bases

+

These are the base types that are used to implement version-specific API’s. These are published for reference +but the end user should never need to use these directly.

+
+
+class Message(identifier: Union[SettingId, StatusId, ActionId, CmdId, BleUUID, str], parser: open_gopro.parser_interface.Parser | None = None)
+

Bases: ABC

+

Base class for all messages that will be contained in a Messages class

+
+ +
+
+class HttpMessage(endpoint: str, identifier: Optional[Union[SettingId, StatusId, ActionId, CmdId, BleUUID, str]], components: list[str] | None = None, arguments: list[str] | None = None, body_args: list[str] | None = None, headers: dict[str, Any] | None = None, certificate: pathlib.Path | None = None, parser: open_gopro.parser_interface.Parser | None = None)
+

Bases: Message

+

The base class for all HTTP messages. Stores common information.

+
+
Parameters:
+
    +

  • endpoint (str) – base endpoint

    • +

  • identifier (types.IdType | None) – explicit message identifier. If None, will be generated from endpoint.

    • +

  • components (list[str] | None) – Additional path components (i.e. endpoint/{COMPONENT}). Defaults to None.

    • +

  • arguments (list[str] | None) – Any arguments to be appended after endpoint (i.e. endpoint?{ARGUMENT}). Defaults to None.

    • +

  • body_args (list[str] | None) – Arguments to be added to the body JSON. Defaults to None.

    • +

  • headers (dict[str, Any] | None) – A dict of values to be set in the HTTP operation headers. Defaults to None.

    • +

  • certificate (Path | None) – Path to SSL certificate bundle. Defaults to None.

    • +

  • parser (Parser | None) – Parser to interpret HTTP responses. Defaults to None.

    • +
+
+
+
+
+build_body(**kwargs: Any) → dict[str, Any]
+

Build JSON body from run-time body arguments

+
+
Parameters:
+

**kwargs (Any) – run-time arguments to check to see if each should be added to the body

+
+
Returns:
+

built JSON body

+
+
Return type:
+

dict[str, Any]

+
+
+
+ +
+
+build_url(**kwargs: Any) → str
+

Build the URL string from the passed in components and arguments

+
+
Parameters:
+

**kwargs (Any) – additional entries for the dict

+
+
Returns:
+

built URL

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+class BleMessage(uuid: BleUUID, identifier: Union[SettingId, StatusId, ActionId, CmdId, BleUUID, str], parser: open_gopro.parser_interface.Parser | None)
+

Bases: Message

+

The base class for all BLE messages to store common info

+
+
Parameters:
+
    +

  • communicator (GoProBle) – BLE client to read / write

    • +

  • uuid (BleUUID) – BleUUID to read / write to

    • +
+
+
+
+ +
+
+class Messages(communicator: CommunicatorType)
+

Bases: ABC, dict, Generic[MessageType, CommunicatorType]

+

Base class for setting and status containers

+

Allows message groups to be iterable and supports dict-like access.

+

Instance attributes that are an instance (or subclass) of Message are automatically accumulated during +instantiation

+
+ +
+
+class BleMessages(communicator: CommunicatorType)
+

Bases: Messages[MessageType, GoProBle]

+

A container of BLE Messages.

+

Identical to Messages and it just used for typing

+
+ +
+
+class HttpMessages(communicator: CommunicatorType)
+

Bases: Messages[MessageType, GoProHttp]

+

A container of HTTP Messages.

+

Identical to Messages and it just used for typing

+
+ +
+
+class MessageRules(fastpass_analyzer: Analyzer = <function MessageRules.<lambda>>, wait_for_encoding_analyzer: Analyzer = <function MessageRules.<lambda>>)
+

Message Rules Manager

+
+
Parameters:
+
    +

  • fastpass_analyzer (Analyzer) – used to check if message is fastpass. Defaults to always_false.

    • +

  • wait_for_encoding_analyer (Analyzer) – Used to check if message should wait for encoding. Defaults to always_false.

    • +
+
+
+
+
+class Analyzer(*args, **kwargs)
+

Protocol definition of message rules analyzer

+
+ +
+
+is_fastpass(**kwargs: Any) → bool
+

Is this command fastpass?

+
+
Parameters:
+

kwargs (Any) – Arguments passed into the message

+
+
Returns:
+

result of rule check

+
+
Return type:
+

bool

+
+
+
+ +
+
+should_wait_for_encoding_start(**kwargs: Any) → bool
+

Should this message wait for encoding to start?

+
+
Parameters:
+

kwargs (Any) – Arguments passed into the message

+
+
Returns:
+

result of rule check

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+
+
+

Parameters

+

All of these parameters can be accessed via:

+
from open_gopro import Params
+
+
+

Parameter definitions for GoPro BLE and WiFi commands for Open GoPro version 2.0

+
+
+class AccMicStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+CONNECTED = 1
+
+ +
+
+CONNECTED_AND_PLUGGED_IN = 2
+
+ +
+
+NOT_CONNECTED = 0
+
+ +
+ +
+
+class AnalyticsState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NOT_READY = 0
+
+ +
+
+ON_CONNECT = 2
+
+ +
+
+READY = 1
+
+ +
+ +
+
+class AntiFlicker(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HZ_50 = 3
+
+ +
+
+HZ_60 = 2
+
+ +
+ +
+
+class AutoOff(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+MIN_1 = 1
+
+ +
+
+MIN_15 = 6
+
+ +
+
+MIN_30 = 7
+
+ +
+
+MIN_5 = 4
+
+ +
+
+NEVER = 0
+
+ +
+
+SEC_30 = 12
+
+ +
+
+SEC_8 = 11
+
+ +
+ +
+
+class BitDepth(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+BIT_10 = 2
+
+ +
+
+BIT_8 = 0
+
+ +
+ +
+
+class BitRate(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HIGH = 1
+
+ +
+
+STANDARD = 0
+
+ +
+ +
+
+class CameraControl(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+CAMERA = 1
+
+ +
+
+EXTERNAL = 2
+
+ +
+
+IDLE = 0
+
+ +
+ +
+
+class CameraUxMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+EASY = 0
+
+ +
+
+PRO = 1
+
+ +
+ +
+
+class EasyAspectRatio(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+MOBILE = 1
+
+ +
+
+UNIVERSAL = 2
+
+ +
+
+WIDESCREEN = 0
+
+ +
+ +
+
+class ExposureMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+AUTO = 1
+
+ +
+
+DISABLED = 0
+
+ +
+
+HEMISPHERE = 3
+
+ +
+
+ISO_LOCK = 2
+
+ +
+ +
+
+class FPS(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+FPS_100 = 2
+
+ +
+
+FPS_120 = 1
+
+ +
+
+FPS_200 = 13
+
+ +
+
+FPS_24 = 10
+
+ +
+
+FPS_240 = 0
+
+ +
+
+FPS_25 = 9
+
+ +
+
+FPS_30 = 8
+
+ +
+
+FPS_50 = 6
+
+ +
+
+FPS_60 = 5
+
+ +
+ +
+
+class Flatmode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+BURST_PHOTO = 19
+
+ +
+
+LIVE_BURST = 25
+
+ +
+
+LOOPING = 15
+
+ +
+
+NIGHT_LAPSE_PHOTO = 21
+
+ +
+
+NIGHT_LAPSE_VIDEO = 26
+
+ +
+
+NIGHT_PHOTO = 18
+
+ +
+
+NOT_APPLICABLE = 0
+
+ +
+
+SINGLE_PHOTO = 16
+
+ +
+
+SLO_MO = 27
+
+ +
+
+TIME_LAPSE_PHOTO = 20
+
+ +
+
+TIME_LAPSE_VIDEO = 13
+
+ +
+
+TIME_WARP_VIDEO = 24
+
+ +
+
+UNKNOWN = 28
+
+ +
+
+VIDEO = 12
+
+ +
+
+WEBCAM = 23
+
+ +
+ +
+
+class Framing(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+FULL = 2
+
+ +
+
+VERTICAL = 1
+
+ +
+
+WIDESCREEN = 0
+
+ +
+ +
+
+class Hindsight(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+OFF = 4
+
+ +
+
+SEC_15 = 2
+
+ +
+
+SEC_30 = 3
+
+ +
+ +
+
+class HorizonLeveling(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+LOCKED = 2
+
+ +
+
+OFF = 0
+
+ +
+
+ON = 1
+
+ +
+ +
+
+class HypersmoothMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+AUTO_BOOST = 4
+
+ +
+
+BOOST = 3
+
+ +
+
+HIGH = 2
+
+ +
+
+OFF = 0
+
+ +
+
+ON = 1
+
+ +
+
+STANDARD = 100
+
+ +
+ +
+
+class LED(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ALL_OFF = 4
+
+ +
+
+ALL_ON = 3
+
+ +
+
+BLE_KEEP_ALIVE = 66
+
+ +
+
+FRONT_OFF_ONLY = 5
+
+ +
+
+LED_2 = 2
+
+ +
+ +
+
+class LensMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+DUAL = 5
+
+ +
+
+SINGLE = 0
+
+ +
+ +
+
+class MaxLensModType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NONE = 0
+
+ +
+
+V1 = 1
+
+ +
+
+V2 = 2
+
+ +
+ +
+
+class MaxLensMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+DEFAULT = 0
+
+ +
+
+MAX_LENS = 1
+
+ +
+ +
+
+class MediaFormat(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NIGHT_LAPSE_PHOTO = 21
+
+ +
+
+NIGHT_LAPSE_VIDEO = 26
+
+ +
+
+TIME_LAPSE_PHOTO = 20
+
+ +
+
+TIME_LAPSE_VIDEO = 13
+
+ +
+ +
+
+class MediaModMicStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ONLY = 1
+
+ +
+
+REMOVED = 0
+
+ +
+
+WITH_EXTERNAL = 2
+
+ +
+ +
+
+class MediaModStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+SELFIE_0_HDMI_0_MEDIAMODCONNECTED_FALSE = 0
+
+ +
+
+SELFIE_0_HDMI_0_MEDIAMODCONNECTED_TRUE = 1
+
+ +
+
+SELFIE_0_HDMI_1_MEDIAMODCONNECTED_FALSE = 2
+
+ +
+
+SELFIE_0_HDMI_1_MEDIAMODCONNECTED_TRUE = 3
+
+ +
+
+SELFIE_1_HDMI_0_MEDIAMODCONNECTED_FALSE = 4
+
+ +
+
+SELFIE_1_HDMI_0_MEDIAMODCONNECTED_TRUE = 5
+
+ +
+
+SELFIE_1_HDMI_1_MEDIAMODCONNECTED_FALSE = 6
+
+ +
+
+SELFIE_1_HDMI_1_MEDIAMODCONNECTED_TRUE = 7
+
+ +
+ +
+
+class MultishotFOV(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+LINEAR = 102
+
+ +
+
+MAX_SUPERVIEW = 100
+
+ +
+
+NARROW = 19
+
+ +
+
+NOT_APPLICABLE = 0
+
+ +
+
+WIDE = 101
+
+ +
+ +
+
+class OTAStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+DOWNLOADING = 1
+
+ +
+
+DOWNLOAD_FAILED = 3
+
+ +
+
+GOPRO_APP_DOWNLOADING = 6
+
+ +
+
+GOPRO_APP_DOWNLOAD_FAILED = 8
+
+ +
+
+GOPRO_APP_READY = 10
+
+ +
+
+GOPRO_APP_VERIFYING = 7
+
+ +
+
+GOPRO_APP_VERIFY_FAILED = 9
+
+ +
+
+IDLE = 0
+
+ +
+
+READY = 5
+
+ +
+
+VERIFYING = 2
+
+ +
+
+VERIFY_FAILED = 4
+
+ +
+ +
+
+class Orientation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ON_LEFT_SIDE = 3
+
+ +
+
+ON_RIGHT_SIDE = 2
+
+ +
+
+UPRIGHT = 0
+
+ +
+
+UPSIDE_DOWN = 1
+
+ +
+ +
+
+class PairState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+COMPLETED = 4
+
+ +
+
+FAILED = 2
+
+ +
+
+IN_PROGRESS = 1
+
+ +
+
+NOT_STARTED = 0
+
+ +
+
+STOPPED = 3
+
+ +
+ +
+
+class PairType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NOT_PAIRING = 0
+
+ +
+
+PAIRING_APP = 1
+
+ +
+
+PAIRING_BLUETOOTH = 3
+
+ +
+
+PAIRING_REMOTE_CONTROL = 2
+
+ +
+ +
+
+class PerformanceMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+EXTENDED_BATTERY = 1
+
+ +
+
+MAX_PERFORMANCE = 0
+
+ +
+
+STATIONARY = 2
+
+ +
+ +
+
+class PhotoDuration(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HOUR_1 = 7
+
+ +
+
+HOUR_2 = 8
+
+ +
+
+HOUR_3 = 9
+
+ +
+
+MIN_1 = 3
+
+ +
+
+MIN_15 = 5
+
+ +
+
+MIN_30 = 6
+
+ +
+
+MIN_5 = 4
+
+ +
+
+OFF = 0
+
+ +
+
+SEC_15 = 1
+
+ +
+
+SEC_30 = 2
+
+ +
+ +
+
+class PhotoEasyMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NIGHT_PHOTO = 101
+
+ +
+
+OFF = 0
+
+ +
+
+ON = 1
+
+ +
+
+SUPER_PHOTO = 100
+
+ +
+ +
+
+class PhotoFOV(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HYPERVIEW = 9
+
+ +
+
+LINEAR = 102
+
+ +
+
+LINEAR_HORIZON = 121
+
+ +
+
+MAX_SUPERVIEW = 100
+
+ +
+
+NARROW = 19
+
+ +
+
+NOT_APPLICABLE = 0
+
+ +
+
+WIDE = 101
+
+ +
+ +
+
+class PhotoInterval(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+OFF = 0
+
+ +
+
+SEC_0_5 = 2
+
+ +
+
+SEC_1 = 3
+
+ +
+
+SEC_10 = 6
+
+ +
+
+SEC_120 = 9
+
+ +
+
+SEC_2 = 4
+
+ +
+
+SEC_3 = 10
+
+ +
+
+SEC_30 = 7
+
+ +
+
+SEC_5 = 5
+
+ +
+
+SEC_60 = 8
+
+ +
+ +
+
+class PhotoMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NIGHT = 1
+
+ +
+
+SUPER = 0
+
+ +
+ +
+
+class PresetGroup(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+PHOTO = 1001
+
+ +
+
+TIMELAPSE = 1002
+
+ +
+
+VIDEO = 1000
+
+ +
+ +
+
+class Resolution(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NOT_APPLICABLE = 0
+
+ +
+
+RES_1080 = 9
+
+ +
+
+RES_1080_16_9 = 106
+
+ +
+
+RES_1080_8_7 = 110
+
+ +
+
+RES_1080_9_16 = 30
+
+ +
+
+RES_1440 = 7
+
+ +
+
+RES_2_7K = 4
+
+ +
+
+RES_2_7K_16_9 = 104
+
+ +
+
+RES_2_7K_4_3 = 6
+
+ +
+
+RES_2_7K_4_3_TODO = 105
+
+ +
+
+RES_2_7_K_8_7 = 11
+
+ +
+
+RES_4K = 1
+
+ +
+
+RES_4K_16_9 = 102
+
+ +
+
+RES_4K_4_3 = 18
+
+ +
+
+RES_4K_4_3_TODO = 103
+
+ +
+
+RES_4K_8_7 = 108
+
+ +
+
+RES_4K_8_7_ = 109
+
+ +
+
+RES_4K_8_7_LEGACY = 28
+
+ +
+
+RES_4K_9_16 = 29
+
+ +
+
+RES_5K = 24
+
+ +
+
+RES_5K_4_3 = 25
+
+ +
+
+RES_5_3K = 100
+
+ +
+
+RES_5_3K_16_9 = 101
+
+ +
+
+RES_5_3K_4_3 = 27
+
+ +
+
+RES_5_3K_8_7 = 107
+
+ +
+
+RES_5_3K_8_7_LEGACY = 26
+
+ +
+ +
+
+class SDStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+BUSY = 4
+
+ +
+
+FORMAT_ERROR = 3
+
+ +
+
+FULL = 1
+
+ +
+
+OK = 0
+
+ +
+
+REMOVED = 2
+
+ +
+
+SWAPPED = 8
+
+ +
+
+UNKNOWN = 255
+
+ +
+ +
+
+class StarTrailLength(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+LONG = 2
+
+ +
+
+MAX = 3
+
+ +
+
+NOT_APPLICABLE = 0
+
+ +
+
+SHORT = 1
+
+ +
+ +
+
+class SystemVideoMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+EXTENDED_BATTERY = 1
+
+ +
+
+EXTENDED_BATTERY_GREEN_ICON = 101
+
+ +
+
+HIGHEST_QUALITY = 0
+
+ +
+
+LONGEST_BATTERY_GREEN_ICON = 102
+
+ +
+ +
+
+class TimeWarpSpeed(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+SPEED_10X = 9
+
+ +
+
+SPEED_150X = 3
+
+ +
+
+SPEED_15X = 0
+
+ +
+
+SPEED_1800X = 6
+
+ +
+
+SPEED_1X = 11
+
+ +
+
+SPEED_2X = 7
+
+ +
+
+SPEED_300X = 4
+
+ +
+
+SPEED_30X = 1
+
+ +
+
+SPEED_5X = 8
+
+ +
+
+SPEED_60X = 2
+
+ +
+
+SPEED_900X = 5
+
+ +
+
+SPEED_AUTO = 10
+
+ +
+
+SPEED_HALF = 12
+
+ +
+ +
+
+class TimelapseMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+LIGHT_PAINTING = 2
+
+ +
+
+MAX_LIGHT_PAINTING = 6
+
+ +
+
+MAX_STAR_TRAILS = 5
+
+ +
+
+MAX_TIMEWARP = 4
+
+ +
+
+MAX_VEHICLE_LIGHTS = 7
+
+ +
+
+STAR_TRAILS = 1
+
+ +
+
+TIMEWARP = 0
+
+ +
+
+VEHICLE_LIGHTS = 3
+
+ +
+ +
+
+class Toggle(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+DISABLE = 0
+
+ +
+
+ENABLE = 1
+
+ +
+ +
+
+class VideoAspectRatio(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+RATIO_16_9 = 1
+
+ +
+
+RATIO_4_3 = 0
+
+ +
+
+RATIO_8_7 = 3
+
+ +
+
+RATIO_9_16 = 4
+
+ +
+ +
+
+class VideoFOV(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HYPERVIEW = 9
+
+ +
+
+LINEAR = 4
+
+ +
+
+LINEAR_HORIZON_LEVELING = 8
+
+ +
+
+LINEAR_HORIZON_LOCK = 10
+
+ +
+
+MAX_HYPERVIEW = 11
+
+ +
+
+MAX_SUPERVIEW = 7
+
+ +
+
+NARROW = 2
+
+ +
+
+SUPERVIEW = 3
+
+ +
+
+WIDE = 0
+
+ +
+ +
+
+class VideoMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+BASIC = 2
+
+ +
+
+HIGHEST = 0
+
+ +
+
+STANDARD = 1
+
+ +
+ +
+
+class VideoProfile(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HDR = 1
+
+ +
+
+LOG = 2
+
+ +
+
+STANDARD = 0
+
+ +
+ +
+
+class WAPState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ABORTED = 2
+
+ +
+
+CANCELED = 3
+
+ +
+
+COMPLETED = 4
+
+ +
+
+NEVER_STARTED = 0
+
+ +
+
+STARTED = 1
+
+ +
+ +
+
+class WebcamFOV(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+LINEAR = 4
+
+ +
+
+NARROW = 2
+
+ +
+
+SUPERVIEW = 3
+
+ +
+
+WIDE = 0
+
+ +
+ +
+
+class WebcamProtocol(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+RTSP = 'RTSP'
+
+ +
+
+TS = 'TS'
+
+ +
+ +
+
+class WebcamResolution(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+NOT_APPLICABLE = 0
+
+ +
+
+RES_1080 = 12
+
+ +
+
+RES_480 = 4
+
+ +
+
+RES_720 = 7
+
+ +
+ +
+
+class WifiBand(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+BAND_2_4_GHZ = 0
+
+ +
+
+BAND_5_GHZ = 1
+
+ +
+
+BAND_MAX = 2
+
+ +
+ +
+
+
+

Responses

+

Generic common response container:

+

This can be imported via:

+
from open_gopro import GoProResp
+
+
+
+
+class GoProResp(protocol: Protocol, status: ErrorCode, data: T, identifier: Union[CmdId, QueryCmdId, ActionId, StatusId, SettingId, BleUUID, str, Enum])
+

The object used to encapsulate all GoPro responses.

+

It consists of several common properties / attribute and a data attribute that varies per response.

+
>>> gopro = WirelessGoPro()
+>>> await gopro.open()
+>>> response = await (gopro.ble_setting.resolution).get_value()
+>>> print(response)
+
+
+

Now let’s inspect the responses various attributes / properties:

+
>>> print(response.status)
+ErrorCode.SUCCESS
+>>> print(response.ok)
+True
+>>> print(response.identifier)
+QueryCmdId.GET_SETTING_VAL
+>>> print(response.protocol)
+Protocol.BLE
+
+
+

Now let’s print it’s data as (as JSON):

+
>>> print(response)
+{
+    "id" : "QueryCmdId.GET_SETTING_VAL",
+    "status" : "ErrorCode.SUCCESS",
+    "protocol" : "Protocol.BLE",
+    "data" : {
+        "SettingId.RESOLUTION" : "Resolution.RES_4K_16_9",
+    },
+}
+
+
+
+
+protocol
+

protocol response was received on

+
+
Type:
+

GoProResp.Protocol

+
+
+
+ +
+
+status
+

status of response

+
+
Type:
+

ErrorCode

+
+
+
+ +
+
+data
+

parsed response data

+
+
Type:
+

T

+
+
+
+ +
+
+identifier
+

response identifier, the type of which will vary depending on the response

+
+
Type:
+

types.ResponseType

+
+
+
+ +
+
+class Protocol(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+

Protocol that Command will be sent on.

+
+ +
+
+property ok: bool
+

Are there any errors in this response?

+
+
Returns:
+

True if the response is ok (i.e. there are no errors), False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+ +
+

Data Models

+

These are the various models that are returned in responses, used in commands, etc. They can be imported with:

+
from open_gopro.models import ***
+
+
+
+
+pydantic model MediaMetadata
+

Base Media Metadata class

+

+Show JSON schema
{
+   "title": "MediaMetadata",
+   "description": "Base Media Metadata class",
+   "type": "object",
+   "properties": {
+      "ct": {
+         "title": "Ct",
+         "type": "string"
+      },
+      "cre": {
+         "title": "Cre",
+         "type": "string"
+      },
+      "s": {
+         "title": "S",
+         "type": "string"
+      },
+      "gumi": {
+         "title": "Gumi",
+         "type": "string"
+      },
+      "h": {
+         "title": "H",
+         "type": "string"
+      },
+      "w": {
+         "title": "W",
+         "type": "string"
+      },
+      "hc": {
+         "title": "Hc",
+         "type": "string"
+      },
+      "eis": {
+         "title": "Eis",
+         "type": "string"
+      },
+      "mp": {
+         "title": "Mp",
+         "type": "string"
+      },
+      "rot": {
+         "title": "Rot",
+         "type": "string"
+      },
+      "tr": {
+         "title": "Tr",
+         "type": "string"
+      },
+      "us": {
+         "title": "Us",
+         "type": "string"
+      },
+      "mos": {
+         "anyOf": [
+            {
+               "items": {
+                  "type": "string"
+               },
+               "type": "array"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Mos"
+      },
+      "pgumi": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Pgumi"
+      },
+      "fov": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Fov"
+      },
+      "lc": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Lc"
+      },
+      "prjn": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Prjn"
+      }
+   },
+   "required": [
+      "ct",
+      "cre",
+      "s",
+      "gumi",
+      "h",
+      "w",
+      "hc",
+      "eis",
+      "mp",
+      "rot",
+      "tr",
+      "us"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field content_type: str [Required] (alias 'ct')
+

Media content type

+
+ +
+
+field creation_timestamp: str [Required] (alias 'cre')
+

Creation time in seconds since epoch

+
+ +
+
+field field_of_view: Optional[str] = None (alias 'fov')
+

Field of View

+
+ +
+
+field file_size: str [Required] (alias 's')
+

File size in bytes

+
+ +
+
+field gumi: str [Required]
+

Globally Unique Media ID

+
+ +
+
+field height: str [Required] (alias 'h')
+

Height of media in pixels

+
+ +
+
+field hilight_count: str [Required] (alias 'hc')
+

Number of hilights in media

+
+ +
+
+field image_stabilization: str [Required] (alias 'eis')
+

1 if stabilized, 0 otherwise

+
+ +
+
+field lens_config: Optional[str] = None (alias 'lc')
+

Lens configuration

+
+ +
+
+field lens_projection: Optional[str] = None (alias 'prjn')
+

Lens projection

+
+ +
+
+field media_offload_state: Optional[list[str]] = None (alias 'mos')
+

List of offload states

+
+ +
+
+field metadata_present: str [Required] (alias 'mp')
+

1 if metadata is present, 0 otherwise

+
+ +
+
+field parent_gumi: Optional[str] = None (alias 'pgumi')
+

Only present if in a clip

+
+ +
+
+field rotate: str [Required] (alias 'rot')
+

Media rotation

+
+ +
+
+field transcoded: str [Required] (alias 'tr')
+

1 if file is transcoded, 0 otherwise

+
+ +
+
+field upload_status: str [Required] (alias 'us')
+

Whether or not the media file has been uploaded

+
+ +
+
+field width: str [Required] (alias 'w')
+

Width of media in pixels

+
+ +
+
+classmethod from_json(json_str: dict[str, Any]) → MediaMetadata
+

Build a metadata object given JSON input

+
+
Parameters:
+

json_str (types.JsonDict) – raw JSON

+
+
Returns:
+

parsed metadata

+
+
Return type:
+

MediaMetadata

+
+
+
+ +
+ +
+
+pydantic model PhotoMetadata
+

Bases: MediaMetadata

+

Metadata for a Photo file

+

+Show JSON schema
{
+   "title": "PhotoMetadata",
+   "description": "Metadata for a Photo file",
+   "type": "object",
+   "properties": {
+      "ct": {
+         "title": "Ct",
+         "type": "string"
+      },
+      "cre": {
+         "title": "Cre",
+         "type": "string"
+      },
+      "s": {
+         "title": "S",
+         "type": "string"
+      },
+      "gumi": {
+         "title": "Gumi",
+         "type": "string"
+      },
+      "h": {
+         "title": "H",
+         "type": "string"
+      },
+      "w": {
+         "title": "W",
+         "type": "string"
+      },
+      "hc": {
+         "title": "Hc",
+         "type": "string"
+      },
+      "eis": {
+         "title": "Eis",
+         "type": "string"
+      },
+      "mp": {
+         "title": "Mp",
+         "type": "string"
+      },
+      "rot": {
+         "title": "Rot",
+         "type": "string"
+      },
+      "tr": {
+         "title": "Tr",
+         "type": "string"
+      },
+      "us": {
+         "title": "Us",
+         "type": "string"
+      },
+      "mos": {
+         "anyOf": [
+            {
+               "items": {
+                  "type": "string"
+               },
+               "type": "array"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Mos"
+      },
+      "pgumi": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Pgumi"
+      },
+      "fov": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Fov"
+      },
+      "lc": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Lc"
+      },
+      "prjn": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Prjn"
+      },
+      "raw": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Raw"
+      },
+      "wdr": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Wdr"
+      },
+      "hdr": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Hdr"
+      }
+   },
+   "required": [
+      "ct",
+      "cre",
+      "s",
+      "gumi",
+      "h",
+      "w",
+      "hc",
+      "eis",
+      "mp",
+      "rot",
+      "tr",
+      "us"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field high_dynamic_range: Optional[str] = None (alias 'hdr')
+
+ +
+
+field raw: Optional[str] = None
+

1 if photo taken with wide dynamic range, 0 otherwise

+
+ +
+
+field wide_dynamic_range: Optional[str] = None (alias 'wdr')
+

1 if photo taken with high dynamic range, 0 otherwise

+
+ +
+ +
+
+pydantic model VideoMetadata
+

Bases: MediaMetadata

+

Metadata for a video file

+

+Show JSON schema
{
+   "title": "VideoMetadata",
+   "description": "Metadata for a video file",
+   "type": "object",
+   "properties": {
+      "ct": {
+         "title": "Ct",
+         "type": "string"
+      },
+      "cre": {
+         "title": "Cre",
+         "type": "string"
+      },
+      "s": {
+         "title": "S",
+         "type": "string"
+      },
+      "gumi": {
+         "title": "Gumi",
+         "type": "string"
+      },
+      "h": {
+         "title": "H",
+         "type": "string"
+      },
+      "w": {
+         "title": "W",
+         "type": "string"
+      },
+      "hc": {
+         "title": "Hc",
+         "type": "string"
+      },
+      "eis": {
+         "title": "Eis",
+         "type": "string"
+      },
+      "mp": {
+         "title": "Mp",
+         "type": "string"
+      },
+      "rot": {
+         "title": "Rot",
+         "type": "string"
+      },
+      "tr": {
+         "title": "Tr",
+         "type": "string"
+      },
+      "us": {
+         "title": "Us",
+         "type": "string"
+      },
+      "mos": {
+         "anyOf": [
+            {
+               "items": {
+                  "type": "string"
+               },
+               "type": "array"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Mos"
+      },
+      "pgumi": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Pgumi"
+      },
+      "fov": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Fov"
+      },
+      "lc": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Lc"
+      },
+      "prjn": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Prjn"
+      },
+      "ao": {
+         "title": "Ao",
+         "type": "string"
+      },
+      "profile": {
+         "title": "Profile",
+         "type": "string"
+      },
+      "avc_profile": {
+         "title": "Avc Profile",
+         "type": "string"
+      },
+      "cl": {
+         "title": "Cl",
+         "type": "string"
+      },
+      "dur": {
+         "title": "Dur",
+         "type": "string"
+      },
+      "fps": {
+         "title": "Fps",
+         "type": "string"
+      },
+      "fps_denom": {
+         "title": "Fps Denom",
+         "type": "string"
+      },
+      "hi": {
+         "items": {
+            "type": "string"
+         },
+         "title": "Hi",
+         "type": "array"
+      },
+      "ls": {
+         "title": "Ls",
+         "type": "string"
+      },
+      "mahs": {
+         "title": "Mahs",
+         "type": "string"
+      },
+      "pta": {
+         "title": "Pta",
+         "type": "string"
+      },
+      "subsample": {
+         "title": "Subsample",
+         "type": "string"
+      },
+      "progr": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Progr"
+      }
+   },
+   "required": [
+      "ct",
+      "cre",
+      "s",
+      "gumi",
+      "h",
+      "w",
+      "hc",
+      "eis",
+      "mp",
+      "rot",
+      "tr",
+      "us",
+      "ao",
+      "profile",
+      "avc_profile",
+      "cl",
+      "dur",
+      "fps",
+      "fps_denom",
+      "hi",
+      "ls",
+      "mahs",
+      "pta",
+      "subsample"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field audio_option: str [Required] (alias 'ao')
+

Auto, wind, or stereo

+
+ +
+
+field avc_level: str [Required] (alias 'profile')
+

Advanced Video Codec Level

+
+ +
+
+field avc_profile: str [Required]
+

Advanced Video Code Profile

+
+ +
+
+field clipped: str [Required] (alias 'cl')
+

1 if clipped, 0 otherwise

+
+ +
+
+field duration: str [Required] (alias 'dur')
+

Video duration in seconds

+
+ +
+
+field frame_rate: str [Required] (alias 'fps')
+
+ +
+
+field frame_rate_divisor: str [Required] (alias 'fps_denom')
+

Used to modify frame rate

+
+ +
+
+field hilight_list: list[str] [Required] (alias 'hi')
+

List of hlights in ms offset from start of video

+
+ +
+
+field lrv_file_size: str [Required] (alias 'ls')
+

Low Resolution Video file size in bytes. -1 if there is no LRV

+
+ +
+
+field max_auto_hilight_score: str [Required] (alias 'mahs')
+

Maximum auto-hilight score

+
+ +
+
+field progressive: Optional[str] = None (alias 'progr')
+

1 if progressive, 0 otherwise

+
+ +
+
+field protune_audio: str [Required] (alias 'pta')
+

1 if protune audio is present, 0 otherwise

+
+ +
+
+field subsample: str [Required]
+

1 if subsampled from other video, 0 otherwise

+
+ +
+ +
+
+pydantic model MediaItem
+

Base Media Item class

+

+Show JSON schema
{
+   "title": "MediaItem",
+   "description": "Base Media Item class",
+   "type": "object",
+   "properties": {
+      "n": {
+         "title": "N",
+         "type": "string"
+      },
+      "cre": {
+         "title": "Cre",
+         "type": "string"
+      },
+      "mod": {
+         "title": "Mod",
+         "type": "string"
+      },
+      "glrv": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Glrv"
+      },
+      "ls": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Ls"
+      },
+      "id": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Id"
+      }
+   },
+   "required": [
+      "n",
+      "cre",
+      "mod"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field creation_timestamp: str [Required] (alias 'cre')
+

Creation time in seconds since epoch

+
+ +
+
+field filename: str [Required] (alias 'n')
+

Name of media item

+
+ +
+
+field low_res_video_size: Optional[str] = None (alias 'glrv')
+

Low resolution video size

+
+ +
+
+field lrv_file_size: Optional[str] = None (alias 'ls')
+

Low resolution file size

+
+ +
+
+field modified_time: str [Required] (alias 'mod')
+

Time file was last modified in seconds since epoch

+
+ +
+
+field session_id: Optional[str] = None (alias 'id')
+
+ +
+ +
+
+pydantic model GroupedMediaItem
+

Bases: MediaItem

+

Media Item that is also a grouped item.

+

An example of a grouped item is a burst photo.

+

+Show JSON schema
{
+   "title": "GroupedMediaItem",
+   "description": "Media Item that is also a grouped item.\n\nAn example of a grouped item is a burst photo.",
+   "type": "object",
+   "properties": {
+      "n": {
+         "title": "N",
+         "type": "string"
+      },
+      "cre": {
+         "title": "Cre",
+         "type": "string"
+      },
+      "mod": {
+         "title": "Mod",
+         "type": "string"
+      },
+      "glrv": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Glrv"
+      },
+      "ls": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Ls"
+      },
+      "id": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Id"
+      },
+      "g": {
+         "default": null,
+         "title": "G",
+         "type": "string"
+      },
+      "s": {
+         "default": null,
+         "title": "S",
+         "type": "string"
+      },
+      "b": {
+         "default": null,
+         "title": "B",
+         "type": "string"
+      },
+      "l": {
+         "default": null,
+         "title": "L",
+         "type": "string"
+      },
+      "m": {
+         "default": null,
+         "items": {
+            "type": "string"
+         },
+         "title": "M",
+         "type": "array"
+      },
+      "t": {
+         "default": null,
+         "title": "T",
+         "type": "string"
+      }
+   },
+   "required": [
+      "n",
+      "cre",
+      "mod"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field group_first_member_id: str = None (alias 'b')
+
+ +
+
+field group_id: str = None (alias 'g')
+

Group Identifier

+
+ +
+
+field group_last_member_id: str = None (alias 'l')
+

ID of last member in the group

+
+ +
+
+field group_missing_ids: list[str] = None (alias 'm')
+

(b -> burst, c -> continuous shot, n -> night lapse, t -> time lapse)

+
+ +
+
+field group_size: str = None (alias 's')
+
+ +
+
+field group_type: str = None (alias 't')
+
+ +
+ +
+
+pydantic model MediaFileSystem
+

Grouping of media items into filesystem(s)

+

+Show JSON schema
{
+   "title": "MediaFileSystem",
+   "description": "Grouping of media items into filesystem(s)",
+   "type": "object",
+   "properties": {
+      "d": {
+         "title": "D",
+         "type": "string"
+      },
+      "fs": {
+         "items": {
+            "$ref": "#/$defs/MediaItem"
+         },
+         "title": "Fs",
+         "type": "array"
+      }
+   },
+   "$defs": {
+      "MediaItem": {
+         "description": "Base Media Item class",
+         "properties": {
+            "n": {
+               "title": "N",
+               "type": "string"
+            },
+            "cre": {
+               "title": "Cre",
+               "type": "string"
+            },
+            "mod": {
+               "title": "Mod",
+               "type": "string"
+            },
+            "glrv": {
+               "anyOf": [
+                  {
+                     "type": "string"
+                  },
+                  {
+                     "type": "null"
+                  }
+               ],
+               "default": null,
+               "title": "Glrv"
+            },
+            "ls": {
+               "anyOf": [
+                  {
+                     "type": "string"
+                  },
+                  {
+                     "type": "null"
+                  }
+               ],
+               "default": null,
+               "title": "Ls"
+            },
+            "id": {
+               "anyOf": [
+                  {
+                     "type": "string"
+                  },
+                  {
+                     "type": "null"
+                  }
+               ],
+               "default": null,
+               "title": "Id"
+            }
+         },
+         "required": [
+            "n",
+            "cre",
+            "mod"
+         ],
+         "title": "MediaItem",
+         "type": "object"
+      }
+   },
+   "required": [
+      "d",
+      "fs"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field directory: str [Required] (alias 'd')
+
+ +
+
+field file_system: list[MediaItem] [Required] (alias 'fs')
+

List of files

+
+ +
+
+classmethod identify_item(item: dict[str, Any]) → MediaItem
+

Extent item into GroupedMediaItem if it such an item

+

A group item is identified by the presence of a “g” field

+
+
Parameters:
+

item (types.JsonDict) – input JSON

+
+
Returns:
+

parsed media item

+
+
Return type:
+

MediaItem

+
+
+
+ +
+ +
+
+pydantic model MediaList
+

Top level media list object

+

+Show JSON schema
{
+   "title": "MediaList",
+   "description": "Top level media list object",
+   "type": "object",
+   "properties": {
+      "id": {
+         "title": "Id",
+         "type": "string"
+      },
+      "media": {
+         "items": {
+            "$ref": "#/$defs/MediaFileSystem"
+         },
+         "title": "Media",
+         "type": "array"
+      }
+   },
+   "$defs": {
+      "MediaFileSystem": {
+         "description": "Grouping of media items into filesystem(s)",
+         "properties": {
+            "d": {
+               "title": "D",
+               "type": "string"
+            },
+            "fs": {
+               "items": {
+                  "$ref": "#/$defs/MediaItem"
+               },
+               "title": "Fs",
+               "type": "array"
+            }
+         },
+         "required": [
+            "d",
+            "fs"
+         ],
+         "title": "MediaFileSystem",
+         "type": "object"
+      },
+      "MediaItem": {
+         "description": "Base Media Item class",
+         "properties": {
+            "n": {
+               "title": "N",
+               "type": "string"
+            },
+            "cre": {
+               "title": "Cre",
+               "type": "string"
+            },
+            "mod": {
+               "title": "Mod",
+               "type": "string"
+            },
+            "glrv": {
+               "anyOf": [
+                  {
+                     "type": "string"
+                  },
+                  {
+                     "type": "null"
+                  }
+               ],
+               "default": null,
+               "title": "Glrv"
+            },
+            "ls": {
+               "anyOf": [
+                  {
+                     "type": "string"
+                  },
+                  {
+                     "type": "null"
+                  }
+               ],
+               "default": null,
+               "title": "Ls"
+            },
+            "id": {
+               "anyOf": [
+                  {
+                     "type": "string"
+                  },
+                  {
+                     "type": "null"
+                  }
+               ],
+               "default": null,
+               "title": "Id"
+            }
+         },
+         "required": [
+            "n",
+            "cre",
+            "mod"
+         ],
+         "title": "MediaItem",
+         "type": "object"
+      }
+   },
+   "required": [
+      "id",
+      "media"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field identifier: str [Required] (alias 'id')
+

String identifier of this media list

+
+ +
+
+field media: list[MediaFileSystem] [Required]
+

Media filesystem(s)

+
+ +
+
+model_post_init(__context: Any) → None
+

This function is meant to behave like a BaseModel method to initialise private attributes.

+

It takes context as an argument since that’s what pydantic-core passes when calling it.

+
+
Parameters:
+
    +

  • self – The BaseModel instance.

    • +

  • __context – The context.

    • +
+
+
+
+ +
+
+property files: list[open_gopro.models.media_list.MediaItem]
+

Helper method to get list of media items

+
+
Returns:
+

all media items in this media list

+
+
Return type:
+

list[MediaItem]

+
+
+
+ +
+ +
+
+pydantic model TzDstDateTime
+

DST aware datetime

+

+Show JSON schema
{
+   "title": "TzDstDateTime",
+   "description": "DST aware datetime",
+   "type": "object",
+   "properties": {
+      "datetime": {
+         "format": "date-time",
+         "title": "Datetime",
+         "type": "string"
+      },
+      "tzone": {
+         "title": "Tzone",
+         "type": "integer"
+      },
+      "dst": {
+         "title": "Dst",
+         "type": "boolean"
+      }
+   },
+   "required": [
+      "datetime",
+      "tzone",
+      "dst"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field datetime: datetime.datetime [Required]
+
+ +
+
+field dst: bool [Required]
+
+ +
+
+field tzone: int [Required]
+
+ +
+ +
+
+pydantic model CameraInfo
+

General camera info

+

+Show JSON schema
{
+   "title": "CameraInfo",
+   "description": "General camera info",
+   "type": "object",
+   "properties": {
+      "model_number": {
+         "title": "Model Number",
+         "type": "integer"
+      },
+      "model_name": {
+         "title": "Model Name",
+         "type": "string"
+      },
+      "firmware_version": {
+         "title": "Firmware Version",
+         "type": "string"
+      },
+      "serial_number": {
+         "title": "Serial Number",
+         "type": "string"
+      },
+      "ap_mac_addr": {
+         "title": "Ap Mac Addr",
+         "type": "string"
+      },
+      "ap_ssid": {
+         "title": "Ap Ssid",
+         "type": "string"
+      }
+   },
+   "required": [
+      "model_number",
+      "model_name",
+      "firmware_version",
+      "serial_number",
+      "ap_mac_addr",
+      "ap_ssid"
+   ]
+}
+
+
+

+
Config:
+
    +

  • protected_namespaces: tuple = ()

    • +
+
+
Fields:
+
+
+
+
+
+field ap_mac_addr: str [Required]
+

Camera access point MAC address

+
+ +
+
+field ap_ssid: str [Required]
+

Camera access point SSID name

+
+ +
+
+field firmware_version: str [Required]
+

Complete firmware version

+
+ +
+
+field model_name: str [Required]
+

Camera model name as string

+
+ +
+
+field model_number: int [Required]
+

Camera model number

+
+ +
+
+field serial_number: str [Required]
+

Camera serial number

+
+ +
+ +
+
+pydantic model WebcamResponse
+

Common Response from Webcam Commands

+

+Show JSON schema
{
+   "title": "WebcamResponse",
+   "description": "Common Response from Webcam Commands",
+   "type": "object",
+   "properties": {
+      "status": {
+         "anyOf": [
+            {
+               "$ref": "#/$defs/WebcamStatus"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null
+      },
+      "error": {
+         "$ref": "#/$defs/WebcamError"
+      },
+      "setting_id": {
+         "anyOf": [
+            {
+               "type": "string"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Setting Id"
+      },
+      "supported_options": {
+         "anyOf": [
+            {
+               "items": {
+                  "$ref": "#/$defs/SupportedOption"
+               },
+               "type": "array"
+            },
+            {
+               "type": "null"
+            }
+         ],
+         "default": null,
+         "title": "Supported Options"
+      }
+   },
+   "$defs": {
+      "SupportedOption": {
+         "description": "A supported option in an invalid setting response",
+         "properties": {
+            "display_name": {
+               "title": "Display Name",
+               "type": "string"
+            },
+            "id": {
+               "title": "Id",
+               "type": "integer"
+            }
+         },
+         "required": [
+            "display_name",
+            "id"
+         ],
+         "title": "SupportedOption",
+         "type": "object"
+      },
+      "WebcamError": {
+         "enum": [
+            0,
+            1,
+            2,
+            3,
+            4,
+            5,
+            6,
+            7,
+            8
+         ],
+         "title": "WebcamError",
+         "type": "integer"
+      },
+      "WebcamStatus": {
+         "enum": [
+            0,
+            1,
+            2,
+            3
+         ],
+         "title": "WebcamStatus",
+         "type": "integer"
+      }
+   },
+   "required": [
+      "error"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field error: constants.WebcamError [Required]
+
+ +
+
+field setting_id: Optional[str] = None
+
+ +
+
+field status: Optional[constants.WebcamStatus] = None
+
+ +
+
+field supported_options: Optional[list[SupportedOption]] = None
+
+ +
+ +
+
+pydantic model SupportedOption
+

A supported option in an invalid setting response

+

+Show JSON schema
{
+   "title": "SupportedOption",
+   "description": "A supported option in an invalid setting response",
+   "type": "object",
+   "properties": {
+      "display_name": {
+         "title": "Display Name",
+         "type": "string"
+      },
+      "id": {
+         "title": "Id",
+         "type": "integer"
+      }
+   },
+   "required": [
+      "display_name",
+      "id"
+   ]
+}
+
+
+

+
Fields:
+
+
+
+
+
+field display_name: str [Required]
+
+ +
+
+field id: int [Required]
+
+ +
+ +
+
+
+

Constants

+

These can be imported as:

+
from open_gopro import constants
+
+
+

Constant numbers shared across the GoPro module. These do not change across Open GoPro Versions

+
+
+class ActionId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+GET_AP_ENTRIES = 3
+
+ +
+
+GET_AP_ENTRIES_RSP = 131
+
+ +
+
+GET_LIVESTREAM_STATUS = 116
+
+ +
+
+GET_PRESET_STATUS = 114
+
+ +
+
+GET_PRESET_STATUS_RSP = 242
+
+ +
+
+LIVESTREAM_STATUS_NOTIF = 245
+
+ +
+
+LIVESTREAM_STATUS_RSP = 244
+
+ +
+
+NOTIF_PROVIS_STATE = 12
+
+ +
+
+NOTIF_START_SCAN = 11
+
+ +
+
+PRESET_MODIFIED_NOTIFICATION = 243
+
+ +
+
+RELEASE_NETWORK = 120
+
+ +
+
+RELEASE_NETWORK_RSP = 248
+
+ +
+
+REQUEST_CLEAR_COHN_CERT = 102
+
+ +
+
+REQUEST_COHN_SETTING = 101
+
+ +
+
+REQUEST_CREATE_COHN_CERT = 103
+
+ +
+
+REQUEST_GET_COHN_CERT = 110
+
+ +
+
+REQUEST_GET_COHN_STATUS = 111
+
+ +
+
+REQUEST_GET_LAST_MEDIA = 109
+
+ +
+
+REQUEST_PRESET_UPDATE_CUSTOM = 100
+
+ +
+
+REQUEST_WIFI_CONNECT = 4
+
+ +
+
+REQUEST_WIFI_CONNECT_NEW = 5
+
+ +
+
+REQUEST_WIFI_CONNECT_NEW_RSP = 133
+
+ +
+
+REQUEST_WIFI_CONNECT_RSP = 132
+
+ +
+
+RESPONSE_CLEAR_COHN_CERT = 230
+
+ +
+
+RESPONSE_COHN_SETTING = 229
+
+ +
+
+RESPONSE_CREATE_COHN_CERT = 231
+
+ +
+
+RESPONSE_GET_COHN_CERT = 238
+
+ +
+
+RESPONSE_GET_COHN_STATUS = 239
+
+ +
+
+RESPONSE_GET_LAST_MEDIA = 237
+
+ +
+
+RESPONSE_PRESET_UPDATE_CUSTOM = 228
+
+ +
+
+SCAN_WIFI_NETWORKS = 2
+
+ +
+
+SCAN_WIFI_NETWORKS_RSP = 130
+
+ +
+
+SET_CAMERA_CONTROL = 105
+
+ +
+
+SET_CAMERA_CONTROL_RSP = 233
+
+ +
+
+SET_LIVESTREAM_MODE = 121
+
+ +
+
+SET_LIVESTREAM_MODE_RSP = 249
+
+ +
+
+SET_TURBO_MODE = 107
+
+ +
+
+SET_TURBO_MODE_RSP = 235
+
+ +
+ +
+
+class CmdId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+GET_CAMERA_CAPABILITIES = 50
+
+ +
+
+GET_CAMERA_SETTINGS = 18
+
+ +
+
+GET_CAMERA_STATUSES = 19
+
+ +
+
+GET_DATE_TIME = 14
+
+ +
+
+GET_DATE_TIME_DST = 16
+
+ +
+
+GET_HW_INFO = 60
+
+ +
+
+GET_SETTINGS_JSON = 59
+
+ +
+
+GET_THIRD_PARTY_API_VERSION = 81
+
+ +
+
+LOAD_PRESET = 64
+
+ +
+
+LOAD_PRESET_GROUP = 62
+
+ +
+
+POWER_DOWN = 4
+
+ +
+
+REGISTER_ALL_CAPABILITIES = 98
+
+ +
+
+REGISTER_ALL_SETTINGS = 82
+
+ +
+
+REGISTER_ALL_STATUSES = 83
+
+ +
+
+SET_DATE_TIME = 13
+
+ +
+
+SET_DATE_TIME_DST = 15
+
+ +
+
+SET_PAIRING_COMPLETE = 3
+
+ +
+
+SET_SHUTTER = 1
+
+ +
+
+SET_THIRD_PARTY_CLIENT_INFO = 80
+
+ +
+
+SET_WIFI = 23
+
+ +
+
+SLEEP = 5
+
+ +
+
+TAG_HILIGHT = 24
+
+ +
+
+UNREGISTER_ALL_CAPABILITIES = 130
+
+ +
+
+UNREGISTER_ALL_SETTINGS = 114
+
+ +
+
+UNREGISTER_ALL_STATUSES = 115
+
+ +
+ +
+
+class ErrorCode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ERROR = 1
+
+ +
+
+INVALID_PARAM = 2
+
+ +
+
+SUCCESS = 0
+
+ +
+
+UNKNOWN = -1
+
+ +
+ +
+
+class FeatureId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+COMMAND = 241
+
+ +
+
+NETWORK_MANAGEMENT = 2
+
+ +
+
+QUERY = 245
+
+ +
+
+SETTING = 243
+
+ +
+ +
+
+class GoProUUIDs(*_: Any)
+

GoPro Proprietary BleUUID’s.

+
+
+CM_NET_MGMT_COMM = Camera Management
+
+ +
+
+CN_NET_MGMT_RESP = Camera Management Response
+
+ +
+
+CQ_COMMAND = Command
+
+ +
+
+CQ_COMMAND_RESP = Command Response
+
+ +
+
+CQ_QUERY = Query
+
+ +
+
+CQ_QUERY_RESP = Query Response
+
+ +
+
+CQ_SENSOR = Sensor
+
+ +
+
+CQ_SENSOR_RESP = Sensor Response
+
+ +
+
+CQ_SETTINGS = Settings
+
+ +
+
+CQ_SETTINGS_RESP = Settings Response
+
+ +
+
+S_CAMERA_MANAGEMENT = Camera Management Service
+
+ +
+
+S_CONTROL_QUERY = Control and Query Service
+
+ +
+
+S_WIFI_ACCESS_POINT = Wifi Access Point Service
+
+ +
+
+WAP_CSI_PASSWORD = CSI Password
+
+ +
+
+WAP_PASSWORD = Wifi AP Password
+
+ +
+
+WAP_POWER = Wifi Power
+
+ +
+
+WAP_SSID = Wifi AP SSID
+
+ +
+
+WAP_STATE = Wifi State
+
+ +
+ +
+
+class QueryCmdId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+GET_CAPABILITIES_NAME = 66
+
+ +
+
+GET_CAPABILITIES_VAL = 50
+
+ +
+
+GET_SETTING_NAME = 34
+
+ +
+
+GET_SETTING_VAL = 18
+
+ +
+
+GET_STATUS_VAL = 19
+
+ +
+
+INVALID_FOR_TESTING = 255
+
+ +
+
+PROTOBUF_QUERY = 245
+
+ +
+
+REG_CAPABILITIES_UPDATE = 98
+
+ +
+
+REG_SETTING_VAL_UPDATE = 82
+
+ +
+
+REG_STATUS_VAL_UPDATE = 83
+
+ +
+
+SETTING_CAPABILITY_PUSH = 162
+
+ +
+
+SETTING_VAL_PUSH = 146
+
+ +
+
+STATUS_VAL_PUSH = 147
+
+ +
+
+UNREG_CAPABILITIES_UPDATE = 130
+
+ +
+
+UNREG_SETTING_VAL_UPDATE = 114
+
+ +
+
+UNREG_STATUS_VAL_UPDATE = 115
+
+ +
+ +
+
+class SettingId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ADDON_MAX_LENS_MOD = 189
+
+ +
+
+ADDON_MAX_LENS_MOD_ENABLE = 190
+
+ +
+
+ANTI_FLICKER = 134
+
+ +
+
+AUTO_OFF = 59
+
+ +
+
+BIT_DEPTH = 183
+
+ +
+
+BIT_RATE = 182
+
+ +
+
+CAMERA_UX_MODE = 175
+
+ +
+
+FPS = 3
+
+ +
+
+FRAMING = 193
+
+ +
+
+HINDSIGHT = 167
+
+ +
+
+HYPERSMOOTH = 135
+
+ +
+
+INVALID_FOR_TESTING = 255
+
+ +
+
+LED = 91
+
+ +
+
+MAX_LENS_MOD = 162
+
+ +
+
+MEDIA_FORMAT = 128
+
+ +
+
+MULTI_SHOT_EASY_ASPECT_RATIO = 188
+
+ +
+
+MULTI_SHOT_FOV = 123
+
+ +
+
+MULTI_SHOT_NLV_ASPECT_RATIO = 192
+
+ +
+
+PHOTO_EASY_MODE = 177
+
+ +
+
+PHOTO_FOV = 122
+
+ +
+
+PHOTO_HORIZON_LEVELING = 151
+
+ +
+
+PHOTO_INTERVAL = 171
+
+ +
+
+PHOTO_INTERVAL_DURATION = 172
+
+ +
+
+PHOTO_MODE = 191
+
+ +
+
+PROTOBUF_SETTING = 243
+
+ +
+
+RESOLUTION = 2
+
+ +
+
+STAR_TRAIL_LENGTH = 179
+
+ +
+
+SYSTEM_VIDEO_MODE = 180
+
+ +
+
+TIMELAPSE_MODE = 187
+
+ +
+
+VIDEO_ASPECT_RATIO = 108
+
+ +
+
+VIDEO_EASY_ASPECT_RATIO = 185
+
+ +
+
+VIDEO_EASY_MODE = 176
+
+ +
+
+VIDEO_FOV = 121
+
+ +
+
+VIDEO_HORIZON_LEVELING = 150
+
+ +
+
+VIDEO_MODE = 186
+
+ +
+
+VIDEO_PERFORMANCE_MODE = 173
+
+ +
+
+VIDEO_PROFILE = 184
+
+ +
+
+WIFI_BAND = 178
+
+ +
+ +
+
+class StatusId(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+ACC_MIC_STAT = 74
+
+ +
+
+ACTIVE_PRESET = 97
+
+ +
+
+ANALYTICS_RDY = 61
+
+ +
+
+ANALYTICS_SIZE = 62
+
+ +
+
+APP_COUNT = 31
+
+ +
+
+AP_SSID = 30
+
+ +
+
+AP_STATE = 69
+
+ +
+
+BAND_5GHZ_AVAIL = 81
+
+ +
+
+BATT_LEVEL = 2
+
+ +
+
+BATT_OK_OTA = 83
+
+ +
+
+BATT_PRESENT = 1
+
+ +
+
+CAMERA_CONTROL = 114
+
+ +
+
+CAMERA_LENS_TYPE = 105
+
+ +
+
+CAPTURE_DELAY = 84
+
+ +
+
+CAPT_DELAY_ACTIVE = 101
+
+ +
+
+CONTROL_OVER_USB = 116
+
+ +
+
+CREATING_PRESET = 109
+
+ +
+
+CURRENT_TIME_MS = 57
+
+ +
+
+DIGITAL_ZOOM = 75
+
+ +
+
+DIG_ZOOM_ACTIVE = 77
+
+ +
+
+DOWNLOAD_CANCEL_PEND = 42
+
+ +
+
+ENCODING = 10
+
+ +
+
+EXPOSURE_TYPE = 65
+
+ +
+
+EXPOSURE_X = 66
+
+ +
+
+EXPOSURE_Y = 67
+
+ +
+
+FIRST_TIME = 79
+
+ +
+
+FLATMODE_ID = 89
+
+ +
+
+GPS_STAT = 68
+
+ +
+
+INT_BATT_PER = 70
+
+ +
+
+IN_CONTEXT_MENU = 63
+
+ +
+
+LAST_HILIGHT = 59
+
+ +
+
+LCD_LOCK_ACTIVE = 11
+
+ +
+
+LINUX_CORE_ACTIVE = 104
+
+ +
+
+LIVE_BURST_REM = 99
+
+ +
+
+LIVE_BURST_TOTAL = 100
+
+ +
+
+LOCATE_ACTIVE = 45
+
+ +
+
+LOGS_READY = 91
+
+ +
+
+MEDIA_MOD_MIC_STAT = 102
+
+ +
+
+MEDIA_MOD_STAT = 110
+
+ +
+
+MOBILE_VIDEO = 78
+
+ +
+
+MODE_GROUP = 43
+
+ +
+
+MULTI_COUNT_DOWN = 49
+
+ +
+
+NEXT_POLL = 60
+
+ +
+
+NUM_GROUP_PHOTO = 36
+
+ +
+
+NUM_GROUP_VIDEO = 37
+
+ +
+
+NUM_HILIGHTS = 58
+
+ +
+
+NUM_TOTAL_PHOTO = 38
+
+ +
+
+NUM_TOTAL_VIDEO = 39
+
+ +
+
+ORIENTATION = 86
+
+ +
+
+OTA_STAT = 41
+
+ +
+
+PAIR_STATE = 19
+
+ +
+
+PAIR_STATE2 = 28
+
+ +
+
+PAIR_TIME = 21
+
+ +
+
+PAIR_TYPE = 20
+
+ +
+
+PHOTOS_REM = 34
+
+ +
+
+PHOTO_PRESETS = 94
+
+ +
+
+PRESETS_GROUP = 96
+
+ +
+
+PRESET_MODIFIED = 98
+
+ +
+
+PREVIEW_ENABLED = 32
+
+ +
+
+QUICK_CAPTURE = 9
+
+ +
+
+REMOTE_CTRL_CONN = 27
+
+ +
+
+REMOTE_CTRL_VER = 26
+
+ +
+
+SCHEDULED_CAPTURE = 108
+
+ +
+
+SCHEDULED_PRESET = 107
+
+ +
+
+SD_RATING_CHECK_ERROR = 111
+
+ +
+
+SD_STATUS = 33
+
+ +
+
+SD_WRITE_SPEED_ERROR = 112
+
+ +
+
+SEC_SD_STAT = 80
+
+ +
+
+SPACE_REM = 54
+
+ +
+
+STREAMING_SUPP = 55
+
+ +
+
+SYSTEM_BUSY = 8
+
+ +
+
+SYSTEM_HOT = 6
+
+ +
+
+SYSTEM_READY = 82
+
+ +
+
+TIMELAPSE_PRESETS = 95
+
+ +
+
+TIMELAPSE_REM = 64
+
+ +
+
+TIMEWARP_SPEED_RAMP = 103
+
+ +
+
+TOTAL_SD_SPACE_KB = 117
+
+ +
+
+TURBO_MODE = 113
+
+ +
+
+USB_CONNECTED = 115
+
+ +
+
+VIDEO_HINDSIGHT = 106
+
+ +
+
+VIDEO_LOW_TEMP = 85
+
+ +
+
+VIDEO_PRESETS = 93
+
+ +
+
+VIDEO_PROGRESS = 13
+
+ +
+
+VIDEO_REM = 35
+
+ +
+
+WAP_PROV_STAT = 24
+
+ +
+
+WAP_SCAN_STATE = 22
+
+ +
+
+WAP_SCAN_TIME = 23
+
+ +
+
+WIFI_BARS = 56
+
+ +
+
+WIRELESS_BAND = 76
+
+ +
+
+WIRELESS_ENABLED = 17
+
+ +
+
+WLAN_SSID = 29
+
+ +
+
+ZOOM_ENCODING = 88
+
+ +
+ +
+
+class WebcamError(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+COM_TIMEOUT = 5
+
+ +
+
+EXEC_STREAM = 3
+
+ +
+
+EXIT = 8
+
+ +
+
+INVALID_PARAM = 6
+
+ +
+
+SET_PRESET = 1
+
+ +
+
+SET_WINDOW_SIZE = 2
+
+ +
+
+SHUTTER = 4
+
+ +
+
+SUCCESS = 0
+
+ +
+
+UNAVAILABLE = 7
+
+ +
+ +
+
+class WebcamStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+
+
+HIGH_POWER_PREVIEW = 2
+
+ +
+
+IDLE = 1
+
+ +
+
+LOW_POWER_PREVIEW = 3
+
+ +
+
+OFF = 0
+
+ +
+ +
+
+

Exceptions

+

Exceptions that pertain to Gopro-level functionality.

+
+
+exception ConnectFailed(connection: str, timeout: float, retries: int)
+

A BLE connection failed to establish

+
+
Parameters:
+
    +

  • connection (str) – type of connection that failed

    • +

  • retries (int) – how many retries were attempted

    • +

  • timeout (int) – the timeout used for each attempt

    • +
+
+
+
+ +
+
+exception ConnectionTerminated(message: str)
+

A connection that was previously established has terminated.

+
+ +
+
+ExceptionHandler
+

Exception handler callback type

+

alias of Callable[[Exception], None]

+
+ +
+
+exception FailedToFindDevice
+

The scan failed without finding a device.

+
+ +
+
+exception GoProError
+

Base class for other GoPro-level exceptions.

+
+ +
+
+exception GoProNotOpened(message: str)
+

A command was attempted without waiting for the GoPro instance to open.

+
+ +
+
+exception InterfaceConfigFailure
+

An error has occurred while setting up the communication interface

+
+ +
+
+exception InvalidConfiguration(message: str)
+

Something was attempted that is not possible for the current configuration.

+
+ +
+
+exception InvalidOpenGoProVersion(version: str)
+

Attempt to access an invalid Open GoPro API version

+
+ +
+
+exception ResponseParseError(identifier: str, data: bytearray, msg: str = '')
+

Error when parsing received data.

+
+ +
+
+exception ResponseTimeout(timeout: float)
+

A response has timed out.

+
+ +
+
+

Common Interface

+
+
+class GoProBase(**kwargs: Any)
+

The base class for communicating with all GoPro Clients

+
+
+abstract property ble_command: BleCommands
+

Used to call the BLE commands

+
+
Returns:
+

the commands

+
+
Return type:
+

BleCommands

+
+
+
+ +
+
+abstract property ble_setting: BleSettings
+

Used to access the BLE settings

+
+
Returns:
+

the settings

+
+
Return type:
+

BleSettings

+
+
+
+ +
+
+abstract property ble_status: BleStatuses
+

Used to access the BLE statuses

+
+
Returns:
+

the statuses

+
+
Return type:
+

BleStatuses

+
+
+
+ +
+
+abstract async close() → None
+

Gracefully close the GoPro Client connection

+
+ +
+
+abstract async configure_cohn(timeout: int = 60) → bool
+

Prepare Camera on the Home Network

+

Provision if not provisioned +Then wait for COHN to be connected and ready

+
+
Parameters:
+

timeout (int) – time in seconds to wait for COHN to be ready. Defaults to 60.

+
+
Returns:
+

True if success, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract property http_command: HttpCommands
+

Used to access the Wifi commands

+
+
Returns:
+

the commands

+
+
Return type:
+

HttpCommands

+
+
+
+ +
+
+abstract property http_setting: HttpSettings
+

Used to access the Wifi settings

+
+
Returns:
+

the settings

+
+
Return type:
+

HttpSettings

+
+
+
+ +
+
+abstract property identifier: str
+

Unique identifier for the connected GoPro Client

+
+
Returns:
+

identifier

+
+
Return type:
+

str

+
+
+
+ +
+
+abstract property is_ble_connected: bool
+

Are we connected via BLE to the GoPro device?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract property is_cohn_provisioned: bool
+

Is COHN currently provisioned?

+

Get the current COHN status from the camera

+
+
Returns:
+

True if COHN is provisioned, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract property is_http_connected: bool
+

Are we connected via HTTP to the GoPro device?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract property is_open: bool
+

Is this client ready for communication?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract property is_ready: bool
+

Is gopro ready to receive commands

+
+
Returns:
+

yes if ready, no otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract async open(timeout: int = 10, retries: int = 5) → None
+

Connect to the GoPro Client and prepare it for communication

+
+
Parameters:
+
    +

  • timeout (int) – time before considering connection a failure. Defaults to 10.

    • +

  • retries (int) – number of connection retries. Defaults to 5.

    • +
+
+
+
+ +
+
+property version: str
+

The API version that the connected camera supports

+

Only 2.0 is currently supported

+
+
Returns:
+

supported version

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+class GoProBle(controller: BLEController, disconnected_cb: Callable[[BleDevice], None], notification_cb: Callable[[int, bytearray], None], target: Union[Pattern, BleDevice])
+

GoPro specific BLE Client

+
+
Parameters:
+
    +

  • controller (BLEController) – controller implementation to use for this client

    • +

  • disconnected_cb (DisconnectHandlerType) – disconnected callback

    • +

  • notification_cb (NotiHandlerType) – notification callback

    • +

  • target (Pattern | BleDevice) – regex or device to connect to

    • +
+
+
+
+ +
+
+class GoProHttp
+

Interface definition for all HTTP communicators

+
+ +
+
+class GoProWifi(controller: WifiController)
+

GoPro specific WiFi Client

+
+
Parameters:
+

controller (WifiController) – instance of Wifi Controller to use for this client

+
+
+
+
+property password: str | None
+

Get the GoPro AP’s password

+
+
Returns:
+

password or None if it is not known

+
+
Return type:
+

str | None

+
+
+
+ +
+
+property ssid: str | None
+

Get the GoPro AP’s WiFi SSID

+
+
Returns:
+

SSID or None if it is not known

+
+
Return type:
+

str | None

+
+
+
+ +
+ +
+
+class GoProWiredInterface
+

The top-level interface for a Wired Open GoPro controller

+
+ +
+
+class GoProWirelessInterface(ble_controller: BLEController, wifi_controller: open_gopro.wifi.controller.WifiController | None, disconnected_cb: Callable[[BleDevice], None], notification_cb: Callable[[int, bytearray], None], target: Union[Pattern, BleDevice])
+

The top-level interface for a Wireless Open GoPro controller

+

This always supports BLE and can optionally support Wifi

+
+ +
+
+class BaseGoProCommunicator
+

Common Communicator interface

+
+
+abstract register_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]], update: Union[SettingId, StatusId, ActionId]) → None
+

Register for callbacks when an update occurs

+
+
Parameters:
+
    +

  • callback (types.UpdateCb) – callback to be notified in

    • +

  • update (types.UpdateType) – update to register for

    • +
+
+
+
+ +
+
+abstract unregister_update(callback: Callable[[Union[SettingId, StatusId, ActionId], Any], Coroutine[Any, Any, None]], update: Optional[Union[SettingId, StatusId, ActionId]] = None) → None
+

Unregister for asynchronous update(s)

+
+
Parameters:
+
    +

  • callback (types.UpdateCb) – callback to stop receiving update(s) on

    • +

  • update (types.UpdateType | None) – updates to unsubscribe for. Defaults to None (all +updates that use this callback will be unsubscribed).

    • +
+
+
+
+ +
+ +
+
+

BLE Interface

+

BLE Controller Interface Definition.

+
+
+class BLEController(exception_handler: Optional[Callable] = None)
+

Interface definition for a BLE driver to be used by GoPro.

+
+
+abstract async connect(disconnect_cb: Callable[[BleDevice], None], device: BleDevice, timeout: int = 15) → BleHandle
+

Connect to a BLE device.

+
+
Parameters:
+
    +

  • disconnect_cb (DisconnectHandlerType) – function to call when disconnect is received

    • +

  • device (BleDevice) – device to connect to

    • +

  • timeout (int) – How long to attempt connecting before giving up. Defaults to 15.

    • +
+
+
Returns:
+

handle that has been connected to

+
+
Return type:
+

BleHandle

+
+
+
+ +
+
+abstract async disconnect(handle: BleHandle) → None
+

Terminate the BLE connection.

+
+
Parameters:
+

handle (BleHandle) – handle to disconnect from

+
+
+
+ +
+
+abstract async discover_chars(handle: BleHandle, uuids: Optional[type[open_gopro.ble.services.UUIDs]] = None) → GattDB
+

Discover all characteristics for a connected handle.

+

By default, the BLE controller only knows Spec-Defined BleUUID’s so any additional BleUUID’s should +be passed in with the uuids argument

+
+
Parameters:
+
    +

  • handle (BleHandle) – BLE handle to discover for

    • +

  • uuids (type[UUIDs], Optional) – Additional BleUUID information to use when building the +Gatt Database. Defaults to None.

    • +
+
+
Returns:
+

Gatt Database

+
+
Return type:
+

GattDB

+
+
+
+ +
+
+abstract async enable_notifications(handle: BleHandle, handler: Callable[[int, bytearray], None]) → None
+

Enable notifications for all notifiable characteristics.

+

The handler is used to register for notifications. It will be called when a a notification +is received.

+
+
Parameters:
+
    +

  • handle (BleHandle) – handle to enable notifications on

    • +

  • handler (NotiHandlerType) – notification handler

    • +
+
+
+
+ +
+
+abstract async pair(handle: BleHandle) → None
+

Pair to an already connected handle.

+
+
Parameters:
+

handle (BleHandle) – handle to pair to

+
+
+
+ +
+
+abstract async read(handle: BleHandle, uuid: BleUUID) → bytearray
+

Read a bytestream response from a BleUUID.

+
+
Parameters:
+
    +

  • handle (BleHandle) – handle to pair to

    • +

  • uuid (BleUUID) – BleUUID to read from

    • +
+
+
Returns:
+

response

+
+
Return type:
+

bytearray

+
+
+
+ +
+
+abstract async scan(token: Pattern, timeout: int = 5, service_uuids: Optional[list[open_gopro.ble.services.BleUUID]] = None) → BleDevice
+

Scan BLE device with a regex in it’s device name.

+
+
Parameters:
+
    +

  • token (Pattern) – Regex to scan for

    • +

  • timeout (int) – Time to scan (in seconds) before considering scanning as failed. Defaults to 5.

    • +

  • service_uuids (list[BleUUID], Optional) – The list of BleUUID’s to filter on. Defaults to None.

    • +
+
+
Returns:
+

discovered device (shall not be multiple devices)

+
+
Return type:
+

BleDevice

+
+
+
+ +
+
+abstract async write(handle: BleHandle, uuid: BleUUID, data: bytearray) → None
+

Write a bytestream to a BleUUID.

+
+
Parameters:
+
    +

  • handle (BleHandle) – handle to pair to

    • +

  • uuid (BleUUID) – BleUUID to write to

    • +

  • data (bytearray) – bytestream to write

    • +
+
+
Returns:
+

response

+
+
Return type:
+

bytearray

+
+
+
+ +
+ +

Generic BLE Client definition that is composed of a BLE Controller.

+
+
+class BleClient(controller: BLEController, disconnected_cb: Callable[[BleDevice], None], notification_cb: Callable[[int, bytearray], None], target: tuple[Union[Pattern, BleDevice], Optional[list[open_gopro.ble.services.BleUUID]]], uuids: Optional[type[open_gopro.ble.services.UUIDs]] = None)
+

A BLE device that is to be connected to.

+
+
+async close() → None
+

Close the client resource.

+

This should always be called before exiting.

+
+ +
+
+property gatt_db: GattDB
+

Return the attribute table

+
+
Raises:
+

RuntimeError – GATT table hasn’t been discovered

+
+
Returns:
+

table of BLE attributes

+
+
Return type:
+

GattDB

+
+
+
+ +
+
+property identifier: Optional[str]
+

A string that identifies the GoPro

+
+
Returns:
+

identifier or None if client has not yet been discovered

+
+
Return type:
+

Optional[str]

+
+
+
+ +
+
+property is_connected: bool
+

Is BLE currently connected?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_discovered: bool
+

Has the target been discovered (via BLE scanning)?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+async open(timeout: int = 10, retries: int = 5) → None
+

Open the client resource so that it is ready to send and receive data.

+
+
Parameters:
+
    +

  • timeout (int) – How long to try connecting (in seconds) before retrying. Defaults to 10.

    • +

  • retries (int) – How many retries to attempt before giving up. Defaults to 5

    • +
+
+
Raises:
+

ConnectFailed – The BLE connection was not able to establish

+
+
+
+ +
+
+async read(uuid: BleUUID) → bytearray
+

Read byte data from a characteristic (identified by BleUUID)

+
+
Parameters:
+

uuid (BleUUID) – characteristic to read

+
+
Returns:
+

byte data that was read

+
+
Return type:
+

bytearray

+
+
+
+ +
+
+services_as_csv(file: Path = PosixPath('services.csv')) → None
+

Dump the services as a .csv

+
+
Parameters:
+

file (Path) – Where to dump the csv. Defaults to Path(“services.csv”).

+
+
+
+ +
+
+async write(uuid: BleUUID, data: bytearray) → None
+

Write byte data to a characteristic (identified by BleUUID)

+
+
Parameters:
+
    +

  • uuid (BleUUID) – characteristic to write to

    • +

  • data (bytearray) – byte data to write

    • +
+
+
+
+ +
+ +
+

BLEServices

+

Objects to nicely interact with BLE services, characteristics, and attributes.

+
+
+class BleUUID(name: str, format: Format = Format.BIT_128, hex: Optional[str] = None, bytes: Optional[bytes] = None, bytes_le: Optional[bytes] = None, int: Optional[int] = None)
+

An extension of the standard UUID to associate a string name with the UUID and allow 8-bit UUID input

+

Can only be initialized with one of [hex, bytes, bytes_le, int]

+
+
+class Format(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+

Used to specify 8-bit or 128-bit UUIDs

+
+ +
+
+property format: Format
+

Is this a 16 bit or 128 bit UUID?

+
+
Returns:
+

format of UUID

+
+
Return type:
+

BleUUID.Format

+
+
+
+ +
+ +
+
+class CharProps(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+

BLE Spec-Defined Characteristic Property bitmask values

+
+ +
+
+class Characteristic(handle: int, uuid: BleUUID, props: CharProps, value: Optional[bytes] = None, init_descriptors: dataclasses.InitVar[Optional[list[open_gopro.ble.services.Descriptor]]] = None, descriptor_handle: Optional[int] = None)
+

A BLE characteristic.

+
+
Parameters:
+
    +

  • handle (int) – the handle of the attribute table that the characteristic resides at

    • +

  • uuid (BleUUID) – the BleUUID of the characteristic

    • +

  • props (CharProps) – the characteristic’s properties (READ, WRITE, NOTIFY, etc)

    • +

  • value (bytes) – the current byte stream value of the characteristic value

    • +

  • init_descriptors (Optional[list[Descriptor]]) – Descriptors known at initialization (can also be +set later using the descriptors property)

    • +

  • descriptor_handle (Optional[int]) – handle of this characteristic’s declaration descriptor. If not +passed, defaults to handle + 1

    • +
+
+
+
+
+property cccd_handle: int
+

What is this characteristics CCCD (client characteristic configuration descriptor) handle

+
+
Returns:
+

the CCCD handle

+
+
Return type:
+

int

+
+
+
+ +
+
+property descriptors: dict[open_gopro.ble.services.BleUUID, open_gopro.ble.services.Descriptor]
+

Return uuid-to-descriptor mapping

+
+
Returns:
+

dictionary of descriptors indexed by BleUUID

+
+
Return type:
+

dict[BleUUID, Descriptor]

+
+
+
+ +
+
+property is_indicatable: bool
+

Does this characteristic have indicatable property?

+
+
Returns:
+

True if indicatable, False if not

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_notifiable: bool
+

Does this characteristic have notifiable property?

+
+
Returns:
+

True if notifiable, False if not

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_readable: bool
+

Does this characteristic have readable property?

+
+
Returns:
+

True if readable, False if not

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_writeable: bool
+

Does this characteristic have writeable property?

+

That is, does it have writeable-with-response or writeable-without-response property

+
+
Returns:
+

True if writeable, False if not

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_writeable_with_response: bool
+

Does this characteristic have writeable-with-response property?

+
+
Returns:
+

True if writeable-with-response, False if not

+
+
Return type:
+

bool

+
+
+
+ +
+
+property is_writeable_without_response: bool
+

Does this characteristic have writeable-without-response property?

+
+
Returns:
+

True if writeable-without-response, False if not

+
+
Return type:
+

bool

+
+
+
+ +
+
+property name: str
+

What is the human-readable name of this characteristic?

+
+
Returns:
+

characteristic’s name

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+class Descriptor(handle: int, uuid: BleUUID, value: Optional[bytes] = None)
+

A characteristic descriptor.

+
+
Parameters:
+
    +

  • handle (int) – the handle of the attribute table that the descriptor resides at

    • +

  • uuid (BleUUID) – BleUUID of this descriptor

    • +

  • value (bytes) – the byte stream value of the descriptor

    • +
+
+
+
+
+property name: str
+

What is the human-readable name of this characteristic?

+
+
Returns:
+

characteristic’s name

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+class GattDB(init_services: list[open_gopro.ble.services.Service])
+

The attribute table to store / look up BLE services, characteristics, and attributes.

+
+
Parameters:
+

init_services (list[Service]) – A list of services known at instantiation time. Can be updated later +with the services property

+
+
+
+
+class CharacteristicView(db: GattDB)
+

Represent the GattDB mapping as characteristics indexed by BleUUID

+
+
+items() → Generator[tuple[BleUUID, Characteristic], None, None]
+

Generate dict-like items view

+
+
Returns:
+

items generator

+
+
Return type:
+

Generator[tuple[BleUUID, Characteristic], None, None]

+
+
+
+ +
+
+keys() → Generator[BleUUID, None, None]
+

Generate dict-like keys view

+
+
Returns:
+

keys generator

+
+
Return type:
+

Generator[BleUUID, None, None]

+
+
+
+ +
+
+values() → Generator[Characteristic, None, None]
+

Generate dict-like values view

+
+
Returns:
+

values generator

+
+
Return type:
+

Generator[Characteristic, None, None]

+
+
+
+ +
+ +
+
+dump_to_csv(file: Path = PosixPath('attributes.csv')) → None
+

Dump discovered services to a csv file.

+
+
Parameters:
+

file (Path) – File to write to. Defaults to “./attributes.csv”.

+
+
+
+ +
+
+handle2uuid(handle: int) → BleUUID
+

Get a BleUUID from a handle.

+
+
Parameters:
+

handle (int) – the handle to search for

+
+
Raises:
+

KeyError – No characteristic was found at this handle

+
+
Returns:
+

The found BleUUID

+
+
Return type:
+

BleUUID

+
+
+
+ +
+
+property services: dict[open_gopro.ble.services.BleUUID, open_gopro.ble.services.Service]
+

Return uuid-to-service mapping

+
+
Returns:
+

Dict of services indexed by uuid

+
+
Return type:
+

dict[BleUUID, Service]

+
+
+
+ +
+
+uuid2handle(ble_uuid: BleUUID) → int
+

Convert a handle to a BleUUID

+
+
Parameters:
+

ble_uuid (BleUUID) – BleUUID to translate

+
+
Returns:
+

the handle in the Gatt Database where this BleUUID resides

+
+
Return type:
+

int

+
+
+
+ +
+ +
+
+class Service(uuid: BleUUID, start_handle: int, end_handle: int = 65535, init_chars: dataclasses.InitVar[Optional[list[open_gopro.ble.services.Characteristic]]] = None)
+

A BLE service or grouping of Characteristics.

+
+
Parameters:
+
    +

  • uuid (BleUUID) – the service’s BleUUID

    • +

  • start_handle (int) – the attribute handle where the service begins

    • +

  • end_handle (int) – the attribute handle where the service ends. Defaults to 0xFFFF.

    • +

  • init_chars (list[Characteristic]) – list of characteristics known at service instantiation. Can be set +later with the characteristics property

    • +
+
+
+
+
+property characteristics: dict[open_gopro.ble.services.BleUUID, open_gopro.ble.services.Characteristic]
+

Return uuid-to-characteristic mapping

+
+
Returns:
+

Dict of characteristics indexed by uuid

+
+
Return type:
+

dict[BleUUID, Characteristic]

+
+
+
+ +
+
+property name: str
+

What is the human-readable name of this characteristic?

+
+
Returns:
+

characteristic’s name

+
+
Return type:
+

str

+
+
+
+ +
+ +
+
+class SpecUuidNumber(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+

BLE Spec-Defined BleUUID Number values as ints

+
+ +
+
+class UUIDs(*_: Any)
+

BLE Spec-defined UUIDs that are common across all applications.

+

Also functions as a dict to look up UUID’s by str, int, or BleUUID

+
+ +
+
+class UUIDsMeta(name, bases, dct)
+

The metaclass used to build a UUIDs container

+

Upon creation of a new UUIDs class, this will store the BleUUID names in an internal mapping indexed by UUID as int

+
+ +
+
+
+

WiFi Interface

+

Wifi Controller Interface Definition.

+
+
+class SsidState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
+

Current state of the SSID

+
+ +
+
+class WifiController(interface: Optional[str] = None, password: Optional[str] = None)
+

Interface definition for a Wifi driver to be used by GoPro.

+
+
+abstract available_interfaces() → list[str]
+

Return a list of available Wifi Interface strings

+
+
Returns:
+

list of interfaces

+
+
Return type:
+

list[str]

+
+
+
+ +
+
+abstract connect(ssid: str, password: str, timeout: float = 15) → bool
+

Connect to a network.

+
+
Parameters:
+
    +

  • ssid (str) – SSID of network to connect to

    • +

  • password (str) – password of network to connect to

    • +

  • timeout (float) – Time before considering connection failed (in seconds). Defaults to 15.

    • +
+
+
Returns:
+

True if successful, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract current() → tuple[Optional[str], open_gopro.wifi.controller.SsidState]
+

Return the SSID and state of the current network.

+
+
Returns:
+

Tuple of SSID str and state. If SSID is None, +there is no current connection.

+
+
Return type:
+

tuple[Optional[str], SsidState]

+
+
+
+ +
+
+abstract disconnect() → bool
+

Disconnect from a network.

+
+
Returns:
+

True if successful, False otherwise

+
+
Return type:
+

bool

+
+
+
+ +
+
+property interface: str
+

Get the Wifi Interface

+
+
Returns:
+

interface

+
+
Return type:
+

str

+
+
+
+ +
+
+abstract property is_on: bool
+

Is the wireless driver currently enabled.

+
+
Returns:
+

True if yes. False if no.

+
+
Return type:
+

bool

+
+
+
+ +
+
+abstract power(power: bool) → bool
+

Enable / disable the wireless driver.

+
+
Parameters:
+

power (bool) – Enable if True. Disable if False.

+
+
+
+ +
+
+property sudo: str
+

Return the sudo encapsulated password

+
+
Returns:
+

echo “******” | sudo -S

+
+
Return type:
+

str

+
+
+
+ +
+ +

Open GoPro WiFi Client Implementation

+
+
+class WifiClient(controller: WifiController)
+

A Wifi client that is composed of, among other things, a Wifi interface

+
+
+close() → None
+

Close the client resource.

+

This should always be called before exiting.

+
+ +
+
+property is_connected: bool
+

Is the WiFi connection currently established?

+
+
Returns:
+

True if yes, False if no

+
+
Return type:
+

bool

+
+
+
+ +
+
+open(ssid: str, password: str, timeout: int = 15, retries: int = 5) → None
+

Open the WiFi client resource so that it is ready to send and receive data

+
+
Parameters:
+
    +

  • ssid (str) – [description]

    • +

  • password (str) – [description]

    • +

  • timeout (int) – [description]. Defaults to 15.

    • +

  • retries (int) – [description]. Defaults to 5.

    • +
+
+
Raises:
+

ConnectFailed – [description]

+
+
+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/authors.html b/python_sdk/authors.html new file mode 100644 index 00000000..ad6c0381 --- /dev/null +++ b/python_sdk/authors.html @@ -0,0 +1,140 @@ + + + + + + + Credits — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Credits

+
+

Development Lead

+ +
+
+

Contributors

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/changelog.html b/python_sdk/changelog.html new file mode 100644 index 00000000..bd6f0121 --- /dev/null +++ b/python_sdk/changelog.html @@ -0,0 +1,535 @@ + + + + + + + Changelog — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Changelog

+

All notable changes to this project will be documented in this file.

+

The format is based on Keep a Changelog, +and this project adheres to Semantic Versioning.

+
+

0.16.0 (April-9-2024)

+
    +

  • Refactor all network operations to operate on common Message class

    • +

  • Add PUT Operation support

    • +

  • Add Custom Preset Update

    • +

  • Update Bleak to 0.21.1

    • +
+
+
+

0.15.1 (December-6-2023)

+
    +

  • Fix livestream demo.

    • +
+
+
+

0.15.0 (December-6-2023)

+
    +
  • +
    Add alpha support for COHN (Camera-on-the-Home-Network)
      +

    • A real implementation is going to require a major rearchitecture to dynamically add connection types.

      • +
    +
    +
    +
    • +

  • Remove TKinter GUI. Will be replaced with Textual TUI in the future

    • +

  • Improve wifi SSID matching

    • +

  • Fix unhashable pydantic base models

    • +
+
+
+

0.14.1 (September-21-2023)

+
    +

  • Fix BLE notifications not being routed correctly

    • +

  • Don’t hardcode media directory. Also append directory to filenames in media list.

    • +

  • Fix malformed Set Setting HTTP url

    • +
+
+
+

0.14.0 (September-13-2023)

+
    +

  • NOTE! This is a major update and includes massive API breaking changes.

    • +

  • Move to asyncio-based framework

    • +

  • Add HERO 12 support

    • +

  • Move from generic response to per-command typed response

    • +

  • Improve video viewer latency

    • +

  • Improve BLE and HTTP setting documentation

    • +

  • Add media list and metadata pydantic models

    • +
+
+
+

0.13.0 (February-24-2023)

+
    +

  • Allow for GUI dependencies to be optional (with “gui” extras)

    • +

  • Add English language verification for Wifi Driver

    • +

  • Documentation fixes missed from 0.12.0

    • +

  • Update dependencies (including bleak to 0.19.5)

    • +
+
+
+

0.12.0 (December-16-2023)

+
    +

  • Add USB support

    +
    +
      +

    • Introduces breaking changes of top level interface (i.e. GoPro –> WirelessGoPro / WiredGoPro)

      • +

    • Includes mDNS discovery of GoPro’s

      • +
    +
    +
    • +

  • Add run-time python version verification

    • +

  • Improve error messaging and documentation around wifi interface issues

    • +

  • Add livestream demo

    • +

  • Add webcam demo

    • +

  • Add message rules for Commands / Settings / Statuses (Fastpass, etc)

    • +
+
+
+

0.11.2 (November-9-2022)

+
    +

  • Update bleak to 0.19.0

    • +

  • Improve Bluetooth Scan delays

    • +

  • Add support for Hero 11 Mini

    • +
+
+
+

0.11.1 (October-18-2022)

+
    +

  • Improve Mac Wifi connection robustness

    • +

  • Fix BLE can ignoring timeout and retry args

    • +
+
+
+

0.11.0 (September-14-2022)

+
    +

  • Add Hero 11 Support

    • +

  • Add Presets Control Demo

    • +

  • Refactor all commands to be variadic

    • +

  • Add API GUI MVC framework

    • +

  • Protobuf command bug fixes

    • +

  • Improve API doc generation and docstring verification

    • +

  • Drop Python 3.8 support

    • +
+
+
+

0.10.0 (July-14-2022)

+
    +

  • Add sudo password argument to Wifi Controller and expose through CLI demos via stdin

    • +

  • Add more protobuf commands and missing protobuf ID parsing functionality

    • +

  • Add livestream demo GUI

    • +

  • Change preview stream demo to be a GUI

    • +

  • Add support for fragmenting long data packets when sending BLE data

    • +
+
+
+

0.9.2 (June-16-2022)

+
    +

  • Remove use of importlib.metadata as it was complicating pyinstaller use of this package

    • +
+
+
+

0.9.1 (May-27-2022)

+
    +

  • Improve non-main thread and asyncio exception handling

    • +

  • Add pydocstyle verification

    • +
+
+
+

0.9.0 (February-7-2022)

+
    +

  • Move to Poetry-based development environment

    • +

  • Fix docstring inconsistencies

    • +
+
+
+

0.8.0 (February-3-2022)

+
    +

  • Improve BLE connection Robustness

    • +

  • Deprecate support for Open GoPro Versions other than 2.0

    • +

  • Add set / date time commands

    • +

  • Implement remaining protobuf commands and fix protobuf parsing

    • +

  • Add hilight commands

    • +

  • Implement common UUID type

    • +

  • Add video performance mode

    • +

  • Remove deprecated status and setting ID’s

    • +
+
+
+

0.7.2 (January-3-2022)

+
    +

  • Allow for WiFi adapter to specify interface

    • +

  • Clean up Wifi adapter

    • +

  • Bump test package versions

    • +
+
+
+

0.7.1 (December-16-2021)

+
    +

  • Add global behaviors commands and camera control status

    • +

  • Add register / unregister all for settings and statuses

    • +

  • Add max lens setting

    • +

  • Improve API documentation

    • +
+
+
+

0.7.0 (October-27-2021)

+
    +

  • Add video performance mode functionality

    • +
+
+
+

0.6.3 (October-7-2021)

+
    +

  • Decouple response accumulating from parsing

    • +
+
+
+

0.6.2 (September-28-2021)

+
    +

  • Fix setup.py entrypoints for demo programs

    • +
+
+
+

0.6.1 (September-20-2021)

+
    +

  • make parsers available at instantiation

    • +

  • use GoPro specific enums to handle invalid parameter cases

    • +

  • handle HTTP GET errors

    • +

  • add Construct typing

    • +

  • update Construct parsers to return actual enum’s so identity checks can be used

    • +
+
+
+

0.6.0 (September-2-2021)

+
    +

  • Major refactor to support multiple Open GoPro API versions and different BLE / WiFi adapters

    • +

  • Improve BLE connection robustness by ensuring disconnects

    • +

  • Implement Open GoPro Version 2.0

    • +

  • Major documentation updates

    • +

  • Add end-to-end testing and improve test coverage

    • +

  • Upgrade bleak

    • +

  • Add connect WiFi demos

    • +
+
+
+

0.5.8 (August-10-2021)

+
    +

  • Add option to start GoPro communication without WiFi (i.e only use BLE)

    • +

  • Add battery logging example

    • +
+
+
+

0.5.7 (June-7-2021)

+
    +

  • Fix wifi driver for Windows

    • +
+
+
+

0.5.6 (May-26-2021)

+
    +

  • Minor documentation updates

    • +
+
+
+

0.5.5 (May-26-2021)

+
    +

  • Documentation link updates

    • +
+
+
+

0.5.4 (May-6-2021)

+
    +

  • Update documentation to coexist with jekyll on Github pages

    • +
+
+
+

0.5.3 (April-15-2021)

+
    +

  • Documentation updates

    • +

  • Move into Open GoPro repo

    • +
+
+
+

0.5.2 (April-2-2021)

+
    +

  • Add entrypoints for video, photo, and stream

    • +

  • Updates to response interface for usability

    • +

  • Fix Ubuntu Wifi driver scanning

    • +
+
+
+

0.5.1 (April-1-2021)

+
    +

  • Add photo, video, and stream entry points

    • +

  • Change active accumulating response to a dict indexed by UUID’s to handle simultaneous active responses

    • +
+
+
+

0.5.0 (March-30-2021)

+
    +

  • Add support for Ubuntu 20.04

    • +

  • Upgrade to bleak 0.11.0

    • +
+
+
+

0.4.6 (March-29-2021)

+
    +

  • Fix bug where multiple simultaneous sync responses weren’t handled

    • +
+
+
+

0.4.5 (March-29-2021)

+
    +
  • +
    Infrastructure updates:
      +

    • Move from flake8 to pylint in order to catch missing args in docstrings

      • +

    • Implement a lot of pylint suggestions

      • +
    +
    +
    +
    • +
+
+
+

0.4.4 (March-27-2021)

+
    +
  • +
    Infrastructure updates:
      +

    • Add Github actions for CI / CD

      • +

    • Fix all mypy and flake8 errors

      • +
    +
    +
    +
    • +
+
+
+

0.4.3 (March-26-2021)

+
    +

  • Make BLE interface controller-agnostic

    • +
+
+
+

0.4.2 (March-25-2021)

+
    +

  • Fix line endings that were causing PyPi failures

    • +
+
+
+

0.4.1 (March-25-2021)

+
    +

  • Fix install error by adding protobuf requirement

    • +
+
+
+

0.4.0 (March-25-2021)

+
    +

  • Merge BLE and WiFi classes into one GoPro class

    • +

  • Automatically periodically send keep alive

    • +

  • Run pydocstyle on docstrings

    • +
+
+
+

0.3.3 (March-22-2021)

+
    +

  • Add support to wait for encoding and system ready statuses in BLE

    • +

  • Add protobuf framework (not being sent yet)

    • +

  • Fix Wi-Fi SSID corner cases

    • +
+
+
+

0.3.2 (March-15-2021)

+
    +

  • Handle case where BLE parameter has length 0

    • +

  • Doc updates

    • +
+
+
+

0.3.1 (March-12-2021)

+
    +

  • Add automatic VLC opening

    • +
+
+
+

0.3.0 (March-11-2021)

+
    +

  • Wrote documentation and did some refactoring

    • +
+
+
+

0.2.0 (March-10-2021)

+
    +

  • first usable Beta package.

    • +

  • Should work on Windows and Mac

    • +
+
+
+

0.1.x (March-10-2021)

+
    +

  • open_gopro created. Incremental updates until the package could actually install

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/contributing.html b/python_sdk/contributing.html new file mode 100644 index 00000000..25a2e553 --- /dev/null +++ b/python_sdk/contributing.html @@ -0,0 +1,274 @@ + + + + + + + Contributing — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Contributing

+

Contributions are welcome, are greatly appreciated, and credit will always be given.

+
+

Types of Contributions

+
+

Report Bugs

+

Report bugs at https://github.com/gopro/OpenGoPro/issues.

+

If you are reporting a bug, please include:

+
    +

  • Your operating system name and version.

    • +

  • Any details about your local setup that might be helpful in troubleshooting.

    • +

  • Detailed steps to reproduce the bug.

    • +
+
+
+

Fix Bugs

+

Look through the GitHub issues for bugs. Anything tagged with “bug” +and “help wanted” is open to whoever wants to implement it.

+
+
+

Implement Features

+

Look through the GitHub issues for features. Anything tagged with “enhancement” +and “help wanted” is open to whoever wants to implement it.

+
+
+

Write Documentation

+

Open GoPro could always use more documentation, whether as part of the +official Open GoPro docs, in docstrings, or even on the web in blog posts, +articles, and such.

+
+
+

Submit Feedback

+

The best way to send feedback is to file an issue at +https://github.com/gopro/OpenGoPro/issues.

+

If you are proposing a feature:

+
    +

  • Explain in detail how it would work.

    • +

  • Keep the scope as narrow as possible, to make it easier to implement.

    • +
+
+
+
+

Get Started!

+

Ready to contribute? Here’s how to set up Open GoPro for local development.

+
+

Minimal Requirements

+
    +

  • Python (>= 3.9, < 3.12)

    • +

  • Poetry : Needed to install dependencies / development tasks

    • +
+

Additional Optional Requirements:

+
    +

  • protoc to build protobuf python files from .proto’s

    • +

  • graphviz to build diagrams in sphinx

    • +
+
+
+

Steps

+
    +

  1. Fork the Open GoPro repo on GitHub.

    2. +

  2. Clone your fork locally:

    +
    +
    $ git clone git@github.com:your_name_here/OpenGoPro.git
+
    +
    +
    +
    3. +

  3. Enter the sdk_wireless_camera_control directory:

    +
    +
    $ cd OpenGoPro/demos/python/sdk_wireless_camera_control
+
    +
    +
    +
    4. +

  4. Create a branch for local development, originating from the main branch:

    +
    +
    $ git checkout -b name-of-your-bugfix-or-feature main
+
    +
    +
    +
    5. +

  5. Install your local copy into a virtual environment.

    +
    +
    $ poetry install --all-extras
+
    +
    +
    +
    6. +

  6. Make your changes locally. When you’re done making changes, check that your changes are:

    +
    +
      +

    • formatted

      • +

    • pass type checking

      • +

    • pass linting

      • +

    • pass unit tests

      • +

    • pass docstring tests

      • +
    +
    $ poetry run poe all
+
    +
    +

    Note that each of these checks can be run individually. For more information, see:

    +
    $ poetry run poe --help
+
    +
    +
    +
    7. +

  7. Commit your changes, push your branch to GitHub, and submit a pull request into main. Once the Pull Request is made, +Github Actions will test the changes across multiple OS’s and Python versions.

    8. +
+
+
+
+

Pull Request Guidelines

+

Before you submit a pull request, check that it meets these guidelines:

+
    +

  1. If the pull request adds functionality, the docs should be updated. The docs can be build locally via:

    +
    +
    $ poetry run poe docs
+
    +
    +
    +
    2. +

  2. Modify the CHANGELOG.rst.

    3. +

  3. The pull request should work for Python 3.8 - 3.12 on the following platforms:

    +
    +
      +

    • Windows 10, version 16299 (Fall Creators Update) and greater

      • +

    • Linux distributions with BlueZ >= 5.43

      • +

    • OS X / macOS >= 10.11

      • +
    +
    +
    4. +

  4. Feel free to add your name as a contributor to the AUTHORS.rst file!

    5. +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/future_work.html b/python_sdk/future_work.html new file mode 100644 index 00000000..dd41c6c2 --- /dev/null +++ b/python_sdk/future_work.html @@ -0,0 +1,136 @@ + + + + + + + Future Work — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Future Work

+

See the Github Issues page for tickets tagged with “Python SDK” +and “Enhancement.” +Here is a +sample search.

+
+

Known issues

+

See the Github Issues page for tickets tagged with “Python SDK” +and “bug.” +Here is a sample +search.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/genindex.html b/python_sdk/genindex.html new file mode 100644 index 00000000..5130676d --- /dev/null +++ b/python_sdk/genindex.html @@ -0,0 +1,2762 @@ + + + + + + Index — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | Q + | R + | S + | T + | U + | V + | W + | Z + +
+

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + + +
+ +

F

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

K

+ + + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

Q

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ +

V

+ + + +
+ +

W

+ + + +
+ +

Z

+ + + +
+ + + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/index.html b/python_sdk/index.html new file mode 100644 index 00000000..37b176a6 --- /dev/null +++ b/python_sdk/index.html @@ -0,0 +1,1086 @@ + + + + + + + Open GoPro Python SDK — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Open GoPro Python SDK

+
+GoPro Logo +
+MIT License +Build and Test +PyPI +Black +Coverage
+

Summary

+

Welcome to the Open GoPro Python package documentation. This is a Python package that provides an +interface for the user to exercise the Open GoPro Bluetooth Low Energy (BLE) and Wi-Fi / USB HTTP API’s as +well as install command line interfaces to take photos, videos, and view video streams.

+

This package implements the API as defined in the Open GoPro Specification . +For more information on the API, see the relevant documentation:

+ +
+

Warning

+

This package requires Python >= version 3.9 and < 3.12

+
+
+
+

Features

+
    +

  • Top-level GoPro class interface to use BLE, WiFi, and / or USB

    • +

  • Cross-platform (tested on Windows 10, and Ubuntu 20.04, and >= MacOS Big Sur)

    +
      +

    • BLE controller implemented using bleak

      • +

    • Wi-Fi controller provided in the Open GoPro package (loosely based on the Wireless Library )

      • +
    +
    • +

  • Supports all wireless commands, settings, and statuses from the Open GoPro API

    • +

  • Automatically handles connection maintenance:

    +
      +

    • manage camera ready / encoding

      • +

    • periodically sends keep alive signals

      • +
    +
    • +

  • Includes detailed logging for each module

    • +

  • Includes demo scripts installed as command-line applications to show BLE, WiFi, and USB functionality such as:

    +
      +

    • Take a photo

      • +

    • GUI to send all commands and view the live / preview stream

      • +

    • Configure and view a GoPro webcam stream

      • +

    • Take a video

      • +

    • Start a livestream

      • +

    • View the GoPro as a webcam

      • +

    • Log the battery

      • +
    +
    • +
+
+
+

Getting Started

+

Here is a suggested procedure for getting acquainted with this package (it is the same as reading through +this document in order):

+
    +

  1. Install the package

    2. +

  2. Try some of the demos

    3. +

  3. Implement your own example, perhaps starting with a demo, with usage information

    4. +

  4. If you need more detailed implementation reference, see the Interface documentation

    5. +
+
+
+

Development

+
    +

  1. Set up the development environment

    2. +

  2. Open a Pull Request

    3. +
+
+

Contents:

+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/installation.html b/python_sdk/installation.html new file mode 100644 index 00000000..f7eddf1d --- /dev/null +++ b/python_sdk/installation.html @@ -0,0 +1,188 @@ + + + + + + + Installation — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Installation

+
+

Stable release

+

This is the preferred method to install Open GoPro, as it will always install the most recent stable release +from PyPi .

+

If you don’t have pip installed, this Python installation guide can guide +you through the process.

+
+

Minimal Install

+

To minimally install Open GoPro (to use the library and CLI demos), run this command in your terminal:

+
$ pip install open-gopro
+
+
+
+
+

Additional GUI Install

+

To additionally install the extra dependencies to run the GUI demos:

+
$ pip install open-gopro[gui]
+
+
+
+
+

External Dependencies

+

In order to use any of the Webcam API’s, ensure first that your system is setup to +Use the GoPro as a Webcam

+
+
+
+

From sources

+

The sources for Open GoPro can be downloaded from the Github repo.

+

You can either clone the public repository:

+
$ git clone https://github.com/gopro/OpenGoPro
+
+
+

Or download the zip:

+
$ curl  -OL https://github.com/gopro/OpenGoPro/archive/refs/heads/main.zip
+
+
+

Once you have a copy of the source, you can install it:

+

First, enter the directory where the source code exists

+
$ cd OpenGoPro/demos/python/sdk_wireless_camera_control
+
+
+

Then install the package

+
$ pip install .
+
+
+
+

For Developers

+

The above installation will not install Open GoPro in editable mode. If you want to modify the package so that +you can change it, for i.e. development, see Contribution.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/objects.inv b/python_sdk/objects.inv new file mode 100644 index 00000000..7a4d7a2e Binary files /dev/null and b/python_sdk/objects.inv differ diff --git a/python_sdk/py-modindex.html b/python_sdk/py-modindex.html new file mode 100644 index 00000000..d4431d14 --- /dev/null +++ b/python_sdk/py-modindex.html @@ -0,0 +1,174 @@ + + + + + + Python Module Index — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Python Module Index
    • +
  • +
    • +
+
+
+
+
+ + +

Python Module Index

+ +
+ o +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ o
+ open_gopro +
    + open_gopro.api.params +
    + open_gopro.ble.client +
    + open_gopro.ble.controller +
    + open_gopro.ble.services +
    + open_gopro.constants +
    + open_gopro.exceptions +
    + open_gopro.wifi.client +
    + open_gopro.wifi.controller +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/quickstart.html b/python_sdk/quickstart.html new file mode 100644 index 00000000..8d301772 --- /dev/null +++ b/python_sdk/quickstart.html @@ -0,0 +1,334 @@ + + + + + + + QuickStart Guide — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

QuickStart Guide

+
+

Warning

+

This section assumes you have successfully installed the package.

+
+

Open GoPro installs with several demos to demonstrate BLE and Wi-Fi. The source code for these examples +can be found on Github +or locally in $INSTALL/open_gopro/demos where $INSTALL can be found with:

+
$ pip show open-gopro
+
+
+

Note that the GUI demos will only be available if OpenGoPro was installed with the additional GUI option. +See the installation steps for more informatoin.

+
+

Command Line Interface (CLI) Demos

+

All of the CLI demos have command-line help via the –help parameter. All demos will log to the console as well +as write a more detailed log to a file (this file can be set with the –log parameter). The detailed log +is very helpful for diagnosing BLE / WiFi inconsistencies.

+
+

Photo Demo

+

The photo demo will discover a GoPro camera, connect to it, take a photo, and then download the +photo to your local machine. It defaults to connecting to a wireless camera but can connect to a wired camera +by setting the wired option. To run, do:

+
$ gopro-photo
+
+
+

For more information, do:

+
$ gopro-photo --help
+usage: gopro-photo [-h] [--output OUTPUT] [--wired] [--log LOG] [--identifier IDENTIFIER] [--wifi_interface WIFI_INTERFACE] [--password]
+
+Connect to a GoPro camera, take a photo, then download it.
+
+options:
+-h, --help            show this help message and exit
+--output OUTPUT       Where to write the photo to. If not set, write to 'photo.jpg'
+--wired               Set to use wired (USB) instead of wireless (BLE / WIFI) interface
+--log LOG             Location to store detailed log
+--identifier IDENTIFIER
+                        Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first
+                        discovered GoPro will be connected to
+--wifi_interface WIFI_INTERFACE
+                        System Wifi Interface. If not set, first discovered interface will be used.
+--password            Set to read sudo password from stdin. If not set, you will be prompted for password if needed
+
+
+
+
+

Video Demo

+

The video demo will discover a GoPro camera, connect to it, take a video for a given amount of time, and then +download the photo to your local machine. It defaults to connecting to a wireless camera but can connect to a +wired camera by setting the wired option.To run and capture a 2 second video, do:

+
$ gopro-video 2
+
+
+

For more information, do:

+
$ gopro-video --help
+usage: gopro-video [-h] [-o OUTPUT] [--wired] [--log LOG] [--identifier IDENTIFIER] [--wifi_interface WIFI_INTERFACE] [--password]
+                record_time
+
+Connect to a GoPro camera, take a video, then download it.
+
+positional arguments:
+record_time           How long to record for
+
+options:
+-h, --help            show this help message and exit
+-o OUTPUT, --output OUTPUT
+                        Where to write the video to. If not set, write to 'video.mp4'
+--wired               Set to use wired (USB) instead of wireless (BLE / WIFI) interface
+--log LOG             Location to store detailed log
+--identifier IDENTIFIER
+                        Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first
+                        discovered GoPro will be connected to
+--wifi_interface WIFI_INTERFACE
+                        System Wifi Interface. If not set, first discovered interface will be used.
+--password            Set to read sudo password from stdin. If not set, you will be prompted for password if needed
+
+
+
+
+

WiFi Demo

+

The wifi demo will discover a GoPro camera, connect to it, enable the camera’a WiFi AP, and then connect +to it via WiFi. This is useful if you want to send HTTP commands to it from some external source such as curl.

+

Note that this demo will run, thus maintaining the WiFi connection, until exited by pressing enter.

+
$ gopro-wifi
+
+
+

For more information, do:

+
$ gopro-wif --help
+usage: gopro-wifi [-h] [-l LOG] [-i IDENTIFIER] [-w WIFI_INTERFACE] [-p]
+
+Connect to a GoPro camera's Wifi Access Point.
+
+optional arguments:
+-h, --help            show this help message and exit
+-l LOG, --log LOG     Location to store detailed log
+-i IDENTIFIER, --identifier IDENTIFIER
+                        Last 4 digits of GoPro serial number, which is the last 4 digits of the
+                        default camera SSID. If not used, first discovered GoPro will be
+                        connected to
+-w WIFI_INTERFACE, --wifi_interface WIFI_INTERFACE
+                        System Wifi Interface. If not set, first discovered interface will be
+                        used.
+-p, --password        Set to read sudo password from stdin. If not set, you will be prompted
+                        for password if needed
+
+
+
+
+

Battery Demo

+

This demo will continuously read the battery level (either via polling or registering fro notifications as +configured per the command line argument) and write +the results to a .csv file. To run, do:

+
$ gopro-log-battery
+
+
+

For more information, do:

+
$ gopro-log-battery --help
+usage: gopro-log-battery [-h] [-p POLL] [-l LOG] [-i IDENTIFIER]
+
+Connect to the GoPro via BLE only and continuously read the battery (either by polling or
+notifications).
+
+optional arguments:
+-h, --help            show this help message and exit
+-p POLL, --poll POLL  Set to poll the battery at a given interval. If not set, battery level
+                        will be notified instead. Defaults to notifications.
+-l LOG, --log LOG     Location to store detailed log
+-i IDENTIFIER, --identifier IDENTIFIER
+                        Last 4 digits of GoPro serial number, which is the last 4 digits of the
+                        default camera SSID. If not used, first discovered GoPro will be
+                        connected to
+
+
+
+
+
+

Graphical User Interface (GUI) Demos

+
+

Wired Webcam Demo

+

The webcam demo will configure a GoPro (identified via serial number) as a webcam, start the webcam, and use +OpenCV to start a viewer to display the stream.

+
$ gopro-webcam
+
+
+

For more information, do:

+
$ gopro-webcam --help
+usage: gopro-webcam [-h] [-i IDENTIFIER] [-l LOG]
+
+Setup and view a GoPro webcam.
+
+options:
+-h, --help            show this help message and exit
+-i IDENTIFIER, --identifier IDENTIFIER
+                        Last 3 digits of GoPro serial number, which is the last 3 digits of the default camera SSID. If not specified, first
+                        GoPro discovered via mDNS will be used
+-l LOG, --log LOG     Location to store detailed log
+
+
+
+
+

Livestream Demo

+

The livestream demo will connect via BLE to the camera, connect the camera to a Wifi AP, configure / start +livestream, then use OpenCV to start a viewer to display the stream.

+
$ gopro-webcam
+
+
+

For more information, do:

+
$ gopro-livestream --help
+usage: gopro-livestream [-h] [--min_bit MIN_BIT] [--max_bit MAX_BIT] [--start_bit START_BIT] [--resolution {4,7,12}] [--fov {0,4,3}]
+                        [--log LOG] [--identifier IDENTIFIER]
+                        ssid password url
+
+Connect to the GoPro via BLE only, configure then start a Livestream, then display it with CV2.
+
+positional arguments:
+ssid                  WiFi SSID to connect to.
+password              Password of WiFi SSID.
+url                   RTMP server URL to stream to.
+
+options:
+-h, --help            show this help message and exit
+--min_bit MIN_BIT     Minimum bitrate.
+--max_bit MAX_BIT     Maximum bitrate.
+--start_bit START_BIT
+                        Starting bitrate.
+--resolution {4,7,12}
+                        Resolution.
+--fov {0,4,3}         Field of View.
+--log LOG             Location to store detailed log
+--identifier IDENTIFIER
+                        Last 4 digits of GoPro serial number, which is the last 4 digits of the default camera SSID. If not used, first
+                        discovered GoPro will be connected to
+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/search.html b/python_sdk/search.html new file mode 100644 index 00000000..165c30ff --- /dev/null +++ b/python_sdk/search.html @@ -0,0 +1,134 @@ + + + + + + Search — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+ +
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/python_sdk/searchindex.js b/python_sdk/searchindex.js new file mode 100644 index 00000000..0e344f00 --- /dev/null +++ b/python_sdk/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["api", "authors", "changelog", "contributing", "future_work", "index", "installation", "quickstart", "troubleshooting", "usage"], "filenames": ["api.rst", "authors.rst", "changelog.rst", "contributing.rst", "future_work.rst", "index.rst", "installation.rst", "quickstart.rst", "troubleshooting.rst", "usage.rst"], "titles": ["API Reference", "Credits", "Changelog", "Contributing", "Future Work", "Open GoPro Python SDK", "Installation", "QuickStart Guide", "Troubleshooting", "Usage"], "terms": {"thi": [0, 2, 5, 6, 7, 8, 9], "section": [0, 7, 8, 9], "i": [0, 2, 3, 4, 5, 6, 7, 8, 9], "python": [0, 2, 3, 4, 6, 8, 9], "packag": [0, 2, 5, 6, 7, 8, 9], "The": [0, 2, 3, 6, 7, 9], "": [0, 2, 3, 5, 6, 7, 9], "implement": [0, 2, 5], "can": [0, 2, 3, 6, 7, 8, 9], "found": [0, 7, 9], "document": [0, 2, 5, 9], "link": [0, 2], "from": [0, 2, 3, 5, 7, 8, 9], "summari": 0, "Not": [0, 8], "everyth": 0, "expos": [0, 2], "here": [0, 3, 4, 5, 8, 9], "should": [0, 2, 3, 8], "onli": [0, 2, 7, 9], "consist": 0, "inform": [0, 3, 5, 7, 8, 9], "user": [0, 5, 9], "develop": [0, 2, 3], "modul": [0, 5, 8, 9], "care": 0, "about": [0, 3, 9], "For": [0, 3, 5, 7, 9], "higher": 0, "level": [0, 2, 5, 7, 8, 9], "usag": [0, 5, 7], "see": [0, 3, 4, 5, 6, 7, 9], "substitut": 0, "specif": [0, 2, 5, 9], "That": 0, "show": [0, 5, 7], "how": [0, 3, 7, 8, 9], "us": [0, 2, 3, 5, 6, 7, 8, 9], "variou": [0, 9], "command": [0, 2, 5, 6], "an": [0, 3, 5, 8, 9], "exhaust": 0, "sourc": [0, 5, 7], "what": [0, 9], "each": [0, 3, 5], "doe": 0, "spec": 0, "simultan": [0, 2], "There": [0, 8, 9], "ar": [0, 3, 8, 9], "two": [0, 9], "top": [0, 2, 5, 9], "open_gopro": [0, 2, 7, 8, 9], "import": [0, 8, 9], "wirelessgopro": [0, 2, 5, 8, 9], "gopro_wireless": 0, "gopro_bas": 0, "goprobas": [0, 5], "communicator_interfac": 0, "goprohttp": [0, 5], "basegoprocommun": [0, 5], "abc": 0, "gener": [0, 2, 9], "goprowirelessinterfac": [0, 5], "goprobl": [0, 5], "goprowifi": [0, 5], "class": [0, 2, 5, 8, 9], "target": [0, 9], "option": [0, 2, 3, 7, 9], "pattern": [0, 9], "none": [0, 9], "wifi_interfac": [0, 7], "str": [0, 9], "sudo_password": 0, "enable_wifi": [0, 9], "bool": 0, "true": [0, 9], "kwarg": 0, "ani": [0, 3, 6, 9], "devic": [0, 9], "sdk": [0, 4, 9], "complet": [0, 9], "handl": [0, 2, 5], "discov": [0, 7, 8, 9], "establish": 0, "connect": [0, 2, 5, 7, 9], "gatt": 0, "characterist": [0, 5, 9], "enabl": [0, 7, 8, 9], "notif": [0, 2, 5, 7], "version": [0, 2, 3, 5], "date": [0, 2], "time": [0, 2, 7], "timezon": 0, "dst": 0, "transfer": 0, "find": 0, "ssid": [0, 2, 5, 7], "password": [0, 2, 5, 7], "It": [0, 7, 9], "also": [0, 2, 9], "do": [0, 7, 9], "some": [0, 2, 5, 7, 8, 9], "synchron": [0, 5], "etc": [0, 2], "ensur": [0, 2, 6], "camera": [0, 2, 5, 7], "readi": [0, 2, 3, 5], "encod": [0, 2, 5, 9], "befor": [0, 3, 9], "send": [0, 2, 3, 5, 7], "keep": [0, 2, 3, 5], "aliv": [0, 2, 5], "signal": [0, 5], "period": [0, 2, 5], "If": [0, 3, 5, 6, 7, 9], "arg": [0, 2], "pass": [0, 3, 9], "first": [0, 2, 6, 7, 9], "via": [0, 2, 3, 7, 9], "context": [0, 9], "manag": [0, 5, 9], "async": [0, 8, 9], "print": [0, 9], "yai": [0, 9], "m": [0, 8, 9], "get": [0, 2, 9], "now": [0, 9], "Or": [0, 6], "without": [0, 2, 9], "await": [0, 9], "A": [0, 2, 9], "regex": 0, "search": [0, 4, 9], "name": [0, 3], "exampl": [0, 2, 5, 7, 8, 9], "0456": 0, "default": [0, 7, 8, 9], "e": [0, 2, 6, 9], "specifi": [0, 2, 7, 9], "local": [0, 3, 7], "machin": [0, 7], "sudo": [0, 2, 5, 7], "you": [0, 3, 5, 6, 7, 8, 9], "prompt": [0, 7], "need": [0, 3, 5, 7, 8, 9], "which": [0, 7, 9], "happen": [0, 8], "nix": 0, "system": [0, 2, 3, 6, 7], "fals": [0, 9], "dict": [0, 2, 9], "addit": [0, 3, 5, 7], "intern": [0, 9], "test": [0, 2, 3, 5], "noqa": 0, "dar401": 0, "rais": [0, 9], "interfaceconfigfailur": [0, 5], "In": [0, 6, 9], "order": [0, 2, 5, 6], "commun": [0, 2, 9], "must": [0, 9], "avail": [0, 2, 7], "dar402": 0, "By": 0, "dure": [0, 9], "initi": [0, 9], "driver": [0, 2], "attempt": 0, "automat": [0, 2, 5, 9], "note": [0, 2, 3, 7, 9], "manual": [0, 9], "argument": [0, 2, 7, 9], "properti": [0, 9], "ble_command": [0, 5, 9], "blecommand": [0, 5, 9], "call": [0, 9], "return": [0, 2, 9], "ble_set": [0, 5, 9], "bleset": [0, 5, 9], "access": [0, 5, 7], "ble_statu": [0, 5, 9], "blestatus": [0, 5], "status": [0, 2, 5], "close": [0, 5], "safe": 0, "stop": [0, 9], "instanc": [0, 9], "disconnect": [0, 2, 5, 9], "applic": [0, 5], "mandatori": 0, "exit": [0, 5, 7, 9], "program": [0, 2, 9], "prevent": 0, "reconnect": [0, 9], "issu": [0, 2, 3, 5, 9], "becaus": 0, "o": [0, 3, 7, 9], "ha": [0, 2, 9], "never": 0, "previou": 0, "session": 0, "configure_cohn": [0, 5], "timeout": [0, 2], "int": [0, 9], "60": 0, "prepar": 0, "home": [0, 2], "network": [0, 2], "provis": 0, "Then": [0, 6, 9], "wait": [0, 2], "cohn": [0, 2], "second": [0, 7], "success": [0, 5, 9], "otherwis": [0, 9], "connect_to_access_point": 0, "point": [0, 2, 7], "ap": [0, 7], "current": [0, 5, 9], "http_command": [0, 5, 9], "httpcommand": [0, 5, 9], "http_set": [0, 5, 9], "httpset": [0, 5, 9], "identifi": [0, 5, 7, 9], "uniqu": 0, "last": [0, 7], "4": [0, 5, 7], "digit": [0, 7], "same": [0, 5, 9], "string": [0, 8, 9], "scan": [0, 2, 5, 9], "been": [0, 9], "provid": [0, 5, 8, 9], "yet": [0, 2, 9], "gopronotopen": [0, 5], "so": [0, 2, 6, 9], "els": [0, 9], "is_ble_connect": [0, 5, 9], "we": [0, 9], "ye": 0, "is_cohn_provis": [0, 5], "is_http_connect": [0, 5, 9], "is_open": [0, 5, 9], "is_readi": [0, 5, 9], "receiv": [0, 9], "keep_al": 0, "heartbeat": 0, "drop": [0, 2], "sent": [0, 2, 9], "its": [0, 9], "maintain_bl": 0, "succeed": 0, "10": [0, 3, 5], "retri": [0, 2], "5": [0, 3, 5], "perform": [0, 2, 9], "all": [0, 2, 3, 5, 7, 8, 9], "configur": [0, 5, 7, 9], "queri": [0, 5, 9], "start": [0, 2, 7], "mainten": [0, 5], "disabl": [0, 9], "propag": 0, "through": [0, 2, 3, 5, 6], "invalidopengoprovers": [0, 5, 9], "2": [0, 5, 7, 9], "0": [0, 5, 7, 9], "support": [0, 2, 5, 9], "long": [0, 2, 7], "out": 0, "mani": 0, "consid": [0, 9], "fail": 0, "known": [0, 5], "register_upd": [0, 5, 9], "callback": [0, 9], "callabl": [0, 9], "union": 0, "settingid": [0, 5, 9], "statusid": [0, 5, 9], "actionid": [0, 5], "coroutin": [0, 9], "updat": [0, 2, 3, 9], "regist": [0, 2, 7, 9], "when": [0, 2, 3, 9], "occur": [0, 9], "updatecb": 0, "notifi": [0, 7], "updatetyp": [0, 9], "unregister_upd": [0, 5], "unregist": [0, 2, 9], "asynchron": [0, 5], "unsubscrib": 0, "wiredgopro": [0, 2, 5, 9], "gopro_wir": 0, "goprowiredinterfac": [0, 5], "serial": [0, 7, 9], "usb": [0, 2, 5, 7, 9], "number": [0, 7], "instanti": [0, 2], "mdn": [0, 2, 7, 9], "server": [0, 7, 9], "least": 0, "3": [0, 3, 5, 7], "keyword": [0, 9], "notimplementederror": [0, 9], "valid": 0, "gracefulli": [0, 9], "possibl": [0, 3, 9], "wa": [0, 2, 7, 9], "ip": 0, "1": [0, 5], "failur": [0, 2], "correct": 0, "failedtofinddevic": [0, 5], "could": [0, 2, 3], "auto": 0, "These": [0, 9], "both": [0, 9], "themselv": 0, "directli": [0, 9], "instead": [0, 7, 9], "relev": [0, 5, 9], "wifi_set": 0, "communicatortyp": 0, "blemessag": 0, "To": [0, 6, 7, 9], "deleg": 0, "build": [0, 3], "cohn_clear_certif": [0, 5], "goproresp": [0, 5, 9], "clear": 0, "ssl": 0, "certif": 0, "cohn_create_certif": [0, 5], "overrid": 0, "creat": [0, 2, 3], "cert": 0, "overwritten": 0, "creation": 0, "cohn_get_certif": [0, 5], "responsecohncert": 0, "proto": [0, 3], "cohn_get_statu": [0, 5], "notifycohnstatu": 0, "whether": [0, 3], "cohn_set_set": [0, 5], "mode": [0, 2, 6], "toggl": [0, 5, 9], "param": [0, 9], "custom_preset_upd": [0, 5], "icon_id": 0, "titl": 0, "responsegener": 0, "custom": [0, 2, 8], "preset": [0, 2], "icon": 0, "enumpreseticon": 0, "valuetyp": 0, "id": [0, 2, 9], "enumpresettitl": 0, "factori": 0, "valueerror": 0, "did": [0, 2], "typeerror": 0, "enable_wifi_ap": [0, 5], "wi": [0, 2, 5, 7], "fi": [0, 2, 5, 7], "json": [0, 9], "get_ap_entri": [0, 5], "scan_id": 0, "start_index": 0, "max_entri": 0, "100": 0, "responsegetapentri": 0, "result": [0, 7], "correspond": [0, 9], "page": [0, 2, 4], "notifstartscan": 0, "total_entri": 0, "valu": [0, 9], "entri": [0, 2], "get_camera_cap": [0, 5], "capabl": [0, 9], "get_camera_set": [0, 5, 9], "get_camera_status": [0, 5, 9], "get_date_tim": [0, 5], "datetim": 0, "non": [0, 2], "get_date_time_tz_dst": [0, 5], "tzdstdatetim": [0, 5], "get_hardware_info": [0, 5, 9], "camerainfo": [0, 5, 9], "board": 0, "firmwar": 0, "info": [0, 8, 9], "get_last_captured_media": [0, 5], "responselastcapturedmedia": 0, "captur": [0, 7], "media": [0, 2], "file": [0, 2, 3, 7, 8], "request": [0, 5], "get_open_gopro_api_vers": [0, 5], "get_preset_statu": [0, 5], "list": [0, 2], "notifypresetstatu": 0, "group": [0, 9], "state": [0, 9], "un": 0, "modifi": [0, 3, 6], "preset_modified_notif": [0, 5], "enumregisterpresetstatu": 0, "describ": [0, 9], "get_wifi_password": [0, 5], "get_wifi_ssid": [0, 5], "load_preset": [0, 5], "load": 0, "integ": 0, "load_preset_group": [0, 5], "onc": [0, 3, 6, 9], "most": [0, 6, 9], "recent": [0, 6], "activ": [0, 2], "enumpresetgroup": 0, "power_down": [0, 5], "power": [0, 5], "down": 0, "register_for_all_cap": [0, 5, 9], "push": [0, 3, 5], "register_for_all_set": [0, 5, 9], "register_for_all_status": [0, 5, 9], "register_livestream_statu": [0, 5], "notifylivestreamstatu": 0, "livestream": [0, 2, 5], "enumregisterlivestreamstatu": 0, "don": [0, 2, 6], "t": [0, 2, 6, 8], "release_network": [0, 5], "sta": 0, "releas": [0, 5, 9], "request_wifi_connect": [0, 5], "responseconnect": 0, "alreadi": [0, 9], "notif_provis_st": [0, 5], "request_wifi_connect_new": [0, 5], "responseconnectnew": 0, "scan_wifi_network": [0, 5], "responsestartscan": 0, "set_camera_control": [0, 5], "camera_control_statu": 0, "tell": 0, "app": 0, "extern": [0, 5, 7], "control": [0, 2, 5, 8], "wish": 0, "claim": 0, "enumcameracontrolstatu": 0, "desir": [0, 9], "set_date_tim": [0, 5], "date_tim": 0, "ignor": [0, 2], "set_date_time_tz_dst": [0, 5], "tz_offset": 0, "is_dst": 0, "utc": 0, "offset": 0, "daylight": 0, "save": 0, "set_livestream_mod": [0, 5], "url": [0, 2, 7], "window_s": 0, "minimum_bitr": 0, "maximum_bitr": 0, "starting_bitr": 0, "len": [0, 2], "pathlib": [0, 8], "path": [0, 8], "site": 0, "accept": 0, "rtmp": [0, 7], "stream": [0, 2, 5, 7], "empti": 0, "invalid": [0, 2], "cancel": 0, "enumwindows": 0, "video": [0, 2, 5], "resolut": [0, 5, 7, 9], "minimum": [0, 7], "bitrat": [0, 5, 7], "800": 0, "maximum": [0, 7, 8], "8000": 0, "honor": 0, "enumlen": 0, "field": [0, 7], "view": [0, 5, 7], "set_shutt": [0, 5, 9], "shutter": [0, 5, 9], "off": [0, 5], "set_third_party_client_info": [0, 5], "flag": 0, "third": 0, "parti": 0, "set_turbo_mod": [0, 5], "turbo": 0, "sleep": [0, 5], "put": [0, 2, 9], "standbi": 0, "tag_hilight": [0, 5], "tag": [0, 3, 4], "highlight": 0, "unregister_for_all_cap": [0, 5, 9], "unregister_for_all_set": [0, 5, 9], "unregister_for_all_status": [0, 5, 9], "blesettingmessagebas": 0, "collect": 0, "adapt": [0, 2], "read": [0, 5, 7, 9], "write": [0, 5, 7], "anti_flick": [0, 5], "blesettingfacad": [0, 9], "antiflick": [0, 5], "anti": 0, "flicker": 0, "frequenc": 0, "auto_off": [0, 5], "autooff": [0, 5], "bit_depth": [0, 5], "bitdepth": [0, 5], "bit": 0, "depth": 0, "bit_rat": [0, 5], "rate": 0, "camera_ux_mod": [0, 5], "camerauxmod": [0, 5], "fp": [0, 5, 9], "frame": [0, 5], "per": [0, 2, 7], "hindsight": [0, 5], "hypersmooth": [0, 5], "hypersmoothmod": [0, 5], "led": [0, 5], "max_lens_mod": [0, 5], "maxlensmod": [0, 5], "max": [0, 2], "mod": 0, "maxlens_mod_typ": [0, 5], "maxlensmodtyp": [0, 5], "maxlens_statu": [0, 5], "media_format": [0, 5], "mediaformat": [0, 5], "format": [0, 2, 3], "multi_shot_easy_aspect_ratio": [0, 5], "easyaspectratio": [0, 5], "multi": 0, "shot": 0, "easi": 0, "aspect": 0, "ratio": 0, "multi_shot_field_of_view": [0, 5], "multishotfov": [0, 5], "fov": [0, 7, 9], "multi_shot_nlv_aspect_ratio": [0, 5], "nlv": 0, "photo_dur": [0, 5], "photodur": [0, 5], "interv": [0, 7], "between": 0, "photo": [0, 2, 5], "photo_easy_mod": [0, 5], "photoeasymod": [0, 5], "night": 0, "photo_field_of_view": [0, 5], "photofov": [0, 5], "photo_horizon_level": [0, 5], "horizonlevel": [0, 5], "lock": 0, "unlock": 0, "horizon": 0, "photo_interv": [0, 5], "photointerv": [0, 5], "photo_mod": [0, 5], "photomod": [0, 5], "star_trail_length": [0, 5], "startraillength": [0, 5], "star": 0, "trail": 0, "length": [0, 2], "system_video_mod": [0, 5], "systemvideomod": [0, 5], "timelapse_mod": [0, 5], "timelapsemod": [0, 5], "timelaps": 0, "video_aspect_ratio": [0, 5], "videoaspectratio": [0, 5], "video_easy_aspect_ratio": [0, 5], "video_easy_mod": [0, 5], "speed": 0, "feasibl": 0, "maintain": [0, 7, 9], "code": [0, 6, 7, 9], "just": [0, 9], "video_field_of_view": [0, 5, 9], "videofov": [0, 5], "video_horizon_level": [0, 5], "video_mod": [0, 5], "videomod": [0, 5], "qualiti": 0, "video_performance_mod": [0, 5], "performancemod": [0, 5], "video_profil": [0, 5], "videoprofil": [0, 5], "profil": 0, "hdr": 0, "wifi_band": [0, 5], "wifiband": [0, 5], "band": 0, "being": [0, 2], "blestatusmessagebas": 0, "acc_mic_stat": [0, 5], "blestatusfacad": [0, 9], "exposuremod": [0, 5], "microphon": 0, "accessori": 0, "active_preset": [0, 5], "analytics_rdi": [0, 5], "analyticsst": [0, 5], "analyt": 0, "analytics_s": [0, 5], "size": 0, "unit": [0, 3], "ap_ssid": [0, 5, 9], "On": 0, "big": [0, 5], "endian": 0, "byte": [0, 8], "ap_stat": [0, 5], "radio": 0, "app_count": [0, 5], "band_5ghz_avail": [0, 5], "5ghz": 0, "batt_level": [0, 5, 9], "rough": 0, "approxim": 0, "batteri": [0, 2, 5, 9], "bar": 0, "batt_ok_ota": [0, 5], "charg": 0, "suffici": 0, "over": 0, "air": 0, "ota": 0, "batt_pres": [0, 5], "present": 0, "camera_control": [0, 5], "cameracontrol": [0, 5], "camera_lens_typ": [0, 5], "reflect": 0, "chang": [0, 2, 3, 6, 9], "162": 0, "capt_delay_act": [0, 5], "delai": [0, 2], "count": 0, "control_allowed_over_usb": [0, 5], "allow": [0, 2], "creating_preset": [0, 5], "process": [0, 6], "current_time_m": [0, 5], "millisecond": 0, "sinc": 0, "boot": 0, "dig_zoom_act": [0, 5], "zoom": 0, "featur": 0, "digital_zoom": [0, 5], "percent": 0, "download_cancel_pend": [0, 5], "download": [0, 6, 7], "pend": 0, "encoding_act": [0, 5, 9], "exposure_typ": [0, 5], "liveview": 0, "exposur": 0, "select": [0, 5], "exposure_x": [0, 5], "y": 0, "coordin": 0, "exposure_i": [0, 5], "first_tim": [0, 5], "ftu": 0, "ui": 0, "flow": 0, "flatmode_id": [0, 5], "flatmod": [0, 5], "gps_stat": [0, 5], "have": [0, 6, 7, 8, 9], "gp": 0, "in_context_menu": [0, 5], "contextu": 0, "menu": 0, "g": 0, "prefer": [0, 6], "int_batt_p": [0, 5, 9], "last_hilight": [0, 5], "msec": 0, "hilight": [0, 2], "lcd_lock_act": [0, 5], "lcd": 0, "linux_core_act": [0, 5], "linux": [0, 3], "core": 0, "live_burst_rem": [0, 5], "live": [0, 5], "burst": 0, "sdcard": 0, "full": [0, 9], "live_burst_tot": [0, 5], "total": 0, "locate_act": [0, 5], "locat": [0, 7], "logs_readi": [0, 5], "log": [0, 2, 5, 7, 9], "media_mod_mic_stat": [0, 5], "mediamodmicstatu": [0, 5], "media_mod_stat": [0, 5], "mediamodstatu": [0, 5], "bitmask": 0, "mobile_video": [0, 5], "mobil": 0, "friendli": 0, "relat": [0, 8], "compress": 0, "mode_group": [0, 5], "deprec": [0, 2], "hero8": 0, "multi_count_down": [0, 5], "countdown": 0, "next_pol": [0, 5], "min": 0, "poll": [0, 7], "more": [0, 2, 3, 5, 7, 8, 9], "often": 0, "than": [0, 2], "num_group_photo": [0, 5], "taken": 0, "num_group_video": [0, 5], "num_hilight": [0, 5], "num_total_photo": [0, 5], "num_total_video": [0, 5], "orient": [0, 5], "rotat": 0, "ota_stat": [0, 5], "otastatu": [0, 5], "pair_stat": [0, 5], "pairstat": [0, 5], "pair": [0, 5, 9], "pair_state2": [0, 5], "pair_tim": [0, 5], "action": [0, 2, 3], "pair_typ": [0, 5], "pairtyp": [0, 5], "engag": 0, "photo_preset": [0, 5], "photos_rem": [0, 5], "preset_modifi": [0, 5], "contain": [0, 9], "event": 0, "presets_group": [0, 5], "preview_en": [0, 5], "preview": [0, 2, 5], "quick_captur": [0, 5], "quick": 0, "remote_ctrl_conn": [0, 5], "remot": 0, "remote_ctrl_v": [0, 5], "scheduled_captur": [0, 5], "schedul": 0, "scheduled_preset": [0, 5], "sd_rating_check_error": [0, 5], "meet": [0, 3], "sd_statu": [0, 5], "sdstatu": [0, 5], "primari": 0, "storag": 0, "sd_write_speed_error": [0, 5], "error": [0, 2, 5, 8], "sec_sd_stat": [0, 5], "secondari": 0, "exclus": 0, "superbank": 0, "space_rem": [0, 5], "remain": [0, 2], "space": 0, "kilobyt": 0, "streaming_supp": [0, 5], "record": [0, 7], "system_busi": [0, 5], "busi": [0, 9], "system_hot": [0, 5], "overh": 0, "system_readi": [0, 5], "timelapse_preset": [0, 5], "timelapse_rem": [0, 5], "timewarp_speed_ramp": [0, 5], "timewarpspe": [0, 5], "warp": 0, "total_sd_space_kb": [0, 5], "up": [0, 2, 3, 5], "sd": 0, "card": 0, "turbo_mod": [0, 5], "usb_connect": [0, 5], "pc": 0, "video_hindsight": [0, 5], "video_low_temp": [0, 5], "too": 0, "cold": 0, "continu": [0, 7, 9], "video_preset": [0, 5], "video_progress": [0, 5], "durat": 0, "far": 0, "video_rem": [0, 5], "minut": 0, "wap_prov_stat": [0, 5], "wap_scan_st": [0, 5], "appear": 0, "cah": 0, "wifi_bar": [0, 5], "strength": 0, "wireless_band": [0, 5], "wireless_en": [0, 5], "wlan_ssid": [0, 5], "zoom_encod": [0, 5], "while": [0, 9], "static": 0, "httpmessag": 0, "add_file_hilight": [0, 5], "add": [0, 2, 3], "mp4": [0, 7], "delete_al": [0, 5], "delet": 0, "delete_fil": [0, 5], "singl": 0, "includ": [0, 2, 3, 5], "part": [0, 3], "delete_group": [0, 5], "content": 0, "download_fil": [0, 5], "camera_fil": 0, "local_fil": 0, "output": [0, 7], "filenam": [0, 2], "oper": [0, 2, 3, 5], "comput": 0, "written": 0, "get_camera_info": [0, 5], "get_camera_st": [0, 5, 9], "awar": 0, "get_gpmf_data": [0, 5], "gpmf": 0, "mediapath": 0, "get_media_list": [0, 5], "medialist": [0, 5], "structur": [0, 5], "get_media_metadata": [0, 5], "mediametadata": [0, 5], "metadata": [0, 2], "get_screennail__call__": [0, 5], "screennail": 0, "get_telemetri": [0, 5], "telemetri": 0, "store": [0, 7, 9], "get_thumbnail": [0, 5], "thumbnail": 0, "get_webcam_vers": [0, 5], "webcam": [0, 2, 5, 6], "given": [0, 3, 7, 9], "remove_file_hilight": [0, 5], "remov": [0, 2], "global": [0, 2], "behavior": [0, 2], "idl": [0, 5], "set_digital_zoom": [0, 5], "percentag": 0, "set_keep_al": [0, 5], "set_preview_stream": [0, 5], "port": 0, "8554": 0, "update_custom_preset": [0, 5], "title_id": 0, "custom_nam": 0, "preset_title_user_defined_custom_nam": 0, "webcam_exit": [0, 5], "webcamrespons": [0, 5], "webcam_preview": [0, 5], "webcam_start": [0, 5], "webcamresolut": [0, 5], "webcamfov": [0, 5], "webcamprotocol": [0, 5], "webcam_statu": [0, 5], "webcam_stop": [0, 5], "wired_usb_control": [0, 5], "extend": [0, 8], "tripod": 0, "goproenum": 0, "qualnam": 0, "boundari": 0, "goprointenum": 0, "builder": 0, "parser_build": 0, "construct": [0, 2], "bytesparserbuild": 0, "wrapper": 0, "around": [0, 2, 9], "definit": [0, 9], "object": [0, 9], "queryparsertyp": 0, "pars": [0, 2], "uuid": [0, 2, 5, 9], "bleuuid": [0, 5], "querycmdid": [0, 5, 9], "setting_id": 0, "builderprotocol": 0, "actual": [0, 2], "wrap": 0, "facad": 0, "mai": [0, 5], "match": [0, 2], "case": [0, 2, 9], "get_capabilities_valu": [0, 9], "get_valu": [0, 9], "register_capability_upd": [0, 9], "respect": 0, "register_value_upd": [0, 9], "unregister_capability_upd": [0, 9], "unregister_value_upd": [0, 9], "parser": [0, 2], "blestatu": [0, 9], "status_id": 0, "bytearrai": 0, "individu": [0, 3, 9], "interact": [0, 9], "build_url": 0, "endpoint": [0, 9], "run": [0, 2, 3, 6, 7, 9], "built": 0, "publish": 0, "end": [0, 2, 9], "cmdid": [0, 5, 9], "parser_interfac": 0, "compon": 0, "body_arg": 0, "header": 0, "idtyp": 0, "explicit": 0, "append": [0, 2, 9], "after": [0, 9], "ad": [0, 2], "bodi": 0, "bundl": 0, "interpret": 0, "build_bodi": 0, "check": [0, 2, 3, 9], "messagetyp": 0, "iter": 0, "like": 0, "attribut": [0, 9], "subclass": 0, "accumul": [0, 2], "ident": [0, 2], "messagerul": 0, "fastpass_analyz": 0, "analyz": 0, "function": [0, 2, 3, 5, 8, 9], "lambda": 0, "wait_for_encoding_analyz": 0, "rule": [0, 2], "fastpass": [0, 2], "always_fals": 0, "wait_for_encoding_analy": 0, "is_fastpass": 0, "should_wait_for_encoding_start": 0, "accmicstatu": [0, 5], "connected_and_plugged_in": 0, "not_connect": 0, "not_readi": 0, "on_connect": 0, "hz_50": 0, "hz_60": 0, "min_1": 0, "min_15": 0, "6": [0, 5], "min_30": 0, "7": [0, 5, 7], "min_5": 0, "sec_30": 0, "12": [0, 3, 5, 7], "sec_8": 0, "11": [0, 3, 5], "bit_10": 0, "bit_8": 0, "high": [0, 9], "standard": [0, 8, 9], "pro": 0, "univers": 0, "widescreen": 0, "hemispher": 0, "iso_lock": 0, "fps_100": 0, "fps_120": 0, "fps_200": 0, "13": [0, 5], "fps_24": 0, "fps_240": 0, "fps_25": 0, "9": [0, 3, 5], "fps_30": [0, 9], "8": [0, 3, 5], "fps_50": 0, "fps_60": 0, "burst_photo": 0, "19": [0, 2], "live_burst": 0, "25": [0, 5], "loop": 0, "15": [0, 5], "night_lapse_photo": 0, "21": [0, 5], "night_lapse_video": 0, "26": [0, 5], "night_photo": 0, "18": [0, 5], "not_applic": 0, "single_photo": 0, "16": [0, 5], "slo_mo": 0, "27": [0, 5], "time_lapse_photo": 0, "20": [0, 5], "time_lapse_video": 0, "time_warp_video": 0, "24": [0, 5], "unknown": [0, 5], "28": [0, 5], "23": 0, "vertic": 0, "sec_15": 0, "ON": 0, "auto_boost": 0, "boost": 0, "all_off": 0, "all_on": 0, "ble_keep_al": 0, "66": 0, "front_off_onli": 0, "led_2": 0, "lensmod": [0, 5], "dual": 0, "v1": 0, "v2": 0, "max_len": 0, "with_extern": 0, "selfie_0_hdmi_0_mediamodconnected_fals": 0, "selfie_0_hdmi_0_mediamodconnected_tru": 0, "selfie_0_hdmi_1_mediamodconnected_fals": 0, "selfie_0_hdmi_1_mediamodconnected_tru": 0, "selfie_1_hdmi_0_mediamodconnected_fals": 0, "selfie_1_hdmi_0_mediamodconnected_tru": 0, "selfie_1_hdmi_1_mediamodconnected_fals": 0, "selfie_1_hdmi_1_mediamodconnected_tru": 0, "linear": 0, "102": 0, "max_superview": 0, "narrow": [0, 3], "wide": 0, "101": 0, "download_fail": 0, "gopro_app_download": 0, "gopro_app_download_fail": 0, "gopro_app_readi": 0, "gopro_app_verifi": 0, "gopro_app_verify_fail": 0, "verifi": 0, "verify_fail": 0, "on_left_sid": 0, "on_right_sid": 0, "upright": 0, "upside_down": 0, "in_progress": 0, "not_start": 0, "not_pair": 0, "pairing_app": 0, "pairing_bluetooth": 0, "pairing_remote_control": 0, "extended_batteri": 0, "max_perform": 0, "stationari": 0, "hour_1": 0, "hour_2": 0, "hour_3": 0, "super_photo": 0, "hyperview": 0, "linear_horizon": 0, "121": 0, "sec_0_5": 0, "sec_1": 0, "sec_10": 0, "sec_120": 0, "sec_2": 0, "sec_3": 0, "sec_5": 0, "sec_60": 0, "super": 0, "presetgroup": [0, 5], "1001": 0, "1002": 0, "1000": 0, "res_1080": 0, "res_1080_16_9": 0, "106": 0, "res_1080_8_7": 0, "110": 0, "res_1080_9_16": 0, "30": [0, 5], "res_1440": 0, "res_2_7k": 0, "res_2_7k_16_9": 0, "104": 0, "res_2_7k_4_3": 0, "res_2_7k_4_3_todo": 0, "105": 0, "res_2_7_k_8_7": 0, "res_4k": [0, 9], "res_4k_16_9": [0, 9], "res_4k_4_3": 0, "res_4k_4_3_todo": 0, "103": 0, "res_4k_8_7": 0, "108": 0, "res_4k_8_7_": 0, "109": 0, "res_4k_8_7_legaci": 0, "res_4k_9_16": 0, "29": [0, 5], "res_5k": 0, "res_5k_4_3": 0, "res_5_3k": 0, "res_5_3k_16_9": 0, "res_5_3k_4_3": 0, "res_5_3k_8_7": 0, "107": 0, "res_5_3k_8_7_legaci": 0, "format_error": 0, "ok": [0, 5, 9], "swap": 0, "255": 0, "short": 0, "extended_battery_green_icon": 0, "highest_qu": 0, "longest_battery_green_icon": 0, "speed_10x": 0, "speed_150x": 0, "speed_15x": 0, "speed_1800x": 0, "speed_1x": 0, "speed_2x": 0, "speed_300x": 0, "speed_30x": 0, "speed_5x": 0, "speed_60x": 0, "speed_900x": 0, "speed_auto": 0, "speed_half": 0, "light_paint": 0, "max_light_paint": 0, "max_star_trail": 0, "max_timewarp": 0, "max_vehicle_light": 0, "star_trail": 0, "timewarp": 0, "vehicle_light": 0, "ratio_16_9": 0, "ratio_4_3": 0, "ratio_8_7": 0, "ratio_9_16": 0, "linear_horizon_level": 0, "linear_horizon_lock": 0, "max_hyperview": 0, "superview": 0, "basic": 0, "highest": 0, "wapstat": [0, 5], "abort": 0, "never_start": 0, "rtsp": 0, "res_480": 0, "res_720": 0, "band_2_4_ghz": 0, "band_5_ghz": 0, "band_max": 0, "errorcod": [0, 5, 9], "encapsul": 0, "sever": [0, 7, 8, 9], "vari": [0, 9], "let": [0, 9], "inspect": [0, 9], "get_setting_v": [0, 5, 9], "depend": [0, 2, 3, 5, 9], "responsetyp": 0, "thei": [0, 9], "pydant": [0, 2], "schema": 0, "descript": 0, "ct": 0, "cre": 0, "gumi": 0, "h": [0, 7], "w": [0, 7], "hc": 0, "ei": 0, "mp": 0, "rot": 0, "tr": 0, "u": 0, "mo": 0, "anyof": 0, "item": 0, "arrai": 0, "null": 0, "pgumi": 0, "lc": 0, "prjn": 0, "requir": [0, 2, 5, 9], "content_typ": 0, "creation_timestamp": 0, "field_of_view": 0, "file_s": 0, "height": 0, "hilight_count": 0, "image_stabil": 0, "lens_config": 0, "lens_project": 0, "media_offload_st": 0, "metadata_pres": 0, "parent_gumi": 0, "transcod": 0, "upload_statu": 0, "width": 0, "alia": 0, "epoch": 0, "pixel": 0, "stabil": 0, "project": [0, 2], "offload": 0, "clip": 0, "upload": 0, "classmethod": 0, "from_json": 0, "json_str": 0, "input": 0, "jsondict": 0, "raw": 0, "photometadata": [0, 5], "wdr": 0, "high_dynamic_rang": 0, "wide_dynamic_rang": 0, "dynam": [0, 2], "rang": 0, "videometadata": [0, 5], "ao": 0, "avc_profil": 0, "avc": 0, "cl": 0, "dur": 0, "fps_denom": 0, "denom": 0, "hi": 0, "l": [0, 7], "mah": 0, "pta": 0, "subsampl": 0, "progr": 0, "audio_opt": 0, "avc_level": 0, "frame_r": 0, "frame_rate_divisor": 0, "hilight_list": 0, "lrv_file_s": 0, "max_auto_hilight_scor": 0, "progress": 0, "protune_audio": 0, "wind": 0, "stereo": 0, "advanc": 0, "codec": 0, "hlight": 0, "low": [0, 5], "lrv": 0, "score": 0, "protun": 0, "audio": 0, "other": [0, 2, 8, 9], "mediaitem": [0, 5], "n": 0, "glrv": 0, "low_res_video_s": 0, "modified_tim": 0, "session_id": 0, "groupedmediaitem": [0, 5], "nan": 0, "b": [0, 3], "group_first_member_id": 0, "group_id": 0, "group_last_member_id": 0, "group_missing_id": 0, "group_siz": 0, "group_typ": 0, "member": 0, "c": 0, "laps": 0, "mediafilesystem": [0, 5], "filesystem": 0, "d": 0, "f": 0, "ref": [0, 6], "def": [0, 9], "directori": [0, 2, 3, 6], "file_system": 0, "media_list": 0, "identify_item": 0, "extent": 0, "presenc": 0, "model_post_init": 0, "__context": 0, "meant": 0, "behav": 0, "basemodel": 0, "initialis": 0, "privat": 0, "take": [0, 5, 7], "self": [0, 9], "helper": [0, 9], "tzone": 0, "boolean": 0, "model_numb": [0, 9], "model_nam": [0, 9], "firmware_vers": [0, 9], "serial_numb": [0, 9], "ap_mac_addr": [0, 9], "mac": [0, 2], "addr": 0, "config": 0, "protected_namespac": 0, "tupl": 0, "address": 0, "webcamstatu": [0, 5], "webcamerror": [0, 5], "supported_opt": 0, "supportedopt": [0, 5], "display_nam": 0, "displai": [0, 7], "share": 0, "across": [0, 3], "get_ap_entries_rsp": [0, 5], "131": 0, "get_livestream_statu": [0, 5], "116": 0, "114": 0, "get_preset_status_rsp": [0, 5], "242": 0, "livestream_status_notif": [0, 5], "245": 0, "livestream_status_rsp": [0, 5], "244": 0, "notif_start_scan": [0, 5], "243": 0, "120": 0, "release_network_rsp": [0, 5], "248": 0, "request_clear_cohn_cert": [0, 5], "request_cohn_set": [0, 5], "request_create_cohn_cert": [0, 5], "request_get_cohn_cert": [0, 5], "request_get_cohn_statu": [0, 5], "111": 0, "request_get_last_media": [0, 5], "request_preset_update_custom": [0, 5], "request_wifi_connect_new_rsp": [0, 5], "133": 0, "request_wifi_connect_rsp": [0, 5], "132": 0, "response_clear_cohn_cert": [0, 5], "230": 0, "response_cohn_set": [0, 5], "229": 0, "response_create_cohn_cert": [0, 5], "231": 0, "response_get_cohn_cert": [0, 5], "238": 0, "response_get_cohn_statu": [0, 5], "239": 0, "response_get_last_media": [0, 5], "237": 0, "response_preset_update_custom": [0, 5], "228": 0, "scan_wifi_networks_rsp": [0, 5], "130": 0, "set_camera_control_rsp": [0, 5], "233": 0, "set_livestream_mode_rsp": [0, 5], "249": 0, "set_turbo_mode_rsp": [0, 5], "235": 0, "50": 0, "14": [0, 5], "get_date_time_dst": [0, 5], "get_hw_info": [0, 5], "get_settings_json": [0, 5], "59": 0, "get_third_party_api_vers": [0, 5], "81": 0, "64": 0, "62": [0, 9], "register_all_cap": [0, 5], "98": 0, "register_all_set": [0, 5], "82": 0, "register_all_status": [0, 5], "83": 0, "set_date_time_dst": [0, 5], "set_pairing_complet": [0, 5], "80": 0, "set_wifi": [0, 5], "unregister_all_cap": [0, 5], "unregister_all_set": [0, 5], "unregister_all_status": [0, 5], "115": 0, "invalid_param": [0, 5], "featureid": [0, 5], "241": 0, "network_manag": [0, 5], "goprouuid": [0, 5], "_": 0, "proprietari": 0, "cm_net_mgmt_comm": [0, 5], "cn_net_mgmt_resp": [0, 5], "cq_command": [0, 5], "cq_command_resp": [0, 5], "cq_queri": [0, 5], "cq_query_resp": [0, 5], "cq_sensor": [0, 5], "sensor": 0, "cq_sensor_resp": [0, 5], "cq_set": [0, 5], "cq_settings_resp": [0, 5], "s_camera_manag": [0, 5], "servic": [0, 5], "s_control_queri": [0, 5], "s_wifi_access_point": [0, 5], "wap_csi_password": [0, 5], "csi": 0, "wap_password": [0, 5], "wap_pow": [0, 5], "wap_ssid": [0, 5], "wap_stat": [0, 5], "get_capabilities_nam": [0, 5], "get_capabilities_v": [0, 5], "get_setting_nam": [0, 5], "34": 0, "get_status_v": [0, 5], "invalid_for_test": [0, 5], "protobuf_queri": [0, 5], "reg_capabilities_upd": [0, 5], "reg_setting_val_upd": [0, 5], "reg_status_val_upd": [0, 5], "setting_capability_push": [0, 5], "setting_val_push": [0, 5], "146": 0, "status_val_push": [0, 5], "147": 0, "unreg_capabilities_upd": [0, 5], "unreg_setting_val_upd": [0, 5], "unreg_status_val_upd": [0, 5], "addon_max_lens_mod": [0, 5], "189": 0, "addon_max_lens_mod_en": [0, 5], "190": 0, "134": 0, "183": 0, "182": 0, "175": 0, "193": 0, "167": 0, "135": 0, "91": 0, "128": 0, "188": 0, "multi_shot_fov": [0, 5], "123": 0, "192": 0, "177": 0, "photo_fov": [0, 5], "122": 0, "151": 0, "171": 0, "photo_interval_dur": [0, 5], "172": 0, "191": 0, "protobuf_set": [0, 5], "179": 0, "180": 0, "187": 0, "185": 0, "176": 0, "video_fov": [0, 5], "150": 0, "186": 0, "173": 0, "184": 0, "178": 0, "74": 0, "97": 0, "61": 0, "31": 0, "69": 0, "capture_delai": [0, 5], "84": 0, "control_over_usb": [0, 5], "57": 0, "75": 0, "77": 0, "42": 0, "65": 0, "67": [0, 9], "79": 0, "89": 0, "68": 0, "70": 0, "63": 0, "99": 0, "45": 0, "78": 0, "43": [0, 3], "49": 0, "36": 0, "37": 0, "58": 0, "38": 0, "39": 0, "86": 0, "41": 0, "94": 0, "96": 0, "32": 0, "33": 0, "112": 0, "54": 0, "55": 0, "95": 0, "117": 0, "113": 0, "85": 0, "93": 0, "35": 0, "22": [0, 5], "wap_scan_tim": [0, 5], "56": 0, "76": 0, "17": 0, "88": 0, "com_timeout": [0, 5], "exec_stream": [0, 5], "set_preset": [0, 5], "set_window_s": [0, 5], "unavail": [0, 5], "high_power_preview": [0, 5], "low_power_preview": [0, 5], "pertain": 0, "connectfail": [0, 5], "float": 0, "were": [0, 2], "connectiontermin": [0, 5], "previous": 0, "termin": [0, 6], "exceptionhandl": [0, 5], "handler": 0, "goproerror": [0, 5], "invalidconfigur": [0, 5], "someth": 0, "responseparseerror": [0, 5], "msg": 0, "responsetimeout": [0, 5], "abstract": 0, "blecontrol": [0, 5], "disconnected_cb": 0, "bledevic": 0, "notification_cb": 0, "disconnecthandlertyp": 0, "notihandlertyp": 0, "wificontrol": [0, 5], "ble_control": 0, "wifi_control": 0, "alwai": [0, 3, 6, 9], "exception_handl": 0, "disconnect_cb": 0, "blehandl": 0, "give": 0, "discover_char": [0, 5], "gattdb": [0, 5], "know": [0, 9], "defin": [0, 5, 9], "databas": 0, "enable_notif": [0, 5], "bytestream": 0, "token": 0, "service_uuid": 0, "filter": 0, "shall": 0, "multipl": [0, 2, 3], "compos": 0, "bleclient": [0, 5], "resourc": [0, 9], "gatt_db": [0, 5, 8], "tabl": 0, "runtimeerror": 0, "hasn": 0, "is_connect": [0, 5], "is_discov": [0, 5], "try": [0, 5], "abl": 0, "services_as_csv": [0, 5], "posixpath": 0, "csv": [0, 7, 8], "dump": [0, 8], "where": [0, 2, 6, 7, 9], "nice": 0, "bit_128": 0, "hex": 0, "bytes_l": 0, "extens": 0, "associ": 0, "one": [0, 2, 9], "charprop": [0, 5], "prop": 0, "init_descriptor": 0, "dataclass": 0, "initvar": 0, "descriptor": [0, 5], "descriptor_handl": 0, "resid": 0, "later": 0, "declar": 0, "cccd_handl": 0, "cccd": 0, "map": 0, "dictionari": 0, "index": [0, 2], "is_indicat": 0, "indicat": 0, "is_notifi": 0, "is_read": 0, "readabl": [0, 8], "is_writ": 0, "writeabl": 0, "is_writeable_with_respons": 0, "is_writeable_without_respons": 0, "human": 0, "init_servic": 0, "look": [0, 3], "characteristicview": 0, "db": 0, "repres": 0, "kei": 0, "dump_to_csv": [0, 8], "handle2uuid": 0, "keyerror": 0, "No": 0, "uuid2handl": 0, "ble_uuid": 0, "convert": 0, "translat": 0, "start_handl": 0, "end_handl": 0, "65535": 0, "init_char": 0, "begin": 0, "0xffff": 0, "specuuidnumb": [0, 5], "uuidsmeta": [0, 5], "dct": 0, "metaclass": 0, "upon": [0, 9], "new": 0, "ssidstat": [0, 5], "available_interfac": [0, 5], "is_on": [0, 5], "echo": 0, "wificli": [0, 5], "among": 0, "thing": [0, 8, 9], "tim": 1, "camis": 1, "tcamis": 1, "gopro": [1, 2, 3, 6, 7, 8, 9], "com": [1, 3, 6], "ben": 1, "freeland": 1, "bfreeland": 1, "notabl": 2, "base": [2, 5, 9], "adher": 2, "semant": 2, "refactor": 2, "common": [2, 5], "messag": [2, 5, 7], "bleak": [2, 5], "fix": [2, 5], "demo": [2, 3, 5, 6, 8, 9], "alpha": 2, "real": 2, "go": 2, "major": 2, "rearchitectur": 2, "type": [2, 5, 9], "tkinter": 2, "gui": [2, 5], "Will": 2, "replac": 2, "textual": 2, "tui": 2, "futur": [2, 5, 9], "improv": [2, 9], "wifi": [2, 5, 9], "unhash": 2, "model": [2, 5], "ble": [2, 5, 7, 8, 9], "rout": 2, "correctli": [2, 9], "hardcod": 2, "malform": 2, "set": [2, 3, 5, 7], "http": [2, 3, 5, 6, 7, 9], "massiv": 2, "api": [2, 5, 6], "break": [2, 8], "move": 2, "asyncio": [2, 5], "framework": 2, "hero": 2, "respons": [2, 5], "viewer": [2, 7], "latenc": 2, "extra": [2, 3, 6], "english": 2, "languag": 2, "verif": 2, "miss": 2, "introduc": 2, "interfac": [2, 5, 9], "discoveri": 2, "bluetooth": [2, 5], "mini": 2, "robust": 2, "variad": 2, "mvc": 2, "protobuf": [2, 3], "bug": [2, 4, 5], "doc": [2, 3], "docstr": [2, 3], "cli": [2, 5, 6], "stdin": [2, 7], "fragment": 2, "data": [2, 5], "packet": 2, "importlib": 2, "complic": 2, "pyinstal": 2, "main": [2, 3, 6, 9], "thread": 2, "except": [2, 5], "pydocstyl": 2, "poetri": [2, 3], "environ": [2, 3, 5], "inconsist": [2, 7], "open": [2, 3, 6, 7, 8], "statu": [2, 5, 9], "clean": 2, "bump": 2, "decoupl": 2, "setup": [2, 3, 6, 7], "py": [2, 8], "entrypoint": 2, "make": [2, 3], "enum": [2, 5, 9], "paramet": [2, 5, 7], "differ": [2, 9], "coverag": 2, "upgrad": 2, "window": [2, 3, 5], "minor": 2, "coexist": 2, "jekyl": 2, "github": [2, 3, 4, 6, 7], "repo": [2, 3, 6], "usabl": 2, "ubuntu": [2, 5], "04": [2, 5], "sync": 2, "weren": 2, "infrastructur": 2, "flake8": 2, "pylint": 2, "catch": 2, "lot": [2, 8, 9], "suggest": [2, 5], "ci": 2, "cd": [2, 3, 6], "mypi": 2, "agnost": 2, "line": [2, 5], "caus": [2, 9], "pypi": [2, 6], "instal": [2, 3, 5, 7], "merg": 2, "corner": 2, "vlc": 2, "wrote": 2, "beta": 2, "work": [2, 3, 5], "increment": 2, "until": [2, 7, 9], "welcom": [3, 5], "greatli": 3, "appreci": 3, "credit": [3, 5], "opengopro": [3, 6, 7], "pleas": 3, "your": [3, 5, 6, 7, 9], "detail": [3, 5, 7, 9], "might": 3, "help": [3, 7, 8], "troubleshoot": [3, 5, 9], "reproduc": 3, "anyth": [3, 8, 9], "want": [3, 6, 7], "whoever": 3, "enhanc": [3, 4], "offici": 3, "even": [3, 8], "web": 3, "blog": 3, "post": 3, "articl": 3, "best": 3, "wai": [3, 9], "propos": 3, "explain": 3, "would": 3, "scope": 3, "easier": 3, "task": 3, "protoc": 3, "graphviz": 3, "diagram": 3, "sphinx": 3, "fork": 3, "clone": [3, 6], "git": [3, 6], "your_name_her": 3, "enter": [3, 6, 7], "sdk_wireless_camera_control": [3, 6], "branch": 3, "origin": 3, "checkout": 3, "bugfix": 3, "copi": [3, 6], "virtual": 3, "re": [3, 9], "done": [3, 8, 9], "lint": 3, "poe": 3, "commit": 3, "made": 3, "changelog": [3, 5], "rst": 3, "follow": [3, 9], "platform": [3, 5], "16299": 3, "fall": 3, "creator": 3, "greater": 3, "distribut": 3, "bluez": 3, "x": [3, 5], "maco": [3, 5], "feel": 3, "free": 3, "contributor": [3, 5], "author": 3, "ticket": 4, "sampl": 4, "exercis": 5, "energi": 5, "well": [5, 7, 9], "cross": 5, "sur": 5, "loos": 5, "wireless": [5, 7], "librari": [5, 6], "script": [5, 9], "procedur": [5, 9], "acquaint": 5, "own": 5, "perhap": 5, "refer": [5, 9], "pull": 5, "stabl": 5, "minim": 5, "quickstart": [5, 9], "guid": [5, 6, 8], "graphic": 5, "wire": 5, "overview": 5, "client": [5, 9], "method": [5, 6, 9], "protocol": [5, 9], "constant": [5, 9], "bleservic": 5, "contribut": [5, 6], "report": 5, "submit": 5, "feedback": 5, "step": [5, 7, 9], "guidelin": 5, "lead": 5, "april": 5, "2024": 5, "decemb": 5, "2023": 5, "septemb": 5, "februari": 5, "novemb": 5, "2022": 5, "octob": 5, "juli": 5, "june": 5, "januari": 5, "2021": 5, "august": 5, "march": 5, "pip": [6, 7], "addition": 6, "either": [6, 7, 9], "public": 6, "repositori": 6, "zip": 6, "curl": [6, 7], "ol": 6, "archiv": 6, "head": 6, "exist": 6, "abov": [6, 9], "edit": 6, "assum": [7, 9], "successfulli": 7, "demonstr": 7, "informatoin": 7, "consol": 7, "veri": [7, 8], "diagnos": 7, "jpg": 7, "amount": [7, 8], "record_tim": 7, "posit": [7, 9], "thu": [7, 9], "press": 7, "wif": 7, "p": 7, "fro": 7, "opencv": 7, "min_bit": 7, "max_bit": 7, "start_bit": 7, "cv2": 7, "debug": 8, "sprinkl": 8, "throughout": [8, 9], "furthermor": 8, "util": 8, "setup_log": 8, "logger": 8, "__name__": [8, 9], "my_log": 8, "offer": 8, "finer": 8, "trace": 8, "tx": 8, "rx": 8, "warn": 8, "shouldn": 8, "won": 8, "bad": 8, "unrecover": 8, "critic": 8, "_ble": 8, "potenti": 9, "mean": 9, "snippet": 9, "accomplish": 9, "manner": 9, "our": 9, "__main__": 9, "below": 9, "unless": 9, "One": 9, "sequenc": 9, "block": 9, "combin": 9, "naiv": 9, "reiter": 9, "recommend": 9, "worri": 9, "transport": 9, "superset": 9, "strategi": 9, "enqueu": 9, "remaind": 9, "term": 9, "confus": 9, "perspect": 9, "expand": 9, "But": 9, "whenev": 9, "hint": 9, "clariti": 9, "signatur": 9, "explicitli": 9, "affect": 9, "is_encod": 9, "retriev": 9, "them": 9, "Their": 9, "firstli": 9, "process_battery_notif": 9, "elif": 9, "register_xxx_upd": 9, "coupl": 9, "obviou": 9, "temporari": 9, "solut": 9, "serializ": 9, "identif": 9, "direct": 9, "respond": 9, "therefor": 9, "hero12": 9, "black": 9, "h23": 9, "01": 9, "09": 9, "c3501324500702": 9, "2674f7f66104": 9, "gp24500702": 9, "finish": 9, "problem": 9}, "objects": {"open_gopro.api.ble_commands": [[0, 0, 1, "", "BleCommands"], [0, 0, 1, "", "BleSettings"], [0, 0, 1, "", "BleStatuses"]], "open_gopro.api.ble_commands.BleCommands": [[0, 1, 1, "", "cohn_clear_certificate"], [0, 1, 1, "", "cohn_create_certificate"], [0, 1, 1, "", "cohn_get_certificate"], [0, 1, 1, "", "cohn_get_status"], [0, 1, 1, "", "cohn_set_setting"], [0, 1, 1, "", "custom_preset_update"], [0, 1, 1, "", "enable_wifi_ap"], [0, 1, 1, "", "get_ap_entries"], [0, 1, 1, "", "get_camera_capabilities"], [0, 1, 1, "", "get_camera_settings"], [0, 1, 1, "", "get_camera_statuses"], [0, 1, 1, "", "get_date_time"], [0, 1, 1, "", "get_date_time_tz_dst"], [0, 1, 1, "", "get_hardware_info"], [0, 1, 1, "", "get_last_captured_media"], [0, 1, 1, "", "get_open_gopro_api_version"], [0, 1, 1, "", "get_preset_status"], [0, 1, 1, "", "get_wifi_password"], [0, 1, 1, "", "get_wifi_ssid"], [0, 1, 1, "", "load_preset"], [0, 1, 1, "", "load_preset_group"], [0, 1, 1, "", "power_down"], [0, 1, 1, "", "register_for_all_capabilities"], [0, 1, 1, "", "register_for_all_settings"], [0, 1, 1, "", "register_for_all_statuses"], [0, 1, 1, "", "register_livestream_status"], [0, 1, 1, "", "release_network"], [0, 1, 1, "", "request_wifi_connect"], [0, 1, 1, "", "request_wifi_connect_new"], [0, 1, 1, "", "scan_wifi_networks"], [0, 1, 1, "", "set_camera_control"], [0, 1, 1, "", "set_date_time"], [0, 1, 1, "", "set_date_time_tz_dst"], [0, 1, 1, "", "set_livestream_mode"], [0, 1, 1, "", "set_shutter"], [0, 1, 1, "", "set_third_party_client_info"], [0, 1, 1, "", "set_turbo_mode"], [0, 1, 1, "", "sleep"], [0, 1, 1, "", "tag_hilight"], [0, 1, 1, "", "unregister_for_all_capabilities"], [0, 1, 1, "", "unregister_for_all_settings"], [0, 1, 1, "", "unregister_for_all_statuses"]], "open_gopro.api.ble_commands.BleSettings": [[0, 2, 1, "", "anti_flicker"], [0, 2, 1, "", "auto_off"], [0, 2, 1, "", "bit_depth"], [0, 2, 1, "", "bit_rate"], [0, 2, 1, "", "camera_ux_mode"], [0, 2, 1, "", "fps"], [0, 2, 1, "", "framing"], [0, 2, 1, "", "hindsight"], [0, 2, 1, "", "hypersmooth"], [0, 2, 1, "", "led"], [0, 2, 1, "", "max_lens_mode"], [0, 2, 1, "", "maxlens_mod_type"], [0, 2, 1, "", "maxlens_status"], [0, 2, 1, "", "media_format"], [0, 2, 1, "", "multi_shot_easy_aspect_ratio"], [0, 2, 1, "", "multi_shot_field_of_view"], [0, 2, 1, "", "multi_shot_nlv_aspect_ratio"], [0, 2, 1, "", "photo_duration"], [0, 2, 1, "", "photo_easy_mode"], [0, 2, 1, "", "photo_field_of_view"], [0, 2, 1, "", "photo_horizon_leveling"], [0, 2, 1, "", "photo_interval"], [0, 2, 1, "", "photo_mode"], [0, 2, 1, "", "resolution"], [0, 2, 1, "", "star_trail_length"], [0, 2, 1, "", "system_video_mode"], [0, 2, 1, "", "timelapse_mode"], [0, 2, 1, "", "video_aspect_ratio"], [0, 2, 1, "", "video_easy_aspect_ratio"], [0, 2, 1, "", "video_easy_mode"], [0, 2, 1, "", "video_field_of_view"], [0, 2, 1, "", "video_horizon_leveling"], [0, 2, 1, "", "video_mode"], [0, 2, 1, "", "video_performance_mode"], [0, 2, 1, "", "video_profile"], [0, 2, 1, "", "wifi_band"]], "open_gopro.api.ble_commands.BleStatuses": [[0, 2, 1, "", "acc_mic_stat"], [0, 2, 1, "", "active_preset"], [0, 2, 1, "", "analytics_rdy"], [0, 2, 1, "", "analytics_size"], [0, 2, 1, "", "ap_ssid"], [0, 2, 1, "", "ap_state"], [0, 2, 1, "", "app_count"], [0, 2, 1, "", "band_5ghz_avail"], [0, 2, 1, "", "batt_level"], [0, 2, 1, "", "batt_ok_ota"], [0, 2, 1, "", "batt_present"], [0, 2, 1, "", "camera_control"], [0, 2, 1, "", "camera_lens_type"], [0, 2, 1, "", "capt_delay_active"], [0, 2, 1, "", "control_allowed_over_usb"], [0, 2, 1, "", "creating_preset"], [0, 2, 1, "", "current_time_ms"], [0, 2, 1, "", "dig_zoom_active"], [0, 2, 1, "", "digital_zoom"], [0, 2, 1, "", "download_cancel_pend"], [0, 2, 1, "", "encoding_active"], [0, 2, 1, "", "exposure_type"], [0, 2, 1, "", "exposure_x"], [0, 2, 1, "", "exposure_y"], [0, 2, 1, "", "first_time"], [0, 2, 1, "", "flatmode_id"], [0, 2, 1, "", "gps_stat"], [0, 2, 1, "", "in_context_menu"], [0, 2, 1, "", "int_batt_per"], [0, 2, 1, "", "last_hilight"], [0, 2, 1, "", "lcd_lock_active"], [0, 2, 1, "", "linux_core_active"], [0, 2, 1, "", "live_burst_rem"], [0, 2, 1, "", "live_burst_total"], [0, 2, 1, "", "locate_active"], [0, 2, 1, "", "logs_ready"], [0, 2, 1, "", "media_mod_mic_stat"], [0, 2, 1, "", "media_mod_stat"], [0, 2, 1, "", "mobile_video"], [0, 2, 1, "", "mode_group"], [0, 2, 1, "", "multi_count_down"], [0, 2, 1, "", "next_poll"], [0, 2, 1, "", "num_group_photo"], [0, 2, 1, "", "num_group_video"], [0, 2, 1, "", "num_hilights"], [0, 2, 1, "", "num_total_photo"], [0, 2, 1, "", "num_total_video"], [0, 2, 1, "", "orientation"], [0, 2, 1, "", "ota_stat"], [0, 2, 1, "", "pair_state"], [0, 2, 1, "", "pair_state2"], [0, 2, 1, "", "pair_time"], [0, 2, 1, "", "pair_type"], [0, 2, 1, "", "photo_presets"], [0, 2, 1, "", "photos_rem"], [0, 2, 1, "", "preset_modified"], [0, 2, 1, "", "presets_group"], [0, 2, 1, "", "preview_enabled"], [0, 2, 1, "", "quick_capture"], [0, 2, 1, "", "remote_ctrl_conn"], [0, 2, 1, "", "remote_ctrl_ver"], [0, 2, 1, "", "scheduled_capture"], [0, 2, 1, "", "scheduled_preset"], [0, 2, 1, "", "sd_rating_check_error"], [0, 2, 1, "", "sd_status"], [0, 2, 1, "", "sd_write_speed_error"], [0, 2, 1, "", "sec_sd_stat"], [0, 2, 1, "", "space_rem"], [0, 2, 1, "", "streaming_supp"], [0, 2, 1, "", "system_busy"], [0, 2, 1, "", "system_hot"], [0, 2, 1, "", "system_ready"], [0, 2, 1, "", "timelapse_presets"], [0, 2, 1, "", "timelapse_rem"], [0, 2, 1, "", "timewarp_speed_ramp"], [0, 2, 1, "", "total_sd_space_kb"], [0, 2, 1, "", "turbo_mode"], [0, 2, 1, "", "usb_connected"], [0, 2, 1, "", "video_hindsight"], [0, 2, 1, "", "video_low_temp"], [0, 2, 1, "", "video_presets"], [0, 2, 1, "", "video_progress"], [0, 2, 1, "", "video_rem"], [0, 2, 1, "", "wap_prov_stat"], [0, 2, 1, "", "wap_scan_state"], [0, 2, 1, "", "wifi_bars"], [0, 2, 1, "", "wireless_band"], [0, 2, 1, "", "wireless_enabled"], [0, 2, 1, "", "wlan_ssid"], [0, 2, 1, "", "zoom_encoding"]], "open_gopro.api.builders": [[0, 0, 1, "", "BleSettingFacade"], [0, 0, 1, "", "BleStatusFacade"], [0, 0, 1, "", "BuilderProtocol"], [0, 0, 1, "", "HttpSetting"]], "open_gopro.api.builders.BleSettingFacade": [[0, 0, 1, "", "BleSettingMessageBase"], [0, 1, 1, "", "get_capabilities_values"], [0, 1, 1, "", "get_value"], [0, 1, 1, "", "register_capability_update"], [0, 1, 1, "", "register_value_update"], [0, 1, 1, "", "set"], [0, 1, 1, "", "unregister_capability_update"], [0, 1, 1, "", "unregister_value_update"]], "open_gopro.api.builders.BleStatusFacade": [[0, 0, 1, "", "BleStatusMessageBase"], [0, 1, 1, "", "get_value"], [0, 1, 1, "", "register_value_update"], [0, 1, 1, "", "unregister_value_update"]], "open_gopro.api.builders.HttpSetting": [[0, 1, 1, "", "build_url"], [0, 1, 1, "", "set"]], "open_gopro.api.http_commands": [[0, 0, 1, "", "HttpCommands"], [0, 0, 1, "", "HttpSettings"]], "open_gopro.api.http_commands.HttpCommands": [[0, 1, 1, "", "add_file_hilight"], [0, 1, 1, "", "delete_all"], [0, 1, 1, "", "delete_file"], [0, 1, 1, "", "delete_group"], [0, 1, 1, "", "download_file"], [0, 1, 1, "", "get_camera_info"], [0, 1, 1, "", "get_camera_state"], [0, 1, 1, "", "get_date_time"], [0, 1, 1, "", "get_gpmf_data"], [0, 1, 1, "", "get_last_captured_media"], [0, 1, 1, "", "get_media_list"], [0, 1, 1, "", "get_media_metadata"], [0, 1, 1, "", "get_open_gopro_api_version"], [0, 1, 1, "", "get_preset_status"], [0, 1, 1, "", "get_screennail__call__"], [0, 1, 1, "", "get_telemetry"], [0, 1, 1, "", "get_thumbnail"], [0, 1, 1, "", "get_webcam_version"], [0, 1, 1, "", "load_preset"], [0, 1, 1, "", "load_preset_group"], [0, 1, 1, "", "remove_file_hilight"], [0, 1, 1, "", "set_camera_control"], [0, 1, 1, "", "set_date_time"], [0, 1, 1, "", "set_digital_zoom"], [0, 1, 1, "", "set_keep_alive"], [0, 1, 1, "", "set_preview_stream"], [0, 1, 1, "", "set_shutter"], [0, 1, 1, "", "set_third_party_client_info"], [0, 1, 1, "", "set_turbo_mode"], [0, 1, 1, "", "update_custom_preset"], [0, 1, 1, "", "webcam_exit"], [0, 1, 1, "", "webcam_preview"], [0, 1, 1, "", "webcam_start"], [0, 1, 1, "", "webcam_status"], [0, 1, 1, "", "webcam_stop"], [0, 1, 1, "", "wired_usb_control"]], "open_gopro.api.http_commands.HttpSettings": [[0, 2, 1, "", "anti_flicker"], [0, 2, 1, "", "auto_off"], [0, 2, 1, "", "bit_depth"], [0, 2, 1, "", "bit_rate"], [0, 2, 1, "", "camera_ux_mode"], [0, 2, 1, "", "fps"], [0, 2, 1, "", "framing"], [0, 2, 1, "", "hindsight"], [0, 2, 1, "", "hypersmooth"], [0, 2, 1, "", "max_lens_mode"], [0, 2, 1, "", "maxlens_mod_type"], [0, 2, 1, "", "maxlens_status"], [0, 2, 1, "", "media_format"], [0, 2, 1, "", "multi_shot_easy_aspect_ratio"], [0, 2, 1, "", "multi_shot_field_of_view"], [0, 2, 1, "", "multi_shot_nlv_aspect_ratio"], [0, 2, 1, "", "photo_duration"], [0, 2, 1, "", "photo_easy_mode"], [0, 2, 1, "", "photo_field_of_view"], [0, 2, 1, "", "photo_horizon_leveling"], [0, 2, 1, "", "photo_interval"], [0, 2, 1, "", "photo_mode"], [0, 2, 1, "", "resolution"], [0, 2, 1, "", "star_trail_length"], [0, 2, 1, "", "system_video_mode"], [0, 2, 1, "", "timelapse_mode"], [0, 2, 1, "", "video_aspect_ratio"], [0, 2, 1, "", "video_easy_aspect_ratio"], [0, 2, 1, "", "video_easy_mode"], [0, 2, 1, "", "video_field_of_view"], [0, 2, 1, "", "video_horizon_leveling"], [0, 2, 1, "", "video_mode"], [0, 2, 1, "", "video_performance_mode"], [0, 2, 1, "", "video_profile"], [0, 2, 1, "", "wifi_band"]], "open_gopro.api": [[0, 3, 0, "-", "params"]], "open_gopro.api.params": [[0, 0, 1, "", "AccMicStatus"], [0, 0, 1, "", "AnalyticsState"], [0, 0, 1, "", "AntiFlicker"], [0, 0, 1, "", "AutoOff"], [0, 0, 1, "", "BitDepth"], [0, 0, 1, "", "BitRate"], [0, 0, 1, "", "CameraControl"], [0, 0, 1, "", "CameraUxMode"], [0, 0, 1, "", "EasyAspectRatio"], [0, 0, 1, "", "ExposureMode"], [0, 0, 1, "", "FPS"], [0, 0, 1, "", "Flatmode"], [0, 0, 1, "", "Framing"], [0, 0, 1, "", "Hindsight"], [0, 0, 1, "", "HorizonLeveling"], [0, 0, 1, "", "HypersmoothMode"], [0, 0, 1, "", "LED"], [0, 0, 1, "", "LensMode"], [0, 0, 1, "", "MaxLensModType"], [0, 0, 1, "", "MaxLensMode"], [0, 0, 1, "", "MediaFormat"], [0, 0, 1, "", "MediaModMicStatus"], [0, 0, 1, "", "MediaModStatus"], [0, 0, 1, "", "MultishotFOV"], [0, 0, 1, "", "OTAStatus"], [0, 0, 1, "", "Orientation"], [0, 0, 1, "", "PairState"], [0, 0, 1, "", "PairType"], [0, 0, 1, "", "PerformanceMode"], [0, 0, 1, "", "PhotoDuration"], [0, 0, 1, "", "PhotoEasyMode"], [0, 0, 1, "", "PhotoFOV"], [0, 0, 1, "", "PhotoInterval"], [0, 0, 1, "", "PhotoMode"], [0, 0, 1, "", "PresetGroup"], [0, 0, 1, "", "Resolution"], [0, 0, 1, "", "SDStatus"], [0, 0, 1, "", "StarTrailLength"], [0, 0, 1, "", "SystemVideoMode"], [0, 0, 1, "", "TimeWarpSpeed"], [0, 0, 1, "", "TimelapseMode"], [0, 0, 1, "", "Toggle"], [0, 0, 1, "", "VideoAspectRatio"], [0, 0, 1, "", "VideoFOV"], [0, 0, 1, "", "VideoMode"], [0, 0, 1, "", "VideoProfile"], [0, 0, 1, "", "WAPState"], [0, 0, 1, "", "WebcamFOV"], [0, 0, 1, "", "WebcamProtocol"], [0, 0, 1, "", "WebcamResolution"], [0, 0, 1, "", "WifiBand"]], "open_gopro.api.params.AccMicStatus": [[0, 2, 1, "", "CONNECTED"], [0, 2, 1, "", "CONNECTED_AND_PLUGGED_IN"], [0, 2, 1, "", "NOT_CONNECTED"]], "open_gopro.api.params.AnalyticsState": [[0, 2, 1, "", "NOT_READY"], [0, 2, 1, "", "ON_CONNECT"], [0, 2, 1, "", "READY"]], "open_gopro.api.params.AntiFlicker": [[0, 2, 1, "", "HZ_50"], [0, 2, 1, "", "HZ_60"]], "open_gopro.api.params.AutoOff": [[0, 2, 1, "", "MIN_1"], [0, 2, 1, "", "MIN_15"], [0, 2, 1, "", "MIN_30"], [0, 2, 1, "", "MIN_5"], [0, 2, 1, "", "NEVER"], [0, 2, 1, "", "SEC_30"], [0, 2, 1, "", "SEC_8"]], "open_gopro.api.params.BitDepth": [[0, 2, 1, "", "BIT_10"], [0, 2, 1, "", "BIT_8"]], "open_gopro.api.params.BitRate": [[0, 2, 1, "", "HIGH"], [0, 2, 1, "", "STANDARD"]], "open_gopro.api.params.CameraControl": [[0, 2, 1, "", "CAMERA"], [0, 2, 1, "", "EXTERNAL"], [0, 2, 1, "", "IDLE"]], "open_gopro.api.params.CameraUxMode": [[0, 2, 1, "", "EASY"], [0, 2, 1, "", "PRO"]], "open_gopro.api.params.EasyAspectRatio": [[0, 2, 1, "", "MOBILE"], [0, 2, 1, "", "UNIVERSAL"], [0, 2, 1, "", "WIDESCREEN"]], "open_gopro.api.params.ExposureMode": [[0, 2, 1, "", "AUTO"], [0, 2, 1, "", "DISABLED"], [0, 2, 1, "", "HEMISPHERE"], [0, 2, 1, "", "ISO_LOCK"]], "open_gopro.api.params.FPS": [[0, 2, 1, "", "FPS_100"], [0, 2, 1, "", "FPS_120"], [0, 2, 1, "", "FPS_200"], [0, 2, 1, "", "FPS_24"], [0, 2, 1, "", "FPS_240"], [0, 2, 1, "", "FPS_25"], [0, 2, 1, "", "FPS_30"], [0, 2, 1, "", "FPS_50"], [0, 2, 1, "", "FPS_60"]], "open_gopro.api.params.Flatmode": [[0, 2, 1, "", "BURST_PHOTO"], [0, 2, 1, "", "LIVE_BURST"], [0, 2, 1, "", "LOOPING"], [0, 2, 1, "", "NIGHT_LAPSE_PHOTO"], [0, 2, 1, "", "NIGHT_LAPSE_VIDEO"], [0, 2, 1, "", "NIGHT_PHOTO"], [0, 2, 1, "", "NOT_APPLICABLE"], [0, 2, 1, "", "SINGLE_PHOTO"], [0, 2, 1, "", "SLO_MO"], [0, 2, 1, "", "TIME_LAPSE_PHOTO"], [0, 2, 1, "", "TIME_LAPSE_VIDEO"], [0, 2, 1, "", "TIME_WARP_VIDEO"], [0, 2, 1, "", "UNKNOWN"], [0, 2, 1, "", "VIDEO"], [0, 2, 1, "", "WEBCAM"]], "open_gopro.api.params.Framing": [[0, 2, 1, "", "FULL"], [0, 2, 1, "", "VERTICAL"], [0, 2, 1, "", "WIDESCREEN"]], "open_gopro.api.params.Hindsight": [[0, 2, 1, "", "OFF"], [0, 2, 1, "", "SEC_15"], [0, 2, 1, "", "SEC_30"]], "open_gopro.api.params.HorizonLeveling": [[0, 2, 1, "", "LOCKED"], [0, 2, 1, "", "OFF"], [0, 2, 1, "", "ON"]], "open_gopro.api.params.HypersmoothMode": [[0, 2, 1, "", "AUTO_BOOST"], [0, 2, 1, "", "BOOST"], [0, 2, 1, "", "HIGH"], [0, 2, 1, "", "OFF"], [0, 2, 1, "", "ON"], [0, 2, 1, "", "STANDARD"]], "open_gopro.api.params.LED": [[0, 2, 1, "", "ALL_OFF"], [0, 2, 1, "", "ALL_ON"], [0, 2, 1, "", "BLE_KEEP_ALIVE"], [0, 2, 1, "", "FRONT_OFF_ONLY"], [0, 2, 1, "", "LED_2"]], "open_gopro.api.params.LensMode": [[0, 2, 1, "", "DUAL"], [0, 2, 1, "", "SINGLE"]], "open_gopro.api.params.MaxLensModType": [[0, 2, 1, "", "NONE"], [0, 2, 1, "", "V1"], [0, 2, 1, "", "V2"]], "open_gopro.api.params.MaxLensMode": [[0, 2, 1, "", "DEFAULT"], [0, 2, 1, "", "MAX_LENS"]], "open_gopro.api.params.MediaFormat": [[0, 2, 1, "", "NIGHT_LAPSE_PHOTO"], [0, 2, 1, "", "NIGHT_LAPSE_VIDEO"], [0, 2, 1, "", "TIME_LAPSE_PHOTO"], [0, 2, 1, "", "TIME_LAPSE_VIDEO"]], "open_gopro.api.params.MediaModMicStatus": [[0, 2, 1, "", "ONLY"], [0, 2, 1, "", "REMOVED"], [0, 2, 1, "", "WITH_EXTERNAL"]], "open_gopro.api.params.MediaModStatus": [[0, 2, 1, "", "SELFIE_0_HDMI_0_MEDIAMODCONNECTED_FALSE"], [0, 2, 1, "", "SELFIE_0_HDMI_0_MEDIAMODCONNECTED_TRUE"], [0, 2, 1, "", "SELFIE_0_HDMI_1_MEDIAMODCONNECTED_FALSE"], [0, 2, 1, "", "SELFIE_0_HDMI_1_MEDIAMODCONNECTED_TRUE"], [0, 2, 1, "", "SELFIE_1_HDMI_0_MEDIAMODCONNECTED_FALSE"], [0, 2, 1, "", "SELFIE_1_HDMI_0_MEDIAMODCONNECTED_TRUE"], [0, 2, 1, "", "SELFIE_1_HDMI_1_MEDIAMODCONNECTED_FALSE"], [0, 2, 1, "", "SELFIE_1_HDMI_1_MEDIAMODCONNECTED_TRUE"]], "open_gopro.api.params.MultishotFOV": [[0, 2, 1, "", "LINEAR"], [0, 2, 1, "", "MAX_SUPERVIEW"], [0, 2, 1, "", "NARROW"], [0, 2, 1, "", "NOT_APPLICABLE"], [0, 2, 1, "", "WIDE"]], "open_gopro.api.params.OTAStatus": [[0, 2, 1, "", "DOWNLOADING"], [0, 2, 1, "", "DOWNLOAD_FAILED"], [0, 2, 1, "", "GOPRO_APP_DOWNLOADING"], [0, 2, 1, "", "GOPRO_APP_DOWNLOAD_FAILED"], [0, 2, 1, "", "GOPRO_APP_READY"], [0, 2, 1, "", "GOPRO_APP_VERIFYING"], [0, 2, 1, "", "GOPRO_APP_VERIFY_FAILED"], [0, 2, 1, "", "IDLE"], [0, 2, 1, "", "READY"], [0, 2, 1, "", "VERIFYING"], [0, 2, 1, "", "VERIFY_FAILED"]], "open_gopro.api.params.Orientation": [[0, 2, 1, "", "ON_LEFT_SIDE"], [0, 2, 1, "", "ON_RIGHT_SIDE"], [0, 2, 1, "", "UPRIGHT"], [0, 2, 1, "", "UPSIDE_DOWN"]], "open_gopro.api.params.PairState": [[0, 2, 1, "", "COMPLETED"], [0, 2, 1, "", "FAILED"], [0, 2, 1, "", "IN_PROGRESS"], [0, 2, 1, "", "NOT_STARTED"], [0, 2, 1, "", "STOPPED"]], "open_gopro.api.params.PairType": [[0, 2, 1, "", "NOT_PAIRING"], [0, 2, 1, "", "PAIRING_APP"], [0, 2, 1, "", "PAIRING_BLUETOOTH"], [0, 2, 1, "", "PAIRING_REMOTE_CONTROL"]], "open_gopro.api.params.PerformanceMode": [[0, 2, 1, "", "EXTENDED_BATTERY"], [0, 2, 1, "", "MAX_PERFORMANCE"], [0, 2, 1, "", "STATIONARY"]], "open_gopro.api.params.PhotoDuration": [[0, 2, 1, "", "HOUR_1"], [0, 2, 1, "", "HOUR_2"], [0, 2, 1, "", "HOUR_3"], [0, 2, 1, "", "MIN_1"], [0, 2, 1, "", "MIN_15"], [0, 2, 1, "", "MIN_30"], [0, 2, 1, "", "MIN_5"], [0, 2, 1, "", "OFF"], [0, 2, 1, "", "SEC_15"], [0, 2, 1, "", "SEC_30"]], "open_gopro.api.params.PhotoEasyMode": [[0, 2, 1, "", "NIGHT_PHOTO"], [0, 2, 1, "", "OFF"], [0, 2, 1, "", "ON"], [0, 2, 1, "", "SUPER_PHOTO"]], "open_gopro.api.params.PhotoFOV": [[0, 2, 1, "", "HYPERVIEW"], [0, 2, 1, "", "LINEAR"], [0, 2, 1, "", "LINEAR_HORIZON"], [0, 2, 1, "", "MAX_SUPERVIEW"], [0, 2, 1, "", "NARROW"], [0, 2, 1, "", "NOT_APPLICABLE"], [0, 2, 1, "", "WIDE"]], "open_gopro.api.params.PhotoInterval": [[0, 2, 1, "", "OFF"], [0, 2, 1, "", "SEC_0_5"], [0, 2, 1, "", "SEC_1"], [0, 2, 1, "", "SEC_10"], [0, 2, 1, "", "SEC_120"], [0, 2, 1, "", "SEC_2"], [0, 2, 1, "", "SEC_3"], [0, 2, 1, "", "SEC_30"], [0, 2, 1, "", "SEC_5"], [0, 2, 1, "", "SEC_60"]], "open_gopro.api.params.PhotoMode": [[0, 2, 1, "", "NIGHT"], [0, 2, 1, "", "SUPER"]], "open_gopro.api.params.PresetGroup": [[0, 2, 1, "", "PHOTO"], [0, 2, 1, "", "TIMELAPSE"], [0, 2, 1, "", "VIDEO"]], "open_gopro.api.params.Resolution": [[0, 2, 1, "", "NOT_APPLICABLE"], [0, 2, 1, "", "RES_1080"], [0, 2, 1, "", "RES_1080_16_9"], [0, 2, 1, "", "RES_1080_8_7"], [0, 2, 1, "", "RES_1080_9_16"], [0, 2, 1, "", "RES_1440"], [0, 2, 1, "", "RES_2_7K"], [0, 2, 1, "", "RES_2_7K_16_9"], [0, 2, 1, "", "RES_2_7K_4_3"], [0, 2, 1, "", "RES_2_7K_4_3_TODO"], [0, 2, 1, "", "RES_2_7_K_8_7"], [0, 2, 1, "", "RES_4K"], [0, 2, 1, "", "RES_4K_16_9"], [0, 2, 1, "", "RES_4K_4_3"], [0, 2, 1, "", "RES_4K_4_3_TODO"], [0, 2, 1, "", "RES_4K_8_7"], [0, 2, 1, "", "RES_4K_8_7_"], [0, 2, 1, "", "RES_4K_8_7_LEGACY"], [0, 2, 1, "", "RES_4K_9_16"], [0, 2, 1, "", "RES_5K"], [0, 2, 1, "", "RES_5K_4_3"], [0, 2, 1, "", "RES_5_3K"], [0, 2, 1, "", "RES_5_3K_16_9"], [0, 2, 1, "", "RES_5_3K_4_3"], [0, 2, 1, "", "RES_5_3K_8_7"], [0, 2, 1, "", "RES_5_3K_8_7_LEGACY"]], "open_gopro.api.params.SDStatus": [[0, 2, 1, "", "BUSY"], [0, 2, 1, "", "FORMAT_ERROR"], [0, 2, 1, "", "FULL"], [0, 2, 1, "", "OK"], [0, 2, 1, "", "REMOVED"], [0, 2, 1, "", "SWAPPED"], [0, 2, 1, "", "UNKNOWN"]], "open_gopro.api.params.StarTrailLength": [[0, 2, 1, "", "LONG"], [0, 2, 1, "", "MAX"], [0, 2, 1, "", "NOT_APPLICABLE"], [0, 2, 1, "", "SHORT"]], "open_gopro.api.params.SystemVideoMode": [[0, 2, 1, "", "EXTENDED_BATTERY"], [0, 2, 1, "", "EXTENDED_BATTERY_GREEN_ICON"], [0, 2, 1, "", "HIGHEST_QUALITY"], [0, 2, 1, "", "LONGEST_BATTERY_GREEN_ICON"]], "open_gopro.api.params.TimeWarpSpeed": [[0, 2, 1, "", "SPEED_10X"], [0, 2, 1, "", "SPEED_150X"], [0, 2, 1, "", "SPEED_15X"], [0, 2, 1, "", "SPEED_1800X"], [0, 2, 1, "", "SPEED_1X"], [0, 2, 1, "", "SPEED_2X"], [0, 2, 1, "", "SPEED_300X"], [0, 2, 1, "", "SPEED_30X"], [0, 2, 1, "", "SPEED_5X"], [0, 2, 1, "", "SPEED_60X"], [0, 2, 1, "", "SPEED_900X"], [0, 2, 1, "", "SPEED_AUTO"], [0, 2, 1, "", "SPEED_HALF"]], "open_gopro.api.params.TimelapseMode": [[0, 2, 1, "", "LIGHT_PAINTING"], [0, 2, 1, "", "MAX_LIGHT_PAINTING"], [0, 2, 1, "", "MAX_STAR_TRAILS"], [0, 2, 1, "", "MAX_TIMEWARP"], [0, 2, 1, "", "MAX_VEHICLE_LIGHTS"], [0, 2, 1, "", "STAR_TRAILS"], [0, 2, 1, "", "TIMEWARP"], [0, 2, 1, "", "VEHICLE_LIGHTS"]], "open_gopro.api.params.Toggle": [[0, 2, 1, "", "DISABLE"], [0, 2, 1, "", "ENABLE"]], "open_gopro.api.params.VideoAspectRatio": [[0, 2, 1, "", "RATIO_16_9"], [0, 2, 1, "", "RATIO_4_3"], [0, 2, 1, "", "RATIO_8_7"], [0, 2, 1, "", "RATIO_9_16"]], "open_gopro.api.params.VideoFOV": [[0, 2, 1, "", "HYPERVIEW"], [0, 2, 1, "", "LINEAR"], [0, 2, 1, "", "LINEAR_HORIZON_LEVELING"], [0, 2, 1, "", "LINEAR_HORIZON_LOCK"], [0, 2, 1, "", "MAX_HYPERVIEW"], [0, 2, 1, "", "MAX_SUPERVIEW"], [0, 2, 1, "", "NARROW"], [0, 2, 1, "", "SUPERVIEW"], [0, 2, 1, "", "WIDE"]], "open_gopro.api.params.VideoMode": [[0, 2, 1, "", "BASIC"], [0, 2, 1, "", "HIGHEST"], [0, 2, 1, "", "STANDARD"]], "open_gopro.api.params.VideoProfile": [[0, 2, 1, "", "HDR"], [0, 2, 1, "", "LOG"], [0, 2, 1, "", "STANDARD"]], "open_gopro.api.params.WAPState": [[0, 2, 1, "", "ABORTED"], [0, 2, 1, "", "CANCELED"], [0, 2, 1, "", "COMPLETED"], [0, 2, 1, "", "NEVER_STARTED"], [0, 2, 1, "", "STARTED"]], "open_gopro.api.params.WebcamFOV": [[0, 2, 1, "", "LINEAR"], [0, 2, 1, "", "NARROW"], [0, 2, 1, "", "SUPERVIEW"], [0, 2, 1, "", "WIDE"]], "open_gopro.api.params.WebcamProtocol": [[0, 2, 1, "", "RTSP"], [0, 2, 1, "", "TS"]], "open_gopro.api.params.WebcamResolution": [[0, 2, 1, "", "NOT_APPLICABLE"], [0, 2, 1, "", "RES_1080"], [0, 2, 1, "", "RES_480"], [0, 2, 1, "", "RES_720"]], "open_gopro.api.params.WifiBand": [[0, 2, 1, "", "BAND_2_4_GHZ"], [0, 2, 1, "", "BAND_5_GHZ"], [0, 2, 1, "", "BAND_MAX"]], "open_gopro.ble": [[0, 3, 0, "-", "client"], [0, 3, 0, "-", "controller"], [0, 3, 0, "-", "services"]], "open_gopro.ble.client": [[0, 0, 1, "", "BleClient"]], "open_gopro.ble.client.BleClient": [[0, 1, 1, "", "close"], [0, 4, 1, "", "gatt_db"], [0, 4, 1, "", "identifier"], [0, 4, 1, "", "is_connected"], [0, 4, 1, "", "is_discovered"], [0, 1, 1, "", "open"], [0, 1, 1, "", "read"], [0, 1, 1, "", "services_as_csv"], [0, 1, 1, "", "write"]], "open_gopro.ble.controller": [[0, 0, 1, "", "BLEController"]], "open_gopro.ble.controller.BLEController": [[0, 1, 1, "", "connect"], [0, 1, 1, "", "disconnect"], [0, 1, 1, "", "discover_chars"], [0, 1, 1, "", "enable_notifications"], [0, 1, 1, "", "pair"], [0, 1, 1, "", "read"], [0, 1, 1, "", "scan"], [0, 1, 1, "", "write"]], "open_gopro.ble.services": [[0, 0, 1, "", "BleUUID"], [0, 0, 1, "", "CharProps"], [0, 0, 1, "", "Characteristic"], [0, 0, 1, "", "Descriptor"], [0, 0, 1, "", "GattDB"], [0, 0, 1, "", "Service"], [0, 0, 1, "", "SpecUuidNumber"], [0, 0, 1, "", "UUIDs"], [0, 0, 1, "", "UUIDsMeta"]], "open_gopro.ble.services.BleUUID": [[0, 0, 1, "", "Format"], [0, 4, 1, "", "format"]], "open_gopro.ble.services.Characteristic": [[0, 4, 1, "", "cccd_handle"], [0, 4, 1, "", "descriptors"], [0, 4, 1, "", "is_indicatable"], [0, 4, 1, "", "is_notifiable"], [0, 4, 1, "", "is_readable"], [0, 4, 1, "", "is_writeable"], [0, 4, 1, "", "is_writeable_with_response"], [0, 4, 1, "", "is_writeable_without_response"], [0, 4, 1, "", "name"]], "open_gopro.ble.services.Descriptor": [[0, 4, 1, "", "name"]], "open_gopro.ble.services.GattDB": [[0, 0, 1, "", "CharacteristicView"], [0, 1, 1, "", "dump_to_csv"], [0, 1, 1, "", "handle2uuid"], [0, 4, 1, "", "services"], [0, 1, 1, "", "uuid2handle"]], "open_gopro.ble.services.GattDB.CharacteristicView": [[0, 1, 1, "", "items"], [0, 1, 1, "", "keys"], [0, 1, 1, "", "values"]], "open_gopro.ble.services.Service": [[0, 4, 1, "", "characteristics"], [0, 4, 1, "", "name"]], "open_gopro.communicator_interface": [[0, 0, 1, "", "BaseGoProCommunicator"], [0, 0, 1, "", "BleMessage"], [0, 0, 1, "", "BleMessages"], [0, 0, 1, "", "GoProBle"], [0, 0, 1, "", "GoProHttp"], [0, 0, 1, "", "GoProWifi"], [0, 0, 1, "", "GoProWiredInterface"], [0, 0, 1, "", "GoProWirelessInterface"], [0, 0, 1, "", "HttpMessage"], [0, 0, 1, "", "HttpMessages"], [0, 0, 1, "", "Message"], [0, 0, 1, "", "MessageRules"], [0, 0, 1, "", "Messages"]], "open_gopro.communicator_interface.BaseGoProCommunicator": [[0, 1, 1, "", "register_update"], [0, 1, 1, "", "unregister_update"]], "open_gopro.communicator_interface.GoProWifi": [[0, 4, 1, "", "password"], [0, 4, 1, "", "ssid"]], "open_gopro.communicator_interface.HttpMessage": [[0, 1, 1, "", "build_body"], [0, 1, 1, "", "build_url"]], "open_gopro.communicator_interface.MessageRules": [[0, 0, 1, "", "Analyzer"], [0, 1, 1, "", "is_fastpass"], [0, 1, 1, "", "should_wait_for_encoding_start"]], "open_gopro": [[0, 3, 0, "-", "constants"], [0, 3, 0, "-", "exceptions"]], "open_gopro.constants": [[0, 0, 1, "", "ActionId"], [0, 0, 1, "", "CmdId"], [0, 0, 1, "", "ErrorCode"], [0, 0, 1, "", "FeatureId"], [0, 0, 1, "", "GoProUUIDs"], [0, 0, 1, "", "QueryCmdId"], [0, 0, 1, "", "SettingId"], [0, 0, 1, "", "StatusId"], [0, 0, 1, "", "WebcamError"], [0, 0, 1, "", "WebcamStatus"]], "open_gopro.constants.ActionId": [[0, 2, 1, "", "GET_AP_ENTRIES"], [0, 2, 1, "", "GET_AP_ENTRIES_RSP"], [0, 2, 1, "", "GET_LIVESTREAM_STATUS"], [0, 2, 1, "", "GET_PRESET_STATUS"], [0, 2, 1, "", "GET_PRESET_STATUS_RSP"], [0, 2, 1, "", "LIVESTREAM_STATUS_NOTIF"], [0, 2, 1, "", "LIVESTREAM_STATUS_RSP"], [0, 2, 1, "", "NOTIF_PROVIS_STATE"], [0, 2, 1, "", "NOTIF_START_SCAN"], [0, 2, 1, "", "PRESET_MODIFIED_NOTIFICATION"], [0, 2, 1, "", "RELEASE_NETWORK"], [0, 2, 1, "", "RELEASE_NETWORK_RSP"], [0, 2, 1, "", "REQUEST_CLEAR_COHN_CERT"], [0, 2, 1, "", "REQUEST_COHN_SETTING"], [0, 2, 1, "", "REQUEST_CREATE_COHN_CERT"], [0, 2, 1, "", "REQUEST_GET_COHN_CERT"], [0, 2, 1, "", "REQUEST_GET_COHN_STATUS"], [0, 2, 1, "", "REQUEST_GET_LAST_MEDIA"], [0, 2, 1, "", "REQUEST_PRESET_UPDATE_CUSTOM"], [0, 2, 1, "", "REQUEST_WIFI_CONNECT"], [0, 2, 1, "", "REQUEST_WIFI_CONNECT_NEW"], [0, 2, 1, "", "REQUEST_WIFI_CONNECT_NEW_RSP"], [0, 2, 1, "", "REQUEST_WIFI_CONNECT_RSP"], [0, 2, 1, "", "RESPONSE_CLEAR_COHN_CERT"], [0, 2, 1, "", "RESPONSE_COHN_SETTING"], [0, 2, 1, "", "RESPONSE_CREATE_COHN_CERT"], [0, 2, 1, "", "RESPONSE_GET_COHN_CERT"], [0, 2, 1, "", "RESPONSE_GET_COHN_STATUS"], [0, 2, 1, "", "RESPONSE_GET_LAST_MEDIA"], [0, 2, 1, "", "RESPONSE_PRESET_UPDATE_CUSTOM"], [0, 2, 1, "", "SCAN_WIFI_NETWORKS"], [0, 2, 1, "", "SCAN_WIFI_NETWORKS_RSP"], [0, 2, 1, "", "SET_CAMERA_CONTROL"], [0, 2, 1, "", "SET_CAMERA_CONTROL_RSP"], [0, 2, 1, "", "SET_LIVESTREAM_MODE"], [0, 2, 1, "", "SET_LIVESTREAM_MODE_RSP"], [0, 2, 1, "", "SET_TURBO_MODE"], [0, 2, 1, "", "SET_TURBO_MODE_RSP"]], "open_gopro.constants.CmdId": [[0, 2, 1, "", "GET_CAMERA_CAPABILITIES"], [0, 2, 1, "", "GET_CAMERA_SETTINGS"], [0, 2, 1, "", "GET_CAMERA_STATUSES"], [0, 2, 1, "", "GET_DATE_TIME"], [0, 2, 1, "", "GET_DATE_TIME_DST"], [0, 2, 1, "", "GET_HW_INFO"], [0, 2, 1, "", "GET_SETTINGS_JSON"], [0, 2, 1, "", "GET_THIRD_PARTY_API_VERSION"], [0, 2, 1, "", "LOAD_PRESET"], [0, 2, 1, "", "LOAD_PRESET_GROUP"], [0, 2, 1, "", "POWER_DOWN"], [0, 2, 1, "", "REGISTER_ALL_CAPABILITIES"], [0, 2, 1, "", "REGISTER_ALL_SETTINGS"], [0, 2, 1, "", "REGISTER_ALL_STATUSES"], [0, 2, 1, "", "SET_DATE_TIME"], [0, 2, 1, "", "SET_DATE_TIME_DST"], [0, 2, 1, "", "SET_PAIRING_COMPLETE"], [0, 2, 1, "", "SET_SHUTTER"], [0, 2, 1, "", "SET_THIRD_PARTY_CLIENT_INFO"], [0, 2, 1, "", "SET_WIFI"], [0, 2, 1, "", "SLEEP"], [0, 2, 1, "", "TAG_HILIGHT"], [0, 2, 1, "", "UNREGISTER_ALL_CAPABILITIES"], [0, 2, 1, "", "UNREGISTER_ALL_SETTINGS"], [0, 2, 1, "", "UNREGISTER_ALL_STATUSES"]], "open_gopro.constants.ErrorCode": [[0, 2, 1, "", "ERROR"], [0, 2, 1, "", "INVALID_PARAM"], [0, 2, 1, "", "SUCCESS"], [0, 2, 1, "", "UNKNOWN"]], "open_gopro.constants.FeatureId": [[0, 2, 1, "", "COMMAND"], [0, 2, 1, "", "NETWORK_MANAGEMENT"], [0, 2, 1, "", "QUERY"], [0, 2, 1, "", "SETTING"]], "open_gopro.constants.GoProUUIDs": [[0, 2, 1, "", "CM_NET_MGMT_COMM"], [0, 2, 1, "", "CN_NET_MGMT_RESP"], [0, 2, 1, "", "CQ_COMMAND"], [0, 2, 1, "", "CQ_COMMAND_RESP"], [0, 2, 1, "", "CQ_QUERY"], [0, 2, 1, "", "CQ_QUERY_RESP"], [0, 2, 1, "", "CQ_SENSOR"], [0, 2, 1, "", "CQ_SENSOR_RESP"], [0, 2, 1, "", "CQ_SETTINGS"], [0, 2, 1, "", "CQ_SETTINGS_RESP"], [0, 2, 1, "", "S_CAMERA_MANAGEMENT"], [0, 2, 1, "", "S_CONTROL_QUERY"], [0, 2, 1, "", "S_WIFI_ACCESS_POINT"], [0, 2, 1, "", "WAP_CSI_PASSWORD"], [0, 2, 1, "", "WAP_PASSWORD"], [0, 2, 1, "", "WAP_POWER"], [0, 2, 1, "", "WAP_SSID"], [0, 2, 1, "", "WAP_STATE"]], "open_gopro.constants.QueryCmdId": [[0, 2, 1, "", "GET_CAPABILITIES_NAME"], [0, 2, 1, "", "GET_CAPABILITIES_VAL"], [0, 2, 1, "", "GET_SETTING_NAME"], [0, 2, 1, "", "GET_SETTING_VAL"], [0, 2, 1, "", "GET_STATUS_VAL"], [0, 2, 1, "", "INVALID_FOR_TESTING"], [0, 2, 1, "", "PROTOBUF_QUERY"], [0, 2, 1, "", "REG_CAPABILITIES_UPDATE"], [0, 2, 1, "", "REG_SETTING_VAL_UPDATE"], [0, 2, 1, "", "REG_STATUS_VAL_UPDATE"], [0, 2, 1, "", "SETTING_CAPABILITY_PUSH"], [0, 2, 1, "", "SETTING_VAL_PUSH"], [0, 2, 1, "", "STATUS_VAL_PUSH"], [0, 2, 1, "", "UNREG_CAPABILITIES_UPDATE"], [0, 2, 1, "", "UNREG_SETTING_VAL_UPDATE"], [0, 2, 1, "", "UNREG_STATUS_VAL_UPDATE"]], "open_gopro.constants.SettingId": [[0, 2, 1, "", "ADDON_MAX_LENS_MOD"], [0, 2, 1, "", "ADDON_MAX_LENS_MOD_ENABLE"], [0, 2, 1, "", "ANTI_FLICKER"], [0, 2, 1, "", "AUTO_OFF"], [0, 2, 1, "", "BIT_DEPTH"], [0, 2, 1, "", "BIT_RATE"], [0, 2, 1, "", "CAMERA_UX_MODE"], [0, 2, 1, "", "FPS"], [0, 2, 1, "", "FRAMING"], [0, 2, 1, "", "HINDSIGHT"], [0, 2, 1, "", "HYPERSMOOTH"], [0, 2, 1, "", "INVALID_FOR_TESTING"], [0, 2, 1, "", "LED"], [0, 2, 1, "", "MAX_LENS_MOD"], [0, 2, 1, "", "MEDIA_FORMAT"], [0, 2, 1, "", "MULTI_SHOT_EASY_ASPECT_RATIO"], [0, 2, 1, "", "MULTI_SHOT_FOV"], [0, 2, 1, "", "MULTI_SHOT_NLV_ASPECT_RATIO"], [0, 2, 1, "", "PHOTO_EASY_MODE"], [0, 2, 1, "", "PHOTO_FOV"], [0, 2, 1, "", "PHOTO_HORIZON_LEVELING"], [0, 2, 1, "", "PHOTO_INTERVAL"], [0, 2, 1, "", "PHOTO_INTERVAL_DURATION"], [0, 2, 1, "", "PHOTO_MODE"], [0, 2, 1, "", "PROTOBUF_SETTING"], [0, 2, 1, "", "RESOLUTION"], [0, 2, 1, "", "STAR_TRAIL_LENGTH"], [0, 2, 1, "", "SYSTEM_VIDEO_MODE"], [0, 2, 1, "", "TIMELAPSE_MODE"], [0, 2, 1, "", "VIDEO_ASPECT_RATIO"], [0, 2, 1, "", "VIDEO_EASY_ASPECT_RATIO"], [0, 2, 1, "", "VIDEO_EASY_MODE"], [0, 2, 1, "", "VIDEO_FOV"], [0, 2, 1, "", "VIDEO_HORIZON_LEVELING"], [0, 2, 1, "", "VIDEO_MODE"], [0, 2, 1, "", "VIDEO_PERFORMANCE_MODE"], [0, 2, 1, "", "VIDEO_PROFILE"], [0, 2, 1, "", "WIFI_BAND"]], "open_gopro.constants.StatusId": [[0, 2, 1, "", "ACC_MIC_STAT"], [0, 2, 1, "", "ACTIVE_PRESET"], [0, 2, 1, "", "ANALYTICS_RDY"], [0, 2, 1, "", "ANALYTICS_SIZE"], [0, 2, 1, "", "APP_COUNT"], [0, 2, 1, "", "AP_SSID"], [0, 2, 1, "", "AP_STATE"], [0, 2, 1, "", "BAND_5GHZ_AVAIL"], [0, 2, 1, "", "BATT_LEVEL"], [0, 2, 1, "", "BATT_OK_OTA"], [0, 2, 1, "", "BATT_PRESENT"], [0, 2, 1, "", "CAMERA_CONTROL"], [0, 2, 1, "", "CAMERA_LENS_TYPE"], [0, 2, 1, "", "CAPTURE_DELAY"], [0, 2, 1, "", "CAPT_DELAY_ACTIVE"], [0, 2, 1, "", "CONTROL_OVER_USB"], [0, 2, 1, "", "CREATING_PRESET"], [0, 2, 1, "", "CURRENT_TIME_MS"], [0, 2, 1, "", "DIGITAL_ZOOM"], [0, 2, 1, "", "DIG_ZOOM_ACTIVE"], [0, 2, 1, "", "DOWNLOAD_CANCEL_PEND"], [0, 2, 1, "", "ENCODING"], [0, 2, 1, "", "EXPOSURE_TYPE"], [0, 2, 1, "", "EXPOSURE_X"], [0, 2, 1, "", "EXPOSURE_Y"], [0, 2, 1, "", "FIRST_TIME"], [0, 2, 1, "", "FLATMODE_ID"], [0, 2, 1, "", "GPS_STAT"], [0, 2, 1, "", "INT_BATT_PER"], [0, 2, 1, "", "IN_CONTEXT_MENU"], [0, 2, 1, "", "LAST_HILIGHT"], [0, 2, 1, "", "LCD_LOCK_ACTIVE"], [0, 2, 1, "", "LINUX_CORE_ACTIVE"], [0, 2, 1, "", "LIVE_BURST_REM"], [0, 2, 1, "", "LIVE_BURST_TOTAL"], [0, 2, 1, "", "LOCATE_ACTIVE"], [0, 2, 1, "", "LOGS_READY"], [0, 2, 1, "", "MEDIA_MOD_MIC_STAT"], [0, 2, 1, "", "MEDIA_MOD_STAT"], [0, 2, 1, "", "MOBILE_VIDEO"], [0, 2, 1, "", "MODE_GROUP"], [0, 2, 1, "", "MULTI_COUNT_DOWN"], [0, 2, 1, "", "NEXT_POLL"], [0, 2, 1, "", "NUM_GROUP_PHOTO"], [0, 2, 1, "", "NUM_GROUP_VIDEO"], [0, 2, 1, "", "NUM_HILIGHTS"], [0, 2, 1, "", "NUM_TOTAL_PHOTO"], [0, 2, 1, "", "NUM_TOTAL_VIDEO"], [0, 2, 1, "", "ORIENTATION"], [0, 2, 1, "", "OTA_STAT"], [0, 2, 1, "", "PAIR_STATE"], [0, 2, 1, "", "PAIR_STATE2"], [0, 2, 1, "", "PAIR_TIME"], [0, 2, 1, "", "PAIR_TYPE"], [0, 2, 1, "", "PHOTOS_REM"], [0, 2, 1, "", "PHOTO_PRESETS"], [0, 2, 1, "", "PRESETS_GROUP"], [0, 2, 1, "", "PRESET_MODIFIED"], [0, 2, 1, "", "PREVIEW_ENABLED"], [0, 2, 1, "", "QUICK_CAPTURE"], [0, 2, 1, "", "REMOTE_CTRL_CONN"], [0, 2, 1, "", "REMOTE_CTRL_VER"], [0, 2, 1, "", "SCHEDULED_CAPTURE"], [0, 2, 1, "", "SCHEDULED_PRESET"], [0, 2, 1, "", "SD_RATING_CHECK_ERROR"], [0, 2, 1, "", "SD_STATUS"], [0, 2, 1, "", "SD_WRITE_SPEED_ERROR"], [0, 2, 1, "", "SEC_SD_STAT"], [0, 2, 1, "", "SPACE_REM"], [0, 2, 1, "", "STREAMING_SUPP"], [0, 2, 1, "", "SYSTEM_BUSY"], [0, 2, 1, "", "SYSTEM_HOT"], [0, 2, 1, "", "SYSTEM_READY"], [0, 2, 1, "", "TIMELAPSE_PRESETS"], [0, 2, 1, "", "TIMELAPSE_REM"], [0, 2, 1, "", "TIMEWARP_SPEED_RAMP"], [0, 2, 1, "", "TOTAL_SD_SPACE_KB"], [0, 2, 1, "", "TURBO_MODE"], [0, 2, 1, "", "USB_CONNECTED"], [0, 2, 1, "", "VIDEO_HINDSIGHT"], [0, 2, 1, "", "VIDEO_LOW_TEMP"], [0, 2, 1, "", "VIDEO_PRESETS"], [0, 2, 1, "", "VIDEO_PROGRESS"], [0, 2, 1, "", "VIDEO_REM"], [0, 2, 1, "", "WAP_PROV_STAT"], [0, 2, 1, "", "WAP_SCAN_STATE"], [0, 2, 1, "", "WAP_SCAN_TIME"], [0, 2, 1, "", "WIFI_BARS"], [0, 2, 1, "", "WIRELESS_BAND"], [0, 2, 1, "", "WIRELESS_ENABLED"], [0, 2, 1, "", "WLAN_SSID"], [0, 2, 1, "", "ZOOM_ENCODING"]], "open_gopro.constants.WebcamError": [[0, 2, 1, "", "COM_TIMEOUT"], [0, 2, 1, "", "EXEC_STREAM"], [0, 2, 1, "", "EXIT"], [0, 2, 1, "", "INVALID_PARAM"], [0, 2, 1, "", "SET_PRESET"], [0, 2, 1, "", "SET_WINDOW_SIZE"], [0, 2, 1, "", "SHUTTER"], [0, 2, 1, "", "SUCCESS"], [0, 2, 1, "", "UNAVAILABLE"]], "open_gopro.constants.WebcamStatus": [[0, 2, 1, "", "HIGH_POWER_PREVIEW"], [0, 2, 1, "", "IDLE"], [0, 2, 1, "", "LOW_POWER_PREVIEW"], [0, 2, 1, "", "OFF"]], "open_gopro.enum": [[0, 0, 1, "", "GoProEnum"], [0, 0, 1, "", "GoProIntEnum"]], "open_gopro.exceptions": [[0, 5, 1, "", "ConnectFailed"], [0, 5, 1, "", "ConnectionTerminated"], [0, 6, 1, "", "ExceptionHandler"], [0, 5, 1, "", "FailedToFindDevice"], [0, 5, 1, "", "GoProError"], [0, 5, 1, "", "GoProNotOpened"], [0, 5, 1, "", "InterfaceConfigFailure"], [0, 5, 1, "", "InvalidConfiguration"], [0, 5, 1, "", "InvalidOpenGoProVersion"], [0, 5, 1, "", "ResponseParseError"], [0, 5, 1, "", "ResponseTimeout"]], "open_gopro.gopro_base": [[0, 0, 1, "", "GoProBase"]], "open_gopro.gopro_base.GoProBase": [[0, 4, 1, "", "ble_command"], [0, 4, 1, "", "ble_setting"], [0, 4, 1, "", "ble_status"], [0, 1, 1, "", "close"], [0, 1, 1, "", "configure_cohn"], [0, 4, 1, "", "http_command"], [0, 4, 1, "", "http_setting"], [0, 4, 1, "", "identifier"], [0, 4, 1, "", "is_ble_connected"], [0, 4, 1, "", "is_cohn_provisioned"], [0, 4, 1, "", "is_http_connected"], [0, 4, 1, "", "is_open"], [0, 4, 1, "", "is_ready"], [0, 1, 1, "", "open"], [0, 4, 1, "", "version"]], "open_gopro.gopro_wired": [[0, 0, 1, "", "WiredGoPro"]], "open_gopro.gopro_wired.WiredGoPro": [[0, 4, 1, "", "ble_command"], [0, 4, 1, "", "ble_setting"], [0, 4, 1, "", "ble_status"], [0, 1, 1, "", "close"], [0, 1, 1, "", "configure_cohn"], [0, 4, 1, "", "http_command"], [0, 4, 1, "", "http_setting"], [0, 4, 1, "", "identifier"], [0, 4, 1, "", "is_ble_connected"], [0, 4, 1, "", "is_cohn_provisioned"], [0, 4, 1, "", "is_http_connected"], [0, 4, 1, "", "is_open"], [0, 4, 1, "", "is_ready"], [0, 1, 1, "", "open"], [0, 1, 1, "", "register_update"], [0, 1, 1, "", "unregister_update"], [0, 4, 1, "", "version"]], "open_gopro.gopro_wireless": [[0, 0, 1, "", "WirelessGoPro"]], "open_gopro.gopro_wireless.WirelessGoPro": [[0, 4, 1, "", "ble_command"], [0, 4, 1, "", "ble_setting"], [0, 4, 1, "", "ble_status"], [0, 1, 1, "", "close"], [0, 1, 1, "", "configure_cohn"], [0, 1, 1, "", "connect_to_access_point"], [0, 4, 1, "", "http_command"], [0, 4, 1, "", "http_setting"], [0, 4, 1, "", "identifier"], [0, 4, 1, "", "is_ble_connected"], [0, 4, 1, "", "is_cohn_provisioned"], [0, 4, 1, "", "is_http_connected"], [0, 4, 1, "", "is_open"], [0, 4, 1, "", "is_ready"], [0, 1, 1, "", "keep_alive"], [0, 1, 1, "", "open"], [0, 4, 1, "", "password"], [0, 1, 1, "", "register_update"], [0, 4, 1, "", "ssid"], [0, 1, 1, "", "unregister_update"], [0, 4, 1, "", "version"]], "open_gopro.models.general": [[0, 7, 1, "", "CameraInfo"], [0, 7, 1, "", "SupportedOption"], [0, 7, 1, "", "TzDstDateTime"], [0, 7, 1, "", "WebcamResponse"]], "open_gopro.models.general.CameraInfo": [[0, 8, 1, "", "ap_mac_addr"], [0, 8, 1, "", "ap_ssid"], [0, 8, 1, "", "firmware_version"], [0, 8, 1, "", "model_name"], [0, 8, 1, "", "model_number"], [0, 8, 1, "", "serial_number"]], "open_gopro.models.general.SupportedOption": [[0, 8, 1, "", "display_name"], [0, 8, 1, "", "id"]], "open_gopro.models.general.TzDstDateTime": [[0, 8, 1, "", "datetime"], [0, 8, 1, "", "dst"], [0, 8, 1, "", "tzone"]], "open_gopro.models.general.WebcamResponse": [[0, 8, 1, "", "error"], [0, 8, 1, "", "setting_id"], [0, 8, 1, "", "status"], [0, 8, 1, "", "supported_options"]], "open_gopro.models.media_list": [[0, 7, 1, "", "GroupedMediaItem"], [0, 7, 1, "", "MediaFileSystem"], [0, 7, 1, "", "MediaItem"], [0, 7, 1, "", "MediaList"], [0, 7, 1, "", "MediaMetadata"], [0, 7, 1, "", "PhotoMetadata"], [0, 7, 1, "", "VideoMetadata"]], "open_gopro.models.media_list.GroupedMediaItem": [[0, 8, 1, "", "group_first_member_id"], [0, 8, 1, "", "group_id"], [0, 8, 1, "", "group_last_member_id"], [0, 8, 1, "", "group_missing_ids"], [0, 8, 1, "", "group_size"], [0, 8, 1, "", "group_type"]], "open_gopro.models.media_list.MediaFileSystem": [[0, 8, 1, "", "directory"], [0, 8, 1, "", "file_system"], [0, 1, 1, "", "identify_item"]], "open_gopro.models.media_list.MediaItem": [[0, 8, 1, "", "creation_timestamp"], [0, 8, 1, "", "filename"], [0, 8, 1, "", "low_res_video_size"], [0, 8, 1, "", "lrv_file_size"], [0, 8, 1, "", "modified_time"], [0, 8, 1, "", "session_id"]], "open_gopro.models.media_list.MediaList": [[0, 4, 1, "", "files"], [0, 8, 1, "", "identifier"], [0, 8, 1, "", "media"], [0, 1, 1, "", "model_post_init"]], "open_gopro.models.media_list.MediaMetadata": [[0, 8, 1, "", "content_type"], [0, 8, 1, "", "creation_timestamp"], [0, 8, 1, "", "field_of_view"], [0, 8, 1, "", "file_size"], [0, 1, 1, "", "from_json"], [0, 8, 1, "", "gumi"], [0, 8, 1, "", "height"], [0, 8, 1, "", "hilight_count"], [0, 8, 1, "", "image_stabilization"], [0, 8, 1, "", "lens_config"], [0, 8, 1, "", "lens_projection"], [0, 8, 1, "", "media_offload_state"], [0, 8, 1, "", "metadata_present"], [0, 8, 1, "", "parent_gumi"], [0, 8, 1, "", "rotate"], [0, 8, 1, "", "transcoded"], [0, 8, 1, "", "upload_status"], [0, 8, 1, "", "width"]], "open_gopro.models.media_list.PhotoMetadata": [[0, 8, 1, "", "high_dynamic_range"], [0, 8, 1, "", "raw"], [0, 8, 1, "", "wide_dynamic_range"]], "open_gopro.models.media_list.VideoMetadata": [[0, 8, 1, "", "audio_option"], [0, 8, 1, "", "avc_level"], [0, 8, 1, "", "avc_profile"], [0, 8, 1, "", "clipped"], [0, 8, 1, "", "duration"], [0, 8, 1, "", "frame_rate"], [0, 8, 1, "", "frame_rate_divisor"], [0, 8, 1, "", "hilight_list"], [0, 8, 1, "", "lrv_file_size"], [0, 8, 1, "", "max_auto_hilight_score"], [0, 8, 1, "", "progressive"], [0, 8, 1, "", "protune_audio"], [0, 8, 1, "", "subsample"]], "open_gopro.models.response": [[0, 0, 1, "", "GoProResp"]], "open_gopro.models.response.GoProResp": [[0, 0, 1, "", "Protocol"], [0, 2, 1, "", "data"], [0, 2, 1, "", "identifier"], [0, 4, 1, "", "ok"], [0, 2, 1, "", "protocol"], [0, 2, 1, "", "status"]], "open_gopro.wifi": [[0, 3, 0, "-", "client"], [0, 3, 0, "-", "controller"]], "open_gopro.wifi.client": [[0, 0, 1, "", "WifiClient"]], "open_gopro.wifi.client.WifiClient": [[0, 1, 1, "", "close"], [0, 4, 1, "", "is_connected"], [0, 1, 1, "", "open"]], "open_gopro.wifi.controller": [[0, 0, 1, "", "SsidState"], [0, 0, 1, "", "WifiController"]], "open_gopro.wifi.controller.WifiController": [[0, 1, 1, "", "available_interfaces"], [0, 1, 1, "", "connect"], [0, 1, 1, "", "current"], [0, 1, 1, "", "disconnect"], [0, 4, 1, "", "interface"], [0, 4, 1, "", "is_on"], [0, 1, 1, "", "power"], [0, 4, 1, "", "sudo"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:attribute", "3": "py:module", "4": "py:property", "5": "py:exception", "6": "py:data", "7": "py:pydantic_model", "8": "py:pydantic_field"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "module", "Python module"], "4": ["py", "property", "Python property"], "5": ["py", "exception", "Python exception"], "6": ["py", "data", "Python data"], "7": ["py", "pydantic_model", "Python model"], "8": ["py", "pydantic_field", "Python field"]}, "titleterms": {"api": [0, 9], "refer": 0, "gopro": [0, 5], "client": 0, "wireless": [0, 9], "wire": [0, 7, 9], "open": [0, 5, 9], "base": 0, "type": [0, 3], "enum": 0, "ble": 0, "set": [0, 9], "statu": 0, "http": 0, "method": 0, "protocol": 0, "messag": [0, 9], "paramet": [0, 9], "respons": [0, 9], "data": [0, 9], "model": 0, "constant": 0, "except": 0, "common": [0, 9], "interfac": [0, 7], "bleservic": 0, "wifi": [0, 7], "credit": 1, "develop": [1, 5, 6], "lead": 1, "contributor": 1, "changelog": 2, "0": 2, "16": 2, "april": 2, "9": 2, "2024": 2, "15": 2, "1": 2, "decemb": 2, "6": 2, "2023": 2, "14": 2, "septemb": 2, "21": 2, "13": 2, "februari": 2, "24": 2, "12": 2, "11": 2, "2": 2, "novemb": 2, "2022": 2, "octob": 2, "18": 2, "10": 2, "juli": 2, "june": 2, "mai": 2, "27": 2, "7": 2, "8": 2, "3": 2, "januari": 2, "2021": 2, "28": 2, "20": 2, "5": 2, "august": 2, "26": 2, "4": 2, "march": 2, "30": 2, "29": 2, "25": 2, "22": 2, "x": 2, "contribut": 3, "report": 3, "bug": 3, "fix": 3, "implement": 3, "featur": [3, 5], "write": 3, "document": 3, "submit": 3, "feedback": 3, "get": [3, 5], "start": [3, 5], "minim": [3, 6], "requir": 3, "step": 3, "pull": 3, "request": 3, "guidelin": 3, "futur": 4, "work": 4, "known": 4, "issu": 4, "python": 5, "sdk": 5, "summari": 5, "content": 5, "instal": 6, "stabl": 6, "releas": 6, "addit": 6, "gui": [6, 7], "extern": 6, "depend": 6, "from": 6, "sourc": 6, "For": 6, "quickstart": 7, "guid": 7, "command": [7, 9], "line": 7, "cli": 7, "demo": 7, "photo": 7, "video": 7, "batteri": 7, "graphic": 7, "user": 7, "webcam": 7, "livestream": 7, "troubleshoot": 8, "log": 8, "bluetooth": 8, "characterist": 8, "usag": 9, "overview": 9, "asyncio": 9, "version": 9, "camera": 9, "readi": 9, "send": 9, "select": 9, "synchron": 9, "oper": 9, "status": 9, "asynchron": 9, "push": 9, "notif": 9, "handl": 9, "structur": 9, "access": 9, "close": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"API Reference": [[0, "api-reference"]], "GoPro Client": [[0, "gopro-client"]], "Wireless": [[0, "wireless"]], "Wired": [[0, "wired"]], "Open GoPro API": [[0, "open-gopro-api"]], "Base Types": [[0, "base-types"]], "GoPro Enum": [[0, "gopro-enum"]], "BLE Setting": [[0, "ble-setting"]], "BLE Status": [[0, "ble-status"]], "HTTP Setting": [[0, "http-setting"]], "Method Protocols": [[0, "method-protocols"]], "Message Bases": [[0, "message-bases"]], "Parameters": [[0, "parameters"]], "Responses": [[0, "responses"]], "Data Models": [[0, "data-models"]], "Constants": [[0, "constants"]], "Exceptions": [[0, "module-open_gopro.exceptions"]], "Common Interface": [[0, "common-interface"]], "BLE Interface": [[0, "module-open_gopro.ble.controller"]], "BLEServices": [[0, "module-open_gopro.ble.services"]], "WiFi Interface": [[0, "module-open_gopro.wifi.controller"]], "Credits": [[1, "credits"]], "Development Lead": [[1, "development-lead"]], "Contributors": [[1, "contributors"]], "Changelog": [[2, "changelog"]], "0.16.0 (April-9-2024)": [[2, "april-9-2024"]], "0.15.1 (December-6-2023)": [[2, "december-6-2023"]], "0.15.0 (December-6-2023)": [[2, "id1"]], "0.14.1 (September-21-2023)": [[2, "september-21-2023"]], "0.14.0 (September-13-2023)": [[2, "september-13-2023"]], "0.13.0 (February-24-2023)": [[2, "february-24-2023"]], "0.12.0 (December-16-2023)": [[2, "december-16-2023"]], "0.11.2 (November-9-2022)": [[2, "november-9-2022"]], "0.11.1 (October-18-2022)": [[2, "october-18-2022"]], "0.11.0 (September-14-2022)": [[2, "september-14-2022"]], "0.10.0 (July-14-2022)": [[2, "july-14-2022"]], "0.9.2 (June-16-2022)": [[2, "june-16-2022"]], "0.9.1 (May-27-2022)": [[2, "may-27-2022"]], "0.9.0 (February-7-2022)": [[2, "february-7-2022"]], "0.8.0 (February-3-2022)": [[2, "february-3-2022"]], "0.7.2 (January-3-2022)": [[2, "january-3-2022"]], "0.7.1 (December-16-2021)": [[2, "december-16-2021"]], "0.7.0 (October-27-2021)": [[2, "october-27-2021"]], "0.6.3 (October-7-2021)": [[2, "october-7-2021"]], "0.6.2 (September-28-2021)": [[2, "september-28-2021"]], "0.6.1 (September-20-2021)": [[2, "september-20-2021"]], "0.6.0 (September-2-2021)": [[2, "september-2-2021"]], "0.5.8 (August-10-2021)": [[2, "august-10-2021"]], "0.5.7 (June-7-2021)": [[2, "june-7-2021"]], "0.5.6 (May-26-2021)": [[2, "may-26-2021"]], "0.5.5 (May-26-2021)": [[2, "id2"]], "0.5.4 (May-6-2021)": [[2, "may-6-2021"]], "0.5.3 (April-15-2021)": [[2, "april-15-2021"]], "0.5.2 (April-2-2021)": [[2, "april-2-2021"]], "0.5.1 (April-1-2021)": [[2, "april-1-2021"]], "0.5.0 (March-30-2021)": [[2, "march-30-2021"]], "0.4.6 (March-29-2021)": [[2, "march-29-2021"]], "0.4.5 (March-29-2021)": [[2, "id3"]], "0.4.4 (March-27-2021)": [[2, "march-27-2021"]], "0.4.3 (March-26-2021)": [[2, "march-26-2021"]], "0.4.2 (March-25-2021)": [[2, "march-25-2021"]], "0.4.1 (March-25-2021)": [[2, "id4"]], "0.4.0 (March-25-2021)": [[2, "id5"]], "0.3.3 (March-22-2021)": [[2, "march-22-2021"]], "0.3.2 (March-15-2021)": [[2, "march-15-2021"]], "0.3.1 (March-12-2021)": [[2, "march-12-2021"]], "0.3.0 (March-11-2021)": [[2, "march-11-2021"]], "0.2.0 (March-10-2021)": [[2, "march-10-2021"]], "0.1.x (March-10-2021)": [[2, "x-march-10-2021"]], "Contributing": [[3, "contributing"]], "Types of Contributions": [[3, "types-of-contributions"]], "Report Bugs": [[3, "report-bugs"]], "Fix Bugs": [[3, "fix-bugs"]], "Implement Features": [[3, "implement-features"]], "Write Documentation": [[3, "write-documentation"]], "Submit Feedback": [[3, "submit-feedback"]], "Get Started!": [[3, "get-started"]], "Minimal Requirements": [[3, "minimal-requirements"]], "Steps": [[3, "steps"]], "Pull Request Guidelines": [[3, "pull-request-guidelines"]], "Future Work": [[4, "future-work"]], "Known issues": [[4, "known-issues"]], "Open GoPro Python SDK": [[5, "open-gopro-python-sdk"]], "Summary": [[5, "summary"]], "Features": [[5, "features"]], "Getting Started": [[5, "getting-started"]], "Development": [[5, "development"]], "Contents:": [[5, null]], "Installation": [[6, "installation"]], "Stable release": [[6, "stable-release"]], "Minimal Install": [[6, "minimal-install"]], "Additional GUI Install": [[6, "additional-gui-install"]], "External Dependencies": [[6, "external-dependencies"]], "From sources": [[6, "from-sources"]], "For Developers": [[6, "for-developers"]], "QuickStart Guide": [[7, "quickstart-guide"]], "Command Line Interface (CLI) Demos": [[7, "command-line-interface-cli-demos"]], "Photo Demo": [[7, "photo-demo"]], "Video Demo": [[7, "video-demo"]], "WiFi Demo": [[7, "wifi-demo"]], "Battery Demo": [[7, "battery-demo"]], "Graphical User Interface (GUI) Demos": [[7, "graphical-user-interface-gui-demos"]], "Wired Webcam Demo": [[7, "wired-webcam-demo"]], "Livestream Demo": [[7, "livestream-demo"]], "Troubleshooting": [[8, "troubleshooting"]], "Logging": [[8, "logging"]], "Bluetooth Characteristics": [[8, "bluetooth-characteristics"]], "Usage": [[9, "usage"]], "Overview": [[9, "overview"]], "Asyncio": [[9, "asyncio"]], "Opening": [[9, "opening"]], "Wireless Opening": [[9, "wireless-opening"]], "Wired Opening": [[9, "wired-opening"]], "Common Opening": [[9, "common-opening"]], "API Version": [[9, "api-version"]], "Camera Readiness": [[9, "camera-readiness"]], "Sending Messages": [[9, "sending-messages"]], "Selecting Parameters": [[9, "selecting-parameters"]], "Synchronous Data Operations": [[9, "synchronous-data-operations"]], "Commands": [[9, "commands"]], "Statuses": [[9, "statuses"]], "Settings": [[9, "settings"]], "Asynchronous Push Notifications": [[9, "asynchronous-push-notifications"]], "Handling Responses": [[9, "handling-responses"]], "Response Structure": [[9, "response-structure"]], "Data Access": [[9, "data-access"]], "Closing": [[9, "closing"]]}, "indexentries": {"aborted (wapstate attribute)": [[0, "open_gopro.api.params.WAPState.ABORTED"]], "acc_mic_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.ACC_MIC_STAT"]], "active_preset (statusid attribute)": [[0, "open_gopro.constants.StatusId.ACTIVE_PRESET"]], "addon_max_lens_mod (settingid attribute)": [[0, "open_gopro.constants.SettingId.ADDON_MAX_LENS_MOD"]], "addon_max_lens_mod_enable (settingid attribute)": [[0, "open_gopro.constants.SettingId.ADDON_MAX_LENS_MOD_ENABLE"]], "all_off (led attribute)": [[0, "open_gopro.api.params.LED.ALL_OFF"]], "all_on (led attribute)": [[0, "open_gopro.api.params.LED.ALL_ON"]], "analytics_rdy (statusid attribute)": [[0, "open_gopro.constants.StatusId.ANALYTICS_RDY"]], "analytics_size (statusid attribute)": [[0, "open_gopro.constants.StatusId.ANALYTICS_SIZE"]], "anti_flicker (settingid attribute)": [[0, "open_gopro.constants.SettingId.ANTI_FLICKER"]], "app_count (statusid attribute)": [[0, "open_gopro.constants.StatusId.APP_COUNT"]], "ap_ssid (statusid attribute)": [[0, "open_gopro.constants.StatusId.AP_SSID"]], "ap_state (statusid attribute)": [[0, "open_gopro.constants.StatusId.AP_STATE"]], "auto (exposuremode attribute)": [[0, "open_gopro.api.params.ExposureMode.AUTO"]], "auto_boost (hypersmoothmode attribute)": [[0, "open_gopro.api.params.HypersmoothMode.AUTO_BOOST"]], "auto_off (settingid attribute)": [[0, "open_gopro.constants.SettingId.AUTO_OFF"]], "accmicstatus (class in open_gopro.api.params)": [[0, "open_gopro.api.params.AccMicStatus"]], "actionid (class in open_gopro.constants)": [[0, "open_gopro.constants.ActionId"]], "analyticsstate (class in open_gopro.api.params)": [[0, "open_gopro.api.params.AnalyticsState"]], "antiflicker (class in open_gopro.api.params)": [[0, "open_gopro.api.params.AntiFlicker"]], "autooff (class in open_gopro.api.params)": [[0, "open_gopro.api.params.AutoOff"]], "band_2_4_ghz (wifiband attribute)": [[0, "open_gopro.api.params.WifiBand.BAND_2_4_GHZ"]], "band_5ghz_avail (statusid attribute)": [[0, "open_gopro.constants.StatusId.BAND_5GHZ_AVAIL"]], "band_5_ghz (wifiband attribute)": [[0, "open_gopro.api.params.WifiBand.BAND_5_GHZ"]], "band_max (wifiband attribute)": [[0, "open_gopro.api.params.WifiBand.BAND_MAX"]], "basic (videomode attribute)": [[0, "open_gopro.api.params.VideoMode.BASIC"]], "batt_level (statusid attribute)": [[0, "open_gopro.constants.StatusId.BATT_LEVEL"]], "batt_ok_ota (statusid attribute)": [[0, "open_gopro.constants.StatusId.BATT_OK_OTA"]], "batt_present (statusid attribute)": [[0, "open_gopro.constants.StatusId.BATT_PRESENT"]], "bit_10 (bitdepth attribute)": [[0, "open_gopro.api.params.BitDepth.BIT_10"]], "bit_8 (bitdepth attribute)": [[0, "open_gopro.api.params.BitDepth.BIT_8"]], "bit_depth (settingid attribute)": [[0, "open_gopro.constants.SettingId.BIT_DEPTH"]], "bit_rate (settingid attribute)": [[0, "open_gopro.constants.SettingId.BIT_RATE"]], "blecontroller (class in open_gopro.ble.controller)": [[0, "open_gopro.ble.controller.BLEController"]], "ble_keep_alive (led attribute)": [[0, "open_gopro.api.params.LED.BLE_KEEP_ALIVE"]], "boost (hypersmoothmode attribute)": [[0, "open_gopro.api.params.HypersmoothMode.BOOST"]], "burst_photo (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.BURST_PHOTO"]], "busy (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.BUSY"]], "basegoprocommunicator (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.BaseGoProCommunicator"]], "bitdepth (class in open_gopro.api.params)": [[0, "open_gopro.api.params.BitDepth"]], "bitrate (class in open_gopro.api.params)": [[0, "open_gopro.api.params.BitRate"]], "bleclient (class in open_gopro.ble.client)": [[0, "open_gopro.ble.client.BleClient"]], "blecommands (class in open_gopro.api.ble_commands)": [[0, "open_gopro.api.ble_commands.BleCommands"]], "blemessage (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.BleMessage"]], "blemessages (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.BleMessages"]], "blesettingfacade (class in open_gopro.api.builders)": [[0, "open_gopro.api.builders.BleSettingFacade"]], "blesettingfacade.blesettingmessagebase (class in open_gopro.api.builders)": [[0, "open_gopro.api.builders.BleSettingFacade.BleSettingMessageBase"]], "blesettings (class in open_gopro.api.ble_commands)": [[0, "open_gopro.api.ble_commands.BleSettings"]], "blestatusfacade (class in open_gopro.api.builders)": [[0, "open_gopro.api.builders.BleStatusFacade"]], "blestatusfacade.blestatusmessagebase (class in open_gopro.api.builders)": [[0, "open_gopro.api.builders.BleStatusFacade.BleStatusMessageBase"]], "blestatuses (class in open_gopro.api.ble_commands)": [[0, "open_gopro.api.ble_commands.BleStatuses"]], "bleuuid (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.BleUUID"]], "bleuuid.format (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.BleUUID.Format"]], "builderprotocol (class in open_gopro.api.builders)": [[0, "open_gopro.api.builders.BuilderProtocol"]], "camera (cameracontrol attribute)": [[0, "open_gopro.api.params.CameraControl.CAMERA"]], "camera_control (statusid attribute)": [[0, "open_gopro.constants.StatusId.CAMERA_CONTROL"]], "camera_lens_type (statusid attribute)": [[0, "open_gopro.constants.StatusId.CAMERA_LENS_TYPE"]], "camera_ux_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.CAMERA_UX_MODE"]], "canceled (wapstate attribute)": [[0, "open_gopro.api.params.WAPState.CANCELED"]], "capture_delay (statusid attribute)": [[0, "open_gopro.constants.StatusId.CAPTURE_DELAY"]], "capt_delay_active (statusid attribute)": [[0, "open_gopro.constants.StatusId.CAPT_DELAY_ACTIVE"]], "cm_net_mgmt_comm (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CM_NET_MGMT_COMM"]], "cn_net_mgmt_resp (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CN_NET_MGMT_RESP"]], "command (featureid attribute)": [[0, "open_gopro.constants.FeatureId.COMMAND"]], "completed (pairstate attribute)": [[0, "open_gopro.api.params.PairState.COMPLETED"]], "completed (wapstate attribute)": [[0, "open_gopro.api.params.WAPState.COMPLETED"]], "com_timeout (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.COM_TIMEOUT"]], "connected (accmicstatus attribute)": [[0, "open_gopro.api.params.AccMicStatus.CONNECTED"]], "connected_and_plugged_in (accmicstatus attribute)": [[0, "open_gopro.api.params.AccMicStatus.CONNECTED_AND_PLUGGED_IN"]], "control_over_usb (statusid attribute)": [[0, "open_gopro.constants.StatusId.CONTROL_OVER_USB"]], "cq_command (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_COMMAND"]], "cq_command_resp (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_COMMAND_RESP"]], "cq_query (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_QUERY"]], "cq_query_resp (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_QUERY_RESP"]], "cq_sensor (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_SENSOR"]], "cq_sensor_resp (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_SENSOR_RESP"]], "cq_settings (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_SETTINGS"]], "cq_settings_resp (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.CQ_SETTINGS_RESP"]], "creating_preset (statusid attribute)": [[0, "open_gopro.constants.StatusId.CREATING_PRESET"]], "current_time_ms (statusid attribute)": [[0, "open_gopro.constants.StatusId.CURRENT_TIME_MS"]], "cameracontrol (class in open_gopro.api.params)": [[0, "open_gopro.api.params.CameraControl"]], "camerauxmode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.CameraUxMode"]], "charprops (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.CharProps"]], "characteristic (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.Characteristic"]], "cmdid (class in open_gopro.constants)": [[0, "open_gopro.constants.CmdId"]], "connectfailed": [[0, "open_gopro.exceptions.ConnectFailed"]], "connectionterminated": [[0, "open_gopro.exceptions.ConnectionTerminated"]], "default (maxlensmode attribute)": [[0, "open_gopro.api.params.MaxLensMode.DEFAULT"]], "digital_zoom (statusid attribute)": [[0, "open_gopro.constants.StatusId.DIGITAL_ZOOM"]], "dig_zoom_active (statusid attribute)": [[0, "open_gopro.constants.StatusId.DIG_ZOOM_ACTIVE"]], "disable (toggle attribute)": [[0, "open_gopro.api.params.Toggle.DISABLE"]], "disabled (exposuremode attribute)": [[0, "open_gopro.api.params.ExposureMode.DISABLED"]], "downloading (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.DOWNLOADING"]], "download_cancel_pend (statusid attribute)": [[0, "open_gopro.constants.StatusId.DOWNLOAD_CANCEL_PEND"]], "download_failed (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.DOWNLOAD_FAILED"]], "dual (lensmode attribute)": [[0, "open_gopro.api.params.LensMode.DUAL"]], "descriptor (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.Descriptor"]], "easy (camerauxmode attribute)": [[0, "open_gopro.api.params.CameraUxMode.EASY"]], "enable (toggle attribute)": [[0, "open_gopro.api.params.Toggle.ENABLE"]], "encoding (statusid attribute)": [[0, "open_gopro.constants.StatusId.ENCODING"]], "error (errorcode attribute)": [[0, "open_gopro.constants.ErrorCode.ERROR"]], "exec_stream (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.EXEC_STREAM"]], "exit (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.EXIT"]], "exposure_type (statusid attribute)": [[0, "open_gopro.constants.StatusId.EXPOSURE_TYPE"]], "exposure_x (statusid attribute)": [[0, "open_gopro.constants.StatusId.EXPOSURE_X"]], "exposure_y (statusid attribute)": [[0, "open_gopro.constants.StatusId.EXPOSURE_Y"]], "extended_battery (performancemode attribute)": [[0, "open_gopro.api.params.PerformanceMode.EXTENDED_BATTERY"]], "extended_battery (systemvideomode attribute)": [[0, "open_gopro.api.params.SystemVideoMode.EXTENDED_BATTERY"]], "extended_battery_green_icon (systemvideomode attribute)": [[0, "open_gopro.api.params.SystemVideoMode.EXTENDED_BATTERY_GREEN_ICON"]], "external (cameracontrol attribute)": [[0, "open_gopro.api.params.CameraControl.EXTERNAL"]], "easyaspectratio (class in open_gopro.api.params)": [[0, "open_gopro.api.params.EasyAspectRatio"]], "errorcode (class in open_gopro.constants)": [[0, "open_gopro.constants.ErrorCode"]], "exceptionhandler (in module open_gopro.exceptions)": [[0, "open_gopro.exceptions.ExceptionHandler"]], "exposuremode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.ExposureMode"]], "failed (pairstate attribute)": [[0, "open_gopro.api.params.PairState.FAILED"]], "first_time (statusid attribute)": [[0, "open_gopro.constants.StatusId.FIRST_TIME"]], "flatmode_id (statusid attribute)": [[0, "open_gopro.constants.StatusId.FLATMODE_ID"]], "format_error (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.FORMAT_ERROR"]], "fps (settingid attribute)": [[0, "open_gopro.constants.SettingId.FPS"]], "fps (class in open_gopro.api.params)": [[0, "open_gopro.api.params.FPS"]], "fps_100 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_100"]], "fps_120 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_120"]], "fps_200 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_200"]], "fps_24 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_24"]], "fps_240 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_240"]], "fps_25 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_25"]], "fps_30 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_30"]], "fps_50 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_50"]], "fps_60 (fps attribute)": [[0, "open_gopro.api.params.FPS.FPS_60"]], "framing (settingid attribute)": [[0, "open_gopro.constants.SettingId.FRAMING"]], "front_off_only (led attribute)": [[0, "open_gopro.api.params.LED.FRONT_OFF_ONLY"]], "full (framing attribute)": [[0, "open_gopro.api.params.Framing.FULL"]], "full (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.FULL"]], "failedtofinddevice": [[0, "open_gopro.exceptions.FailedToFindDevice"]], "featureid (class in open_gopro.constants)": [[0, "open_gopro.constants.FeatureId"]], "flatmode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.Flatmode"]], "framing (class in open_gopro.api.params)": [[0, "open_gopro.api.params.Framing"]], "get_ap_entries (actionid attribute)": [[0, "open_gopro.constants.ActionId.GET_AP_ENTRIES"]], "get_ap_entries_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.GET_AP_ENTRIES_RSP"]], "get_camera_capabilities (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_CAMERA_CAPABILITIES"]], "get_camera_settings (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_CAMERA_SETTINGS"]], "get_camera_statuses (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_CAMERA_STATUSES"]], "get_capabilities_name (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.GET_CAPABILITIES_NAME"]], "get_capabilities_val (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.GET_CAPABILITIES_VAL"]], "get_date_time (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_DATE_TIME"]], "get_date_time_dst (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_DATE_TIME_DST"]], "get_hw_info (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_HW_INFO"]], "get_livestream_status (actionid attribute)": [[0, "open_gopro.constants.ActionId.GET_LIVESTREAM_STATUS"]], "get_preset_status (actionid attribute)": [[0, "open_gopro.constants.ActionId.GET_PRESET_STATUS"]], "get_preset_status_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.GET_PRESET_STATUS_RSP"]], "get_settings_json (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_SETTINGS_JSON"]], "get_setting_name (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.GET_SETTING_NAME"]], "get_setting_val (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.GET_SETTING_VAL"]], "get_status_val (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.GET_STATUS_VAL"]], "get_third_party_api_version (cmdid attribute)": [[0, "open_gopro.constants.CmdId.GET_THIRD_PARTY_API_VERSION"]], "gopro_app_downloading (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.GOPRO_APP_DOWNLOADING"]], "gopro_app_download_failed (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.GOPRO_APP_DOWNLOAD_FAILED"]], "gopro_app_ready (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.GOPRO_APP_READY"]], "gopro_app_verifying (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.GOPRO_APP_VERIFYING"]], "gopro_app_verify_failed (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.GOPRO_APP_VERIFY_FAILED"]], "gps_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.GPS_STAT"]], "gattdb (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.GattDB"]], "gattdb.characteristicview (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.GattDB.CharacteristicView"]], "goprobase (class in open_gopro.gopro_base)": [[0, "open_gopro.gopro_base.GoProBase"]], "goproble (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.GoProBle"]], "goproenum (class in open_gopro.enum)": [[0, "open_gopro.enum.GoProEnum"]], "goproerror": [[0, "open_gopro.exceptions.GoProError"]], "goprohttp (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.GoProHttp"]], "goprointenum (class in open_gopro.enum)": [[0, "open_gopro.enum.GoProIntEnum"]], "gopronotopened": [[0, "open_gopro.exceptions.GoProNotOpened"]], "goproresp (class in open_gopro.models.response)": [[0, "open_gopro.models.response.GoProResp"]], "goproresp.protocol (class in open_gopro.models.response)": [[0, "open_gopro.models.response.GoProResp.Protocol"]], "goprouuids (class in open_gopro.constants)": [[0, "open_gopro.constants.GoProUUIDs"]], "goprowifi (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.GoProWifi"]], "goprowiredinterface (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.GoProWiredInterface"]], "goprowirelessinterface (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.GoProWirelessInterface"]], "hdr (videoprofile attribute)": [[0, "open_gopro.api.params.VideoProfile.HDR"]], "hemisphere (exposuremode attribute)": [[0, "open_gopro.api.params.ExposureMode.HEMISPHERE"]], "high (bitrate attribute)": [[0, "open_gopro.api.params.BitRate.HIGH"]], "high (hypersmoothmode attribute)": [[0, "open_gopro.api.params.HypersmoothMode.HIGH"]], "highest (videomode attribute)": [[0, "open_gopro.api.params.VideoMode.HIGHEST"]], "highest_quality (systemvideomode attribute)": [[0, "open_gopro.api.params.SystemVideoMode.HIGHEST_QUALITY"]], "high_power_preview (webcamstatus attribute)": [[0, "open_gopro.constants.WebcamStatus.HIGH_POWER_PREVIEW"]], "hindsight (settingid attribute)": [[0, "open_gopro.constants.SettingId.HINDSIGHT"]], "hour_1 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.HOUR_1"]], "hour_2 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.HOUR_2"]], "hour_3 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.HOUR_3"]], "hypersmooth (settingid attribute)": [[0, "open_gopro.constants.SettingId.HYPERSMOOTH"]], "hyperview (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.HYPERVIEW"]], "hyperview (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.HYPERVIEW"]], "hz_50 (antiflicker attribute)": [[0, "open_gopro.api.params.AntiFlicker.HZ_50"]], "hz_60 (antiflicker attribute)": [[0, "open_gopro.api.params.AntiFlicker.HZ_60"]], "hindsight (class in open_gopro.api.params)": [[0, "open_gopro.api.params.Hindsight"]], "horizonleveling (class in open_gopro.api.params)": [[0, "open_gopro.api.params.HorizonLeveling"]], "httpcommands (class in open_gopro.api.http_commands)": [[0, "open_gopro.api.http_commands.HttpCommands"]], "httpmessage (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.HttpMessage"]], "httpmessages (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.HttpMessages"]], "httpsetting (class in open_gopro.api.builders)": [[0, "open_gopro.api.builders.HttpSetting"]], "httpsettings (class in open_gopro.api.http_commands)": [[0, "open_gopro.api.http_commands.HttpSettings"]], "hypersmoothmode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.HypersmoothMode"]], "idle (cameracontrol attribute)": [[0, "open_gopro.api.params.CameraControl.IDLE"]], "idle (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.IDLE"]], "idle (webcamstatus attribute)": [[0, "open_gopro.constants.WebcamStatus.IDLE"]], "int_batt_per (statusid attribute)": [[0, "open_gopro.constants.StatusId.INT_BATT_PER"]], "invalid_for_testing (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.INVALID_FOR_TESTING"]], "invalid_for_testing (settingid attribute)": [[0, "open_gopro.constants.SettingId.INVALID_FOR_TESTING"]], "invalid_param (errorcode attribute)": [[0, "open_gopro.constants.ErrorCode.INVALID_PARAM"]], "invalid_param (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.INVALID_PARAM"]], "in_context_menu (statusid attribute)": [[0, "open_gopro.constants.StatusId.IN_CONTEXT_MENU"]], "in_progress (pairstate attribute)": [[0, "open_gopro.api.params.PairState.IN_PROGRESS"]], "iso_lock (exposuremode attribute)": [[0, "open_gopro.api.params.ExposureMode.ISO_LOCK"]], "interfaceconfigfailure": [[0, "open_gopro.exceptions.InterfaceConfigFailure"]], "invalidconfiguration": [[0, "open_gopro.exceptions.InvalidConfiguration"]], "invalidopengoproversion": [[0, "open_gopro.exceptions.InvalidOpenGoProVersion"]], "last_hilight (statusid attribute)": [[0, "open_gopro.constants.StatusId.LAST_HILIGHT"]], "lcd_lock_active (statusid attribute)": [[0, "open_gopro.constants.StatusId.LCD_LOCK_ACTIVE"]], "led (settingid attribute)": [[0, "open_gopro.constants.SettingId.LED"]], "led (class in open_gopro.api.params)": [[0, "open_gopro.api.params.LED"]], "led_2 (led attribute)": [[0, "open_gopro.api.params.LED.LED_2"]], "light_painting (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.LIGHT_PAINTING"]], "linear (multishotfov attribute)": [[0, "open_gopro.api.params.MultishotFOV.LINEAR"]], "linear (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.LINEAR"]], "linear (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.LINEAR"]], "linear (webcamfov attribute)": [[0, "open_gopro.api.params.WebcamFOV.LINEAR"]], "linear_horizon (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.LINEAR_HORIZON"]], "linear_horizon_leveling (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.LINEAR_HORIZON_LEVELING"]], "linear_horizon_lock (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.LINEAR_HORIZON_LOCK"]], "linux_core_active (statusid attribute)": [[0, "open_gopro.constants.StatusId.LINUX_CORE_ACTIVE"]], "livestream_status_notif (actionid attribute)": [[0, "open_gopro.constants.ActionId.LIVESTREAM_STATUS_NOTIF"]], "livestream_status_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.LIVESTREAM_STATUS_RSP"]], "live_burst (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.LIVE_BURST"]], "live_burst_rem (statusid attribute)": [[0, "open_gopro.constants.StatusId.LIVE_BURST_REM"]], "live_burst_total (statusid attribute)": [[0, "open_gopro.constants.StatusId.LIVE_BURST_TOTAL"]], "load_preset (cmdid attribute)": [[0, "open_gopro.constants.CmdId.LOAD_PRESET"]], "load_preset_group (cmdid attribute)": [[0, "open_gopro.constants.CmdId.LOAD_PRESET_GROUP"]], "locate_active (statusid attribute)": [[0, "open_gopro.constants.StatusId.LOCATE_ACTIVE"]], "locked (horizonleveling attribute)": [[0, "open_gopro.api.params.HorizonLeveling.LOCKED"]], "log (videoprofile attribute)": [[0, "open_gopro.api.params.VideoProfile.LOG"]], "logs_ready (statusid attribute)": [[0, "open_gopro.constants.StatusId.LOGS_READY"]], "long (startraillength attribute)": [[0, "open_gopro.api.params.StarTrailLength.LONG"]], "longest_battery_green_icon (systemvideomode attribute)": [[0, "open_gopro.api.params.SystemVideoMode.LONGEST_BATTERY_GREEN_ICON"]], "looping (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.LOOPING"]], "low_power_preview (webcamstatus attribute)": [[0, "open_gopro.constants.WebcamStatus.LOW_POWER_PREVIEW"]], "lensmode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.LensMode"]], "max (startraillength attribute)": [[0, "open_gopro.api.params.StarTrailLength.MAX"]], "max_hyperview (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.MAX_HYPERVIEW"]], "max_lens (maxlensmode attribute)": [[0, "open_gopro.api.params.MaxLensMode.MAX_LENS"]], "max_lens_mod (settingid attribute)": [[0, "open_gopro.constants.SettingId.MAX_LENS_MOD"]], "max_light_painting (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.MAX_LIGHT_PAINTING"]], "max_performance (performancemode attribute)": [[0, "open_gopro.api.params.PerformanceMode.MAX_PERFORMANCE"]], "max_star_trails (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.MAX_STAR_TRAILS"]], "max_superview (multishotfov attribute)": [[0, "open_gopro.api.params.MultishotFOV.MAX_SUPERVIEW"]], "max_superview (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.MAX_SUPERVIEW"]], "max_superview (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.MAX_SUPERVIEW"]], "max_timewarp (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.MAX_TIMEWARP"]], "max_vehicle_lights (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.MAX_VEHICLE_LIGHTS"]], "media_format (settingid attribute)": [[0, "open_gopro.constants.SettingId.MEDIA_FORMAT"]], "media_mod_mic_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.MEDIA_MOD_MIC_STAT"]], "media_mod_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.MEDIA_MOD_STAT"]], "min_1 (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.MIN_1"]], "min_1 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.MIN_1"]], "min_15 (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.MIN_15"]], "min_15 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.MIN_15"]], "min_30 (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.MIN_30"]], "min_30 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.MIN_30"]], "min_5 (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.MIN_5"]], "min_5 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.MIN_5"]], "mobile (easyaspectratio attribute)": [[0, "open_gopro.api.params.EasyAspectRatio.MOBILE"]], "mobile_video (statusid attribute)": [[0, "open_gopro.constants.StatusId.MOBILE_VIDEO"]], "mode_group (statusid attribute)": [[0, "open_gopro.constants.StatusId.MODE_GROUP"]], "multi_count_down (statusid attribute)": [[0, "open_gopro.constants.StatusId.MULTI_COUNT_DOWN"]], "multi_shot_easy_aspect_ratio (settingid attribute)": [[0, "open_gopro.constants.SettingId.MULTI_SHOT_EASY_ASPECT_RATIO"]], "multi_shot_fov (settingid attribute)": [[0, "open_gopro.constants.SettingId.MULTI_SHOT_FOV"]], "multi_shot_nlv_aspect_ratio (settingid attribute)": [[0, "open_gopro.constants.SettingId.MULTI_SHOT_NLV_ASPECT_RATIO"]], "maxlensmodtype (class in open_gopro.api.params)": [[0, "open_gopro.api.params.MaxLensModType"]], "maxlensmode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.MaxLensMode"]], "mediaformat (class in open_gopro.api.params)": [[0, "open_gopro.api.params.MediaFormat"]], "mediamodmicstatus (class in open_gopro.api.params)": [[0, "open_gopro.api.params.MediaModMicStatus"]], "mediamodstatus (class in open_gopro.api.params)": [[0, "open_gopro.api.params.MediaModStatus"]], "message (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.Message"]], "messagerules (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.MessageRules"]], "messagerules.analyzer (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.MessageRules.Analyzer"]], "messages (class in open_gopro.communicator_interface)": [[0, "open_gopro.communicator_interface.Messages"]], "multishotfov (class in open_gopro.api.params)": [[0, "open_gopro.api.params.MultishotFOV"]], "narrow (multishotfov attribute)": [[0, "open_gopro.api.params.MultishotFOV.NARROW"]], "narrow (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.NARROW"]], "narrow (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.NARROW"]], "narrow (webcamfov attribute)": [[0, "open_gopro.api.params.WebcamFOV.NARROW"]], "network_management (featureid attribute)": [[0, "open_gopro.constants.FeatureId.NETWORK_MANAGEMENT"]], "never (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.NEVER"]], "never_started (wapstate attribute)": [[0, "open_gopro.api.params.WAPState.NEVER_STARTED"]], "next_poll (statusid attribute)": [[0, "open_gopro.constants.StatusId.NEXT_POLL"]], "night (photomode attribute)": [[0, "open_gopro.api.params.PhotoMode.NIGHT"]], "night_lapse_photo (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.NIGHT_LAPSE_PHOTO"]], "night_lapse_photo (mediaformat attribute)": [[0, "open_gopro.api.params.MediaFormat.NIGHT_LAPSE_PHOTO"]], "night_lapse_video (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.NIGHT_LAPSE_VIDEO"]], "night_lapse_video (mediaformat attribute)": [[0, "open_gopro.api.params.MediaFormat.NIGHT_LAPSE_VIDEO"]], "night_photo (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.NIGHT_PHOTO"]], "night_photo (photoeasymode attribute)": [[0, "open_gopro.api.params.PhotoEasyMode.NIGHT_PHOTO"]], "none (maxlensmodtype attribute)": [[0, "open_gopro.api.params.MaxLensModType.NONE"]], "notif_provis_state (actionid attribute)": [[0, "open_gopro.constants.ActionId.NOTIF_PROVIS_STATE"]], "notif_start_scan (actionid attribute)": [[0, "open_gopro.constants.ActionId.NOTIF_START_SCAN"]], "not_applicable (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.NOT_APPLICABLE"]], "not_applicable (multishotfov attribute)": [[0, "open_gopro.api.params.MultishotFOV.NOT_APPLICABLE"]], "not_applicable (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.NOT_APPLICABLE"]], "not_applicable (resolution attribute)": [[0, "open_gopro.api.params.Resolution.NOT_APPLICABLE"]], "not_applicable (startraillength attribute)": [[0, "open_gopro.api.params.StarTrailLength.NOT_APPLICABLE"]], "not_applicable (webcamresolution attribute)": [[0, "open_gopro.api.params.WebcamResolution.NOT_APPLICABLE"]], "not_connected (accmicstatus attribute)": [[0, "open_gopro.api.params.AccMicStatus.NOT_CONNECTED"]], "not_pairing (pairtype attribute)": [[0, "open_gopro.api.params.PairType.NOT_PAIRING"]], "not_ready (analyticsstate attribute)": [[0, "open_gopro.api.params.AnalyticsState.NOT_READY"]], "not_started (pairstate attribute)": [[0, "open_gopro.api.params.PairState.NOT_STARTED"]], "num_group_photo (statusid attribute)": [[0, "open_gopro.constants.StatusId.NUM_GROUP_PHOTO"]], "num_group_video (statusid attribute)": [[0, "open_gopro.constants.StatusId.NUM_GROUP_VIDEO"]], "num_hilights (statusid attribute)": [[0, "open_gopro.constants.StatusId.NUM_HILIGHTS"]], "num_total_photo (statusid attribute)": [[0, "open_gopro.constants.StatusId.NUM_TOTAL_PHOTO"]], "num_total_video (statusid attribute)": [[0, "open_gopro.constants.StatusId.NUM_TOTAL_VIDEO"]], "off (hindsight attribute)": [[0, "open_gopro.api.params.Hindsight.OFF"]], "off (horizonleveling attribute)": [[0, "open_gopro.api.params.HorizonLeveling.OFF"]], "off (hypersmoothmode attribute)": [[0, "open_gopro.api.params.HypersmoothMode.OFF"]], "off (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.OFF"]], "off (photoeasymode attribute)": [[0, "open_gopro.api.params.PhotoEasyMode.OFF"]], "off (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.OFF"]], "off (webcamstatus attribute)": [[0, "open_gopro.constants.WebcamStatus.OFF"]], "ok (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.OK"]], "on (horizonleveling attribute)": [[0, "open_gopro.api.params.HorizonLeveling.ON"]], "on (hypersmoothmode attribute)": [[0, "open_gopro.api.params.HypersmoothMode.ON"]], "on (photoeasymode attribute)": [[0, "open_gopro.api.params.PhotoEasyMode.ON"]], "only (mediamodmicstatus attribute)": [[0, "open_gopro.api.params.MediaModMicStatus.ONLY"]], "on_connect (analyticsstate attribute)": [[0, "open_gopro.api.params.AnalyticsState.ON_CONNECT"]], "on_left_side (orientation attribute)": [[0, "open_gopro.api.params.Orientation.ON_LEFT_SIDE"]], "on_right_side (orientation attribute)": [[0, "open_gopro.api.params.Orientation.ON_RIGHT_SIDE"]], "orientation (statusid attribute)": [[0, "open_gopro.constants.StatusId.ORIENTATION"]], "otastatus (class in open_gopro.api.params)": [[0, "open_gopro.api.params.OTAStatus"]], "ota_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.OTA_STAT"]], "orientation (class in open_gopro.api.params)": [[0, "open_gopro.api.params.Orientation"]], "pairing_app (pairtype attribute)": [[0, "open_gopro.api.params.PairType.PAIRING_APP"]], "pairing_bluetooth (pairtype attribute)": [[0, "open_gopro.api.params.PairType.PAIRING_BLUETOOTH"]], "pairing_remote_control (pairtype attribute)": [[0, "open_gopro.api.params.PairType.PAIRING_REMOTE_CONTROL"]], "pair_state (statusid attribute)": [[0, "open_gopro.constants.StatusId.PAIR_STATE"]], "pair_state2 (statusid attribute)": [[0, "open_gopro.constants.StatusId.PAIR_STATE2"]], "pair_time (statusid attribute)": [[0, "open_gopro.constants.StatusId.PAIR_TIME"]], "pair_type (statusid attribute)": [[0, "open_gopro.constants.StatusId.PAIR_TYPE"]], "photo (presetgroup attribute)": [[0, "open_gopro.api.params.PresetGroup.PHOTO"]], "photos_rem (statusid attribute)": [[0, "open_gopro.constants.StatusId.PHOTOS_REM"]], "photo_easy_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.PHOTO_EASY_MODE"]], "photo_fov (settingid attribute)": [[0, "open_gopro.constants.SettingId.PHOTO_FOV"]], "photo_horizon_leveling (settingid attribute)": [[0, "open_gopro.constants.SettingId.PHOTO_HORIZON_LEVELING"]], "photo_interval (settingid attribute)": [[0, "open_gopro.constants.SettingId.PHOTO_INTERVAL"]], "photo_interval_duration (settingid attribute)": [[0, "open_gopro.constants.SettingId.PHOTO_INTERVAL_DURATION"]], "photo_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.PHOTO_MODE"]], "photo_presets (statusid attribute)": [[0, "open_gopro.constants.StatusId.PHOTO_PRESETS"]], "power_down (cmdid attribute)": [[0, "open_gopro.constants.CmdId.POWER_DOWN"]], "presets_group (statusid attribute)": [[0, "open_gopro.constants.StatusId.PRESETS_GROUP"]], "preset_modified (statusid attribute)": [[0, "open_gopro.constants.StatusId.PRESET_MODIFIED"]], "preset_modified_notification (actionid attribute)": [[0, "open_gopro.constants.ActionId.PRESET_MODIFIED_NOTIFICATION"]], "preview_enabled (statusid attribute)": [[0, "open_gopro.constants.StatusId.PREVIEW_ENABLED"]], "pro (camerauxmode attribute)": [[0, "open_gopro.api.params.CameraUxMode.PRO"]], "protobuf_query (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.PROTOBUF_QUERY"]], "protobuf_setting (settingid attribute)": [[0, "open_gopro.constants.SettingId.PROTOBUF_SETTING"]], "pairstate (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PairState"]], "pairtype (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PairType"]], "performancemode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PerformanceMode"]], "photoduration (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PhotoDuration"]], "photoeasymode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PhotoEasyMode"]], "photofov (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PhotoFOV"]], "photointerval (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PhotoInterval"]], "photomode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PhotoMode"]], "presetgroup (class in open_gopro.api.params)": [[0, "open_gopro.api.params.PresetGroup"]], "query (featureid attribute)": [[0, "open_gopro.constants.FeatureId.QUERY"]], "quick_capture (statusid attribute)": [[0, "open_gopro.constants.StatusId.QUICK_CAPTURE"]], "querycmdid (class in open_gopro.constants)": [[0, "open_gopro.constants.QueryCmdId"]], "ratio_16_9 (videoaspectratio attribute)": [[0, "open_gopro.api.params.VideoAspectRatio.RATIO_16_9"]], "ratio_4_3 (videoaspectratio attribute)": [[0, "open_gopro.api.params.VideoAspectRatio.RATIO_4_3"]], "ratio_8_7 (videoaspectratio attribute)": [[0, "open_gopro.api.params.VideoAspectRatio.RATIO_8_7"]], "ratio_9_16 (videoaspectratio attribute)": [[0, "open_gopro.api.params.VideoAspectRatio.RATIO_9_16"]], "ready (analyticsstate attribute)": [[0, "open_gopro.api.params.AnalyticsState.READY"]], "ready (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.READY"]], "register_all_capabilities (cmdid attribute)": [[0, "open_gopro.constants.CmdId.REGISTER_ALL_CAPABILITIES"]], "register_all_settings (cmdid attribute)": [[0, "open_gopro.constants.CmdId.REGISTER_ALL_SETTINGS"]], "register_all_statuses (cmdid attribute)": [[0, "open_gopro.constants.CmdId.REGISTER_ALL_STATUSES"]], "reg_capabilities_update (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.REG_CAPABILITIES_UPDATE"]], "reg_setting_val_update (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.REG_SETTING_VAL_UPDATE"]], "reg_status_val_update (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.REG_STATUS_VAL_UPDATE"]], "release_network (actionid attribute)": [[0, "open_gopro.constants.ActionId.RELEASE_NETWORK"]], "release_network_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.RELEASE_NETWORK_RSP"]], "remote_ctrl_conn (statusid attribute)": [[0, "open_gopro.constants.StatusId.REMOTE_CTRL_CONN"]], "remote_ctrl_ver (statusid attribute)": [[0, "open_gopro.constants.StatusId.REMOTE_CTRL_VER"]], "removed (mediamodmicstatus attribute)": [[0, "open_gopro.api.params.MediaModMicStatus.REMOVED"]], "removed (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.REMOVED"]], "request_clear_cohn_cert (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_CLEAR_COHN_CERT"]], "request_cohn_setting (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_COHN_SETTING"]], "request_create_cohn_cert (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_CREATE_COHN_CERT"]], "request_get_cohn_cert (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_GET_COHN_CERT"]], "request_get_cohn_status (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_GET_COHN_STATUS"]], "request_get_last_media (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_GET_LAST_MEDIA"]], "request_preset_update_custom (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_PRESET_UPDATE_CUSTOM"]], "request_wifi_connect (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_WIFI_CONNECT"]], "request_wifi_connect_new (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_WIFI_CONNECT_NEW"]], "request_wifi_connect_new_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_WIFI_CONNECT_NEW_RSP"]], "request_wifi_connect_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.REQUEST_WIFI_CONNECT_RSP"]], "resolution (settingid attribute)": [[0, "open_gopro.constants.SettingId.RESOLUTION"]], "response_clear_cohn_cert (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_CLEAR_COHN_CERT"]], "response_cohn_setting (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_COHN_SETTING"]], "response_create_cohn_cert (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_CREATE_COHN_CERT"]], "response_get_cohn_cert (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_GET_COHN_CERT"]], "response_get_cohn_status (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_GET_COHN_STATUS"]], "response_get_last_media (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_GET_LAST_MEDIA"]], "response_preset_update_custom (actionid attribute)": [[0, "open_gopro.constants.ActionId.RESPONSE_PRESET_UPDATE_CUSTOM"]], "res_1080 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_1080"]], "res_1080 (webcamresolution attribute)": [[0, "open_gopro.api.params.WebcamResolution.RES_1080"]], "res_1080_16_9 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_1080_16_9"]], "res_1080_8_7 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_1080_8_7"]], "res_1080_9_16 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_1080_9_16"]], "res_1440 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_1440"]], "res_2_7k (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_2_7K"]], "res_2_7k_16_9 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_2_7K_16_9"]], "res_2_7k_4_3 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_2_7K_4_3"]], "res_2_7k_4_3_todo (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_2_7K_4_3_TODO"]], "res_2_7_k_8_7 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_2_7_K_8_7"]], "res_480 (webcamresolution attribute)": [[0, "open_gopro.api.params.WebcamResolution.RES_480"]], "res_4k (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K"]], "res_4k_16_9 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_16_9"]], "res_4k_4_3 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_4_3"]], "res_4k_4_3_todo (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_4_3_TODO"]], "res_4k_8_7 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_8_7"]], "res_4k_8_7_ (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_8_7_"]], "res_4k_8_7_legacy (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_8_7_LEGACY"]], "res_4k_9_16 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_4K_9_16"]], "res_5k (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5K"]], "res_5k_4_3 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5K_4_3"]], "res_5_3k (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5_3K"]], "res_5_3k_16_9 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5_3K_16_9"]], "res_5_3k_4_3 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5_3K_4_3"]], "res_5_3k_8_7 (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5_3K_8_7"]], "res_5_3k_8_7_legacy (resolution attribute)": [[0, "open_gopro.api.params.Resolution.RES_5_3K_8_7_LEGACY"]], "res_720 (webcamresolution attribute)": [[0, "open_gopro.api.params.WebcamResolution.RES_720"]], "rtsp (webcamprotocol attribute)": [[0, "open_gopro.api.params.WebcamProtocol.RTSP"]], "resolution (class in open_gopro.api.params)": [[0, "open_gopro.api.params.Resolution"]], "responseparseerror": [[0, "open_gopro.exceptions.ResponseParseError"]], "responsetimeout": [[0, "open_gopro.exceptions.ResponseTimeout"]], "scan_wifi_networks (actionid attribute)": [[0, "open_gopro.constants.ActionId.SCAN_WIFI_NETWORKS"]], "scan_wifi_networks_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.SCAN_WIFI_NETWORKS_RSP"]], "scheduled_capture (statusid attribute)": [[0, "open_gopro.constants.StatusId.SCHEDULED_CAPTURE"]], "scheduled_preset (statusid attribute)": [[0, "open_gopro.constants.StatusId.SCHEDULED_PRESET"]], "sdstatus (class in open_gopro.api.params)": [[0, "open_gopro.api.params.SDStatus"]], "sd_rating_check_error (statusid attribute)": [[0, "open_gopro.constants.StatusId.SD_RATING_CHECK_ERROR"]], "sd_status (statusid attribute)": [[0, "open_gopro.constants.StatusId.SD_STATUS"]], "sd_write_speed_error (statusid attribute)": [[0, "open_gopro.constants.StatusId.SD_WRITE_SPEED_ERROR"]], "sec_0_5 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_0_5"]], "sec_1 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_1"]], "sec_10 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_10"]], "sec_120 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_120"]], "sec_15 (hindsight attribute)": [[0, "open_gopro.api.params.Hindsight.SEC_15"]], "sec_15 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.SEC_15"]], "sec_2 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_2"]], "sec_3 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_3"]], "sec_30 (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.SEC_30"]], "sec_30 (hindsight attribute)": [[0, "open_gopro.api.params.Hindsight.SEC_30"]], "sec_30 (photoduration attribute)": [[0, "open_gopro.api.params.PhotoDuration.SEC_30"]], "sec_30 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_30"]], "sec_5 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_5"]], "sec_60 (photointerval attribute)": [[0, "open_gopro.api.params.PhotoInterval.SEC_60"]], "sec_8 (autooff attribute)": [[0, "open_gopro.api.params.AutoOff.SEC_8"]], "sec_sd_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.SEC_SD_STAT"]], "selfie_0_hdmi_0_mediamodconnected_false (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_0_HDMI_0_MEDIAMODCONNECTED_FALSE"]], "selfie_0_hdmi_0_mediamodconnected_true (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_0_HDMI_0_MEDIAMODCONNECTED_TRUE"]], "selfie_0_hdmi_1_mediamodconnected_false (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_0_HDMI_1_MEDIAMODCONNECTED_FALSE"]], "selfie_0_hdmi_1_mediamodconnected_true (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_0_HDMI_1_MEDIAMODCONNECTED_TRUE"]], "selfie_1_hdmi_0_mediamodconnected_false (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_1_HDMI_0_MEDIAMODCONNECTED_FALSE"]], "selfie_1_hdmi_0_mediamodconnected_true (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_1_HDMI_0_MEDIAMODCONNECTED_TRUE"]], "selfie_1_hdmi_1_mediamodconnected_false (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_1_HDMI_1_MEDIAMODCONNECTED_FALSE"]], "selfie_1_hdmi_1_mediamodconnected_true (mediamodstatus attribute)": [[0, "open_gopro.api.params.MediaModStatus.SELFIE_1_HDMI_1_MEDIAMODCONNECTED_TRUE"]], "setting (featureid attribute)": [[0, "open_gopro.constants.FeatureId.SETTING"]], "setting_capability_push (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.SETTING_CAPABILITY_PUSH"]], "setting_val_push (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.SETTING_VAL_PUSH"]], "set_camera_control (actionid attribute)": [[0, "open_gopro.constants.ActionId.SET_CAMERA_CONTROL"]], "set_camera_control_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.SET_CAMERA_CONTROL_RSP"]], "set_date_time (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SET_DATE_TIME"]], "set_date_time_dst (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SET_DATE_TIME_DST"]], "set_livestream_mode (actionid attribute)": [[0, "open_gopro.constants.ActionId.SET_LIVESTREAM_MODE"]], "set_livestream_mode_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.SET_LIVESTREAM_MODE_RSP"]], "set_pairing_complete (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SET_PAIRING_COMPLETE"]], "set_preset (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.SET_PRESET"]], "set_shutter (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SET_SHUTTER"]], "set_third_party_client_info (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SET_THIRD_PARTY_CLIENT_INFO"]], "set_turbo_mode (actionid attribute)": [[0, "open_gopro.constants.ActionId.SET_TURBO_MODE"]], "set_turbo_mode_rsp (actionid attribute)": [[0, "open_gopro.constants.ActionId.SET_TURBO_MODE_RSP"]], "set_wifi (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SET_WIFI"]], "set_window_size (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.SET_WINDOW_SIZE"]], "short (startraillength attribute)": [[0, "open_gopro.api.params.StarTrailLength.SHORT"]], "shutter (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.SHUTTER"]], "single (lensmode attribute)": [[0, "open_gopro.api.params.LensMode.SINGLE"]], "single_photo (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.SINGLE_PHOTO"]], "sleep (cmdid attribute)": [[0, "open_gopro.constants.CmdId.SLEEP"]], "slo_mo (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.SLO_MO"]], "space_rem (statusid attribute)": [[0, "open_gopro.constants.StatusId.SPACE_REM"]], "speed_10x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_10X"]], "speed_150x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_150X"]], "speed_15x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_15X"]], "speed_1800x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_1800X"]], "speed_1x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_1X"]], "speed_2x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_2X"]], "speed_300x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_300X"]], "speed_30x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_30X"]], "speed_5x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_5X"]], "speed_60x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_60X"]], "speed_900x (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_900X"]], "speed_auto (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_AUTO"]], "speed_half (timewarpspeed attribute)": [[0, "open_gopro.api.params.TimeWarpSpeed.SPEED_HALF"]], "standard (bitrate attribute)": [[0, "open_gopro.api.params.BitRate.STANDARD"]], "standard (hypersmoothmode attribute)": [[0, "open_gopro.api.params.HypersmoothMode.STANDARD"]], "standard (videomode attribute)": [[0, "open_gopro.api.params.VideoMode.STANDARD"]], "standard (videoprofile attribute)": [[0, "open_gopro.api.params.VideoProfile.STANDARD"]], "started (wapstate attribute)": [[0, "open_gopro.api.params.WAPState.STARTED"]], "star_trails (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.STAR_TRAILS"]], "star_trail_length (settingid attribute)": [[0, "open_gopro.constants.SettingId.STAR_TRAIL_LENGTH"]], "stationary (performancemode attribute)": [[0, "open_gopro.api.params.PerformanceMode.STATIONARY"]], "status_val_push (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.STATUS_VAL_PUSH"]], "stopped (pairstate attribute)": [[0, "open_gopro.api.params.PairState.STOPPED"]], "streaming_supp (statusid attribute)": [[0, "open_gopro.constants.StatusId.STREAMING_SUPP"]], "success (errorcode attribute)": [[0, "open_gopro.constants.ErrorCode.SUCCESS"]], "success (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.SUCCESS"]], "super (photomode attribute)": [[0, "open_gopro.api.params.PhotoMode.SUPER"]], "superview (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.SUPERVIEW"]], "superview (webcamfov attribute)": [[0, "open_gopro.api.params.WebcamFOV.SUPERVIEW"]], "super_photo (photoeasymode attribute)": [[0, "open_gopro.api.params.PhotoEasyMode.SUPER_PHOTO"]], "swapped (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.SWAPPED"]], "system_busy (statusid attribute)": [[0, "open_gopro.constants.StatusId.SYSTEM_BUSY"]], "system_hot (statusid attribute)": [[0, "open_gopro.constants.StatusId.SYSTEM_HOT"]], "system_ready (statusid attribute)": [[0, "open_gopro.constants.StatusId.SYSTEM_READY"]], "system_video_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.SYSTEM_VIDEO_MODE"]], "s_camera_management (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.S_CAMERA_MANAGEMENT"]], "s_control_query (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.S_CONTROL_QUERY"]], "s_wifi_access_point (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.S_WIFI_ACCESS_POINT"]], "service (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.Service"]], "settingid (class in open_gopro.constants)": [[0, "open_gopro.constants.SettingId"]], "specuuidnumber (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.SpecUuidNumber"]], "ssidstate (class in open_gopro.wifi.controller)": [[0, "open_gopro.wifi.controller.SsidState"]], "startraillength (class in open_gopro.api.params)": [[0, "open_gopro.api.params.StarTrailLength"]], "statusid (class in open_gopro.constants)": [[0, "open_gopro.constants.StatusId"]], "systemvideomode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.SystemVideoMode"]], "tag_hilight (cmdid attribute)": [[0, "open_gopro.constants.CmdId.TAG_HILIGHT"]], "timelapse (presetgroup attribute)": [[0, "open_gopro.api.params.PresetGroup.TIMELAPSE"]], "timelapse_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.TIMELAPSE_MODE"]], "timelapse_presets (statusid attribute)": [[0, "open_gopro.constants.StatusId.TIMELAPSE_PRESETS"]], "timelapse_rem (statusid attribute)": [[0, "open_gopro.constants.StatusId.TIMELAPSE_REM"]], "timewarp (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.TIMEWARP"]], "timewarp_speed_ramp (statusid attribute)": [[0, "open_gopro.constants.StatusId.TIMEWARP_SPEED_RAMP"]], "time_lapse_photo (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.TIME_LAPSE_PHOTO"]], "time_lapse_photo (mediaformat attribute)": [[0, "open_gopro.api.params.MediaFormat.TIME_LAPSE_PHOTO"]], "time_lapse_video (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.TIME_LAPSE_VIDEO"]], "time_lapse_video (mediaformat attribute)": [[0, "open_gopro.api.params.MediaFormat.TIME_LAPSE_VIDEO"]], "time_warp_video (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.TIME_WARP_VIDEO"]], "total_sd_space_kb (statusid attribute)": [[0, "open_gopro.constants.StatusId.TOTAL_SD_SPACE_KB"]], "ts (webcamprotocol attribute)": [[0, "open_gopro.api.params.WebcamProtocol.TS"]], "turbo_mode (statusid attribute)": [[0, "open_gopro.constants.StatusId.TURBO_MODE"]], "timewarpspeed (class in open_gopro.api.params)": [[0, "open_gopro.api.params.TimeWarpSpeed"]], "timelapsemode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.TimelapseMode"]], "toggle (class in open_gopro.api.params)": [[0, "open_gopro.api.params.Toggle"]], "unavailable (webcamerror attribute)": [[0, "open_gopro.constants.WebcamError.UNAVAILABLE"]], "universal (easyaspectratio attribute)": [[0, "open_gopro.api.params.EasyAspectRatio.UNIVERSAL"]], "unknown (errorcode attribute)": [[0, "open_gopro.constants.ErrorCode.UNKNOWN"]], "unknown (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.UNKNOWN"]], "unknown (sdstatus attribute)": [[0, "open_gopro.api.params.SDStatus.UNKNOWN"]], "unregister_all_capabilities (cmdid attribute)": [[0, "open_gopro.constants.CmdId.UNREGISTER_ALL_CAPABILITIES"]], "unregister_all_settings (cmdid attribute)": [[0, "open_gopro.constants.CmdId.UNREGISTER_ALL_SETTINGS"]], "unregister_all_statuses (cmdid attribute)": [[0, "open_gopro.constants.CmdId.UNREGISTER_ALL_STATUSES"]], "unreg_capabilities_update (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.UNREG_CAPABILITIES_UPDATE"]], "unreg_setting_val_update (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.UNREG_SETTING_VAL_UPDATE"]], "unreg_status_val_update (querycmdid attribute)": [[0, "open_gopro.constants.QueryCmdId.UNREG_STATUS_VAL_UPDATE"]], "upright (orientation attribute)": [[0, "open_gopro.api.params.Orientation.UPRIGHT"]], "upside_down (orientation attribute)": [[0, "open_gopro.api.params.Orientation.UPSIDE_DOWN"]], "usb_connected (statusid attribute)": [[0, "open_gopro.constants.StatusId.USB_CONNECTED"]], "uuids (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.UUIDs"]], "uuidsmeta (class in open_gopro.ble.services)": [[0, "open_gopro.ble.services.UUIDsMeta"]], "v1 (maxlensmodtype attribute)": [[0, "open_gopro.api.params.MaxLensModType.V1"]], "v2 (maxlensmodtype attribute)": [[0, "open_gopro.api.params.MaxLensModType.V2"]], "vehicle_lights (timelapsemode attribute)": [[0, "open_gopro.api.params.TimelapseMode.VEHICLE_LIGHTS"]], "verifying (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.VERIFYING"]], "verify_failed (otastatus attribute)": [[0, "open_gopro.api.params.OTAStatus.VERIFY_FAILED"]], "vertical (framing attribute)": [[0, "open_gopro.api.params.Framing.VERTICAL"]], "video (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.VIDEO"]], "video (presetgroup attribute)": [[0, "open_gopro.api.params.PresetGroup.VIDEO"]], "video_aspect_ratio (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_ASPECT_RATIO"]], "video_easy_aspect_ratio (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_EASY_ASPECT_RATIO"]], "video_easy_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_EASY_MODE"]], "video_fov (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_FOV"]], "video_hindsight (statusid attribute)": [[0, "open_gopro.constants.StatusId.VIDEO_HINDSIGHT"]], "video_horizon_leveling (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_HORIZON_LEVELING"]], "video_low_temp (statusid attribute)": [[0, "open_gopro.constants.StatusId.VIDEO_LOW_TEMP"]], "video_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_MODE"]], "video_performance_mode (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_PERFORMANCE_MODE"]], "video_presets (statusid attribute)": [[0, "open_gopro.constants.StatusId.VIDEO_PRESETS"]], "video_profile (settingid attribute)": [[0, "open_gopro.constants.SettingId.VIDEO_PROFILE"]], "video_progress (statusid attribute)": [[0, "open_gopro.constants.StatusId.VIDEO_PROGRESS"]], "video_rem (statusid attribute)": [[0, "open_gopro.constants.StatusId.VIDEO_REM"]], "videoaspectratio (class in open_gopro.api.params)": [[0, "open_gopro.api.params.VideoAspectRatio"]], "videofov (class in open_gopro.api.params)": [[0, "open_gopro.api.params.VideoFOV"]], "videomode (class in open_gopro.api.params)": [[0, "open_gopro.api.params.VideoMode"]], "videoprofile (class in open_gopro.api.params)": [[0, "open_gopro.api.params.VideoProfile"]], "wapstate (class in open_gopro.api.params)": [[0, "open_gopro.api.params.WAPState"]], "wap_csi_password (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.WAP_CSI_PASSWORD"]], "wap_password (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.WAP_PASSWORD"]], "wap_power (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.WAP_POWER"]], "wap_prov_stat (statusid attribute)": [[0, "open_gopro.constants.StatusId.WAP_PROV_STAT"]], "wap_scan_state (statusid attribute)": [[0, "open_gopro.constants.StatusId.WAP_SCAN_STATE"]], "wap_scan_time (statusid attribute)": [[0, "open_gopro.constants.StatusId.WAP_SCAN_TIME"]], "wap_ssid (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.WAP_SSID"]], "wap_state (goprouuids attribute)": [[0, "open_gopro.constants.GoProUUIDs.WAP_STATE"]], "webcam (flatmode attribute)": [[0, "open_gopro.api.params.Flatmode.WEBCAM"]], "wide (multishotfov attribute)": [[0, "open_gopro.api.params.MultishotFOV.WIDE"]], "wide (photofov attribute)": [[0, "open_gopro.api.params.PhotoFOV.WIDE"]], "wide (videofov attribute)": [[0, "open_gopro.api.params.VideoFOV.WIDE"]], "wide (webcamfov attribute)": [[0, "open_gopro.api.params.WebcamFOV.WIDE"]], "widescreen (easyaspectratio attribute)": [[0, "open_gopro.api.params.EasyAspectRatio.WIDESCREEN"]], "widescreen (framing attribute)": [[0, "open_gopro.api.params.Framing.WIDESCREEN"]], "wifi_band (settingid attribute)": [[0, "open_gopro.constants.SettingId.WIFI_BAND"]], "wifi_bars (statusid attribute)": [[0, "open_gopro.constants.StatusId.WIFI_BARS"]], "wireless_band (statusid attribute)": [[0, "open_gopro.constants.StatusId.WIRELESS_BAND"]], "wireless_enabled (statusid attribute)": [[0, "open_gopro.constants.StatusId.WIRELESS_ENABLED"]], "with_external (mediamodmicstatus attribute)": [[0, "open_gopro.api.params.MediaModMicStatus.WITH_EXTERNAL"]], "wlan_ssid (statusid attribute)": [[0, "open_gopro.constants.StatusId.WLAN_SSID"]], "webcamerror (class in open_gopro.constants)": [[0, "open_gopro.constants.WebcamError"]], "webcamfov (class in open_gopro.api.params)": [[0, "open_gopro.api.params.WebcamFOV"]], "webcamprotocol (class in open_gopro.api.params)": [[0, "open_gopro.api.params.WebcamProtocol"]], "webcamresolution (class in open_gopro.api.params)": [[0, "open_gopro.api.params.WebcamResolution"]], "webcamstatus (class in open_gopro.constants)": [[0, "open_gopro.constants.WebcamStatus"]], "wifiband (class in open_gopro.api.params)": [[0, "open_gopro.api.params.WifiBand"]], "wificlient (class in open_gopro.wifi.client)": [[0, "open_gopro.wifi.client.WifiClient"]], "wificontroller (class in open_gopro.wifi.controller)": [[0, "open_gopro.wifi.controller.WifiController"]], "wiredgopro (class in open_gopro.gopro_wired)": [[0, "open_gopro.gopro_wired.WiredGoPro"]], "wirelessgopro (class in open_gopro.gopro_wireless)": [[0, "open_gopro.gopro_wireless.WirelessGoPro"]], "zoom_encoding (statusid attribute)": [[0, "open_gopro.constants.StatusId.ZOOM_ENCODING"]], "acc_mic_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.acc_mic_stat"]], "active_preset (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.active_preset"]], "add_file_hilight() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.add_file_hilight"]], "analytics_rdy (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.analytics_rdy"]], "analytics_size (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.analytics_size"]], "anti_flicker (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.anti_flicker"]], "anti_flicker (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.anti_flicker"]], "ap_mac_addr (camerainfo attribute)": [[0, "open_gopro.models.general.CameraInfo.ap_mac_addr"]], "ap_ssid (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.ap_ssid"]], "ap_ssid (camerainfo attribute)": [[0, "open_gopro.models.general.CameraInfo.ap_ssid"]], "ap_state (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.ap_state"]], "app_count (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.app_count"]], "audio_option (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.audio_option"]], "auto_off (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.auto_off"]], "auto_off (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.auto_off"]], "available_interfaces() (wificontroller method)": [[0, "open_gopro.wifi.controller.WifiController.available_interfaces"]], "avc_level (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.avc_level"]], "avc_profile (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.avc_profile"]], "band_5ghz_avail (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.band_5ghz_avail"]], "batt_level (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.batt_level"]], "batt_ok_ota (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.batt_ok_ota"]], "batt_present (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.batt_present"]], "bit_depth (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.bit_depth"]], "bit_depth (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.bit_depth"]], "bit_rate (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.bit_rate"]], "bit_rate (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.bit_rate"]], "ble_command (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.ble_command"]], "ble_command (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.ble_command"]], "ble_command (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.ble_command"]], "ble_setting (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.ble_setting"]], "ble_setting (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.ble_setting"]], "ble_setting (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.ble_setting"]], "ble_status (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.ble_status"]], "ble_status (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.ble_status"]], "ble_status (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.ble_status"]], "build_body() (httpmessage method)": [[0, "open_gopro.communicator_interface.HttpMessage.build_body"]], "build_url() (httpmessage method)": [[0, "open_gopro.communicator_interface.HttpMessage.build_url"]], "build_url() (httpsetting method)": [[0, "open_gopro.api.builders.HttpSetting.build_url"]], "camera_control (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.camera_control"]], "camera_lens_type (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.camera_lens_type"]], "camera_ux_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.camera_ux_mode"]], "camera_ux_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.camera_ux_mode"]], "capt_delay_active (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.capt_delay_active"]], "cccd_handle (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.cccd_handle"]], "characteristics (service property)": [[0, "open_gopro.ble.services.Service.characteristics"]], "clipped (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.clipped"]], "close() (bleclient method)": [[0, "open_gopro.ble.client.BleClient.close"]], "close() (goprobase method)": [[0, "open_gopro.gopro_base.GoProBase.close"]], "close() (wificlient method)": [[0, "open_gopro.wifi.client.WifiClient.close"]], "close() (wiredgopro method)": [[0, "open_gopro.gopro_wired.WiredGoPro.close"]], "close() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.close"]], "cohn_clear_certificate() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.cohn_clear_certificate"]], "cohn_create_certificate() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.cohn_create_certificate"]], "cohn_get_certificate() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.cohn_get_certificate"]], "cohn_get_status() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.cohn_get_status"]], "cohn_set_setting() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.cohn_set_setting"]], "configure_cohn() (goprobase method)": [[0, "open_gopro.gopro_base.GoProBase.configure_cohn"]], "configure_cohn() (wiredgopro method)": [[0, "open_gopro.gopro_wired.WiredGoPro.configure_cohn"]], "configure_cohn() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.configure_cohn"]], "connect() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.connect"]], "connect() (wificontroller method)": [[0, "open_gopro.wifi.controller.WifiController.connect"]], "connect_to_access_point() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.connect_to_access_point"]], "content_type (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.content_type"]], "control_allowed_over_usb (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.control_allowed_over_usb"]], "creating_preset (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.creating_preset"]], "creation_timestamp (mediaitem attribute)": [[0, "open_gopro.models.media_list.MediaItem.creation_timestamp"]], "creation_timestamp (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.creation_timestamp"]], "current() (wificontroller method)": [[0, "open_gopro.wifi.controller.WifiController.current"]], "current_time_ms (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.current_time_ms"]], "custom_preset_update() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.custom_preset_update"]], "data (goproresp attribute)": [[0, "open_gopro.models.response.GoProResp.data"]], "datetime (tzdstdatetime attribute)": [[0, "open_gopro.models.general.TzDstDateTime.datetime"]], "delete_all() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.delete_all"]], "delete_file() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.delete_file"]], "delete_group() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.delete_group"]], "descriptors (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.descriptors"]], "dig_zoom_active (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.dig_zoom_active"]], "digital_zoom (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.digital_zoom"]], "directory (mediafilesystem attribute)": [[0, "open_gopro.models.media_list.MediaFileSystem.directory"]], "disconnect() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.disconnect"]], "disconnect() (wificontroller method)": [[0, "open_gopro.wifi.controller.WifiController.disconnect"]], "discover_chars() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.discover_chars"]], "display_name (supportedoption attribute)": [[0, "open_gopro.models.general.SupportedOption.display_name"]], "download_cancel_pend (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.download_cancel_pend"]], "download_file() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.download_file"]], "dst (tzdstdatetime attribute)": [[0, "open_gopro.models.general.TzDstDateTime.dst"]], "dump_to_csv() (gattdb method)": [[0, "open_gopro.ble.services.GattDB.dump_to_csv"]], "duration (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.duration"]], "enable_notifications() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.enable_notifications"]], "enable_wifi_ap() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.enable_wifi_ap"]], "encoding_active (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.encoding_active"]], "error (webcamresponse attribute)": [[0, "open_gopro.models.general.WebcamResponse.error"]], "exposure_type (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.exposure_type"]], "exposure_x (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.exposure_x"]], "exposure_y (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.exposure_y"]], "field_of_view (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.field_of_view"]], "file_size (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.file_size"]], "file_system (mediafilesystem attribute)": [[0, "open_gopro.models.media_list.MediaFileSystem.file_system"]], "filename (mediaitem attribute)": [[0, "open_gopro.models.media_list.MediaItem.filename"]], "files (medialist property)": [[0, "open_gopro.models.media_list.MediaList.files"]], "firmware_version (camerainfo attribute)": [[0, "open_gopro.models.general.CameraInfo.firmware_version"]], "first_time (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.first_time"]], "flatmode_id (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.flatmode_id"]], "format (bleuuid property)": [[0, "open_gopro.ble.services.BleUUID.format"]], "fps (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.fps"]], "fps (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.fps"]], "frame_rate (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.frame_rate"]], "frame_rate_divisor (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.frame_rate_divisor"]], "framing (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.framing"]], "framing (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.framing"]], "from_json() (mediametadata class method)": [[0, "open_gopro.models.media_list.MediaMetadata.from_json"]], "gatt_db (bleclient property)": [[0, "open_gopro.ble.client.BleClient.gatt_db"]], "get_ap_entries() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_ap_entries"]], "get_camera_capabilities() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_camera_capabilities"]], "get_camera_info() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_camera_info"]], "get_camera_settings() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_camera_settings"]], "get_camera_state() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_camera_state"]], "get_camera_statuses() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_camera_statuses"]], "get_capabilities_values() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.get_capabilities_values"]], "get_date_time() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_date_time"]], "get_date_time() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_date_time"]], "get_date_time_tz_dst() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_date_time_tz_dst"]], "get_gpmf_data() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_gpmf_data"]], "get_hardware_info() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_hardware_info"]], "get_last_captured_media() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_last_captured_media"]], "get_last_captured_media() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_last_captured_media"]], "get_media_list() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_media_list"]], "get_media_metadata() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_media_metadata"]], "get_open_gopro_api_version() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_open_gopro_api_version"]], "get_open_gopro_api_version() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_open_gopro_api_version"]], "get_preset_status() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_preset_status"]], "get_preset_status() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_preset_status"]], "get_screennail__call__() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_screennail__call__"]], "get_telemetry() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_telemetry"]], "get_thumbnail() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_thumbnail"]], "get_value() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.get_value"]], "get_value() (blestatusfacade method)": [[0, "open_gopro.api.builders.BleStatusFacade.get_value"]], "get_webcam_version() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.get_webcam_version"]], "get_wifi_password() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_wifi_password"]], "get_wifi_ssid() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.get_wifi_ssid"]], "gps_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.gps_stat"]], "group_first_member_id (groupedmediaitem attribute)": [[0, "open_gopro.models.media_list.GroupedMediaItem.group_first_member_id"]], "group_id (groupedmediaitem attribute)": [[0, "open_gopro.models.media_list.GroupedMediaItem.group_id"]], "group_last_member_id (groupedmediaitem attribute)": [[0, "open_gopro.models.media_list.GroupedMediaItem.group_last_member_id"]], "group_missing_ids (groupedmediaitem attribute)": [[0, "open_gopro.models.media_list.GroupedMediaItem.group_missing_ids"]], "group_size (groupedmediaitem attribute)": [[0, "open_gopro.models.media_list.GroupedMediaItem.group_size"]], "group_type (groupedmediaitem attribute)": [[0, "open_gopro.models.media_list.GroupedMediaItem.group_type"]], "gumi (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.gumi"]], "handle2uuid() (gattdb method)": [[0, "open_gopro.ble.services.GattDB.handle2uuid"]], "height (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.height"]], "high_dynamic_range (photometadata attribute)": [[0, "open_gopro.models.media_list.PhotoMetadata.high_dynamic_range"]], "hilight_count (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.hilight_count"]], "hilight_list (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.hilight_list"]], "hindsight (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.hindsight"]], "hindsight (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.hindsight"]], "http_command (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.http_command"]], "http_command (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.http_command"]], "http_command (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.http_command"]], "http_setting (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.http_setting"]], "http_setting (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.http_setting"]], "http_setting (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.http_setting"]], "hypersmooth (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.hypersmooth"]], "hypersmooth (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.hypersmooth"]], "id (supportedoption attribute)": [[0, "open_gopro.models.general.SupportedOption.id"]], "identifier (bleclient property)": [[0, "open_gopro.ble.client.BleClient.identifier"]], "identifier (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.identifier"]], "identifier (goproresp attribute)": [[0, "open_gopro.models.response.GoProResp.identifier"]], "identifier (medialist attribute)": [[0, "open_gopro.models.media_list.MediaList.identifier"]], "identifier (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.identifier"]], "identifier (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.identifier"]], "identify_item() (mediafilesystem class method)": [[0, "open_gopro.models.media_list.MediaFileSystem.identify_item"]], "image_stabilization (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.image_stabilization"]], "in_context_menu (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.in_context_menu"]], "int_batt_per (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.int_batt_per"]], "interface (wificontroller property)": [[0, "open_gopro.wifi.controller.WifiController.interface"]], "is_ble_connected (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.is_ble_connected"]], "is_ble_connected (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.is_ble_connected"]], "is_ble_connected (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.is_ble_connected"]], "is_cohn_provisioned (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.is_cohn_provisioned"]], "is_cohn_provisioned (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.is_cohn_provisioned"]], "is_cohn_provisioned (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.is_cohn_provisioned"]], "is_connected (bleclient property)": [[0, "open_gopro.ble.client.BleClient.is_connected"]], "is_connected (wificlient property)": [[0, "open_gopro.wifi.client.WifiClient.is_connected"]], "is_discovered (bleclient property)": [[0, "open_gopro.ble.client.BleClient.is_discovered"]], "is_fastpass() (messagerules method)": [[0, "open_gopro.communicator_interface.MessageRules.is_fastpass"]], "is_http_connected (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.is_http_connected"]], "is_http_connected (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.is_http_connected"]], "is_http_connected (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.is_http_connected"]], "is_indicatable (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.is_indicatable"]], "is_notifiable (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.is_notifiable"]], "is_on (wificontroller property)": [[0, "open_gopro.wifi.controller.WifiController.is_on"]], "is_open (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.is_open"]], "is_open (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.is_open"]], "is_open (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.is_open"]], "is_readable (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.is_readable"]], "is_ready (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.is_ready"]], "is_ready (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.is_ready"]], "is_ready (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.is_ready"]], "is_writeable (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.is_writeable"]], "is_writeable_with_response (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.is_writeable_with_response"]], "is_writeable_without_response (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.is_writeable_without_response"]], "items() (gattdb.characteristicview method)": [[0, "open_gopro.ble.services.GattDB.CharacteristicView.items"]], "keep_alive() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.keep_alive"]], "keys() (gattdb.characteristicview method)": [[0, "open_gopro.ble.services.GattDB.CharacteristicView.keys"]], "last_hilight (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.last_hilight"]], "lcd_lock_active (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.lcd_lock_active"]], "led (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.led"]], "lens_config (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.lens_config"]], "lens_projection (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.lens_projection"]], "linux_core_active (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.linux_core_active"]], "live_burst_rem (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.live_burst_rem"]], "live_burst_total (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.live_burst_total"]], "load_preset() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.load_preset"]], "load_preset() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.load_preset"]], "load_preset_group() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.load_preset_group"]], "load_preset_group() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.load_preset_group"]], "locate_active (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.locate_active"]], "logs_ready (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.logs_ready"]], "low_res_video_size (mediaitem attribute)": [[0, "open_gopro.models.media_list.MediaItem.low_res_video_size"]], "lrv_file_size (mediaitem attribute)": [[0, "open_gopro.models.media_list.MediaItem.lrv_file_size"]], "lrv_file_size (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.lrv_file_size"]], "max_auto_hilight_score (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.max_auto_hilight_score"]], "max_lens_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.max_lens_mode"]], "max_lens_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.max_lens_mode"]], "maxlens_mod_type (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.maxlens_mod_type"]], "maxlens_mod_type (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.maxlens_mod_type"]], "maxlens_status (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.maxlens_status"]], "maxlens_status (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.maxlens_status"]], "media (medialist attribute)": [[0, "open_gopro.models.media_list.MediaList.media"]], "media_format (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.media_format"]], "media_format (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.media_format"]], "media_mod_mic_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.media_mod_mic_stat"]], "media_mod_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.media_mod_stat"]], "media_offload_state (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.media_offload_state"]], "metadata_present (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.metadata_present"]], "mobile_video (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.mobile_video"]], "mode_group (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.mode_group"]], "model_name (camerainfo attribute)": [[0, "open_gopro.models.general.CameraInfo.model_name"]], "model_number (camerainfo attribute)": [[0, "open_gopro.models.general.CameraInfo.model_number"]], "model_post_init() (medialist method)": [[0, "open_gopro.models.media_list.MediaList.model_post_init"]], "modified_time (mediaitem attribute)": [[0, "open_gopro.models.media_list.MediaItem.modified_time"]], "module": [[0, "module-open_gopro.api.params"], [0, "module-open_gopro.ble.client"], [0, "module-open_gopro.ble.controller"], [0, "module-open_gopro.ble.services"], [0, "module-open_gopro.constants"], [0, "module-open_gopro.exceptions"], [0, "module-open_gopro.wifi.client"], [0, "module-open_gopro.wifi.controller"]], "multi_count_down (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.multi_count_down"]], "multi_shot_easy_aspect_ratio (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.multi_shot_easy_aspect_ratio"]], "multi_shot_easy_aspect_ratio (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.multi_shot_easy_aspect_ratio"]], "multi_shot_field_of_view (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.multi_shot_field_of_view"]], "multi_shot_field_of_view (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.multi_shot_field_of_view"]], "multi_shot_nlv_aspect_ratio (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.multi_shot_nlv_aspect_ratio"]], "multi_shot_nlv_aspect_ratio (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.multi_shot_nlv_aspect_ratio"]], "name (characteristic property)": [[0, "open_gopro.ble.services.Characteristic.name"]], "name (descriptor property)": [[0, "open_gopro.ble.services.Descriptor.name"]], "name (service property)": [[0, "open_gopro.ble.services.Service.name"]], "next_poll (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.next_poll"]], "num_group_photo (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.num_group_photo"]], "num_group_video (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.num_group_video"]], "num_hilights (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.num_hilights"]], "num_total_photo (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.num_total_photo"]], "num_total_video (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.num_total_video"]], "ok (goproresp property)": [[0, "open_gopro.models.response.GoProResp.ok"]], "open() (bleclient method)": [[0, "open_gopro.ble.client.BleClient.open"]], "open() (goprobase method)": [[0, "open_gopro.gopro_base.GoProBase.open"]], "open() (wificlient method)": [[0, "open_gopro.wifi.client.WifiClient.open"]], "open() (wiredgopro method)": [[0, "open_gopro.gopro_wired.WiredGoPro.open"]], "open() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.open"]], "open_gopro.api.params": [[0, "module-open_gopro.api.params"]], "open_gopro.ble.client": [[0, "module-open_gopro.ble.client"]], "open_gopro.ble.controller": [[0, "module-open_gopro.ble.controller"]], "open_gopro.ble.services": [[0, "module-open_gopro.ble.services"]], "open_gopro.constants": [[0, "module-open_gopro.constants"]], "open_gopro.exceptions": [[0, "module-open_gopro.exceptions"]], "open_gopro.wifi.client": [[0, "module-open_gopro.wifi.client"]], "open_gopro.wifi.controller": [[0, "module-open_gopro.wifi.controller"]], "orientation (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.orientation"]], "ota_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.ota_stat"]], "pair() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.pair"]], "pair_state (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.pair_state"]], "pair_state2 (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.pair_state2"]], "pair_time (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.pair_time"]], "pair_type (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.pair_type"]], "parent_gumi (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.parent_gumi"]], "password (goprowifi property)": [[0, "open_gopro.communicator_interface.GoProWifi.password"]], "password (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.password"]], "photo_duration (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.photo_duration"]], "photo_duration (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.photo_duration"]], "photo_easy_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.photo_easy_mode"]], "photo_easy_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.photo_easy_mode"]], "photo_field_of_view (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.photo_field_of_view"]], "photo_field_of_view (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.photo_field_of_view"]], "photo_horizon_leveling (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.photo_horizon_leveling"]], "photo_horizon_leveling (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.photo_horizon_leveling"]], "photo_interval (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.photo_interval"]], "photo_interval (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.photo_interval"]], "photo_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.photo_mode"]], "photo_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.photo_mode"]], "photo_presets (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.photo_presets"]], "photos_rem (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.photos_rem"]], "power() (wificontroller method)": [[0, "open_gopro.wifi.controller.WifiController.power"]], "power_down() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.power_down"]], "preset_modified (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.preset_modified"]], "presets_group (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.presets_group"]], "preview_enabled (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.preview_enabled"]], "progressive (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.progressive"]], "protocol (goproresp attribute)": [[0, "open_gopro.models.response.GoProResp.protocol"]], "protune_audio (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.protune_audio"]], "quick_capture (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.quick_capture"]], "raw (photometadata attribute)": [[0, "open_gopro.models.media_list.PhotoMetadata.raw"]], "read() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.read"]], "read() (bleclient method)": [[0, "open_gopro.ble.client.BleClient.read"]], "register_capability_update() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.register_capability_update"]], "register_for_all_capabilities() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.register_for_all_capabilities"]], "register_for_all_settings() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.register_for_all_settings"]], "register_for_all_statuses() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.register_for_all_statuses"]], "register_livestream_status() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.register_livestream_status"]], "register_update() (basegoprocommunicator method)": [[0, "open_gopro.communicator_interface.BaseGoProCommunicator.register_update"]], "register_update() (wiredgopro method)": [[0, "open_gopro.gopro_wired.WiredGoPro.register_update"]], "register_update() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.register_update"]], "register_value_update() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.register_value_update"]], "register_value_update() (blestatusfacade method)": [[0, "open_gopro.api.builders.BleStatusFacade.register_value_update"]], "release_network() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.release_network"]], "remote_ctrl_conn (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.remote_ctrl_conn"]], "remote_ctrl_ver (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.remote_ctrl_ver"]], "remove_file_hilight() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.remove_file_hilight"]], "request_wifi_connect() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.request_wifi_connect"]], "request_wifi_connect_new() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.request_wifi_connect_new"]], "resolution (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.resolution"]], "resolution (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.resolution"]], "rotate (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.rotate"]], "scan() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.scan"]], "scan_wifi_networks() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.scan_wifi_networks"]], "scheduled_capture (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.scheduled_capture"]], "scheduled_preset (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.scheduled_preset"]], "sd_rating_check_error (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.sd_rating_check_error"]], "sd_status (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.sd_status"]], "sd_write_speed_error (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.sd_write_speed_error"]], "sec_sd_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.sec_sd_stat"]], "serial_number (camerainfo attribute)": [[0, "open_gopro.models.general.CameraInfo.serial_number"]], "services (gattdb property)": [[0, "open_gopro.ble.services.GattDB.services"]], "services_as_csv() (bleclient method)": [[0, "open_gopro.ble.client.BleClient.services_as_csv"]], "session_id (mediaitem attribute)": [[0, "open_gopro.models.media_list.MediaItem.session_id"]], "set() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.set"]], "set() (httpsetting method)": [[0, "open_gopro.api.builders.HttpSetting.set"]], "set_camera_control() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_camera_control"]], "set_camera_control() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_camera_control"]], "set_date_time() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_date_time"]], "set_date_time() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_date_time"]], "set_date_time_tz_dst() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_date_time_tz_dst"]], "set_digital_zoom() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_digital_zoom"]], "set_keep_alive() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_keep_alive"]], "set_livestream_mode() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_livestream_mode"]], "set_preview_stream() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_preview_stream"]], "set_shutter() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_shutter"]], "set_shutter() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_shutter"]], "set_third_party_client_info() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_third_party_client_info"]], "set_third_party_client_info() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_third_party_client_info"]], "set_turbo_mode() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.set_turbo_mode"]], "set_turbo_mode() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.set_turbo_mode"]], "setting_id (webcamresponse attribute)": [[0, "open_gopro.models.general.WebcamResponse.setting_id"]], "should_wait_for_encoding_start() (messagerules method)": [[0, "open_gopro.communicator_interface.MessageRules.should_wait_for_encoding_start"]], "sleep() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.sleep"]], "space_rem (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.space_rem"]], "ssid (goprowifi property)": [[0, "open_gopro.communicator_interface.GoProWifi.ssid"]], "ssid (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.ssid"]], "star_trail_length (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.star_trail_length"]], "star_trail_length (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.star_trail_length"]], "status (goproresp attribute)": [[0, "open_gopro.models.response.GoProResp.status"]], "status (webcamresponse attribute)": [[0, "open_gopro.models.general.WebcamResponse.status"]], "streaming_supp (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.streaming_supp"]], "subsample (videometadata attribute)": [[0, "open_gopro.models.media_list.VideoMetadata.subsample"]], "sudo (wificontroller property)": [[0, "open_gopro.wifi.controller.WifiController.sudo"]], "supported_options (webcamresponse attribute)": [[0, "open_gopro.models.general.WebcamResponse.supported_options"]], "system_busy (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.system_busy"]], "system_hot (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.system_hot"]], "system_ready (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.system_ready"]], "system_video_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.system_video_mode"]], "system_video_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.system_video_mode"]], "tag_hilight() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.tag_hilight"]], "timelapse_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.timelapse_mode"]], "timelapse_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.timelapse_mode"]], "timelapse_presets (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.timelapse_presets"]], "timelapse_rem (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.timelapse_rem"]], "timewarp_speed_ramp (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.timewarp_speed_ramp"]], "total_sd_space_kb (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.total_sd_space_kb"]], "transcoded (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.transcoded"]], "turbo_mode (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.turbo_mode"]], "tzone (tzdstdatetime attribute)": [[0, "open_gopro.models.general.TzDstDateTime.tzone"]], "unregister_capability_update() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.unregister_capability_update"]], "unregister_for_all_capabilities() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.unregister_for_all_capabilities"]], "unregister_for_all_settings() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.unregister_for_all_settings"]], "unregister_for_all_statuses() (blecommands method)": [[0, "open_gopro.api.ble_commands.BleCommands.unregister_for_all_statuses"]], "unregister_update() (basegoprocommunicator method)": [[0, "open_gopro.communicator_interface.BaseGoProCommunicator.unregister_update"]], "unregister_update() (wiredgopro method)": [[0, "open_gopro.gopro_wired.WiredGoPro.unregister_update"]], "unregister_update() (wirelessgopro method)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.unregister_update"]], "unregister_value_update() (blesettingfacade method)": [[0, "open_gopro.api.builders.BleSettingFacade.unregister_value_update"]], "unregister_value_update() (blestatusfacade method)": [[0, "open_gopro.api.builders.BleStatusFacade.unregister_value_update"]], "update_custom_preset() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.update_custom_preset"]], "upload_status (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.upload_status"]], "usb_connected (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.usb_connected"]], "uuid2handle() (gattdb method)": [[0, "open_gopro.ble.services.GattDB.uuid2handle"]], "values() (gattdb.characteristicview method)": [[0, "open_gopro.ble.services.GattDB.CharacteristicView.values"]], "version (goprobase property)": [[0, "open_gopro.gopro_base.GoProBase.version"]], "version (wiredgopro property)": [[0, "open_gopro.gopro_wired.WiredGoPro.version"]], "version (wirelessgopro property)": [[0, "open_gopro.gopro_wireless.WirelessGoPro.version"]], "video_aspect_ratio (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_aspect_ratio"]], "video_aspect_ratio (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_aspect_ratio"]], "video_easy_aspect_ratio (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_easy_aspect_ratio"]], "video_easy_aspect_ratio (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_easy_aspect_ratio"]], "video_easy_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_easy_mode"]], "video_easy_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_easy_mode"]], "video_field_of_view (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_field_of_view"]], "video_field_of_view (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_field_of_view"]], "video_hindsight (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.video_hindsight"]], "video_horizon_leveling (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_horizon_leveling"]], "video_horizon_leveling (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_horizon_leveling"]], "video_low_temp (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.video_low_temp"]], "video_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_mode"]], "video_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_mode"]], "video_performance_mode (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_performance_mode"]], "video_performance_mode (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_performance_mode"]], "video_presets (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.video_presets"]], "video_profile (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.video_profile"]], "video_profile (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.video_profile"]], "video_progress (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.video_progress"]], "video_rem (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.video_rem"]], "wap_prov_stat (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.wap_prov_stat"]], "wap_scan_state (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.wap_scan_state"]], "webcam_exit() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.webcam_exit"]], "webcam_preview() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.webcam_preview"]], "webcam_start() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.webcam_start"]], "webcam_status() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.webcam_status"]], "webcam_stop() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.webcam_stop"]], "wide_dynamic_range (photometadata attribute)": [[0, "open_gopro.models.media_list.PhotoMetadata.wide_dynamic_range"]], "width (mediametadata attribute)": [[0, "open_gopro.models.media_list.MediaMetadata.width"]], "wifi_band (blesettings attribute)": [[0, "open_gopro.api.ble_commands.BleSettings.wifi_band"]], "wifi_band (httpsettings attribute)": [[0, "open_gopro.api.http_commands.HttpSettings.wifi_band"]], "wifi_bars (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.wifi_bars"]], "wired_usb_control() (httpcommands method)": [[0, "open_gopro.api.http_commands.HttpCommands.wired_usb_control"]], "wireless_band (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.wireless_band"]], "wireless_enabled (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.wireless_enabled"]], "wlan_ssid (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.wlan_ssid"]], "write() (blecontroller method)": [[0, "open_gopro.ble.controller.BLEController.write"]], "write() (bleclient method)": [[0, "open_gopro.ble.client.BleClient.write"]], "zoom_encoding (blestatuses attribute)": [[0, "open_gopro.api.ble_commands.BleStatuses.zoom_encoding"]]}}) \ No newline at end of file diff --git a/python_sdk/troubleshooting.html b/python_sdk/troubleshooting.html new file mode 100644 index 00000000..71ed834b --- /dev/null +++ b/python_sdk/troubleshooting.html @@ -0,0 +1,186 @@ + + + + + + + Troubleshooting — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Troubleshooting

+

This section will provide some information on how to debug the Open GoPro package.

+
+

Logging

+

There is a lot of logging sprinkled throughout using the standard Python logging module.

+

Furthermore, there is a help function in util.py that will enable logging with some default modules / levels. +All of the demos use this and here is an example:

+
from pathlib import Path
+
+from open_gopro import WirelessGoPro
+from open_gopro.util import setup_logging
+
+logger = setup_logging(__name__, Path("my_log.log"))
+
+async with WirelessGoPro() as gopro:
+    logger.info("I'm logged!")
+
+
+

There are several other logging-related functions that extend and / or offer finer logging control.

+

Here is a guide for the levels:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Logging Level

Module use

logging.TRACE

Custom logging level with even more information then debug. You should not need this.

logging.DEBUG

Maximum amount of information. Byte level tx / rx.

logging.INFO

String-level tx / rx. This is very readable.

logging.WARNING

Things that shouldn’t have happened but won’t break anything

logging.ERROR

This is bad and unrecoverable.

logging.CRITICAL

Not used.

+
+
+

Bluetooth Characteristics

+

There is a utility in the GoPro class to dump the discovered BLE characteristics to a +CSV file. This can be done as such:

+
from open_gopro import WirelessGoPro
+
+with WirelessGoPro() as gopro:
+    gopro._ble.gatt_db.dump_to_csv()
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/python_sdk/usage.html b/python_sdk/usage.html new file mode 100644 index 00000000..864fc31a --- /dev/null +++ b/python_sdk/usage.html @@ -0,0 +1,617 @@ + + + + + + + Usage — Open GoPro Python SDK documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Usage

+

This section will describe some high level information of how to use the Open GoPro module. For more detailed +information, see the Interfaces section. For just running the demos, see the +QuickStart section.

+
+

Overview

+

There are two top-level interfaces to communicate with a GoPro camera:

+
+
    +

  • WiredGoPro to communicate with the GoPro via USB HTTP

    • +

  • WirelessGoPro to communicate with the GoPro via BLE and optionally WiFi HTTP

    • +
+
+

An individual instance of one of the above classes corresponds to a (potentially not yet) connected GoPro +camera resource. The general procedure to communicate with the GoPro is:

+
    +

  1. Identify and open the connection to the target GoPro

    2. +

  2. Send Messages and Receive Responses via BLE / HTTP

    3. +

  3. Gracefully close the connection with the GoPro

    4. +
+
+

Tip

+

There is a lot of useful logging throughout the Open GoPro package. See +troubleshooting for more info.

+
+
+
+

Asyncio

+

This package is asyncio-based which means that its awaitable +methods need to be called from an async coroutine. For the code snippets throughout this documentation, assume that this +is accomplished in the same manner as the demo scripts provided:

+
import asyncio
+
+async def main() -> None:
+    # Put our code here
+
+if __name__ == "__main__":
+    asyncio.run(main())
+
+
+
+
+

Opening

+

Before communicating with a camera, the camera resource must be “opened”. This can be done either with or without +the context manager. See the below sections for opening information specific to Wired / Wireless.

+
+

Wireless Opening

+

The Wireless GoPro client can be opened either with the context manager:

+
from open_gopro import WirelessGoPro
+
+async with WirelessGoPro() as gopro:
+    print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!")
+    # Send some messages now
+
+
+

...or without the context manager:

+
from open_gopro import WirelessGoPro
+
+gopro = WirelessGoPro()
+await gopro.open()
+print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!")
+# Send some messages now
+
+
+

In either case, the following will have occurred before the camera is ready to communicate:

+
    +

  1. scan for camera

    2. +

  2. connect to camera via BLE

    3. +

  3. enable notifications

    4. +

  4. pair (if needed)

    5. +

  5. discover characteristics

    6. +

  6. initialize (register for internal status notifications)

    7. +

  7. discover Open GoPro version

    8. +

  8. connect via WiFi (unless specified not to via argument)

    9. +
+
+

Note

+

While a BLE connection is always needed, the WiFi connection is optional. To configure this (and other +instance arguments) see the API Reference for WirelessGoPro

+
+
+
+

Wired Opening

+

The Wired GoPro client can be opened either with the context manager:

+
from open_gopro import WiredGoPro
+
+async with WiredGoPro() as gopro:
+    print("Yay! I'm connected via USB, opened, and ready to send / get data now!")
+    # Send some messages now
+
+
+

...or without the context manager:

+
from open_gopro import WiredGoPro
+
+gopro = WiredGoPro()
+await gopro.open()
+print("Yay! I'm connected via USB, opened, and ready to send / get data now!")
+# Send some messages now
+
+
+

If, as above, an identifier is not passed to the WiredGoPro, the mDNS server will be queried during opening to search +for a connected GoPro.

+
+
+

Common Opening

+

The GoPro’s state can be checked via several properties.

+ +
+

API Version

+

One of the steps during the opening sequence is to query the camera’s Open GoPro API version. This SDK only +supports Open GoPro API Version 2.0 so will raise an InvalidOpenGoProVersion if the connected camera is +using anything else.

+

The version string can be accessed via the version() property.

+
+
+

Camera Readiness

+

A message can not be sent to the camera if it is not ready where “ready” is defined as not encoding and not +busy. These two states are managed automatically by the WirelessGoPro instance such that a call to any +message will block until the camera is ready. They are combined into the following ready state:

+ +

For example,

+
async with WirelessGoPro() as gopro:
+    # A naive check for it to be ready
+    while not await gopro.is_ready:
+        pass
+
+
+

To reiterate…it is not needed or recommended to worry about this as the internal state is managed automatically +by the WirelessGoPro instance. Just know that most commands will be (asynchronously) blocked until the camera is ready.

+
+
+
+
+

Sending Messages

+

Once a WirelessGoPro or WiredGoPro instance has been opened, it is now possible to send +messages to the camera (provided that the camera is ready). Messages are accessed +by transport protocol where the superset of message groups are:

+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Message Group

WiredGoPro

WirelessGoPro (WiFi Enabled)

WirelessGoPro (WiFi Disabled)

http_command()

✔️

✔️

❌

http_setting()

✔️

✔️

❌

ble_command()

❌

✔️

✔️

ble_setting()

❌

✔️

✔️

ble_status()

❌

✔️

✔️

+

In the case where a given group of messages is not supported, a NotImplementedError will be returned when +the relevant property is accessed.

+

All messages are communicated via one of two strategies:

+ +
+

Note

+

For the remainder of this document, the term (a)synchronous is in the context of communication with the camera. +Do not confuse this with asyncio: all operations from the user’s perspective are awaitable.

+
+

Both of these patterns will be expanded upon below. But first, a note on selecting parameters for use with messages…

+
+

Selecting Parameters

+

Whenever a parameter is required for a message, it will be type-hinted in the method definition as either a standard Python type +or an Enum from the Params module.

+

Here is a full example for clarity:

+
from open_gopro import WirelessGoPro, Params
+
+with WirelessGoPro() as gopro:
+    gopro.ble_command.set_shutter(Params.Toggle.ENABLE)
+
+
+
+

Tip

+

The message signature can also be found from the API Reference. For example, here is the documentation +of the above message: set_shutter()

+
+
+
+

Synchronous Data Operations

+
+

Note

+

Unless explicitly specified in the Asynchronous section, +all messages are synchronous messages.

+
+

This section refers to sending commands, getting settings / statuses, and setting settings. In all cases here, +the method will await until a response is received.

+
+

Commands

+

Commands are callable instance attributes of a Messages class instance +(i.e. BleCommands or +HttpCommands), thus they can be called directly:

+
async with WirelessGoPro() as gopro:
+    await gopro.ble_command.set_shutter(shutter=Params.Toggle.ENABLE)
+    await gopro.http_command.set_shutter(shutter=Params.Toggle.DISABLE)
+
+
+
+

Warning

+

Most commands specifically require keyword-only arguments. You can +not optionally use positional arguments in such cases as this will affect functionality.

+
+
+
+

Statuses

+

Statuses are instances of a BleStatus(BleStatusFacade). They can be read +synchronously using their get_value method as such:

+
async with WirelessGoPro() as gopro:
+    is_encoding = await gopro.ble_status.encoding_active.get_value()
+    battery = await gopro.ble_status.int_batt_per.get_value()
+
+
+

It is also possible to read all statuses at once via:

+
async with WirelessGoPro() as gopro:
+    statuses = await gopro.ble_command.get_camera_statuses()
+
+
+
+

Note

+

HTTP can not access individual statuses. Instead it can use +get_camera_state() +to retrieve all of them (as well as all of the settings) at once

+
+
+
+

Settings

+

Settings are instances of a BleSetting(BleSettingFacade) +or HttpSetting(HttpSetting). They can be interacted synchronously in several +ways.

+

Their values can be read (via BLE only) using the get_value method as such:

+
async with WirelessGoPro() as gopro:
+    resolution = await gopro.ble_setting.resolution.get_value()
+    fov = await gopro.ble_setting.video_field_of_view.get_value()
+
+
+

It is also possible to read all settings at once via:

+
async with WirelessGoPro() as gopro:
+    settings = await gopro.ble_command.get_camera_settings()
+
+
+
+

Note

+

HTTP can not access individual settings. Instead it can use +get_camera_state() +to retrieve all of them (as well as all of the statuses) at once.

+
+

Depending on the camera’s current state, settings will have differing capabilities. It is possible to query +the current capabilities for a given setting (via BLE only) using the get_capabilities_values method as such:

+
async with WirelessGoPro() as gopro:
+    capabilities = await gopro.ble_setting.resolution.get_capabilities_values()
+
+
+

Settings’ values can be set (via either BLE or WiFI) using the set method as such:

+
async with WirelessGoPro() as gopro:
+    await gopro.ble_setting.resolution.set(Params.Resolution.RES_4K)
+    await gopro.http_setting.fps.set(Params.FPS.FPS_30)
+
+
+
+
+
+

Asynchronous Push Notifications

+

This section describes how to register for and handle asynchronous push notifications. This is only relevant for BLE.

+

It is possible to enable push notifications for any of the following:

+ +

Firstly, the desired settings / ID must be registered for and given a callback to handle received notifications.

+

register_update().

+

Once registered, the camera will send a push notification when the relevant setting / status changes. These +responses will then be sent to the registered callback for handling.

+

It is possible to stop receiving notifications by issuing the relevant unregister command, i.e.:

+ +

Here is an example of registering for and receiving FOV updates:

+
async def process_battery_notifications(update: types.UpdateType, value: int) -> None:
+    if update == constants.StatusId.INT_BATT_PER:
+        ...
+    elif update == constants.StatusId.BATT_LEVEL:
+        ...
+
+async with WirelessGoPro() as gopro:
+    await gopro.ble_status.int_batt_per.register_value_update(process_battery_notifications)
+    await gopro.ble_status.batt_level.register_value_update(process_battery_notifications)
+
+
+
+

Note

+

The register_XXX_update methods also return the current value / capabilities.

+
+
+

Warning

+

The coupling of command ID to command is not obvious. This is a temporary solution and will be improved upon +in a future release.

+
+

It is also possible to register / unregister for all settings, statuses, and / or capabilities +via one API call using the following commands:

+ +
+
+
+

Handling Responses

+

Unless otherwise stated, all commands, settings, and status operations return a GoProResp +(GoProResp) which is a container around a JSON serializable dict with some helper +functions.

+
+

Response Structure

+

A GoProResp has the following relevant attributes / properties for the end user:

+
    +
  • +
    identifier(): identifier of the completed operation.
    +
    This will vary based on what type the response is and will also contain the most specific identification information.
    +
    +
    +
      +

    • UUID if a direct BLE characteristic read

      • +

    • CmdId if an Open GoPro BLE Operation

      • +

    • endpoint string if a Wifi HTTP operation

      • +
    +
    +
    • +

  • protocol(): the communication protocol where the response was received

    • +

  • status(): the status returned from the camera

    • +

  • data(): JSON serializable dict containing the responded data

    • +

  • ok(): Is this a successful response?

    • +
+

The response object can be serialized to a JSON string with the default Python str() function. Note that +the identifier and status attributes are appended to the JSON.

+

For example, first let’s connect, send a command, and then store the response:

+
>>> gopro = WirelessGoPro()
+>>> await gopro.open()
+>>> response = await (gopro.ble_setting.resolution).get_value()
+>>> print(response)
+
+
+

Now let’s print the response (as JSON):

+
>>> print(response)
+{
+    "id" : "QueryCmdId.GET_SETTING_VAL",
+    "status" : "ErrorCode.SUCCESS",
+    "protocol" : "Protocol.BLE",
+    "data" : {
+        "SettingId.RESOLUTION" : "Resolution.RES_4K_16_9",
+    },
+}
+
+
+

Now let’s inspect the responses various attributes / properties:

+
>>> print(response.status)
+ErrorCode.SUCCESS
+>>> print(response.ok)
+True
+>>> print(response.identifier)
+QueryCmdId.GET_SETTING_VAL
+>>> print(response.protocol)
+Protocol.BLE
+
+
+
+
+

Data Access

+

The response data is stored in the data attribute (data()) and its type +is specified via the Generic type specified in the corresponding command signature where the response is defined.

+

For example, consider get_hardware_info(). It’s signature is:

+
async def get_hardware_info(self) -> GoProResp[CameraInfo]:
+    ...
+
+
+

Therefore, its response’s data property is of type CameraInfo(). Continuing the +example from above:

+
>>> gopro = WirelessGoPro(enable_wifi=False)
+>>> await gopro.open()
+>>> response = await gopro.ble_command.get_hardware_info()
+>>> print(response.data)
+{
+    "model_number" : "62",
+    "model_name" : "HERO12 Black",
+    "firmware_version" : "H23.01.01.09.67",
+    "serial_number" : "C3501324500702",
+    "ap_mac_addr" : "2674f7f66104",
+    "ap_ssid" : "GP24500702",
+}
+
+
+
+
+
+

Closing

+

It is important to close the camera resource when you are done with it. This can be done in two ways. If the context +manager was used, it will automatically be closed when exiting, i.e.:

+
with WirelessGoPro() as gopro:
+    # Do some things.
+    pass
+    # Then when finished...
+# The camera resource is closed now!!
+
+
+

Otherwise, you will need to manually call the close method, i.e.:

+
gopro = WirelessGoPro()
+await gopro.open()
+print("Yay! I'm connected via BLE, Wifi, opened, and ready to send / get data now!")
+# When we're done...
+await gopro.close()
+# The camera resource is closed now!!
+
+
+

The close method will handle gracefully disconnecting BLE and Wifi.

+
+

Warning

+

If the resource is not closed correctly, it is possible that your OS will maintain the BLE connection after +the program exits. This will cause reconnection problems as your OS will not discover devices it is +already connected to.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file