From 8f925adbb0b78f07c4a168c87bf6a98e2c3199cc Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 20 Apr 2023 11:52:48 -0700 Subject: [PATCH 1/2] update all hardware to be consistent --- docs/hardware/devices/heltec/buttons.mdx | 12 ++++---- docs/hardware/devices/lora/buttons.mdx | 12 ++++---- .../devices/nano-g1-explorer/buttons.mdx | 3 +- docs/hardware/devices/nano-g1/buttons.mdx | 7 ++--- docs/hardware/devices/rak/buttons.mdx | 28 +++++++++---------- docs/hardware/devices/station-g1/buttons.mdx | 7 ++--- docs/hardware/devices/tbeam/buttons.mdx | 2 +- 7 files changed, 34 insertions(+), 37 deletions(-) diff --git a/docs/hardware/devices/heltec/buttons.mdx b/docs/hardware/devices/heltec/buttons.mdx index c01bdbbe..e98764b4 100644 --- a/docs/hardware/devices/heltec/buttons.mdx +++ b/docs/hardware/devices/heltec/buttons.mdx @@ -7,9 +7,9 @@ sidebar_position: 3 ## Functionality -- **Reset Button** - - _**Single press**_ resets the device. -- **Program button** - - _**Single press**_ changes the page of information displayed on the screen. - - _**Long press**_ adjusts the contrast of the screen. - - _**Triple press**_ sends a broadcast message of the device position. +- **Reset Button (bottom):** + - **Single press:** Resets the device. +- **User/Program Button (top):** + - **Long press:** Will signal the device to shutdown after 5 seconds. + - **Single press:** Changes the information page displayed on the device's screen. + - **Double press:** Sends an adhoc ping of the device's position to the network. diff --git a/docs/hardware/devices/lora/buttons.mdx b/docs/hardware/devices/lora/buttons.mdx index c01bdbbe..a331a225 100644 --- a/docs/hardware/devices/lora/buttons.mdx +++ b/docs/hardware/devices/lora/buttons.mdx @@ -7,9 +7,9 @@ sidebar_position: 3 ## Functionality -- **Reset Button** - - _**Single press**_ resets the device. -- **Program button** - - _**Single press**_ changes the page of information displayed on the screen. - - _**Long press**_ adjusts the contrast of the screen. - - _**Triple press**_ sends a broadcast message of the device position. +- **Reset Button:** + - **Single press:** Resets the device. +- **User/Program Button:** + - **Long press:** Will signal the device to shutdown after 5 seconds. + - **Single press:** Changes the information page displayed on the device's screen. + - **Double press:** Sends an adhoc ping of the device's position to the network. diff --git a/docs/hardware/devices/nano-g1-explorer/buttons.mdx b/docs/hardware/devices/nano-g1-explorer/buttons.mdx index 8ecf757a..3b467694 100644 --- a/docs/hardware/devices/nano-g1-explorer/buttons.mdx +++ b/docs/hardware/devices/nano-g1-explorer/buttons.mdx @@ -15,10 +15,9 @@ import { bell } from "@heroicons/react/24/solid"; ### Buttons -- **Program Button:** +- **User/Program Button:** - **Single press:** Changes the information page displayed on the device's screen. - **Double press:** Sends an adhoc ping of the device's position to the network. - - **Long press:** Signals the device to shutdown after 5 seconds. - **Message Read Button:** - **Single press:** Clears the New Message LED. diff --git a/docs/hardware/devices/nano-g1/buttons.mdx b/docs/hardware/devices/nano-g1/buttons.mdx index bb53c88c..010425b0 100644 --- a/docs/hardware/devices/nano-g1/buttons.mdx +++ b/docs/hardware/devices/nano-g1/buttons.mdx @@ -7,7 +7,6 @@ sidebar_position: 1 ## Functionality -- **Program button** - - _**Single press**_ changes the page of information displayed on the screen. - - _**Long press**_ adjusts the contrast of the screen. - - _**Triple press**_ sends a broadcast message of the device position. +- **User/Program Button:** + - **Single press:** Changes the information page displayed on the device's screen. + - **Double press:** Sends an adhoc ping of the device's position to the network. diff --git a/docs/hardware/devices/rak/buttons.mdx b/docs/hardware/devices/rak/buttons.mdx index 81657de1..fbf7aa41 100644 --- a/docs/hardware/devices/rak/buttons.mdx +++ b/docs/hardware/devices/rak/buttons.mdx @@ -11,20 +11,20 @@ Button functionality for RAK devices greatly depends on the device specific conf ### RAK5005-O / RAK19007 / RAK19003 -- **Program button** - - _**Single press**_ changes the page of information displayed on the screen. - - _**Double press (nRF52 only)**_ puts the device in bootloader mode and mounts a drive to your computer. - - _**Long press**_ signals the device to shutdown. - - _**Triple press**_ sends a broadcast message of the device position. +- **Reset Button:** + - **Single press:** Resets the device. + - **Double press:** Put device into bootloader mode. +- **User/Program(if configured):** + - **Long press:** Will signal the device to shutdown after 5 seconds. + - **Single press:** Changes the information page displayed on the device's screen. + - **Double press:** Sends an adhoc ping of the device's position to the network. ### RAK19001 -- **Program button** - - - _**Single press**_ changes the page of information displayed on the screen. - - _**Double press (nRF52 only)**_ puts the device in bootloader mode and mounts a drive to your computer. - - _**Long press**_ signals the device to shutdown. - - _**Triple press**_ sends a broadcast message of the device position. - -- **User Button** - - _Not yet implemented by Meshtastic_ +- **Reset Button:** + - **Single press:** Resets the device. + - **Double press:** Put device into bootloader mode. +- **User/Program Button (if configured):** + - **Long press:** Will signal the device to shutdown after 5 seconds. + - **Single press:** Changes the information page displayed on the device's screen. + - **Double press:** Sends an adhoc ping of the device's position to the network. diff --git a/docs/hardware/devices/station-g1/buttons.mdx b/docs/hardware/devices/station-g1/buttons.mdx index bb53c88c..010425b0 100644 --- a/docs/hardware/devices/station-g1/buttons.mdx +++ b/docs/hardware/devices/station-g1/buttons.mdx @@ -7,7 +7,6 @@ sidebar_position: 1 ## Functionality -- **Program button** - - _**Single press**_ changes the page of information displayed on the screen. - - _**Long press**_ adjusts the contrast of the screen. - - _**Triple press**_ sends a broadcast message of the device position. +- **User/Program Button:** + - **Single press:** Changes the information page displayed on the device's screen. + - **Double press:** Sends an adhoc ping of the device's position to the network. diff --git a/docs/hardware/devices/tbeam/buttons.mdx b/docs/hardware/devices/tbeam/buttons.mdx index 09fa5fa9..33fe8eac 100644 --- a/docs/hardware/devices/tbeam/buttons.mdx +++ b/docs/hardware/devices/tbeam/buttons.mdx @@ -11,7 +11,7 @@ sidebar_position: 3 - **Long press:** Powers the device on or off. - **Reset Button (right):** - **Single press:** Resets the device. -- **Program button (middle):** +- **User/Program Button (middle):** - **Long press:** Will signal the device to shutdown after 5 seconds. - **Single press:** Changes the information page displayed on the device's screen. - **Double press:** Sends an adhoc ping of the device's position to the network. From 1c343148d519e821a81dde44ab23314e19541314 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Thu, 20 Apr 2023 13:46:51 -0700 Subject: [PATCH 2/2] fix table in lora.mdx --- docs/configuration/device-config/lora.mdx | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/configuration/device-config/lora.mdx b/docs/configuration/device-config/lora.mdx index 8e602fe7..a6d2797a 100644 --- a/docs/configuration/device-config/lora.mdx +++ b/docs/configuration/device-config/lora.mdx @@ -66,17 +66,16 @@ In most cases you should use zero here. Units are in dBm. ### Bandwidth -Bandwidth in kHz - Certain bandwidth numbers are 'special' and will be converted by the device firmware to the appropriate floating point value: -| Special Value | Interpreted as | -| :---: | :---: | -| 31 | 31.25kHz | -| 62 | 62.5kHz | -| 200 | 203.125kHz | -| 400 | 406.25kHz | -| 800 | 812.5kHz | -| 1600 | 1625.0kHz | + +| Special Value | Interpreted As | +| :-----------: | :------------: | +| 31 | 31.25 kHz | +| 62 | 62.5 kHz | +| 200 | 203.125 kHz | +| 400 | 406.25 kHz | +| 800 | 812.5 kHz | +| 1600 | 1625.0 kHz | Please be aware that values < 62.5kHz may require a TCXO on some hardware devices.