sphinx build from Action 1ee1fa6

gopro · Nov 17, 2023 · eeb7c7e · eeb7c7e
1 parent aa93ec5
commit eeb7c7e
Show file tree

Hide file tree

Showing 12 changed files with 410 additions and 88 deletions.
diff --git a/python_sdk/_images/coverage.svg b/python_sdk/_images/coverage.svg
diff --git a/python_sdk/_sources/api.rst.txt b/python_sdk/_sources/api.rst.txt
@@ -81,6 +81,8 @@ GoPro Enum
 
 .. autoclass:: open_gopro.enum.GoProEnum
 
+.. autoclass:: open_gopro.enum.GoProIntEnum
+
 BLE Setting
 ^^^^^^^^^^^
 

diff --git a/python_sdk/_sources/changelog.rst.txt b/python_sdk/_sources/changelog.rst.txt
@@ -9,6 +9,12 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
+Unreleased
+----------
+* 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
+
 0.14.1 (September-21-2022)
 --------------------------
 * Fix BLE notifications not being routed correctly

diff --git a/python_sdk/_sources/quickstart.rst.txt b/python_sdk/_sources/quickstart.rst.txt
@@ -227,35 +227,3 @@ For more information, do:
     --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
-
-API GUI Demo
--------------
-
-.. warning::
-    This is a work in progress and some complex responses are not yet easily viewed.
-
-This is a GUI which allows the user to connect a camera and send any command, view status / setting
-updates, view a video stream, and log sent / received messages. It can be started with:
-
-.. code-block:: console
-
-    $ gopro-gui
-
-This will launch a camera chooser screen where the user can either manually enter a camera to connect to
-or automatically connect to the first found camera. Once connected, the GUI will appear. Usages is as follows:
-
-- Choose a command from the Command Pallette on the left
-
-  - Note that besides supporting all of the commands from the Open GoPro API, there is also a "Compound" commands
-    section which contains commands that combine API functionality. One of these, for example, is Livestream
-    which will connect Wifi, configure and start livestreaming.
-- Once chosen, enter the desired parameters in the entry form at the top middle
-- In the same entry form, click the button to send the command
-- The sent command and received response will be logged in the log in the bottom middle as well as any
-  asynchronously received messages.
-- Any log messages with a down arrow can be expanded to view their details
-- Any received statuses, settings, and setting capabilities will be updated in the pane at the top right.
-
-  - The most recently received updates will be highlighted in blue
-- A network stream can be started using the video pane in the bottom right. This will automatically get started
-  after sending the Livestream command
diff --git a/python_sdk/_static/coverage.svg b/python_sdk/_static/coverage.svg
diff --git a/python_sdk/api.html b/python_sdk/api.html
diff --git a/python_sdk/changelog.html b/python_sdk/changelog.html
@@ -58,6 +58,7 @@
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="authors.html">Credits</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#september-21-2022">0.14.1 (September-21-2022)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#september-13-2022">0.14.0 (September-13-2022)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#february-24-2023">0.13.0 (February-24-2023)</a></li>
@@ -134,6 +135,19 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
 <p>All notable changes to this project will be documented in this file.</p>
 <p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
 and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
+<section id="unreleased">
+<h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this heading"></a></h2>
+<ul class="simple">
+<li><dl class="simple">
+<dt>Add alpha support for COHN (Camera-on-the-Home-Network)</dt><dd><ul>
+<li><p>A real implementation is going to require a major rearchitecture to dynamically add connection types.</p></li>
+</ul>
+</dd>
+</dl>
+</li>
+<li><p>Remove TKinter GUI. Will be replaced with Textual TUI in the future</p></li>
+</ul>
+</section>
 <section id="september-21-2022">
 <h2>0.14.1 (September-21-2022)<a class="headerlink" href="#september-21-2022" title="Permalink to this heading"></a></h2>
 <ul class="simple">

diff --git a/python_sdk/genindex.html b/python_sdk/genindex.html
@@ -376,16 +376,34 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="api.html#open_gopro.constants.GoProUUIDs.CN_NET_MGMT_RESP">CN_NET_MGMT_RESP (GoProUUIDs attribute)</a>
 </li>
