Built Open GoPro docs from Internal Repo

gopro · Jul 23, 2024 · 85c021c · 85c021c
1 parent 2306e94
commit 85c021c
Show file tree

Hide file tree

Showing 37 changed files with 18,907 additions and 11,564 deletions.
diff --git a/ble/_sources/features/presets.rst.txt b/ble/_sources/features/presets.rst.txt
@@ -47,6 +47,21 @@ The value of this status is set to a non-zero value when:
 Operations
 ----------
 
+.. operation:protobuf:: Create Custom Preset
+    :operation-id: GPCAMERA_CREATE_PRESET_V2
+
+    .. operation:protobuf-message:: request
+        :feature-id: 0xF1
+        :action-id: 0x76
+        :uuid: Command
+        :message: WSDK_RequestCreateCustomPreset
+
+    .. operation:protobuf-message:: response
+        :feature-id: 0xF1
+        :action-id: 0xF6
+        :uuid: Command Response
+        :message: WSDK_ResponseCreateCustomPreset
+
 .. operation:protobuf:: Get Available Presets
     :operation-id: OGP_PRESETS_GET
     :external:

diff --git a/ble/_sources/protocol/protobuf.rst.txt b/ble/_sources/protocol/protobuf.rst.txt
@@ -2249,6 +2249,13 @@ Preset Group meta information and contained Presets
 
      - The icon to display for this preset group
 
+   * - mode_array
+
+     - :ref:`proto-enumflatmode`
+     - 5
+
+     - A list of flatmodes available for this preset group
+
 
 
 
@@ -2535,7 +2542,7 @@ Returns a :ref:`proto-responsegeneric` with the status of the preset update requ
      - string
      - 2
 
-     - | UTF-8 encoded custom preset name
+     - | UTF-8 encoded custom preset name to be used if `title_id` is set to 94 (PRESET_TITLE_USER_DEFINED_CUSTOM_NAME)
        | 
        | The name must obey the following:
        | 
@@ -2896,7 +2903,8 @@ Response: :ref:`proto-responsegeneric`
 
      - | Resolution to use for live stream
        | 
-       | The set of supported resolutions is only available from the `live_stream_window_size_supported_array` in :ref:`proto-notifylivestreamstatus`)
+       | The set of supported resolutions is only available from the `live_stream_window_size_supported_array`
+       | in :ref:`proto-notifylivestreamstatus`.
 
    * - cert
      - bytes
@@ -2929,7 +2937,8 @@ Response: :ref:`proto-responsegeneric`
 
      - | Lens to use for live stream
        | 
-       | The set of supported lenses is only available from the  `live_stream_lens_supported_array` in :ref:`proto-notifylivestreamstatus`)
+       | The set of supported lenses is only available from the  `live_stream_lens_supported_array`
+       | in :ref:`proto-notifylivestreamstatus`.
 
 
 

diff --git a/ble/_static/searchtools.js b/ble/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
 
   htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    for (const removalQuery of [".headerlinks", "script", "style"]) {
+    for (const removalQuery of [".headerlink", "script", "style"]) {
       htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
     }
     if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
     for (const [title, foundTitles] of Object.entries(allTitles)) {
       if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
-          let score = Math.round(100 * queryLower.length / title.length)
+          const score = Math.round(Scorer.title * queryLower.length / title.length);
+          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
           normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
             null,
-            score,
+            score + boost,
             filenames[file],
           ]);
         }

diff --git a/ble/features/access_points.html b/ble/features/access_points.html
@@ -415,6 +415,9 @@
 <a class="reference internal" href="settings.html#setting-ids">Setting IDs</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-resolution-2">Video Resolution (2)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#frames-per-second-3">Frames Per Second (3)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#video-timelapse-rate-5">Video Timelapse Rate (5)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#photo-timelapse-rate-30">Photo Timelapse Rate (30)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#nightlapse-rate-32">Nightlapse Rate (32)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#webcam-digital-lenses-43">Webcam Digital Lenses (43)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#auto-power-down-59">Auto Power Down (59)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#gps-83">GPS (83)</a></li>
@@ -424,7 +427,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#time-lapse-digital-lenses-123">Time Lapse Digital Lenses (123)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#photo-output-125">Photo Output (125)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#media-format-128">Media Format (128)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#setup-anti-flicker-134">Setup Anti-Flicker (134)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#anti-flicker-134">Anti-Flicker (134)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#hypersmooth-135">Hypersmooth (135)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-horizon-leveling-150">Video Horizon Leveling (150)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#photo-horizon-leveling-151">Photo Horizon Leveling (151)</a></li>
@@ -437,7 +440,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#easy-mode-speed-176">Easy Mode Speed (176)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#enable-night-photo-177">Enable Night Photo (177)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#wireless-band-178">Wireless Band (178)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#trail-length-179">Trail Length (179)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#star-trails-length-179">Star Trails Length (179)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#system-video-mode-180">System Video Mode (180)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-bit-rate-182">Video Bit Rate (182)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#bit-depth-183">Bit Depth (183)</a></li>
@@ -446,7 +449,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#lapse-mode-187">Lapse Mode (187)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#max-lens-mod-189">Max Lens Mod (189)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#max-lens-mod-enable-190">Max Lens Mod Enable (190)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#photo-mode-191">Photo Mode (191)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#easy-night-photo-191">Easy Night Photo (191)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#multi-shot-aspect-ratio-192">Multi Shot Aspect Ratio (192)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#framing-193">Framing (193)</a></li>
 </ul>
