From 489c4fff115de5e5a40e4224650f1749f0ddf2e9 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 30 Jun 2023 21:44:39 -0700 Subject: [PATCH 1/5] Reformat nRF52 drivers documentation --- docs/getting-started/index.mdx | 2 +- .../serial-drivers/serial-drivers-nrf52.mdx | 22 ++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 1caaa3e3..8676f0ab 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -59,7 +59,7 @@ Some cables only provide _charging_, verify that your cable is also capable of _ :::caution -With the latest versions of MacOS, USB Serial drivers are built-in. Do _NOT_ download the USB device drivers unless required. You may [test for installed serial drivers](/docs/getting-started/serial-drivers/test-serial-driver-installation) before continuing. +nRF52 devices typically do not require serial drivers. They use the UF2 bootloader which make the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required. You may [test for installed serial drivers](/docs/getting-started/serial-drivers/test-serial-driver-installation) before continuing. ::: diff --git a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx index 52ec415b..ce948445 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx @@ -11,6 +11,12 @@ import Link from "@docusaurus/Link"; ## Install nRF52 USB to Serial Drivers +:::caution + +nRF52 devices typically do not require serial drivers. They use the UF2 bootloader which make the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required. + +::: + -- [CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html) +- [CH34x Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html) -- [CH9102 Driver - macOS Download](https://github.com/WCHSoftGroup/ch34xser_macos) -:::caution +:::info -With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ download the USB device drivers unless required. If you downloaded/installed any already, please remove them. +With the latest versions of MacOS, the USB Serial driver is built-in. If you downloaded/installed any already, please remove them. ::: @@ -47,11 +52,18 @@ Uninstall the kernel extension: 3. `sudo rm -rf /Library/Extensions/usbserial.kext` 4. Reboot + +### Install the CH34x Driver + +- [CH34x Driver- macOS Download](https://github.com/WCHSoftGroup/ch34xser_macos) + + + -- [CH9102 Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html) +- [CH34x Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html) From 2a9ed852e013cbe3b0b43e8126a19c3733088b3b Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 30 Jun 2023 22:06:02 -0700 Subject: [PATCH 2/5] clarify nRF drivers use case --- docs/getting-started/index.mdx | 2 +- docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 8676f0ab..77e7c7fb 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -59,7 +59,7 @@ Some cables only provide _charging_, verify that your cable is also capable of _ :::caution -nRF52 devices typically do not require serial drivers. They use the UF2 bootloader which make the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required. You may [test for installed serial drivers](/docs/getting-started/serial-drivers/test-serial-driver-installation) before continuing. +nRF52 devices typically do not require serial drivers. They use the UF2 bootloader which makes the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required to install UF2 support. ::: diff --git a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx index ce948445..fd85b48a 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx @@ -13,7 +13,7 @@ import Link from "@docusaurus/Link"; :::caution -nRF52 devices typically do not require serial drivers. They use the UF2 bootloader which make the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required. +nRF52 devices typically do not require serial drivers. They use the UF2 bootloader which makes the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required to install UF2 support. ::: From f617433eb93e958666cf61299176633f5745c030 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 30 Jun 2023 22:18:49 -0700 Subject: [PATCH 3/5] add references to factory erase and convert --- docs/getting-started/flashing-firmware/nrf52/index.mdx | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/getting-started/flashing-firmware/nrf52/index.mdx b/docs/getting-started/flashing-firmware/nrf52/index.mdx index 837c5095..fc27d190 100644 --- a/docs/getting-started/flashing-firmware/nrf52/index.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/index.mdx @@ -9,4 +9,11 @@ sidebar_position: 2 The nRF52 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform. -1. The [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) firmware installation method is considered the "manual process" and recommended as the easiest solution. +### Drag & Drop +The [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) firmware installation method is considered the "manual process" and recommended as the easiest solution. + +### Factory Erase +You may wish to perform a [Factory Erase](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) prior to installing firmware to clear data that may change format and location between releases. + +### Convert RAK4631-R to RAK4631 +If your device did not come with the Arduino bootloader you will need to [perform the conversion](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r) \ No newline at end of file From 4f3e6a4562c1fbf7b0c9432a94328acda8425066 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 30 Jun 2023 22:19:30 -0700 Subject: [PATCH 4/5] add missing period --- docs/getting-started/flashing-firmware/nrf52/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/flashing-firmware/nrf52/index.mdx b/docs/getting-started/flashing-firmware/nrf52/index.mdx index fc27d190..32f05c1e 100644 --- a/docs/getting-started/flashing-firmware/nrf52/index.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/index.mdx @@ -16,4 +16,4 @@ The [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) fir You may wish to perform a [Factory Erase](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) prior to installing firmware to clear data that may change format and location between releases. ### Convert RAK4631-R to RAK4631 -If your device did not come with the Arduino bootloader you will need to [perform the conversion](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r) \ No newline at end of file +If your device did not come with the Arduino bootloader you will need to [perform the conversion](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r). \ No newline at end of file From d70bf8ab6e65eaf9a0cd8dd39d260209df28ebea Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 30 Jun 2023 22:27:00 -0700 Subject: [PATCH 5/5] only one option to update firmware --- docs/getting-started/flashing-firmware/nrf52/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/flashing-firmware/nrf52/index.mdx b/docs/getting-started/flashing-firmware/nrf52/index.mdx index 32f05c1e..e9ecd803 100644 --- a/docs/getting-started/flashing-firmware/nrf52/index.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/index.mdx @@ -10,7 +10,7 @@ sidebar_position: 2 The nRF52 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform. ### Drag & Drop -The [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) firmware installation method is considered the "manual process" and recommended as the easiest solution. +nRF52 devices use the [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) installation method to install firmware releases. ### Factory Erase You may wish to perform a [Factory Erase](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) prior to installing firmware to clear data that may change format and location between releases.