Built Open GoPro docs from Github Actions

gopro · Apr 19, 2024 · 8b2cd03 · 8b2cd03
1 parent 8ea81ec
commit 8b2cd03
Show file tree

Hide file tree

Showing 72 changed files with 31,454 additions and 19,484 deletions.
diff --git a/ble/.buildinfo b/ble/.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: ca55401b1ba039d0f22292726a740df9
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/ble/.doctrees/environment.pickle b/ble/.doctrees/environment.pickle
diff --git a/ble/.doctrees/features/access_points.doctree b/ble/.doctrees/features/access_points.doctree
diff --git a/ble/.doctrees/features/cohn.doctree b/ble/.doctrees/features/cohn.doctree
diff --git a/ble/.doctrees/features/control.doctree b/ble/.doctrees/features/control.doctree
diff --git a/ble/.doctrees/features/hilights.doctree b/ble/.doctrees/features/hilights.doctree
diff --git a/ble/.doctrees/features/live_streaming.doctree b/ble/.doctrees/features/live_streaming.doctree
diff --git a/ble/.doctrees/features/presets.doctree b/ble/.doctrees/features/presets.doctree
diff --git a/ble/.doctrees/features/query.doctree b/ble/.doctrees/features/query.doctree
diff --git a/ble/.doctrees/features/settings.doctree b/ble/.doctrees/features/settings.doctree
diff --git a/ble/.doctrees/features/statuses.doctree b/ble/.doctrees/features/statuses.doctree
diff --git a/ble/.doctrees/index.doctree b/ble/.doctrees/index.doctree
diff --git a/ble/.doctrees/protocol.doctree b/ble/.doctrees/protocol.doctree
diff --git a/ble/.doctrees/protocol/ble_setup.doctree b/ble/.doctrees/protocol/ble_setup.doctree
diff --git a/ble/.doctrees/protocol/data_protocol.doctree b/ble/.doctrees/protocol/data_protocol.doctree
diff --git a/ble/.doctrees/protocol/id_tables.doctree b/ble/.doctrees/protocol/id_tables.doctree
diff --git a/ble/.doctrees/protocol/protobuf.doctree b/ble/.doctrees/protocol/protobuf.doctree
diff --git a/ble/.doctrees/protocol/state_management.doctree b/ble/.doctrees/protocol/state_management.doctree
diff --git a/ble/_images/plantuml_all_global_behaviors_fsm.png b/ble/_images/plantuml_all_global_behaviors_fsm.png
diff --git a/ble/_sources/features/access_points.rst.txt b/ble/_sources/features/access_points.rst.txt
@@ -8,7 +8,40 @@ Internet connection. While in this mode, HTTP command and control of the camera
 Operations
 ----------
 
+.. operation:protobuf:: Delete Stored Access Point
+    :operation-id: GPCAMERA_NETWORK_DELETE_AP
+
+    .. operation:protobuf-message:: request
+        :feature-id: 0x02
+        :action-id: 0x06
+        :uuid: Network Management Command
+        :message: RequestDeleteSingleAp
+
+    .. operation:protobuf-message:: response
+        :feature-id: 0x02
+        :action-id: 0x86
+        :uuid: Network Management Response
+        :message: ResponseGeneric
+
+
+.. operation:protobuf:: Delete All Stored Access Points
+    :operation-id: OGP_DELETE_ALL_ACCESS_POINTS
+
+    .. operation:protobuf-message:: request
+        :feature-id: 0x02
+        :action-id: 0x07
+        :uuid: Network Management Command
+        :message: RequestDeleteAllAp
+
+    .. operation:protobuf-message:: response
+        :feature-id: 0x02
+        :action-id: 0x87
+        :uuid: Network Management Response
+        :message: ResponseGeneric
+
 .. operation:protobuf:: Scan for Access Points
+    :operation-id: GPCAMERA_NETWORK_START_AP_SCAN
+    :external:
 
     .. image:: ../../assets/images/plantuml_ble_scan_for_ssids.png
 
@@ -31,20 +64,29 @@ Operations
         :message: NotifStartScanning
 
 .. operation:protobuf:: Get AP Scan Results
+    :operation-id: GPCAMERA_NETWORK_GET_AP_LIST
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0x02
-        :action-id: 0x04
+        :action-id: 0x03
         :uuid: Network Management Command
         :message: RequestGetApEntries
 
     .. operation:protobuf-message:: response
         :feature-id: 0x02