@@ -499,7 +502,7 @@
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#liveview-x-67">Liveview X (67)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#gps-lock-68">GPS Lock (68)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#ap-mode-69">AP Mode (69)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="statuses.html#internal-battery-70">Internal Battery (70)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="statuses.html#internal-battery-percentage-70">Internal Battery Percentage (70)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#microphone-accessory-74">Microphone Accessory (74)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#zoom-level-75">Zoom Level (75)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#wireless-band-76">Wireless Band (76)</a></li>

diff --git a/ble/features/cohn.html b/ble/features/cohn.html
@@ -415,6 +415,9 @@
 <a class="reference internal" href="settings.html#setting-ids">Setting IDs</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-resolution-2">Video Resolution (2)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#frames-per-second-3">Frames Per Second (3)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#video-timelapse-rate-5">Video Timelapse Rate (5)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#photo-timelapse-rate-30">Photo Timelapse Rate (30)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#nightlapse-rate-32">Nightlapse Rate (32)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#webcam-digital-lenses-43">Webcam Digital Lenses (43)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#auto-power-down-59">Auto Power Down (59)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#gps-83">GPS (83)</a></li>
@@ -424,7 +427,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#time-lapse-digital-lenses-123">Time Lapse Digital Lenses (123)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#photo-output-125">Photo Output (125)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#media-format-128">Media Format (128)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#setup-anti-flicker-134">Setup Anti-Flicker (134)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#anti-flicker-134">Anti-Flicker (134)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#hypersmooth-135">Hypersmooth (135)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-horizon-leveling-150">Video Horizon Leveling (150)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#photo-horizon-leveling-151">Photo Horizon Leveling (151)</a></li>
@@ -437,7 +440,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#easy-mode-speed-176">Easy Mode Speed (176)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#enable-night-photo-177">Enable Night Photo (177)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#wireless-band-178">Wireless Band (178)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#trail-length-179">Trail Length (179)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#star-trails-length-179">Star Trails Length (179)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#system-video-mode-180">System Video Mode (180)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-bit-rate-182">Video Bit Rate (182)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#bit-depth-183">Bit Depth (183)</a></li>
@@ -446,7 +449,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#lapse-mode-187">Lapse Mode (187)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#max-lens-mod-189">Max Lens Mod (189)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#max-lens-mod-enable-190">Max Lens Mod Enable (190)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#photo-mode-191">Photo Mode (191)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#easy-night-photo-191">Easy Night Photo (191)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#multi-shot-aspect-ratio-192">Multi Shot Aspect Ratio (192)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#framing-193">Framing (193)</a></li>
 </ul>
@@ -499,7 +502,7 @@
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#liveview-x-67">Liveview X (67)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#gps-lock-68">GPS Lock (68)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#ap-mode-69">AP Mode (69)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="statuses.html#internal-battery-70">Internal Battery (70)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="statuses.html#internal-battery-percentage-70">Internal Battery Percentage (70)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#microphone-accessory-74">Microphone Accessory (74)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#zoom-level-75">Zoom Level (75)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#wireless-band-76">Wireless Band (76)</a></li>

diff --git a/ble/features/control.html b/ble/features/control.html
@@ -415,6 +415,9 @@
 <a class="reference internal" href="settings.html#setting-ids">Setting IDs</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-resolution-2">Video Resolution (2)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#frames-per-second-3">Frames Per Second (3)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#video-timelapse-rate-5">Video Timelapse Rate (5)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#photo-timelapse-rate-30">Photo Timelapse Rate (30)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#nightlapse-rate-32">Nightlapse Rate (32)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#webcam-digital-lenses-43">Webcam Digital Lenses (43)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#auto-power-down-59">Auto Power Down (59)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#gps-83">GPS (83)</a></li>
@@ -424,7 +427,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#time-lapse-digital-lenses-123">Time Lapse Digital Lenses (123)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#photo-output-125">Photo Output (125)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#media-format-128">Media Format (128)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#setup-anti-flicker-134">Setup Anti-Flicker (134)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#anti-flicker-134">Anti-Flicker (134)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#hypersmooth-135">Hypersmooth (135)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-horizon-leveling-150">Video Horizon Leveling (150)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#photo-horizon-leveling-151">Photo Horizon Leveling (151)</a></li>
@@ -437,7 +440,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#easy-mode-speed-176">Easy Mode Speed (176)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#enable-night-photo-177">Enable Night Photo (177)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#wireless-band-178">Wireless Band (178)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#trail-length-179">Trail Length (179)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#star-trails-length-179">Star Trails Length (179)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#system-video-mode-180">System Video Mode (180)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#video-bit-rate-182">Video Bit Rate (182)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#bit-depth-183">Bit Depth (183)</a></li>
@@ -446,7 +449,7 @@
 <li class="toctree-l3"><a class="reference internal" href="settings.html#lapse-mode-187">Lapse Mode (187)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#max-lens-mod-189">Max Lens Mod (189)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#max-lens-mod-enable-190">Max Lens Mod Enable (190)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="settings.html#photo-mode-191">Photo Mode (191)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="settings.html#easy-night-photo-191">Easy Night Photo (191)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#multi-shot-aspect-ratio-192">Multi Shot Aspect Ratio (192)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="settings.html#framing-193">Framing (193)</a></li>
 </ul>
@@ -499,7 +502,7 @@
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#liveview-x-67">Liveview X (67)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#gps-lock-68">GPS Lock (68)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#ap-mode-69">AP Mode (69)</a></li>
-<li class="toctree-l3"><a class="reference internal" href="statuses.html#internal-battery-70">Internal Battery (70)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="statuses.html#internal-battery-percentage-70">Internal Battery Percentage (70)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#microphone-accessory-74">Microphone Accessory (74)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#zoom-level-75">Zoom Level (75)</a></li>
 <li class="toctree-l3"><a class="reference internal" href="statuses.html#wireless-band-76">Wireless Band (76)</a></li>