From d92e916e5178fe2b1c379f1e7b2a6fc058b2294b Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 5 Jul 2023 14:01:30 -0700 Subject: [PATCH 01/28] position updates and corrections --- docs/configuration/device-config/position.mdx | 56 ++++++++++++------- 1 file changed, 35 insertions(+), 21 deletions(-) diff --git a/docs/configuration/device-config/position.mdx b/docs/configuration/device-config/position.mdx index c4f4ac5a..95403b31 100644 --- a/docs/configuration/device-config/position.mdx +++ b/docs/configuration/device-config/position.mdx @@ -8,31 +8,31 @@ sidebar_label: Position import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf. +The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Smart Broadcast Minimum Distance, Smart Broadcast Minimum Interval, Broadcast Interval, Position Packet Flags, and GPS RX/TX Pins. Position config uses an admin message sending a `Config.Position` protobuf. Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a GPS or internet connection for time. ## Position Config Values -### GPS Disabled +### GPS Enabled Acceptable values: `true` or `false` -Defaults to false. Should the device GPS be disabled for this node? +Defaults to true. Enables GPS on the node. ### GPS Update Interval -How often should we try to get GPS position (in seconds), or zero for the default of once every 30 seconds, or a very large value (maxint) to update only once at boot. +How often we should try to get GPS position (in seconds), or zero for the default of once every 2 minutes, or a very large value (maxint) to update only once at boot. ### GPS Attempt Time -How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 30 seconds. +How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 15 minutes. ### Fixed Position Acceptable values: `true` or `false` -Off by default +True by default If set, this node is at a fixed position. The device will generate GPS updates at the regular GPS update interval, but use whatever the last lat/lon/alt it saved for the node. The lat/lon/alt can be set by an internal GPS or with the help of the mobile device's GPS. @@ -40,7 +40,7 @@ If set, this node is at a fixed position. The device will generate GPS updates a Acceptable values: `true` or `false` -On by default +True by default Smart broadcast will send out your position at an increased frequency only if your location has changed enough for a position update to be useful. @@ -48,17 +48,29 @@ Smart broadcast complements broadcast interval (doesn't override that setting) b Smart broadcast will calculate an ideal position update interval based on the data rate of your selected channel configuration. +### Smart Broadcast Minimum Distance + +Default of `0` is 100 meters + +The minimum distance in meters traveled (since the last send) before we can send a position to the mesh if smart broadcast is enabled. + +### Smart Broadcast Minimum Interval + +Default of `0` is 30 seconds + +The minimum number of seconds (since the last send) before we can send a position to the mesh if smart broadcast is enabled. + ### Broadcast Interval Default of `0` is 15 minutes -If smart broadcast is of we should send our position this often (but only if it has changed significantly) +If smart broadcast is off we should send our position this often (but only if it has changed significantly) -The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved. This defaults to broadcast every 15 minutes. +The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved. ### Position Flags -Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags) +Defines which options are sent in POSITION messages. Values are stored as a bit field of boolean configuration options (bitwise OR of PositionFlags). | Value | Description | | :----------------: | :--------------------------------------------------------------: | @@ -116,17 +128,19 @@ All Position config commands are available in the python CLI. Example commands a ::: -| Setting | Acceptable Values | Default | -| :---------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: | -| position.gps_enabled | `true`, `false` | `true` | -| position.gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds | -| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds | -| position.fixed_position | `true`, `false` | `false` | -| position.position_broadcast_smart_enabled | `true`, `false` | `true` | -| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes | -| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` | -| position.rx_gpio | `integer` (0-39) | `UNSET` | -| position.tx_gpio | `integer` (0-34) | `UNSET` | +| Setting | Acceptable Values | Default | +| :------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: | +| position.gps_enabled | `true`, `false` | `true` | +| position.gps_update_interval | `integer` (seconds) | Default `0` is 2 Minutes | +| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 15 Minutes | +| position.fixed_position | `true`, `false` | `false` | +| position.position_broadcast_smart_enabled | `true`, `false` | `true` | +| position.broadcast_smart_minimum_distance | `integer` (meters) | Default of `0` is 100 Meters | +|position.broadcast_smart_minimum_interval_secs| `integer` (seconds) | Default of `0` is 15 Minutes | +| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 30 Seconds | +| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` | +| position.rx_gpio | `integer` (0-39) | `UNSET` | +| position.tx_gpio | `integer` (0-34) | `UNSET` | :::tip From bef945f1856824ba195a426d4f703e0c2eb429cd Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 5 Jul 2023 16:19:37 -0700 Subject: [PATCH 02/28] add ina address to summary --- docs/configuration/device-config/power.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/device-config/power.mdx b/docs/configuration/device-config/power.mdx index a84b092f..1b0d3cdc 100644 --- a/docs/configuration/device-config/power.mdx +++ b/docs/configuration/device-config/power.mdx @@ -13,7 +13,7 @@ import calculateADC from "/src/utils/calculateADC"; Power settings are advanced configuration, most users should choose a role under [Device Config](/docs/settings/config/device) to manage power for their device and shouldn't ever need to adjust these settings. ::: -The power config options are: Power Saving, Shutdown after losing power, ADC Multiplier Override, Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval, and Minimum Wake Interval. Power config uses an admin message sending a `Config.Power` protobuf. +The power config options are: Power Saving, Shutdown after losing power, ADC Multiplier Override, Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval, Minimum Wake Interval, and Device Battery INA2xx Address. Power config uses an admin message sending a `Config.Power` protobuf. :::info ADC Multiplier, Super Deep Sleep, and Light Sleep settings only apply to ESP32-based boards. These settings will have no effect on nRF52 modules. From 2013a4f90894f61fb9a8334a680468d5559b924c Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 5 Jul 2023 21:30:06 -0700 Subject: [PATCH 03/28] update apple config options --- docs/configuration/device-config/user.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/device-config/user.mdx b/docs/configuration/device-config/user.mdx index 81c43b90..d83a2600 100644 --- a/docs/configuration/device-config/user.mdx +++ b/docs/configuration/device-config/user.mdx @@ -51,7 +51,7 @@ values={[ :::info -User Config options are available for Android. +All User config options are available for Android. 1. Open the Meshtastic App 2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > User** @@ -63,7 +63,7 @@ User Config options are available for Android. :::info -`ShortName` and `LongName` User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`. +All User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`. ::: From a549cc0b796fe2bb9a7e32971e3946d05d19a7bf Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 5 Jul 2023 22:10:45 -0700 Subject: [PATCH 04/28] fix cli ls_secs default value --- docs/configuration/device-config/power.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/device-config/power.mdx b/docs/configuration/device-config/power.mdx index a84b092f..7f70959c 100644 --- a/docs/configuration/device-config/power.mdx +++ b/docs/configuration/device-config/power.mdx @@ -176,7 +176,7 @@ All Power config options are available in the python CLI. | power.wait_bluetooth_secs | `integer` (seconds) | Default of `0` is 1 minute | | power.mesh_sds_timeout_secs | `integer` (seconds) | Default of `0` is 2 hours | | power.sds_secs | `integer` (seconds) | Default of `0` is 1 year | -| power.ls_secs | `integer` (seconds) | Default of `0` is 1 hour | +| power.ls_secs | `integer` (seconds) | Default of `0` is 5 minutes | | power.min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds | | power.device_battery_ina_address | `integer` (I2C address as decimal) | Default of `0` is no address set | From 4fdfa015e5d8dac60e076fd8632d0cd959c1c34e Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 5 Jul 2023 23:29:29 -0700 Subject: [PATCH 05/28] nrf52 OTA documentation framework --- .../flashing-firmware/nrf52/index.mdx | 3 ++ .../flashing-firmware/nrf52/ota.mdx | 50 +++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 docs/getting-started/flashing-firmware/nrf52/ota.mdx diff --git a/docs/getting-started/flashing-firmware/nrf52/index.mdx b/docs/getting-started/flashing-firmware/nrf52/index.mdx index e9ecd803..1052e98e 100644 --- a/docs/getting-started/flashing-firmware/nrf52/index.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/index.mdx @@ -12,6 +12,9 @@ The nRF52 based devices have the easiest firmware upgrade process. No driver or ### Drag & Drop nRF52 devices use the [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) installation method to install firmware releases. +### Over-The-Air (OTA) +nRF52 devices are able to accept [OTA firmware updates](/docs/getting-started/flashing-firmware/nrf52/ota) from a mobile device over bluetooth. + ### 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. diff --git a/docs/getting-started/flashing-firmware/nrf52/ota.mdx b/docs/getting-started/flashing-firmware/nrf52/ota.mdx new file mode 100644 index 00000000..9882687d --- /dev/null +++ b/docs/getting-started/flashing-firmware/nrf52/ota.mdx @@ -0,0 +1,50 @@ +--- +id: ota +title: nRF52 OTA Firmware Updates +sidebar_label: Over-The-Air +sidebar_position: 2 +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +nRF52 devices are able to accept OTA firmware updates from a mobile device over bluetooth. + + + + + +:::info +As of this writing, the current release of the nRF DFU app (v2.3.0) is not compatible with Meshtastic firmware updates. +::: + +OTA firmware updates are available using the nRF Connect Android App __version 4.24.3__ available for download from the [Nordic Semiconductor GitHub page](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases/tag/v4.24.3). + +1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads) or [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases). +2. Unzip the firmware folder +3. Open the nRF Connect App and select CONNECT on your device from the SCANNER tab +4. Select the DFU icon from the top-right of the screen +5. Select the correct device firmware file (will end with -ota.zip) +6. The update will start automatically + + + + + + +OTA firmware updates are available on iOS & iPadOS using the nRF Device Firmware Update App available through the [Apple App Store](https://apps.apple.com/us/app/nrf-device-firmware-update/id1624454660) + +1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads), [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases), or via the iOS or iPadOS app. +2. Unzip the firmware folder +3. Open the nRF DFU App and select the correct device firmware file (will end with -ota.zip) +4. Connect to your device +5. Upload the firmware + + + \ No newline at end of file From bd629bd59308a9235eddfe2d4c0ffb9510adff2f Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Wed, 5 Jul 2023 23:56:14 -0700 Subject: [PATCH 06/28] default tab to apple --- docs/getting-started/flashing-firmware/nrf52/ota.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/flashing-firmware/nrf52/ota.mdx b/docs/getting-started/flashing-firmware/nrf52/ota.mdx index 9882687d..28421c5f 100644 --- a/docs/getting-started/flashing-firmware/nrf52/ota.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/ota.mdx @@ -12,7 +12,7 @@ nRF52 devices are able to accept OTA firmware updates from a mobile device over Date: Thu, 6 Jul 2023 11:54:07 -0700 Subject: [PATCH 07/28] fix audio enabled command --- docs/configuration/module-config/audio.mdx | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/configuration/module-config/audio.mdx b/docs/configuration/module-config/audio.mdx index 6e13bc46..ba6696f1 100644 --- a/docs/configuration/module-config/audio.mdx +++ b/docs/configuration/module-config/audio.mdx @@ -95,15 +95,15 @@ All audio module config options are available in the python CLI. Example command ::: -| Setting | Acceptable Values | Default | -| :-----------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: | -| audio.enabled | `true`, `false` | `false` | -| audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset | -| audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` | -| audio.i2s_ws | GPIO Pin Number 1-34 | no Default | -| audio.i2s_sd | GPIO Pin Number 1-39 | no Default | -| audio.i2s_din | GPIO Pin Number 1-34 | no Default | -| audio.i2s_sck | GPIO Pin Number 1-34 | no Default | +| Setting | Acceptable Values | Default | +| :----------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: | +|audio.codec2_enabled| `true`, `false` | `false` | +| audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset | +| audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` | +| audio.i2s_ws | GPIO Pin Number 1-34 | no Default | +| audio.i2s_sd | GPIO Pin Number 1-39 | no Default | +| audio.i2s_din | GPIO Pin Number 1-34 | no Default | +| audio.i2s_sck | GPIO Pin Number 1-34 | no Default | :::tip From 51df9c8175504c08c84dd8781ec2fbbf86b4071b Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Thu, 6 Jul 2023 11:57:01 -0700 Subject: [PATCH 08/28] fix cli examples --- docs/configuration/module-config/audio.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration/module-config/audio.mdx b/docs/configuration/module-config/audio.mdx index ba6696f1..59f6cb03 100644 --- a/docs/configuration/module-config/audio.mdx +++ b/docs/configuration/module-config/audio.mdx @@ -110,14 +110,14 @@ All audio module config options are available in the python CLI. Example command Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one. ```shell title="Example:" -meshtastic --set audio.enabled true --set audio.bitrate CODEC2_1400 +meshtastic --set audio.codec2_enabled true --set audio.bitrate CODEC2_1400 ``` ::: ```shell title="Enable / Disable Module" -meshtastic --set audio.enabled true -meshtastic --set audio.enabled false +meshtastic --set audio.codec2_enabled true +meshtastic --set audio.codec2_enabled false ``` ```shell title="Set WS to GPIO pin number 7" From 3633302b977ec8bbcd7ea19a46394eab0902e030 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Thu, 6 Jul 2023 12:57:16 -0700 Subject: [PATCH 09/28] add Ben Lipsey --- docs/legal/trademark-grants.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 7cd59bd8..f69bdfc5 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -14,3 +14,5 @@ sidebar_label: Trademark Grants - Details: Tony is an admin and contributer of computer aided design (CAD)/3D designs primarily for device enclosures and accessories, and runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Tony is sponsored or endorsed by Meshtastic. Tony also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant: http://k9rocket.tech - Details: K9 Rocket Technologies is an open technology development company selling and implementing Meshtastic-powered devices. The devices and their respective promotional content carry the "Powered by Meshtastic", "Meshtastic", & "M" logos. The use of the Meshtastic Logo and Trademarks does not imply K9 Rocket Technologies is sponsored or endorsed by Meshtastic. K9 Rocket Technologies also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason +- Grant: Ben Lipsey + - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From 8cfb3618f06a4a5a11d07ff846e7cb40c4bb5b9b Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Thu, 6 Jul 2023 15:53:30 -0700 Subject: [PATCH 10/28] correct options and commands --- docs/configuration/module-config/canned-message.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration/module-config/canned-message.mdx b/docs/configuration/module-config/canned-message.mdx index 72161cea..5eb94b93 100644 --- a/docs/configuration/module-config/canned-message.mdx +++ b/docs/configuration/module-config/canned-message.mdx @@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem"; The Canned Message Module will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from. -The canned message module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf. +The canned message module config options are: Enabled, Send Bell, Messages, Input Source, Rotary Encoder Enabled, Up Down Encoder Enabled, Input Broker Pin A, Input Broker Pin B, Input Broker Pin Press, Input Broker Event Clockwise, Input Broker Event Counter Clockwise, and Input Broker Event Press. Canned Message config uses an admin message sending a `ConfigModule.CannedMessage` protobuf. @@ -25,7 +25,7 @@ Enables the canned message module. Sends a bell character with each message. The [External Notification Module](external-notification) can be set up to beep when a new message arrives. -This module can also be configured to beep only when message contains the bell character. +This module can also be configured to beep only when a message contains the bell character. ### Messages @@ -119,7 +119,7 @@ Example commands are below: | canned_message.enabled | `true`, `false` | `false` | | canned_message.send_bell | `true`, `false` | `false` | | canned_message.allow_input_source | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb` | `_any` | -| canned_message.messages | `string` | `""` (separate using pipes) | +| --set-canned-message | `string` | `""` (separate using pipes) | | canned_message.inputbroker_event_cw | `InputEventChar` | (not defined) | | canned_message.inputbroker_event_ccw | `InputEventChar` | (not defined) | | canned_message.inputbroker_event_press | `InputEventChar` | (not defined) | From 8e2ee9ef087983950c10049a670ebfb1be03ddca Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Thu, 6 Jul 2023 22:51:08 -0700 Subject: [PATCH 11/28] add options to summary and move active --- .../module-config/external-notification.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/configuration/module-config/external-notification.mdx b/docs/configuration/module-config/external-notification.mdx index 2efed457..61425a2f 100644 --- a/docs/configuration/module-config/external-notification.mdx +++ b/docs/configuration/module-config/external-notification.mdx @@ -10,6 +10,9 @@ import TabItem from "@theme/TabItem"; The External Notification Module will allow you to connect a buzzer, speaker, LED, or other device to notify you when a message has been received from the mesh network. You can enable up to 3 pins independently from each other. +The External Notification Module config options are: Enabled, Active, Alert Bell (General),Alert Bell Vibra, Alert Bell Buzzer, Alert Message (General), Alert Message Vibra, Alert Message Buzzer, Output (General), Output Vibra, Output Buzzer, Output Milliseconds, Use PWM, and Nag Timeout. External Notification config uses an admin message sending a `ConfigModule.ExternalNotificationConfig` protobuf. + + ## External Notification Module Config Values @@ -18,6 +21,10 @@ The External Notification Module will allow you to connect a buzzer, speaker, LE Enables the external notification module. +### Active (general / LED only) + +Specifies whether the external circuit is active when the device's GPIO is low or high. If this is set true, the pin will be pulled active high, false means active low. + ### Alert when receiving a bell (general / LED, Vibra and Buzzer) Specifies if an alert should be triggered when receiving an incoming bell. @@ -26,10 +33,6 @@ Specifies if an alert should be triggered when receiving an incoming bell. Specifies if an alert should be triggered when receiving an incoming message. -### Active (general / LED only) - -Specifies whether the external circuit is active when the device's GPIO is low or high. - ### GPIO Pins (general / LED, Vibra and Buzzer) Specifies the GPIO that your external circuit is attached to on the device. On devices that have a PWM buzzer, you can use the buzzer for notifications by setting the use_pwm property to TRUE. The Buzzer Pin will be ignored and the device.buzzer_gpio is used instead. If you enable PWM mode, the device will use From f40700805ddccf306256b6bb886a6793ed523833 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Thu, 6 Jul 2023 22:51:56 -0700 Subject: [PATCH 12/28] remove extra space --- docs/configuration/module-config/external-notification.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/configuration/module-config/external-notification.mdx b/docs/configuration/module-config/external-notification.mdx index 61425a2f..79ccf02f 100644 --- a/docs/configuration/module-config/external-notification.mdx +++ b/docs/configuration/module-config/external-notification.mdx @@ -12,7 +12,6 @@ The External Notification Module will allow you to connect a buzzer, speaker, LE The External Notification Module config options are: Enabled, Active, Alert Bell (General),Alert Bell Vibra, Alert Bell Buzzer, Alert Message (General), Alert Message Vibra, Alert Message Buzzer, Output (General), Output Vibra, Output Buzzer, Output Milliseconds, Use PWM, and Nag Timeout. External Notification config uses an admin message sending a `ConfigModule.ExternalNotificationConfig` protobuf. - ## External Notification Module Config Values From 3e29ff61fbfd2df5bf00805773a1b274ad7126dd Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 08:18:15 -0700 Subject: [PATCH 13/28] a bit of clarification --- docs/getting-started/flashing-firmware/nrf52/ota.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/flashing-firmware/nrf52/ota.mdx b/docs/getting-started/flashing-firmware/nrf52/ota.mdx index 28421c5f..4bd51c2f 100644 --- a/docs/getting-started/flashing-firmware/nrf52/ota.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/ota.mdx @@ -21,10 +21,10 @@ values={[ :::info -As of this writing, the current release of the nRF DFU app (v2.3.0) is not compatible with Meshtastic firmware updates. +As of this writing, the current Android release of the nRF DFU app (v2.3.0) is not compatible with Meshtastic firmware updates. ::: -OTA firmware updates are available using the nRF Connect Android App __version 4.24.3__ available for download from the [Nordic Semiconductor GitHub page](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases/tag/v4.24.3). +OTA firmware updates are available for Android using and older release of the more advanced nRF Connect App __version 4.24.3__ which is available for download from the [Nordic Semiconductor GitHub page](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases/tag/v4.24.3). 1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads) or [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases). 2. Unzip the firmware folder From d814d80f51ffc08b26fab941a097ef9fcb32a86b Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:02:56 -0700 Subject: [PATCH 14/28] proto-what? --- docs/configuration/module-config/mqtt.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index f56e89f2..e01bc5e6 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -8,7 +8,7 @@ sidebar_label: MQTT import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must be enabled as uplink and/or downlink for protobufs to be transmitted from and/or to the mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings the node will still connect to MQTT server and send status messages. +If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must also be enabled as uplink and/or downlink for packets to be transmitted from and/or to your mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings enabled, the node will still connect to the MQTT server but only send status messages. The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled and JSON Enabled. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf. From 0b451297180f5926e01c78d3996f2b0dd4590d63 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:19:08 -0700 Subject: [PATCH 15/28] add tls and root --- docs/configuration/module-config/mqtt.mdx | 28 +++++++++++++++-------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index e01bc5e6..ed9bfbb5 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem"; If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must also be enabled as uplink and/or downlink for packets to be transmitted from and/or to your mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings enabled, the node will still connect to the MQTT server but only send status messages. -The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled and JSON Enabled. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf. +The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled, JSON Enabled, TLS Enabled, and Root Topic. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf. ## Settings @@ -40,6 +40,14 @@ Whether to send encrypted or decrypted packets to MQTT. This parameter is only h Enable the sending / consumption of JSON packets on MQTT. These packets are not encrypted, but offer an easy way to integrate with systems that can read JSON. +### TLS Enabled + +If true, we attempt to establish a secure connection using TLS + +### Root Topic + +The root topic to use for MQTT messages. This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs. Default is "msh". + ## MQTT Module Config Client Availability Date: Fri, 7 Jul 2023 22:29:05 -0700 Subject: [PATCH 16/28] typos, tweaks, add Apple availability --- docs/configuration/module-config/mqtt.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index ed9bfbb5..56b62a91 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -22,7 +22,7 @@ Enables the MQTT module. ### Server Address -The server to use for MQTT. If not set, the default server public will be used. +The server to use for MQTT. If not set, the default public server will be used. ### Username @@ -30,11 +30,11 @@ MQTT Server username to use (most useful for a custom MQTT server). If using a c ### Password -MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password +MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password. ### Encryption Enabled -Whether to send encrypted or decrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets. +Whether to send encrypted or unencrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets). Unencrypted packets may be useful for external systems that want to consume meshtastic packets. ### JSON Enabled @@ -42,7 +42,7 @@ Enable the sending / consumption of JSON packets on MQTT. These packets are not ### TLS Enabled -If true, we attempt to establish a secure connection using TLS +If true, we attempt to establish a secure connection using TLS. ### Root Topic @@ -74,7 +74,9 @@ MQTT Config options are available for Android. :::info -MQTT module config is not available for Apple. + +MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules > MQTT. + ::: From 4f201df2f503e1ed95b60c31ab3da32fadb81cdd Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:31:26 -0700 Subject: [PATCH 17/28] remove default root topic --- docs/configuration/module-config/mqtt.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index 56b62a91..b4f70b72 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -46,7 +46,7 @@ If true, we attempt to establish a secure connection using TLS. ### Root Topic -The root topic to use for MQTT messages. This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs. Default is "msh". +The root topic to use for MQTT messages. This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs. ## MQTT Module Config Client Availability @@ -97,7 +97,7 @@ All MQTT module config options are available in the python CLI. Example commands | mqtt.encryption_enabled | `true`, `false` | `false` | | mqtt.json_enabled | `true`, `false` | `false` | | mqtt.tls_enabled | `true`, `false` | `false` | -| mqtt.root | `string` | `msh` | +| mqtt.root | `string` | | :::tip From 0f84ed97902a87e002dd3821d49c0d2236691ba7 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:57:12 -0700 Subject: [PATCH 18/28] web UI available --- docs/configuration/module-config/range-test.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module-config/range-test.mdx b/docs/configuration/module-config/range-test.mdx index be08c540..a709fe26 100644 --- a/docs/configuration/module-config/range-test.mdx +++ b/docs/configuration/module-config/range-test.mdx @@ -103,7 +103,7 @@ meshtastic --set range_test.sender 0 :::info -No range test module config options are available in the Web UI. +All range test module config options are available in the Web UI. ::: From e1b0bca8da6c6cc65c16ae8617db2e988f5cdd72 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 23:05:41 -0700 Subject: [PATCH 19/28] power off clarification --- docs/configuration/module-config/range-test.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module-config/range-test.mdx b/docs/configuration/module-config/range-test.mdx index a709fe26..dfa409ea 100644 --- a/docs/configuration/module-config/range-test.mdx +++ b/docs/configuration/module-config/range-test.mdx @@ -114,7 +114,7 @@ All range test module config options are available in the Web UI. While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration. -Be sure to turn off either the module configured as a sender or the device where the module setup as sender when not in use. This will use a lot of time on air and will spam your channel. +Be sure to turn off the module when not in use. This will use a lot of time on air and will spam your channel. Also be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results. From 8a16e6e37275c67995e59b2f3c5274648079493d Mon Sep 17 00:00:00 2001 From: Mark Trevor Birss Date: Sat, 8 Jul 2023 18:24:49 +0200 Subject: [PATCH 20/28] Update trademark-grants.mdx --- docs/legal/trademark-grants.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index f69bdfc5..e583d106 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -16,3 +16,5 @@ sidebar_label: Trademark Grants - Details: K9 Rocket Technologies is an open technology development company selling and implementing Meshtastic-powered devices. The devices and their respective promotional content carry the "Powered by Meshtastic", "Meshtastic", & "M" logos. The use of the Meshtastic Logo and Trademarks does not imply K9 Rocket Technologies is sponsored or endorsed by Meshtastic. K9 Rocket Technologies also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason - Grant: Ben Lipsey - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. +- Grant: Mark Birss + - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From a393296e2d73ae4aac0beabdb60a5e23bda85e91 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 16:44:03 -0700 Subject: [PATCH 21/28] Update trademark-grants.mdx Add grant section for 3DSafe on Etsy --- docs/legal/trademark-grants.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index e583d106..1fefc64b 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -18,3 +18,6 @@ sidebar_label: Trademark Grants - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant: Mark Birss - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. +www.etsy.com/shop/3Dsafe +- Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) + -Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From a99632556d0a57e1fac055c1d24958a7757c6f34 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 16:55:56 -0700 Subject: [PATCH 22/28] Update trademark-grants.mdx --- docs/legal/trademark-grants.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 1fefc64b..4affc825 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -20,4 +20,4 @@ sidebar_label: Trademark Grants - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. www.etsy.com/shop/3Dsafe - Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) - -Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. + - Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From a990e0d7cc6f4b1e1c0a1b09230203a2402cc0ec Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 16:58:19 -0700 Subject: [PATCH 23/28] Update trademark-grants.mdx Sorry seem to have completely forgotten how to update the docs properly --- docs/legal/trademark-grants.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 4affc825..56ca20ab 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -18,6 +18,5 @@ sidebar_label: Trademark Grants - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant: Mark Birss - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. -www.etsy.com/shop/3Dsafe - Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) - Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From 2d3ea729e100208d66684d87f73d2e402037f04d Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 19:34:49 -0700 Subject: [PATCH 24/28] Update trademark-grants.mdx --- docs/legal/trademark-grants.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 56ca20ab..15d9014b 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -20,3 +20,5 @@ sidebar_label: Trademark Grants - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) - Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. +- Grant: [Keith Monaghan](http://voltaicenclosures.com/) + - Details: Keith is a contributer of computer aided design (CAD)/3D designs primarily for device enclosures and accessories, and runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Keith is sponsored or endorsed by Meshtastic. Keith also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From 3a031380f0e7c5844355e1d3dbd13b0267aa20ba Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Sun, 9 Jul 2023 22:23:41 -0700 Subject: [PATCH 25/28] lots of changes --- .../module-config/range-test.mdx | 70 +++++++++---------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/configuration/module-config/range-test.mdx b/docs/configuration/module-config/range-test.mdx index dfa409ea..05b45833 100644 --- a/docs/configuration/module-config/range-test.mdx +++ b/docs/configuration/module-config/range-test.mdx @@ -8,7 +8,16 @@ sidebar_label: Range Test import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh. +This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh. + +While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration. + +:::info + +Be sure to turn off the module or disable sending when not in use. This will use a lot of time on air, slow down your mesh, and spam your channel. + +::: + The range test module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.RangeTest` protobuf. @@ -18,13 +27,29 @@ The range test module config options are: Enabled, Save, and Sender. Range Test Enables the range test module. -### Save CSV File `ESP32 Only Setting` +### Save CSV File -If enabled, we will save a log of all received messages to a file named rangetest.csv which you can access from the web server Extensions > File Browser > rangetest.csv. The file will be created after receiving messages. The device will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage. +:::info + +Saving files is only available on ESP32-based devises + +::: + +If enabled, a log of all received messages will be saved to a file named rangetest.csv This file can be accessed by first connecting your node to wifi and then navigating to meshtastic.local/rangetest.csv. This file will only be created after receiving messages. To prevent filling up the storage, the device will abort writing if there is less than 50kb of space on the filesystem. ### Sender Interval -How long to wait between sending test packets. 0 is default which disables sending messages. +How long to wait between sending sequential test packets. 0 is default which disables sending messages. + +### Recommended Sender Settings + +| Radio Setting | `range_test.sender` | +| :-----------: | :-----------------: | +| Long Slow | 60 | +| Long Alt | 30 | +| Medium | 15 | +| Short Fast | 15 | + ## Range Test Module Config Client Availability @@ -48,6 +73,8 @@ Range Test Config options are available for Android. ::: +Android also had the option to download a rangetest.csv file which is stored on your phone. This file does not require the Range Test module to be active and will log all incoming Nodeinfo, Position, Telemetry and Messages. + @@ -55,6 +82,8 @@ Range Test Config options are available for Android. All range test module config options are available on iOS, iPadOS and macOS at Settings > Modules > Range Test. ::: +Apple apps also have the option to download logged position data which is stored on your iPhone/iPad/Mac. Access this by clicking on the Nodes tab, selecting a node, then select Position Log and click Save. This data file does not require the Range Test module to be active. + @@ -110,35 +139,6 @@ All range test module config options are available in the Web UI. -## Examples - -While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration. - -Be sure to turn off the module when not in use. This will use a lot of time on air and will spam your channel. - -Also be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results. - -:::note -Leaving this module on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.PortNum) are sent on. -::: - -### Accessing your CSV - -Connect to your device over WiFi, either using the [software access point](/docs/settings/config/network#software-access-point) or [WiFi Client](/docs/settings/config/network#wifi-client). Then navigate to `meshtastic.local` (or your IP address). Your file will be available for download under `Extensions > File Browser > rangetest.csv` once it has been created by receiving messages. - -```plaintext title="Example URLs" -http://meshtastic.local -http://198.168.0.15 -``` - -### Recommended Sender Settings - -| Radio Setting | `range_test.sender` | -| :-----------: | :-----------------: | -| Long Slow | 60 | -| Long Alt | 30 | -| Medium | 15 | -| Short Fast | 15 | ## Application Examples @@ -171,7 +171,7 @@ You can style the ranges differently based on the values, so you can have the pi Q: Where is rangetest.csv saved? -- Turn on the WiFi on your device as either a WiFi client or a WiFi AP. Once you can connect to your device, navigate to `Extensions > File Browser` and you will see `rangetest.csv` once messages have been saved and the file has been created. +- Turn on the WiFi on your device and connect to your network. Once you can connect to your device, navigate to `meshtastic.local/rangetest.csv` (or your_device_ip/rangetest.csv) and the file will be downloaded automatically. Q: Do I need to have WiFi turned on for the file to be saved? @@ -191,7 +191,7 @@ Q: What will happen if I run out of space on my device? Q: What do I do with the rangetest.csv file when I'm done? -- Go to /static and delete the file. +- Currently the only way to erase the file is to perform a factory reset. Q: Can I use this as a sender while on battery power? From b13cd533b72f49c384959a9cc116115ef837a1e5 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Sun, 9 Jul 2023 22:30:45 -0700 Subject: [PATCH 26/28] removed duplicate wording --- docs/configuration/module-config/range-test.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/configuration/module-config/range-test.mdx b/docs/configuration/module-config/range-test.mdx index 05b45833..0177b933 100644 --- a/docs/configuration/module-config/range-test.mdx +++ b/docs/configuration/module-config/range-test.mdx @@ -35,7 +35,11 @@ Saving files is only available on ESP32-based devises ::: -If enabled, a log of all received messages will be saved to a file named rangetest.csv This file can be accessed by first connecting your node to wifi and then navigating to meshtastic.local/rangetest.csv. This file will only be created after receiving messages. To prevent filling up the storage, the device will abort writing if there is less than 50kb of space on the filesystem. +If enabled, a log of all received messages will be saved to a file named rangetest.csv. + +To access this file, first turn on the WiFi on your device and connect to your network. Once you can connect to your device, navigate to `meshtastic.local/rangetest.csv` (or your_device_ip/rangetest.csv) and the file will be downloaded automatically. This file will only be created after receiving initial messages. + +To prevent filling up the storage, the device will abort writing if there is less than 50kb of space on the filesystem. ### Sender Interval @@ -169,10 +173,6 @@ You can style the ranges differently based on the values, so you can have the pi ## FAQ -Q: Where is rangetest.csv saved? - -- Turn on the WiFi on your device and connect to your network. Once you can connect to your device, navigate to `meshtastic.local/rangetest.csv` (or your_device_ip/rangetest.csv) and the file will be downloaded automatically. - Q: Do I need to have WiFi turned on for the file to be saved? - Nope, it'll just work. From 7132132dc8ebeaca1105040f9353cba1de904277 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Mon, 10 Jul 2023 13:27:03 -0700 Subject: [PATCH 27/28] add summary missing config options --- docs/configuration/module-config/serial.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index 33961ba9..52ea28c1 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -8,7 +8,7 @@ sidebar_label: Serial import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO and Sender. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf. +The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO, Baud Rate, Timeout, and Override Console Serial Port. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf. This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection. From ac34161cb08ea6df0df7822764bf99375440ec9a Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Tue, 11 Jul 2023 16:23:20 -0700 Subject: [PATCH 28/28] fix typo --- docs/getting-started/flashing-firmware/nrf52/ota.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/flashing-firmware/nrf52/ota.mdx b/docs/getting-started/flashing-firmware/nrf52/ota.mdx index 4bd51c2f..daed90e0 100644 --- a/docs/getting-started/flashing-firmware/nrf52/ota.mdx +++ b/docs/getting-started/flashing-firmware/nrf52/ota.mdx @@ -24,7 +24,7 @@ values={[ As of this writing, the current Android release of the nRF DFU app (v2.3.0) is not compatible with Meshtastic firmware updates. ::: -OTA firmware updates are available for Android using and older release of the more advanced nRF Connect App __version 4.24.3__ which is available for download from the [Nordic Semiconductor GitHub page](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases/tag/v4.24.3). +OTA firmware updates are available for Android using an older release of the more advanced nRF Connect App __version 4.24.3__ which is available for download from the [Nordic Semiconductor GitHub page](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases/tag/v4.24.3). 1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads) or [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases). 2. Unzip the firmware folder