-        :action-id: 0x84
+        :action-id: 0x83
         :uuid: Network Management Response
         :message: ResponseGetApEntries
 
 .. operation:protobuf:: Connect to Provisioned Access Point
+    :operation-id: GPCAMERA_NETWORK_CONNECT_EXISTING_AP
+    :external:
+
+    .. warning:: This operation can only be used on an Access Point that has been previously configured.  Therefore it is
+        first necessary to :operation:ref:`Scan for Access Points`, then :operation:ref:`Get AP Scan Results` to ensure
+        that the relevant :ref:`Scan Entry<proto-responsegetapentries_scanentry>` has the
+        :ref:`SCAN_FLAG_CONFIGURED<proto-enumscanentryflags>` bit set.
 
     .. image:: ../../assets/images/plantuml_ble_connect_ap.png
 
@@ -67,8 +109,13 @@ Operations
         :message: NotifProvisioningState
 
 .. operation:protobuf:: Connect to a New Access Point
+    :operation-id: GPCAMERA_NETWORK_CONNECT_NEW_AP
+    :external:
 
-    .. note:: This should only be done once to provision the AP; subsequent connections should use RequestConnect.
+    .. warning:: This operation can only be used on an Access Point that has not been previously configured.  Therefore it
+        is first necessary to :operation:ref:`Scan for Access Points`, then :operation:ref:`Get AP Scan Results` to
+        ensure that the relevant :ref:`Scan Entry<proto-responsegetapentries_scanentry>` does not have the
+        :ref:`SCAN_FLAG_CONFIGURED<proto-enumscanentryflags>` bit set.
 
     .. image:: ../../assets/images/plantuml_ble_connect_new_ap.png
 
@@ -93,8 +140,7 @@ Operations
 Disconnect from Access Point
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-To disconnect from a connected Access Point and return the camera to AP mode, use
-`Set AP Control <../features/control.html#set_ap_control>`__
-to set AP Control: ON, which disables Station Mode.
+To disconnect from a connected Access Point and return the camera to AP mode, use :operation:ref:`Set AP Control`
+to set AP Control On, which disables Station Mode.
 
 .. image:: ../../assets/images/plantuml_ble_disconnect_ap.png
diff --git a/ble/_sources/features/cohn.rst.txt b/ble/_sources/features/cohn.rst.txt
@@ -58,9 +58,9 @@ Provisioning Procedure
 In order to use the COHN capability, the camera must first be provisioned for COHN. At a high level, the provisioning process
 is as follows:
 
-1. Instruct the GoPro to `create <cohn.html#create_cohn_certificate>`__ the COHN certificate
-2. `Get <cohn.html#get_cohn_certificate>`__ the created COHN certificate
-3. `Get <cohn.html#get_cohn_status>`__  the Basic auth credentials
+1. Instruct the GoPro to :operation:ref:`Create COHN Certificate`
+2. Use :operation:ref:`Get COHN Certificate` to get the created COHN certificate
+3. Use :operation:ref:`Get COHN Status` to get the Basic auth credentials
 4. Connect the camera to an :doc:`access point<access_points>`
 
 .. tip:: Depending on the use case, some of these steps can be performed via `HTTP <https://gopro.github.io/OpenGoPro/http#tag/COHN>`_
@@ -75,7 +75,8 @@ Operations
 ==========
 
 .. operation:protobuf:: Clear COHN Certificate
-    :unsupported: boilers kongs pismo sultans
+    :operation-id: GPCAMERA_CLEAR_HOME_NETWORK_CERT
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF1
@@ -86,11 +87,12 @@ Operations
     .. operation:protobuf-message:: response
         :feature-id: 0xF1
         :action-id: 0xE6
-        :uuid: Response
+        :uuid: Command Response
         :message: ResponseGeneric
 
 .. operation:protobuf:: Create COHN Certificate
-    :unsupported: boilers kongs pismo sultans
+    :operation-id: GPCAMERA_CREATE_HOME_NETWORK_CERT
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF1
@@ -101,47 +103,50 @@ Operations
     .. operation:protobuf-message:: response
         :feature-id: 0xF1
         :action-id: 0xE7
-        :uuid: Response
+        :uuid: Command Response
         :message: ResponseGeneric
 
 .. operation:protobuf:: Get COHN Certificate
