sphinx build from Action 7ebe3b7

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

python_sdk/_images/inheritance-5a64f3b42883ec3c7a991e32e9e83af0e5c9a522.png.map

@@ -0,0 +1,4 @@
+<map id="inheritance015dfdbf00" name="inheritance015dfdbf00">
+<area shape="rect" id="node1" href="#open_gopro.api.builders.BleSettingFacade" target="_top" title="Wrapper around BleSetting since a BleSetting&#39;s message definition changes based on how it is being operated on." alt="" coords="5,5,140,31"/>
+<area shape="rect" id="node2" title="Abstract base class for generic types." alt="" coords="37,79,109,104"/>
+</map>

python_sdk/_images/inheritance-9e7418576ad1c01c1baac7156ce2480e33be0963.png.map

@@ -0,0 +1,4 @@
+<map id="inheritancee72a61fe19" name="inheritancee72a61fe19">
+<area shape="rect" id="node1" href="#open_gopro.api.builders.BleStatusFacade" target="_top" title="Wrapper around BleStatus since a BleStatus&#39;s message definition changes based on how it is being operated on." alt="" coords="5,5,135,31"/>
+<area shape="rect" id="node2" title="Abstract base class for generic types." alt="" coords="34,79,106,104"/>
+</map>

python_sdk/_images/inheritance-d8546d3def109014f1418034afe6f5ae469f81b2.png.map

@@ -0,0 +1,11 @@
+<map id="inheritance61a0866e97" name="inheritance61a0866e97">
+<area shape="rect" id="node1" title="Helper class that provides a standard way to create an ABC using" alt="" coords="103,372,175,397"/>
+<area shape="rect" id="node2" href="#open_gopro.communicator_interface.BaseGoProCommunicator" target="_top" title="Common Communicator interface" alt="" coords="44,299,233,324"/>
+<area shape="rect" id="node5" href="#open_gopro.communicator_interface.GoProHttp" target="_top" title="Interface definition for all HTTP communicators" alt="" coords="185,225,274,251"/>
+<area shape="rect" id="node6" href="#open_gopro.communicator_interface.GoProBle" target="_top" title="GoPro specific BLE Client" alt="" coords="5,152,88,177"/>
+<area shape="rect" id="node3" title="Abstract base class for generic types." alt="" coords="88,225,160,251"/>
+<area shape="rect" id="node4" href="#open_gopro.gopro_base.GoProBase" target="_top" title="The base class for communicating with all GoPro Clients" alt="" coords="163,152,256,177"/>
+<area shape="rect" id="node8" href="#open_gopro.communicator_interface.GoProWirelessInterface" target="_top" title="The top&#45;level interface for a Wireless Open GoPro controller" alt="" coords="17,79,191,104"/>
+<area shape="rect" id="node9" href="#open_gopro.gopro_wireless.WirelessGoPro" target="_top" title="The top&#45;level BLE and Wifi interface to a Wireless GoPro device." alt="" coords="108,5,225,31"/>
+<area shape="rect" id="node7" href="#open_gopro.communicator_interface.GoProWifi" target="_top" title="GoPro specific WiFi Client" alt="" coords="281,152,367,177"/>
+</map>

python_sdk/_images/inheritance-e1592119d3000c7c19d7ad1c22deefbcce6ad0e2.png.map

@@ -0,0 +1,9 @@
+<map id="inheritancece88257e1f" name="inheritancece88257e1f">
+<area shape="rect" id="node1" title="Helper class that provides a standard way to create an ABC using" alt="" coords="103,299,175,324"/>
+<area shape="rect" id="node2" href="#open_gopro.communicator_interface.BaseGoProCommunicator" target="_top" title="Common Communicator interface" alt="" coords="45,225,234,251"/>
+<area shape="rect" id="node5" href="#open_gopro.communicator_interface.GoProHttp" target="_top" title="Interface definition for all HTTP communicators" alt="" coords="5,152,95,177"/>
+<area shape="rect" id="node6" href="#open_gopro.communicator_interface.GoProWiredInterface" target="_top" title="The top&#45;level interface for a Wired Open GoPro controller" alt="" coords="150,79,307,104"/>
+<area shape="rect" id="node3" title="Abstract base class for generic types." alt="" coords="119,152,191,177"/>
+<area shape="rect" id="node4" href="#open_gopro.gopro_base.GoProBase" target="_top" title="The base class for communicating with all GoPro Clients" alt="" coords="33,79,126,104"/>
+<area shape="rect" id="node7" href="#open_gopro.gopro_wired.WiredGoPro" target="_top" title="The top&#45;level USB interface to a Wired GoPro device." alt="" coords="105,5,203,31"/>
+</map>

python_sdk/_images/inheritance-ec5587989260a7277f9337e599e7e7025c68e6f1.png.map

@@ -0,0 +1,7 @@
+<map id="inheritancef99e758f3f" name="inheritancef99e758f3f">
+<area shape="rect" id="node1" title="Helper class that provides a standard way to create an ABC using" alt="" coords="23,225,95,251"/>
+<area shape="rect" id="node4" href="#open_gopro.communicator_interface.Message" target="_top" title="Base class for all messages that will be contained in a Messages class" alt="" coords="19,152,99,177"/>
+<area shape="rect" id="node2" title="Abstract base class for generic types." alt="" coords="138,79,210,104"/>
+<area shape="rect" id="node5" href="#open_gopro.api.builders.HttpSetting" target="_top" title="An individual camera setting that is interacted with via Wifi." alt="" coords="69,5,165,31"/>
+<area shape="rect" id="node3" href="#open_gopro.communicator_interface.HttpMessage" target="_top" title="The base class for all HTTP messages. Stores common information." alt="" coords="5,79,113,104"/>
+</map>

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<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<Usage>` section
+
+.. warning::
+   This documentation is not a substitute for the Open GoPro BLE and WiFi
+   `specifications <https://gopro.github.io/OpenGoPro/>`_. 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

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 <[email protected]>
+
+Contributors
+------------
+
+* Ben Freeland <[email protected]>