From 90f44f896615bdfd9a6b8cfbfddc10ebbe65dc13 Mon Sep 17 00:00:00 2001 From: Tim Camise Date: Tue, 9 Apr 2024 13:30:43 -0700 Subject: [PATCH] Fix Public Links (#507) --- docs/_tutorials/tutorial_2_send_ble_commands/tutorial.md | 4 ++-- docs/_tutorials/tutorial_4_ble_queries/tutorial.md | 2 +- docs/_tutorials/tutorial_5_ble_protobuf/tutorial.md | 6 +++--- docs/_tutorials/tutorial_6_connect_wifi/tutorial.md | 4 ++-- docs/_tutorials/tutorial_9_cohn/tutorial.md | 4 ++-- docs/faq.md | 2 +- docs/index.md | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/_tutorials/tutorial_2_send_ble_commands/tutorial.md b/docs/_tutorials/tutorial_2_send_ble_commands/tutorial.md index e03d6064..0531bc0d 100644 --- a/docs/_tutorials/tutorial_2_send_ble_commands/tutorial.md +++ b/docs/_tutorials/tutorial_2_send_ble_commands/tutorial.md @@ -18,7 +18,7 @@ This document will provide a walk-through tutorial to use the - Writing to the Setting UUID and receiving responses via the Setting Response [UUID]({{site.baseurl}}/ble/protocol/ble_setup.html#ble-characteristics) -A list of TLV commands can be found in the [Command ID Table](http://localhost:4998/ble/protocol/id_tables.html#command-ids). +A list of TLV commands can be found in the [Command ID Table]{{site.baseurl}}/ble/protocol/id_tables.html#command-ids). {% note %} This tutorial only considers sending these as one-off commands. That is, it does not consider state @@ -261,7 +261,7 @@ sequenceDiagram Now that we are are connected, paired, and have enabled notifications (registered to our defined callback), we can send some commands. -First, we need to define the [UUIDs](http://localhost:4998/ble/protocol/ble_setup.html#configure-gatt-characteristics) +First, we need to define the [UUIDs]({{site.baseurl}}/ble/protocol/ble_setup.html#configure-gatt-characteristics) to write to / receive responses from, which are: {% linkedTabs uuid %} diff --git a/docs/_tutorials/tutorial_4_ble_queries/tutorial.md b/docs/_tutorials/tutorial_4_ble_queries/tutorial.md index c9d78edf..4982ddc7 100644 --- a/docs/_tutorials/tutorial_4_ble_queries/tutorial.md +++ b/docs/_tutorials/tutorial_4_ble_queries/tutorial.md @@ -14,7 +14,7 @@ and status information via BLE. writing to the Query [UUID]({{site.baseurl}}/ble/protocol/ble_setup.html#ble-characteristics) and receiving responses via the Query Response [UUID]({{site.baseurl}}/ble/protocol/ble_setup.html#ble-characteristics). -A list of queries can be found in the [Query ID Table](http://localhost:4998/ble/protocol/id_tables.html#query-ids). +A list of queries can be found in the [Query ID Table]({{site.baseurl}}/ble/protocol/id_tables.html#query-ids). It is important to distinguish between queries and [commands]({% link _tutorials/tutorial_2_send_ble_commands/tutorial.md %}) because they each have different request diff --git a/docs/_tutorials/tutorial_5_ble_protobuf/tutorial.md b/docs/_tutorials/tutorial_5_ble_protobuf/tutorial.md index 3990b78f..7443b66a 100644 --- a/docs/_tutorials/tutorial_5_ble_protobuf/tutorial.md +++ b/docs/_tutorials/tutorial_5_ble_protobuf/tutorial.md @@ -15,7 +15,7 @@ Open GoPro uses [Protocol Buffers Version 2](https://protobuf.dev/reference/prot {% endtip %} A list of Protobuf Operations can be found in the -[Protobuf ID Table](http://localhost:4998/ble/protocol/id_tables.html#protobuf-ids). +[Protobuf ID Table]({{site.baseurl}}/ble/protocol/id_tables.html#protobuf-ids). {% note %} This tutorial only considers sending these as one-off operations. That is, it does not consider state @@ -228,7 +228,7 @@ is as follows: This Feature / Action ID pair is used to identify the Protobuf Message that should be used to serialize / deserialize the payload. This mapping can be found in the -[Protobuf ID Table](http://localhost:4998/ble/protocol/id_tables.html#protobuf-ids). +[Protobuf ID Table]({{site.baseurl}}/ble/protocol/id_tables.html#protobuf-ids). ## Protobuf Response Parser @@ -334,7 +334,7 @@ TODO # Deciphering Response Type -This same procedure is used for all [Protobuf Operations](<(http://localhost:4998/ble/protocol/id_tables.html#protobuf-ids)>). +This same procedure is used for all [Protobuf Operations]({{site.baseurl}}/ble/protocol/id_tables.html#protobuf-ids). Coupled with the information from previous tutorials, you are now capable of parsing any response received from the GoPro. diff --git a/docs/_tutorials/tutorial_6_connect_wifi/tutorial.md b/docs/_tutorials/tutorial_6_connect_wifi/tutorial.md index d3b5e273..02b1c271 100644 --- a/docs/_tutorials/tutorial_6_connect_wifi/tutorial.md +++ b/docs/_tutorials/tutorial_6_connect_wifi/tutorial.md @@ -101,7 +101,7 @@ To perform the tutorial, run the Android Studio project, select "Tutorial 6" fro This requires that a GoPro is already connected via BLE, i.e. that Tutorial 1 was already run. You can check the BLE status at the top of the app. -{% include figure image_path="/assets/images/tutorials/kotlin/tutorial_6.png" alt="kotlin_tutorial_6" size="40%" caption="Perform Tutorial 6" %} +{% include figure image_path="/assets/images/tutorials/kotlin/tutorial_5.png" alt="kotlin_connect_wifi" size="40%" caption="Perform Tutorial 6" %} This will start the tutorial and log to the screen as it executes. When the tutorial is complete, click "Exit Tutorial" to return to the Tutorial selection screen. @@ -472,7 +472,7 @@ First we must request the GoPro to The code here is taken from `connect_as_sta.py` {% endnote %} -Let's send the [scan request]({{site.baseurl}}//ble/protocol/protobuf.html#requeststartscan) and then retrieve and parse +Let's send the [scan request]({{site.baseurl}}/ble/protocol/protobuf.html#requeststartscan) and then retrieve and parse [notifications]({{site.baseurl}}/ble/protocol/protobuf.html#notifstartscanning) until we receive a notification where the `scanning_state` is set to [SCANNING_SUCCESS]({{site.baseurl}}/ble/protocol/protobuf.html#enumscanning). Then we store the `scan id` from the notification for later use in retrieving the scan results. diff --git a/docs/_tutorials/tutorial_9_cohn/tutorial.md b/docs/_tutorials/tutorial_9_cohn/tutorial.md index f92a0245..59d8a28c 100644 --- a/docs/_tutorials/tutorial_9_cohn/tutorial.md +++ b/docs/_tutorials/tutorial_9_cohn/tutorial.md @@ -27,14 +27,14 @@ It is assumed that the hardware and software requirements from the are present and configured correctly. The scripts that will be used for this tutorial can be found in the -[Tutorial 9 Folder](https://github.com/gopro/OpenGoPro/tree/main/demos/python/tutorial/tutorial_modules/tutorial_9_connect_wifi). +[Tutorial 9 Folder](https://github.com/gopro/OpenGoPro/tree/main/demos/python/tutorial/tutorial_modules/tutorial_6_connect_wifi). # Just Show me the Demo(s)!! {% linkedTabs demo %} {% tab demo python %} Each of the scripts for this tutorial can be found in the Tutorial 9 -[directory](https://github.com/gopro/OpenGoPro/tree/main/demos/python/tutorial/tutorial_modules/tutorial_9_connect_wifi/). +[directory](https://github.com/gopro/OpenGoPro/tree/main/demos/python/tutorial/tutorial_modules/tutorial_6_connect_wifi/). {% warning %} Python >= 3.9 and < 3.12 must be used as specified in the requirements diff --git a/docs/faq.md b/docs/faq.md index 48a08195..dfc99464 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -8,7 +8,7 @@ read_time: false # Frequently Asked Questions (FAQ) If you have somehow stumbled here first, note that there are specifications, demos, and tutorials which -expand upon much of the information here. These can be found, among other places, from the [home page](/). +expand upon much of the information here. These can be found, among other places, from the [home page]({{site.baseurl}}/). ## Connectivity diff --git a/docs/index.md b/docs/index.md index e1ebecae..ddd42b10 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,7 +57,7 @@ enabled upon each connection via BLE. WiFi needs to be switched on by a BLE command. Besides command & control, Wi-Fi also allows for video streaming and media manipulation. With the exception of live-streaming, the camera always acts as an Wi-Fi access point that other devices -need to connect to. For more information, see the [Wifi Specification](/http). +need to connect to. For more information, see the [HTTP Specification]({{site.baseurl}}/http). ## USB