-      <li><a href="api.html#open_gopro.constants.WebcamError.COM_TIMEOUT">COM_TIMEOUT (WebcamError attribute)</a>
+      <li><a href="api.html#open_gopro.api.ble_commands.BleCommands.cohn_clear_certificate">cohn_clear_certificate() (BleCommands method)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.ble_commands.BleCommands.cohn_create_certificate">cohn_create_certificate() (BleCommands method)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.ble_commands.BleCommands.cohn_get_certificate">cohn_get_certificate() (BleCommands method)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.ble_commands.BleCommands.cohn_get_status">cohn_get_status() (BleCommands method)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.ble_commands.BleCommands.cohn_set_setting">cohn_set_setting() (BleCommands method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#open_gopro.constants.WebcamError.COM_TIMEOUT">COM_TIMEOUT (WebcamError attribute)</a>
+</li>
       <li><a href="api.html#open_gopro.constants.FeatureId.COMMAND">COMMAND (FeatureId attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.api.params.PairState.COMPLETED">COMPLETED (PairState attribute)</a>
 
       <ul>
         <li><a href="api.html#open_gopro.api.params.WAPState.COMPLETED">(WAPState attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="api.html#open_gopro.gopro_base.GoProBase.configure_cohn">configure_cohn() (GoProBase method)</a>
+
+      <ul>
+        <li><a href="api.html#open_gopro.gopro_wired.WiredGoPro.configure_cohn">(WiredGoPro method)</a>
+</li>
+        <li><a href="api.html#open_gopro.gopro_wireless.WirelessGoPro.configure_cohn">(WirelessGoPro method)</a>
 </li>
       </ul></li>
       <li><a href="api.html#open_gopro.ble.controller.BLEController.connect">connect() (BLEController method)</a>
@@ -734,10 +752,10 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="api.html#open_gopro.constants.QueryCmdId.GET_SETTING_NAME">GET_SETTING_NAME (QueryCmdId attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#open_gopro.constants.QueryCmdId.GET_SETTING_VAL">GET_SETTING_VAL (QueryCmdId attribute)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#open_gopro.constants.CmdId.GET_SETTINGS_JSON">GET_SETTINGS_JSON (CmdId attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.constants.QueryCmdId.GET_STATUS_VAL">GET_STATUS_VAL (QueryCmdId attribute)</a>
@@ -779,6 +797,8 @@ <h2 id="G">G</h2>
       <li><a href="api.html#open_gopro.exceptions.GoProError">GoProError</a>
 </li>
       <li><a href="api.html#open_gopro.communicator_interface.GoProHttp">GoProHttp (class in open_gopro.communicator_interface)</a>
+</li>
+      <li><a href="api.html#open_gopro.enum.GoProIntEnum">GoProIntEnum (class in open_gopro.enum)</a>
 </li>
       <li><a href="api.html#open_gopro.exceptions.GoProNotOpened">GoProNotOpened</a>
 </li>
@@ -970,8 +990,6 @@ <h2 id="I">I</h2>
       </ul></li>
       <li><a href="api.html#open_gopro.exceptions.InvalidConfiguration">InvalidConfiguration</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#open_gopro.exceptions.InvalidOpenGoProVersion">InvalidOpenGoProVersion</a>
 </li>
       <li><a href="api.html#open_gopro.gopro_base.GoProBase.is_ble_connected">is_ble_connected (GoProBase property)</a>
@@ -980,6 +998,16 @@ <h2 id="I">I</h2>
         <li><a href="api.html#open_gopro.gopro_wired.WiredGoPro.is_ble_connected">(WiredGoPro property)</a>
 </li>
         <li><a href="api.html#open_gopro.gopro_wireless.WirelessGoPro.is_ble_connected">(WirelessGoPro property)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#open_gopro.gopro_base.GoProBase.is_cohn_provisioned">is_cohn_provisioned (GoProBase property)</a>
+
+      <ul>
+        <li><a href="api.html#open_gopro.gopro_wired.WiredGoPro.is_cohn_provisioned">(WiredGoPro property)</a>
+</li>
+        <li><a href="api.html#open_gopro.gopro_wireless.WirelessGoPro.is_cohn_provisioned">(WirelessGoPro property)</a>
 </li>
       </ul></li>
       <li><a href="api.html#open_gopro.ble.client.BleClient.is_connected">is_connected (BleClient property)</a>
@@ -1804,6 +1832,8 @@ <h2 id="R">R</h2>
 </li>
       </ul></li>
       <li><a href="api.html#open_gopro.constants.ActionId.RELEASE_NETWORK">RELEASE_NETWORK (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.ble_commands.BleCommands.release_network">release_network() (BleCommands method)</a>
 </li>
       <li><a href="api.html#open_gopro.constants.ActionId.RELEASE_NETWORK_RSP">RELEASE_NETWORK_RSP (ActionId attribute)</a>
 </li>
@@ -1823,6 +1853,16 @@ <h2 id="R">R</h2>
         <li><a href="api.html#open_gopro.api.params.SDStatus.REMOVED">(SDStatus attribute)</a>
 </li>
       </ul></li>
+      <li><a href="api.html#open_gopro.constants.ActionId.REQUEST_CLEAR_COHN_CERT">REQUEST_CLEAR_COHN_CERT (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.REQUEST_COHN_SETTING">REQUEST_COHN_SETTING (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.REQUEST_CREATE_COHN_CERT">REQUEST_CREATE_COHN_CERT (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.REQUEST_GET_COHN_CERT">REQUEST_GET_COHN_CERT (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.REQUEST_GET_COHN_STATUS">REQUEST_GET_COHN_STATUS (ActionId attribute)</a>
+</li>
       <li><a href="api.html#open_gopro.constants.ActionId.REQUEST_WIFI_CONNECT">REQUEST_WIFI_CONNECT (ActionId attribute)</a>
 </li>
   </ul></td>
@@ -1892,12 +1932,24 @@ <h2 id="R">R</h2>
       <li><a href="api.html#open_gopro.api.http_commands.HttpSettings.resolution">resolution (HttpSettings attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.constants.SettingId.RESOLUTION">RESOLUTION (SettingId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.RESPONSE_CLEAR_COHN_CERT">RESPONSE_CLEAR_COHN_CERT (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.RESPONSE_COHN_SETTING">RESPONSE_COHN_SETTING (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.RESPONSE_CREATE_COHN_CERT">RESPONSE_CREATE_COHN_CERT (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.RESPONSE_GET_COHN_CERT">RESPONSE_GET_COHN_CERT (ActionId attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.constants.ActionId.RESPONSE_GET_COHN_STATUS">RESPONSE_GET_COHN_STATUS (ActionId attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.exceptions.ResponseParseError">ResponseParseError</a>
 </li>
       <li><a href="api.html#open_gopro.exceptions.ResponseTimeout">ResponseTimeout</a>
 </li>
       <li><a href="api.html#open_gopro.models.media_list.MediaMetadata.rotate">rotate (MediaMetadata attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.params.WebcamProtocol.RTSP">RTSP (WebcamProtocol attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.communicator_interface.RuleSignature">RuleSignature (class in open_gopro.communicator_interface)</a>
 </li>
@@ -2370,6 +2422,8 @@ <h2 id="T">T</h2>
       <li><a href="api.html#open_gopro.constants.StatusId.TOTAL_SD_SPACE_KB">TOTAL_SD_SPACE_KB (StatusId attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.models.media_list.MediaMetadata.transcoded">transcoded (MediaMetadata attribute)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.params.WebcamProtocol.TS">TS (WebcamProtocol attribute)</a>
 </li>
       <li><a href="api.html#open_gopro.api.ble_commands.BleStatuses.turbo_mode">turbo_mode (BleStatuses attribute)</a>
 </li>
@@ -2628,6 +2682,8 @@ <h2 id="W">W</h2>
       <li><a href="api.html#open_gopro.constants.WebcamError">WebcamError (class in open_gopro.constants)</a>
 </li>
       <li><a href="api.html#open_gopro.api.params.WebcamFOV">WebcamFOV (class in open_gopro.api.params)</a>
+</li>
+      <li><a href="api.html#open_gopro.api.params.WebcamProtocol">WebcamProtocol (class in open_gopro.api.params)</a>
 </li>
       <li><a href="api.html#open_gopro.api.params.WebcamResolution">WebcamResolution (class in open_gopro.api.params)</a>
 </li>