-    :unsupported: boilers kongs pismo sultans
+    :operation-id: GPCAMERA_GET_HOME_NETWORK_CERT
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF5
         :action-id: 0x6E
-        :uuid: Command
+        :uuid: Query
         :message: WSDK_RequestCOHNCert
 
     .. operation:protobuf-message:: response
         :feature-id: 0xF5
         :action-id: 0xEE
-        :uuid: Response
+        :uuid: Query Response
         :message: WSDK_ResponseCOHNCert
 
 .. operation:protobuf:: Get COHN Status
-    :unsupported: boilers kongs pismo sultans
+    :operation-id: GPCAMERA_GET_HOME_NETWORK_STATUS
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF5
         :action-id: 0x6F
-        :uuid: Command
+        :uuid: Query
         :message: WSDK_RequestGetCOHNStatus
 
     .. operation:protobuf-message:: response
         :feature-id: 0xF5
         :action-id: 0xEF
-        :uuid: Response
+        :uuid: Query Response
         :message: WSDK_NotifyCOHNStatus
 
     .. operation:protobuf-message:: notification
         :feature-id: 0xF5
         :action-id: 0xEF
-        :uuid: Response
+        :uuid: Query Response
         :message: WSDK_NotifyCOHNStatus
 
 .. operation:protobuf:: Set COHN Setting
-    :unsupported: boilers kongs pismo sultans
+    :operation-id: GPCAMERA_SET_HOME_NETWORK_SETTING
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF1
@@ -152,5 +157,5 @@ Operations
     .. operation:protobuf-message:: response
         :feature-id: 0xF1
         :action-id: 0xE5
-        :uuid: Response
+        :uuid: Command Response
         :message: ResponseGeneric
diff --git a/ble/_sources/features/control.rst.txt b/ble/_sources/features/control.rst.txt
@@ -6,13 +6,30 @@ This page will detail operations to command and control the GoPro.
 Operations
 ----------
 
+.. operation:protobuf:: Clear New Media Flag
+    :operation-id: GPCAMERA_MOBILE_OFFLOAD_NEW_MEDIA_FLAG_CLEAR
+
+    .. operation:protobuf-message:: request
+        :feature-id: 0xF1
+        :action-id: 0x7C
+        :uuid: Command
+        :message: WSDK_RequestClearNewMediaFlag
+
+    .. operation:protobuf-message:: response
+        :feature-id: 0xF1
+        :action-id: 0xFC
+        :uuid: Command Response
+        :message: ResponseGeneric
+
 .. operation:tlv-command:: Keep Alive
+    :operation-id: OGP_KEEP_ALIVE
+    :external:
     :id: 0x5B
 
     In order to maximize battery life, GoPro cameras automatically go to sleep after some time. This logic is handled by
-    a combination of the `Auto Power Down <../features/settings.html#setting_59>`_
-    setting which most (but not all) cameras support and a Keep Alive message that the user can regularly send to the
-    camera. The camera will automatically go to sleep if both timers reach zero.
+    a combination of the :operation:ref:`Auto Off<Setting 59>` setting which most (but not all) cameras support
+    and a Keep Alive message that the user can regularly send to the camera. The camera will automatically go to sleep
+    if both timers reach zero.
 
     The Auto Power Down timer is reset when the user taps the LCD screen, presses a button on the camera,
     programmatically (un)sets the shutter, sets a setting, or loads a Preset.
@@ -30,6 +47,8 @@ Operations
         :uuid: Settings Response
 
 .. operation:tlv-command:: Set Analytics
+    :operation-id: GPCAMERA_ANALYTICS_SET_CLIENT_INFO
+    :external:
     :id: 0x50
 
     Configure the client as third-party for analytic tracking.
@@ -40,6 +59,8 @@ Operations
         :uuid: Command Response
 
 .. operation:tlv-command:: Set AP Control
+    :operation-id: GPCAMERA_AP_CONTROL
+    :external:
     :id: 0x17
 
     Enable / disable the camera's WiFi access point.
@@ -52,7 +73,8 @@ Operations
         :uuid: Command Response
 
 .. operation:protobuf:: Set Camera Control
-    :unsupported: boilers
+    :operation-id: GPCAMERA_SET_CAMERA_CONTROL_STATUS
+    :external:
 
     .. image:: ../../assets/images/global_behaviors.png
 
@@ -69,6 +91,8 @@ Operations
         :message: ResponseGeneric
 
 .. operation:tlv-command:: Set Date Time
+    :operation-id: GPCAMERA_SET_DATE_AND_TIME_ID
+    :external:
     :id: 0x0D
 
     Set the camera's date and time (without timezone and daylight-savings information).
@@ -92,8 +116,9 @@ Operations
         :uuid: Command Response
 
 .. operation:tlv-command:: Set Local Date Time
+    :operation-id: GPCAMERA_SET_DATE_AND_TIME_DST_ID
+    :external:
     :id: 0x0F
-    :unsupported: boilers kongs
 
     Set the cameras date and time with timezone and daylight-savings information.
 
@@ -117,7 +142,24 @@ Operations
     .. operation:tlv-message:: Response
         :uuid: Command Response
 
+.. operation:protobuf:: Set Pairing State
+    :operation-id: GPCAMERA_WIRELESS_PAIRING_COMPLETE
+
+    .. operation:protobuf-message:: request
+        :feature-id: 0x03
+        :action-id: 0x01
+        :uuid: Network Management Command
+        :message: RequestPairingFinish
+
+    .. operation:protobuf-message:: response
+        :feature-id: 0x03
+        :action-id: 0x81
+        :uuid: Network Management Response
+        :message: ResponseGeneric
+
 .. operation:tlv-command:: Set Shutter
+    :operation-id: GPCAMERA_SHUTTER
+    :external:
     :id: 0x01
 
     Set Shutter On / Off
@@ -130,6 +172,8 @@ Operations
         :uuid: Command Response
 
 .. operation:protobuf:: Set Turbo Transfer
+    :operation-id: GPCAMERA_TURBO_MODE_ENABLE
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF1
@@ -143,7 +187,24 @@ Operations
         :uuid: Command Response
         :message: ResponseGeneric
 
+.. operation:protobuf:: Set Wakeup Reason
+    :operation-id: OGP_SET_WAKEUP_REASON
+
+    .. operation:protobuf-message:: request
+        :feature-id: 0xF1
+        :action-id: 0x7D
+        :uuid: Command
+        :message: WSDK_RequestSetSystemNotifyEvent
+
+    .. operation:protobuf-message:: response
+        :feature-id: 0xF1
+        :action-id: 0xFD
+        :uuid: Command Response
+        :message: ResponseGeneric
+
 .. operation:tlv-command:: Sleep
+    :operation-id: GPCAMERA_POWER_ID
+    :external:
     :id: 0x05
 
     Put the camera to sleep.

diff --git a/ble/_sources/features/hilights.rst.txt b/ble/_sources/features/hilights.rst.txt
@@ -5,6 +5,8 @@ Operations
 ----------
 
 .. operation:tlv-command:: Hilight Moment
+    :operation-id: GPCAMERA_TAG_MOMENT
+    :external:
     :id: 0x18
 
     Add a hilight while recording. This can only be used during encoding.

diff --git a/ble/_sources/features/live_streaming.rst.txt b/ble/_sources/features/live_streaming.rst.txt
@@ -10,8 +10,8 @@ For additional details about getting started with RTMP, see
 Live streaming with camera is accomplished as follows:
 
 1. Put the camera into :doc:`Station Mode<access_points>` and connect it to an access point
-2. Set the `Livestream Mode <live_streaming.html#set_livestream_mode>`__
-3. Poll for `Livestream Status <live_streaming.html#get_livestream_status>`__ until the camera indicates it is ready
+2. Use :operation:ref:`Set Livestream Mode` to configure livestreaming.
+3. Poll for :operation:ref:`Livestream Status<Get Livestream Status>` until the camera indicates it is ready
 4. Set the shutter to begin live streaming
 5. Unset the shutter to stop live streaming
 
@@ -21,10 +21,10 @@ Operations
 ----------
 
 .. operation:protobuf:: Set Livestream Mode
+    :operation-id: GPCAMERA_LIVE_STREAM_SETUP
+    :external:
 
-    .. note:: The current Livestream Mode can be queried via
-        `Get Livestream Status <live_streaming.html#get_livestream_status>`__
-
+    .. note:: The current Livestream Mode can be queried via :operation:ref:`Get Livestream Status`
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF1
@@ -39,6 +39,8 @@ Operations
         :message: ResponseGeneric
 
 .. operation:protobuf:: Get Livestream Status
+    :operation-id: OGP_LIVESTREAM_STATUS
+    :external:
 
     .. operation:protobuf-message:: request
         :feature-id: 0xF5