From bf942e26fb0a60ebdbdafcc208e1aa80f38bd9ef Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 1 Feb 2022 18:58:26 -0700 Subject: [PATCH 01/14] moving settings around, adding settings, and fixing things --- .../settings/canned-message-plugin.md | 172 +++---- docs/software/settings/channel-advanced.md | 50 +- docs/software/settings/channel.md | 237 +++++---- .../environmental-measurment-plugin.md | 319 ++++++------ .../settings/external-notification-plugin.md | 305 ++++++----- docs/software/settings/gps.md | 475 +++++++++++++++--- docs/software/settings/ham.md | 26 +- docs/software/settings/misc.md | 239 +++++---- docs/software/settings/mqtt.md | 97 +++- docs/software/settings/range-test-plugin.md | 129 +++++ .../settings/rotary-encoder-plugin.md | 305 ++++++++++- docs/software/settings/router.md | 44 +- docs/software/settings/serial-plugin.md | 234 +++++++++ .../settings/store-and-forward-plugin.md | 240 +++++++-- docs/software/settings/wifi.md | 126 +++++ 15 files changed, 2188 insertions(+), 810 deletions(-) diff --git a/docs/software/settings/canned-message-plugin.md b/docs/software/settings/canned-message-plugin.md index df02993e..86764493 100644 --- a/docs/software/settings/canned-message-plugin.md +++ b/docs/software/settings/canned-message-plugin.md @@ -32,52 +32,10 @@ Once plugin settings are changed, a **reset** is required for them to take effec Enables the plugin. -### canned_message_plugin_allow_input_source - -Input event source accepted by the canned message plugin. - -| Value | Description | -| :---: | :---------: | -| `_any` | Default. Allows any peripheral input device connected to the device. | -| `rotEnc1` | Hardcoded value naming the input device that this plugin listens to. This could allow multiple input devices to be named with future software development. At present, this doesn't do anything differently than the default setting. | - -### canned_message_plugin_messages - -Predefined messages for CannedMessagePlugin separated by `|` characters. - -You can define up to 50 messages with a total length 1024 bytes. - -### canned_message_plugin_send_bell - -CannedMessagePlugin also sends a bell character with the messages. -The [External Notification Plugin](external-notification-plugin) can benefit from this feature as it utilizes the bell character. - -## Details - -### Prerequisites - - -- Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step. -- Once attached, configure peripheral device with [Rotary Encoder Plugin Settings](rotary-encoder-plugin). - -:::note -Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup. - - ```bash title="Canned Message Plugin - Required Rotary Encoder Plugin Settings" - meshtastic --set rotary1_pin_a GPIO - meshtastic --set rotary1_pin_b GPIO - meshtastic --set rotary1_pin_press GPIO - meshtastic --set rotary1_event_cw KEY_UP - meshtastic --set rotary1_event_ccw KEY_DOWN - meshtastic --set rotary1_event_press KEY_SELECT - meshtastic --set rotary1_enabled True - ``` +:::tip +Using the canned message plugin requires you set up the [rotary encoder plugin](rotary-encoder-plugin). See [prerequisites](#prerequisites) below. ::: -That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Plugin. - -## Examples - -### Enable/Disable the plugin +#### Enable/Disable the plugin -### Set canned messages +### canned_message_plugin_allow_input_source + +Input event source accepted by the canned message plugin. + +| Value | Description | +| :---: | :---------: | +| `_any` | Default. Allows any peripheral input device connected to the device. | +| `rotEnc1` | Hardcoded value naming the input device that this plugin listens to. This could allow multiple input devices to be named with future software development. At present, this doesn't do anything differently than the default setting. | + +#### Set input source + + + +```bash title="Set Allowed Input Source" +meshtastic --set canned_message_plugin_allow_input_source "_any" +``` +```bash title="Specify Allowed Input Source" +meshtastic --set canned_message_plugin_allow_input_source "rotEnc1" +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + + +### canned_message_plugin_messages + +Predefined messages for CannedMessagePlugin separated by `|` characters. + +You can define up to 50 messages with a total length 1024 bytes. + +#### Set canned messages -### Enable/Disable bell character +### canned_message_plugin_send_bell + +CannedMessagePlugin also sends a bell character with the messages. +The [External Notification Plugin](external-notification-plugin) can benefit from this feature as it utilizes the bell character. + +#### Enable/Disable bell character -### Set input source - - +## Details -```bash title="Set Allowed Input Source" -meshtastic --set canned_message_plugin_allow_input_source "_any" -``` -```bash title="Specify Allowed Input Source" -meshtastic --set canned_message_plugin_allow_input_source "rotEnc1" -``` - - +### Prerequisites -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. + +- Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step. +- Once attached, configure peripheral device with [Rotary Encoder Plugin Settings](rotary-encoder-plugin). + +:::note +Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup. + + ```bash title="Canned Message Plugin - Required Rotary Encoder Plugin Settings" + meshtastic --set rotary1_pin_a GPIO + meshtastic --set rotary1_pin_b GPIO + meshtastic --set rotary1_pin_press GPIO + meshtastic --set rotary1_event_cw KEY_UP + meshtastic --set rotary1_event_ccw KEY_DOWN + meshtastic --set rotary1_event_press KEY_SELECT + meshtastic --set rotary1_enabled True + ``` ::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - +That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Plugin. diff --git a/docs/software/settings/channel-advanced.md b/docs/software/settings/channel-advanced.md index 1d500cf5..e1094705 100644 --- a/docs/software/settings/channel-advanced.md +++ b/docs/software/settings/channel-advanced.md @@ -6,7 +6,7 @@ sidebar_label: Channel import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -:::caution +:::warning These settings are for advanced users only. If you don't know what you are doing you could damage your radio or break local radio laws. Proceed with caution. ::: @@ -28,25 +28,7 @@ Most users should not need to change these settings. The default [modem_config]( TODO -### channel_num - -TODO - -### coding_rate - -TODO - -### spread_factor - -TODO - -### tx_power - -TODO - -## Examples - -### Set Bandwidth +#### Set Bandwidth -### Set Channel Number +### channel_num + +TODO + +#### Set Channel Number - TODO +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: @@ -126,7 +114,11 @@ Configuring this setting is not yet available for the selected platform. If this -### Set Coding Rate +### coding_rate + +TODO + +#### Set Coding Rate -### Set Spread Factor +### spread_factor + +TODO + +#### Set Spread Factor -### Set TX Power +### tx_power + +TODO + +#### Set TX Power -### modem_config - -| Setting | Name | Bandwidth | Coding Rate | Spread Factor | Speed | -| :-----: | :--: | :-------: | :---------: | :-----------: | :-----: | -| `Bw125Cr45Sf128` | ShortSlow | 125 kHz | 4/5 | 7 = 128chips/symbol | 5.469 kbps | -| `Bw500Cr45Sf128` | ShortFast | 500 kHz | 4/5 | 7 = 128chips/symbol | 21.875 kbps | -| `Bw31_25Cr48Sf512` | LongFast | 31.25 kHz | 4/8 | 9 = 512chips/symbol | 275 bps | -| `Bw125Cr48Sf4096` | LongSlow | 125 kHz | 4/8 | 12 = 4096chips/symbol | 183 bps | - -### name - -The name of the channel. If this is left an empty string it is assumed that this channel is the special (minimally secure) "Default" channel. Channel Names should be short (less than 12 bytes). - -### psk - - - - - - - -:::note -Selecting a number from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. -::: - -| Setting | Behavior | -| :-----: | :------: | -| `0` | Disable Encryption | -| `1` | Default Encryption | -| `2`-`10` | Default Encryption, except with 1-9 added to the last byte | - - - - - -| Setting | Behavior | -| :-----: | :------: | -| `none` | Disable Encryption | -| `default` | Default Encryption (use the weak encryption key) | -| `random` | Generate a secure 256-bit encryption key. Use this setting for private communication. | - -:::tip -If you use Meshtastic for exchanging messages you don't want other people to see, `random` is the setting you should use. -::: - -### region - -The `region` variable sets which region your radio is configured to work in. It is important to ensure that you've set it to the correct region. If left `Unset`, it will default to `US` settings. - -| Name | Center Frequency | Spacing | Number of Channels | Power Limit | -| :--: | :-------: | :-----: | :----------------: | :---------: | -| US | 903.08 | 2.16 | 13 | 0 | -| EU433 | 433.175 | 0.2 | 8 | 0 | -| EU865 | 865.2 | 0.3 | 10 | 0 | -| CN | 470.0 | 2.0 | 20 | 0 | -| JP | 920.0 | 0.5 | 10 | 13 | -| ANZ | 916.0 | 0.5 | 20 | 0 | -| KR | 921.9 | 0.2 | 8 | 0 | -| TW | 923.0 | 0.2 | 10 | 0 | -| RU | 868.9 | 0.2 | 2 | 20 | -| Unset | 903.08 | 2.16 | 13 | 0 | -:::note -For more details about `region` settings, you can see the source code [here](https://github.com/meshtastic/Meshtastic-device/blob/master/src/mesh/RadioInterface.cpp) -::: - -### uplink_enabled - -If `true`, messages on the mesh will be sent to the public internet by any gateway node. See [MQTT settings](mqtt) for more details. - -## Examples - -### Set Channel ID +#### Set Channel ID + + + ```bash title="Set Modem - LongSlow" + meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0 + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::tip +For advanced modem configuration, see [Channel Settings - Advanced](channel-advanced). +::: + +### name + +The name of the channel. If this is left an empty string it is assumed that this channel is the special (minimally secure) "Default" channel. Channel Names should be short (less than 12 bytes). + +#### Set Channel Name - +### psk - ```bash title="Set encryptions to default on PRIMARY channel" - meshtastic --ch-set psk default --ch-index 0 - ``` - ```bash title="Set encryptions to random on PRIMARY channel" - meshtastic --ch-set psk random --ch-index 0 - ``` - ```bash title="Set encryptions to default on PRIMARY channel" - meshtastic --ch-set psk none --ch-index 0 - ``` - + - - + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - + :::note -See [`psk`](#psk) for details. +Selecting a number from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. ::: -### Set Modem +| Setting | Behavior | +| :-----: | :------: | +| `0` | Disable Encryption | +| `1` | Default Encryption | +| `2`-`10` | Default Encryption, except with 1-9 added to the last byte | + + + + + +| Setting | Behavior | +| :-----: | :------: | +| `none` | Disable Encryption | +| `default` | Default Encryption (use the weak encryption key) | +| `random` | Generate a secure 256-bit encryption key. Use this setting for private communication. | + +:::tip +If you use Meshtastic for exchanging messages you don't want other people to see, `random` is the setting you should use. +::: + +#### Set/Disable Encryption - ```bash title="Set Modem - LongSlow" - meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0 + ```bash title="Set encryption to default on PRIMARY channel" + meshtastic --ch-set psk default --ch-index 0 ``` + ```bash title="Set encryption to random on PRIMARY channel" + meshtastic --ch-set psk random --ch-index 0 + ``` + ```bash title="Disable encryption on PRIMARY channel" + meshtastic --ch-set psk none --ch-index 0 + ``` + @@ -287,11 +262,27 @@ Configuring this setting is not yet available for the selected platform. If this +### region + +The `region` variable sets which region your radio is configured to work in. It is important to ensure that you've set it to the correct region. If left `Unset`, it will default to `US` settings. + +| Name | Center Frequency | Spacing | Number of Channels | Power Limit | +| :--: | :-------: | :-----: | :----------------: | :---------: | +| US | 903.08 | 2.16 | 13 | 0 | +| EU433 | 433.175 | 0.2 | 8 | 0 | +| EU865 | 865.2 | 0.3 | 10 | 0 | +| CN | 470.0 | 2.0 | 20 | 0 | +| JP | 920.0 | 0.5 | 10 | 13 | +| ANZ | 916.0 | 0.5 | 20 | 0 | +| KR | 921.9 | 0.2 | 8 | 0 | +| TW | 923.0 | 0.2 | 10 | 0 | +| RU | 868.9 | 0.2 | 2 | 20 | +| Unset | 903.08 | 2.16 | 13 | 0 | :::note -See [`modem_config`](#modem_config) for details. For advanced modem configuration, see [Channel Settings - Advanced](channel-advanced). +For more details about `region` settings, you can see the source code [here](https://github.com/meshtastic/Meshtastic-device/blob/master/src/mesh/RadioInterface.cpp) ::: -### Set Region +#### Set Region - +### uplink_enabled + +If `true`, messages on the mesh will be sent to the public internet by any gateway node. See [MQTT settings](mqtt) for more details. diff --git a/docs/software/settings/environmental-measurment-plugin.md b/docs/software/settings/environmental-measurment-plugin.md index 9247ac6d..d13a9213 100644 --- a/docs/software/settings/environmental-measurment-plugin.md +++ b/docs/software/settings/environmental-measurment-plugin.md @@ -36,61 +36,7 @@ Once plugin settings are changed, a **reset** is required for them to take effec Enables the plugin. -### environmental_measurement_plugin_display_farenheit - -The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting. - -### environmental_measurement_plugin_read_error_count_threshold - -Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts. Each attempt will be delayed by the minimum required refresh rate for that sensor - -### environmental_measurement_plugin_recovery_interval - -Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again. - -### environmental_measurement_plugin_screen_enabled - -Enable/Disable the environmental measurement plugin on-device display. - -### environmental_measurement_plugin_sensor_pin - -:::note -The preferred setup is using I2C, so the `environmental_measurement_plugin_sensor_pin` may not be needed. -::: - -Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C. - -### environmental_measurement_plugin_sensor_type - -Specify the sensor type. - -| Value | Description | Sensor Features | -| :---: | :---------: | :-------------: | -| `0` | DHT11 | Temperature, Humidity | -| `1` | DS18B20 (Dallas 1-wire) | Temperature | -| `2` | DHT12 | Temperature, Humidity | -| `3` | DHT21 | Temperature, Humidity | -| `4` | DHT22 | Temperature, Humidity | -| `5` | BME280 | Temperature, Humidity, Pressure | -| `6` | BME680 | Temperature, Humidity, Pressure, VOC Gas | - -### environmental_measurement_plugin_update_interval - -Interval in seconds of how often we should try to send our measurements to the mesh. - -## Details - -### Hardware - -The sensors can be wired differently, here's [one example](https://randomnerdtutorials.com/esp32-ds18b20-temperature-arduino-ide) for sensor DS18B20. - -### Known Problems - -* No default configuration values are currently set, so this must be done when enabling the plugin. - -## Examples - -### Enable/Disable the plugin +#### Enable/Disable the plugin -### Enable/Disable the plugin on device screen - - +### environmental_measurement_plugin_display_farenheit -```bash title="Enable on device screen" -meshtastic --set environmental_measurement_plugin_screen_enabled true -``` -```bash title="Disable on device screen" -meshtastic --set environmental_measurement_plugin_screen_enabled false -``` - - +The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting. -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### Display Farenheit/Celsius +#### Display Farenheit/Celsius -### Set plugin update interval + +### environmental_measurement_plugin_read_error_count_threshold + +Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts. Each attempt will be delayed by the minimum required refresh rate for that sensor + +### environmental_measurement_plugin_recovery_interval + +Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again. + +### environmental_measurement_plugin_screen_enabled + +Enable/Disable the environmental measurement plugin on-device display. + +#### Enable/Disable the plugin on device screen + + + +```bash title="Enable on device screen" +meshtastic --set environmental_measurement_plugin_screen_enabled true +``` +```bash title="Disable on device screen" +meshtastic --set environmental_measurement_plugin_screen_enabled false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### environmental_measurement_plugin_sensor_pin + +:::note +The preferred setup is using I2C, so the `environmental_measurement_plugin_sensor_pin` may not be needed. +::: + +Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C. + +#### Set plugin sensor pin + + + +```bash title="Set plugin sensor pin" +meshtastic --set environmental_measurement_plugin_sensor_pin PINNUMBER +``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### environmental_measurement_plugin_sensor_type + +Specify the sensor type. + +| Value | Description | Sensor Features | +| :---: | :---------: | :-------------: | +| `0` | DHT11 | Temperature, Humidity | +| `1` | DS18B20 (Dallas 1-wire) | Temperature | +| `2` | DHT12 | Temperature, Humidity | +| `3` | DHT21 | Temperature, Humidity | +| `4` | DHT22 | Temperature, Humidity | +| `5` | BME280 | Temperature, Humidity, Pressure | +| `6` | BME680 | Temperature, Humidity, Pressure, VOC Gas | + +#### Set sensor type + + + + +:::note +The CLI is able to take the `value` or the `name` of the sensor from the table above. +::: + +```bash title="Set sensor type to DS18B20" +meshtastic --set environmental_measurement_plugin_sensor_type 1 +``` +```bash title="Set sensor type to DS18B20" +meshtastic --set environmental_measurement_plugin_sensor_type DS18B20 +``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### environmental_measurement_plugin_update_interval + +Interval in seconds of how often we should try to send our measurements to the mesh. + +#### Set plugin update interval -### Set sensor type +## Details - - +### Hardware -:::note -The CLI is able to take the [value or the name](#environmental_measurement_plugin_sensor_type) of the sensor. -::: +The sensors can be wired differently, here's [one example](https://randomnerdtutorials.com/esp32-ds18b20-temperature-arduino-ide) for sensor DS18B20. -```bash title="Set sensor type to DS18B20" -meshtastic --set environmental_measurement_plugin_sensor_type 1 -``` -```bash title="Set sensor type to DS18B20" -meshtastic --set environmental_measurement_plugin_sensor_type DS18B20 -``` +### Known Problems - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - +* No default configuration values are currently set, so this must be done when enabling the plugin. diff --git a/docs/software/settings/external-notification-plugin.md b/docs/software/settings/external-notification-plugin.md index 090fed34..58eb71ee 100644 --- a/docs/software/settings/external-notification-plugin.md +++ b/docs/software/settings/external-notification-plugin.md @@ -34,33 +34,7 @@ Once plugin settings are changed, a **reset** is required for them to take effec Enables the plugin. -### ext_notification_plugin_active - -Specifies whether the external circuit is triggered when the device's GPIO is low or high. - -### ext_notification_plugin_alert_bell - -Specifies if an alert should be sent when receiving an incoming bell. - -### ext_notification_plugin_alert_message - -Specifies if an alert should be sent when receiving an incoming message. - -### ext_notification_plugin_output - -Specifies the GPIO that your external circuit is attached to on the device. - -### ext_notification_plugin_output_ms - -Specifies how long in milliseconds you would like your external circuit triggered. Default is `1000`. (Because of the way that defaults are handled in the protobufs `0` is interpreted as `1000`) - -## Details - - - -## Examples - -### Enable/Disable the plugin +#### Enable/Disable the plugin -### Specify GPIO for circuit to monitor +### ext_notification_plugin_active + +Specifies whether the external circuit is triggered when the device's GPIO is low or high. + +#### Specify High/Low GPIO triggers circuit + + + +```bash title="GPIO active high" +meshtastic --set ext_notification_plugin_active true +``` +```bash title="GPIO active low (default)" +meshtastic --set ext_notification_plugin_active false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### ext_notification_plugin_alert_bell + +Specifies if an alert should be sent when receiving an incoming bell. + +#### Enable/Disable alert on incoming bell + + + +```bash title="Enable alert on incoming bell" +meshtastic --set ext_notification_plugin_alert_bell true +``` +```bash title="Disable alert on incoming bell" +meshtastic --set ext_notification_plugin_alert_bell false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### ext_notification_plugin_alert_message + +Specifies if an alert should be sent when receiving an incoming message. + +#### Enable/Disable Alert on incoming message + + + +```bash title="Enable alert on incoming message" +meshtastic --set ext_notification_plugin_alert_message true +``` +```bash title="Disable alert on incoming message" +meshtastic --set ext_notification_plugin_alert_message false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + + + +### ext_notification_plugin_output + +Specifies the GPIO that your external circuit is attached to on the device. + +#### Specify GPIO for circuit to monitor +### ext_notification_plugin_output_ms -### Specify High/Low GPIO triggers circuit - - +Specifies how long in milliseconds you would like your external circuit triggered. Default is `1000`. (Because of the way that defaults are handled in the protobufs `0` is interpreted as `1000`) -```bash title="GPIO active high" -meshtastic --set ext_notification_plugin_active true -``` -```bash title="GPIO active low (default)" -meshtastic --set ext_notification_plugin_active false -``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - - -### Specify how many milliseconds to trigger circuit +#### Specify how many milliseconds to trigger circuit -### Enable/Disable alert on incoming bell - - +## Details -```bash title="Enable alert on incoming bell" -meshtastic --set ext_notification_plugin_alert_bell true -``` -```bash title="Disable alert on incoming bell" -meshtastic --set ext_notification_plugin_alert_bell false -``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - - -### Enable/Disable Alert on incoming message - - - -```bash title="Enable alert on incoming message" -meshtastic --set ext_notification_plugin_alert_message true -``` -```bash title="Disable alert on incoming message" -meshtastic --set ext_notification_plugin_alert_message false -``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - + diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index 42c80646..87ac094f 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -42,10 +42,104 @@ If you wish to disable any GPS features, see below for more information. 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. +#### Set/Unset Fixed Position + + + + ```bash title="Set Fixed Position - Current Location" + meshtastic --set fixed_position true + ``` +:::note +The device will continue to acquire GPS coordinates according to the `gps_update_interval`, but will use the last saved coordinates as its fixed point. +::: + ```bash title="Set Fixed Position - User Defined" + meshtastic --setlat 37.8651 --setlon -119.5383 + ``` + ```bash title="Unset Fixed Position" + meshtastic --set fixed_position false + ``` +:::note +It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### gps_accept_2d Determines whether the device should accept 2D GPS fixes. By default, only 3D fixes are accepted (during a 2D fix, altitude values are unreliable and will be excluded). +#### Enable/Disable 2D GPS Fixes + + + + ```bash title="Enable 2D GPS Fixes" + meshtastic --set gps_accept_2d true + ``` + ```bash title="Disable 2D GPS Fixes" + meshtastic --set gps_accept_2d false + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### gps_format Determines how the GPS coordinates are displayed on the OLED screen. @@ -59,14 +153,183 @@ Determines how the GPS coordinates are displayed on the OLED screen. | GpsFormatOLC | GPS coordinates are displayed in Open Location Code (aka Plus Codes) | | GpsFormatOSGR | GPS coordinates are displayed in Ordnance Survey Grid Reference (the National Grid System of the UK). Format: AB EEEEE NNNNN, where A is the east 100k square, B is the north 100k square, E is the easting, N is the northing | +#### Specify GPS Screen Display + + + + ```bash title="Specify GPS format on device screen" + meshtastic --set gps_format GpsFormatUTM + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### gps_attempt_time Determines the amount of time that a GPS fix should be allowed to take. The default is every 30 seconds. If you increase this value, it will allow the device that amount of time in seconds to acquire coordinates. If the device is unable to get a fix, it will turn off until the next interval. GPS coordinates are updated every [`gps_update_interval`](#gps_update_interval) seconds. +#### Change GPS attempt time frequency + + + + ```bash title="Set GPS attempt time to default (30 seconds)" + meshtastic --set gps_attempt_time 0 + ``` + ```bash title="Set GPS attempt time to 45 seconds" + meshtastic --set gps_attempt_time 45 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### gps_max_dop Determines GPS maximum DOP accepted (dilution of precision) Set a rejection threshold for GPS readings based on their precision, relative to the GPS rated accuracy (which is typically ~3m) Solutions above this value will be treated as retryable errors! Useful range is between 1 - 64 (3m - <~200m) By default (if zero), accept all GPS readings +#### Change maximum GPS dilution of precision + + + + ```bash title="Set GPS max DOP to default (accept all GPS readings)" + meshtastic --set gps_max_dop 0 + ``` + ```bash title="Set GPS max DOP to 3m" + meshtastic --set gps_max_dop 1 + ``` + ```bash title="Set GPS max DOP to < ~200m" + meshtastic --set gps_max_dop 64 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +#### Specify GPS Screen Display + + + + ```bash title="Specify GPS format on device screen" + meshtastic --set gps_format GpsFormatUTM + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### gps_operation How the GPS hardware in the device is operated. @@ -83,69 +346,7 @@ This is independent of how our location is shared with other devices. For that s | GpsOpTimeOnly | We should only use the GPS to get time (no location data should be acquired/stored) Once we have the time we treat `gps_update_interval` as MAXINT (i.e. sleep forever) | | GpsOpDisabled | GPS is always turned off - this mode is not recommended - use `GpsOpTimeOnly` instead. | -### gps_update_interval - -Determines how often should the device should attempt to acquire a GPS position (in seconds). The length of time the device is allowed to attempt to acquire GPS coordinates each interval is set using [`gps_attempt_time`](#gps_attempt_time). The default is every 30 seconds. - -### location_share - -Determines whether location is shared with other nodes. See more details. - -| Value | Description | -| :---: | :---------: | -| LocUnset | **Default**: operates the same as `LocEnabled`| -| LocEnabled | The device is sharing its location (or the paired phone's location) | -| LocDisabled | The device is not sharing its location (if the unit has a GPS it will default to only get time - i.e. [`GpsOpTimeOnly`](#gps_operation)) | - -### position_broadcast_secs - -How often our position is sent to the mesh (but only if it has changed significantly). - -The GPS updates will be sent out every `position_broadcast_secs`, with either the actual GPS location, or an empty location if no GPS fix was achieved. This defaults to broadcast every 15 minutes. - -### position_broadcast_smart - -`position_broadcast_smart` will send out your position at an increased frequency only if your location has changed enough for a position update to be useful. - -Complements `position_broadcast_secs` (doesn't override that setting) but will apply an algorithm to more frequently update your mesh network if you are in motion and then throttle it down when you are standing still. If you use this feature, it's best to leave `position_broadcast_secs` at the default. - -`position_broadcast_smart` will calculate an ideal position update interval based on the data rate of your selected channel configuration. - -As an example, if you configure your radio to use **Long Range / Fast**, if you have traveled at least 144 meters and it's been at least 61 seconds since the last position update, a new position broadcast will be sent out. If you've moved less than 144 meters, we will broadcast the position based on the value of `position_broadcast_secs`. - -The table below is a summary computed values from the algorithm. - -| Long Name | Update every x-seconds | Update distance traveled (meters) | -| :---: | :---------: | :---------: | -| Long Range / Slow | 88 | 150 | -| Long Range / Fast | 61 | 144 | -| Medium Range / Slow | 30 | 41 | -| Medium Range / Fast | 30 | 30 | -| Short Range / Slow | 30 | 30 | -| Short Range / Fast | 30 | 30 | - -Note: A person walking in a straight line will take about 90 seconds to travel 150 meters. That walking speed estimate was used as the baseline for the formula used. - -### position_flags - -Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags) - -| Value | Description | -| :---: | :---------: | -| POS_UNDEFINED | Required for compilation | -| POS_ALTITUDE | Include an altitude value (if available) | -| POS_ALT_MSL | Altitude value is MSL | -| POS_GEO_SEP | Include geoidal separation | -| POS_DOP | Include the DOP value ; PDOP used by default, see below | -| POS_HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of | PDOP -| POS_BATTERY | Include battery level | -| POS_SATINVIEW | Include number of "satellites in view" | -| POS_SEQ_NOS | Include a sequence number incremented per packet | -| POS_TIMESTAMP | Include positional timestamp (from GPS solution) | - -## Examples - -### Disable GPS Completely +#### Enable/Disable GPS + ```bash title="Set GPS to default settings" + meshtastic --set gps_operation GpsOpUnset + ``` + ```bash title="Set GPS to only be used for time" + meshtastic --set gps_operation GpsOpTimeOnly + ``` ```bash title="Disable GPS Completely" meshtastic --set gps_operation GpsOpDisabled ``` @@ -189,7 +396,64 @@ Configuring this setting is not yet available for the selected platform. If this `gps_operation GpsOpTimeOnly` is preferred to `gps_operation GpsOPDisabled` because it allows the device to get a hi-res time. ::: -### Disable Location Sharing +### gps_update_interval + +Determines how often should the device should attempt to acquire a GPS position (in seconds). The length of time the device is allowed to attempt to acquire GPS coordinates each interval is set using [`gps_attempt_time`](#gps_attempt_time). The default is every 30 seconds. + +#### Specify GPS update interval + + + + ```bash title="Set GPS update interval to default settings (every 30 seconds)" + meshtastic --set gps_update_interval 0 + ``` + ```bash title="Set GPS update interval to every 45 seconds" + meshtastic --set gps_update_interval 45 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### location_share + +Determines whether location is shared with other nodes. See more details. + +| Value | Description | +| :---: | :---------: | +| LocUnset | **Default**: operates the same as `LocEnabled`| +| LocEnabled | The device is sharing its location (or the paired phone's location) | +| LocDisabled | The device is not sharing its location (if the unit has a GPS it will default to only get time - i.e. [`GpsOpTimeOnly`](#gps_operation)) | + +#### Disable Location Sharing - ```bash title="Set Fixed Position" - meshtastic --set fixed_position true + ```bash title="Set GPS update interval to default settings (every 15 minutes)" + meshtastic --set position_broadcast_secs 0 + ``` + ```bash title="Set GPS update interval to every 60 seconds" + meshtastic --set position_broadcast_secs 60 ``` @@ -273,11 +546,32 @@ Configuring this setting is not yet available for the selected platform. If this -:::note -The device will continue to acquire GPS coordinates according to the `gps_update_interval`, but will use the last saved coordinates as its fixed point. +### position_broadcast_smart + +`position_broadcast_smart` will send out your position at an increased frequency only if your location has changed enough for a position update to be useful. + +Complements `position_broadcast_secs` (doesn't override that setting) but will apply an algorithm to more frequently update your mesh network if you are in motion and then throttle it down when you are standing still. If you use this feature, it's best to leave `position_broadcast_secs` at the default. + +`position_broadcast_smart` will calculate an ideal position update interval based on the data rate of your selected channel configuration. + +As an example, if you configure your radio to use **Long Range / Fast**, if you have traveled at least 144 meters and it's been at least 61 seconds since the last position update, a new position broadcast will be sent out. If you've moved less than 144 meters, we will broadcast the position based on the value of `position_broadcast_secs`. + +The table below is a summary computed values from the algorithm. + +| Long Name | Update every x-seconds | Update distance traveled (meters) | +| :---: | :---------: | :---------: | +| Long Range / Slow | 88 | 150 | +| Long Range / Fast | 61 | 144 | +| Medium Range / Slow | 30 | 41 | +| Medium Range / Fast | 30 | 30 | +| Short Range / Slow | 30 | 30 | +| Short Range / Fast | 30 | 30 | + +:::tip +A person walking in a straight line will take about 90 seconds to travel 150 meters. That walking speed estimate was used as the baseline for the formula used. ::: -### Set Fixed Position – Specify Lat/Lon +#### Enable/Disable Smart Position Broadcast - ```bash title="Set Fixed Position" - meshtastic --setlat 37.8651 --setlon -119.5383 + ```bash title="Enable smart position broadcast" + meshtastic --set position_broadcast_smart true + ``` + ```bash title="Disable smart position broadcast" + meshtastic --set position_broadcast_smart false ``` @@ -317,7 +614,24 @@ Configuring this setting is not yet available for the selected platform. If this -### Unset Fixed Position +### position_flags + +Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags) + +| Value | Description | +| :---: | :---------: | +| POS_UNDEFINED | Required for compilation | +| POS_ALTITUDE | Include an altitude value (if available) | +| POS_ALT_MSL | Altitude value is MSL | +| POS_GEO_SEP | Include geoidal separation | +| POS_DOP | Include the DOP value ; PDOP used by default, see below | +| POS_HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of | PDOP +| POS_BATTERY | Include battery level | +| POS_SATINVIEW | Include number of "satellites in view" | +| POS_SEQ_NOS | Include a sequence number incremented per packet | +| POS_TIMESTAMP | Include positional timestamp (from GPS solution) | + +#### Set/Unset Position Flags - ```bash title="Unset Fixed Position" - meshtastic --set fixed_position false +:::tip +Include each flag desired from the table above separated by a single space. +::: + + ```bash title="Set Position Flags" + meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL + ``` + ```bash title="Unset Position Flags" + meshtastic --pos-fields POS_UNDEFINED ``` @@ -356,7 +677,3 @@ Configuring this setting is not yet available for the selected platform. If this - -:::note -It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value. -::: diff --git a/docs/software/settings/ham.md b/docs/software/settings/ham.md index 296b9637..dea3c741 100644 --- a/docs/software/settings/ham.md +++ b/docs/software/settings/ham.md @@ -32,24 +32,11 @@ Meshtastic can be used by both unlicensed people and licensed operators. If you If you are a licensed HAM operator, you can set this variable to be your ID. -## Details - -Toggling `set-ham` changes your device settings in the following ways. - -| Setting | `set-ham` Default | Normal Default | -| :-----: | :-----------------: | :------------: | -| `is_licensed` (Protobuf) | `true` | `false` | -| `long_name` (Protobuf) | `id` | User Defined | -| `psk` (Protobuf) | `""` | See [Channel Settings - psk](channel#psk) | -| `short_name` (Protobuf) | TODO | User Defined | - -## Examples - :::warning By changing these settings, you are self certifying that you are licensed to operate in the mode you have chosen. Failure to comply with your local regulations may result in fines. ::: -### Set HAM ID +#### Set HAM ID + +## Details + +Toggling `set-ham` changes your device settings in the following ways. + +| Setting | `set-ham` Default | Normal Default | +| :-----: | :-----------------: | :------------: | +| `is_licensed` (Protobuf) | `true` | `false` | +| `long_name` (Protobuf) | `id` | User Defined | +| `psk` (Protobuf) | `""` | See [Channel Settings - psk](channel#psk) | +| `short_name` (Protobuf) | TODO | User Defined | diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 4cb0df7e..fa11ed4b 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -28,120 +28,100 @@ import TabItem from '@theme/TabItem'; Automatically toggles to the next page on the screen like a carousel, based the specified interval in seconds. Potentially useful for devices without user buttons. +#### Ignore Incoming + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### debug_log_enabled By default we turn off logging as soon as an API client connects (to keep shared serial link quiet and save bandwidth). Set this to true to leave the debug log outputting even when API is active. +#### Enable/Disable Debug Log + + + + + ```bash title="Enable debug log" + meshtastic --set debug_log_enabled true + ``` + ```bash title="Disable debug log" + meshtastic --set debug_log_enabled false + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### factory_reset This setting is never saved to disk, but if set, all device settings will be returned to factory defaults. (Region, serial number etc... will be preserved) -### frequency_offset - -This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors. - -### ignore_incoming - -If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send dropped on receive (by router.cpp) - -### serial_disabled - -If set, this will disable the SerialConsole by not initializing the StreamAPI. - -### hop_limit - -Overrides the default number of hops a message will be passed. If not set, will default to 3 hops. - -Meshtastic allows a maximum of 7 hops (this is a limit of the protocol). Setting a hop_limit of greater than 7 will be replaced with 7 on the device. - -## Examples - -### Debug Log - Disable - -:::note -`debug_log_enabled` set to `false` is the default behavior. -::: - - - - - ```bash title="Example - Disable debug log" - meshtastic --set debug_log_enabled false - ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### Debug Log - Enable - - - - - ```bash title="Example - Enable debug log" - meshtastic --set debug_log_enabled true - ``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### Factory reset +#### Factory reset -### Frequency Offset +### frequency_offset + +This parameter is for advanced users with advanced test equipment, we do not recommend most users use it. A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors. + +#### Frequency Offset - TODO +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: @@ -221,8 +207,11 @@ Configuring this setting is not yet available for the selected platform. If this +### ignore_incoming -### Ignore Incoming +If true, radio should not try to be smart about what packets to queue to the phone bool keep_all_packets = 101; If true, we will try to capture all the packets sent on the mesh, not just the ones destined to our node. bool promiscuous_mode = 102; For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in ignore_incoming will have packets they send dropped on receive (by router.cpp) + +#### Ignore Incoming - TODO +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: @@ -261,8 +252,11 @@ Configuring this setting is not yet available for the selected platform. If this +### serial_disabled -### Serial - Disable +If set, this will disable the SerialConsole by not initializing the StreamAPI. + +#### Enable/Disable Serial - ```bash title="Example - Disable serial" - meshtastic --set disable_serial true + ```bash title="Enable serial" + meshtastic --set serial_disabled false + ``` + ```bash title="Disable serial" + meshtastic --set serial_disabled true ``` @@ -303,11 +300,13 @@ Configuring this setting is not yet available for the selected platform. If this -### Serial - Enable +### hop_limit -:::note -`disable_serial` set to `false` is the default behavior. -::: +Overrides the default number of hops a message will be passed. If not set, will default to 3 hops. + +Meshtastic allows a maximum of 7 hops (this is a limit of the protocol). Setting a hop_limit of greater than 7 will be replaced with 7 on the device. + +#### Ignore Incoming - ```bash title="Example - Enable serial" - meshtastic --set disable_serial false - ``` +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index cff600a7..dd8d251d 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -36,10 +36,103 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as `uplink_enabled` or `downlink_enabled`. But if this flag is set, all MQTT features will be disabled and no servers will be contacted. +#### Enable/Disable MQTT + + + + ```bash title="Enable MQTT (Default)" + meshtastic --set mqtt_disabled false + ``` + ```bash title="Disable MQTT" + meshtastic --set mqtt_disabled true + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### mqtt_server The server to use for our MQTT global message gateway feature. If not set, the default server will be used +#### Enable/Disable MQTT Server + + + +:::tip +When the mqtt_server is set to `""`, it will default to `mqtt.meshtastic.org` +::: + + ```bash title="Enable MQTT Server - Public Meshtastic MQTT Server (Default)" + meshtastic --set mqtt_server "" + ``` + ```bash title="Enable MQTT Server - Personal MQTT Server (by IP)" + meshtastic --set mqtt_server 198.168.0.2 + ``` + ```bash title="Enable MQTT Server - Personal MQTT Server (by URL)" + meshtastic --set mqtt_server mqtt.mydomain.com + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### mqtt_password MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password (TODO - find default password). @@ -50,11 +143,11 @@ MQTT username to use (most useful for a custom MQTT server). If using a custom s ### uplink_enabled -This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages to whatever MQTT server is specified in `mqtt_server`. See [Channel Settings](channel). +This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages to whatever MQTT server is specified in [mqtt_server](#mqtt_server). ### downlink_enabled -This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages from the MQTT server to the mesh from this device. See [Channel Settings](channel). +This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages from the MQTT server specified [here](#mqtt_server) to the mesh from this device. ## Details diff --git a/docs/software/settings/range-test-plugin.md b/docs/software/settings/range-test-plugin.md index 94afa207..02bdb810 100644 --- a/docs/software/settings/range-test-plugin.md +++ b/docs/software/settings/range-test-plugin.md @@ -27,14 +27,143 @@ Once plugin settings are changed, a **reset** is required for them to take effec Enables the plugin. +#### Enable/Disable the plugin + + + + ```bash title="Enable the plugin" + meshtastic --set range_test_plugin_enabled true + ``` + ```bash title="Disable the plugin" + meshtastic --set range_test_plugin_enabled true + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### range_test_plugin_save If enabled, we will save a log of all received messages to `/static/rangetest.csv` which you can access from the web server. We will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage. +#### Enable/Disable range test save `csv` + + + + ```bash title="Enable range test save" + meshtastic --set range_test_plugin_save true + ``` + ```bash title="Disable range test save" + meshtastic --set range_test_plugin_save false + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### range_test_plugin_sender Number of seconds to wait between sending packets. Using the long_slow channel configuration, it's best not to go more frequent than once every 60 seconds. You can be more aggressive with faster settings. `0` is default which disables sending messages. +#### Enable/Disable range test sender + + + + ```bash title="Enable range test sender (send every 60 seconds)" + meshtastic --set range_test_plugin_sender 60 + ``` + ```bash title="Disable range test sender" + meshtastic --set range_test_plugin_sender 0 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ## Details 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. diff --git a/docs/software/settings/rotary-encoder-plugin.md b/docs/software/settings/rotary-encoder-plugin.md index 57b47768..71db1c1e 100644 --- a/docs/software/settings/rotary-encoder-plugin.md +++ b/docs/software/settings/rotary-encoder-plugin.md @@ -36,30 +36,324 @@ Once plugin settings are changed, a **reset** is required for them to take effec ### rotary1_enabled Enable the rotary encoder #1 +#### Enable/Disable rotary1 + + + + ```bash title="Enable rotary1" + meshtastic --set rotary1_enabled true + ``` + ```bash title="Disable rotary1" + meshtastic --set rotary1_enabled true + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### rotary1_pin_a GPIO pin for rotary encoder A port. +#### Specify rotary1 pin a + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + + ```bash title="Specify rotary1 pin a" + meshtastic --set rotary1_pin_a GPIO + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### rotary1_pin_b GPIO pin for rotary encoder B port. +#### Specify rotary1 pin b + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + + ```bash title="Specify rotary1 pin b" + meshtastic --set rotary1_pin_b GPIO + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### rotary1_pin_press GPIO pin for rotary encoder Press port. +#### Specify rotary1 pin press + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + + ```bash title="Specify rotary1 pin press" + meshtastic --set rotary1_pin_press GPIO + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### rotary1_event_cw Generate input event on CW of this kind. -(For using with CannedMessagePlugin you must choose value "UP" here.) + +:::tip +For using with CannedMessagePlugin you must choose value `KEY_UP` here. +::: + +#### Specify rotary1 event cw + + + + ```bash title="Set rotary1 event cw to 'KEY_UP'" + meshtastic --set rotary1_event_press KEY_UP + ``` + ```bash title="Unset rotary1 event cw" + meshtastic --set rotary1_event_press "" + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### rotary1_event_ccw Generate input event on CCW of this kind. -(For using with CannedMessagePlugin you must choose value "DOWN" here.) + +:::tip +For using with CannedMessagePlugin you must choose value `KEY_DOWN` here. +::: + +#### Specify rotary1 event ccw + + + + ```bash title="Set rotary1 event ccw to 'KEY_DOWN'" + meshtastic --set rotary1_event_ccw KEY_DOWN + ``` + ```bash title="Unset rotary1 event ccw" + meshtastic --set rotary1_event_ccw "" + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### rotary1_event_press Generate input event on Press of this kind. -(For using with CannedMessagePlugin you must choose value "SELECT" here.) + +:::tip +For using with CannedMessagePlugin you must choose value `KEY_SELECT` here. +::: + +#### Specify rotary1 event press + + + + ```bash title="Set rotary1 event press to 'KEY_SELECT'" + meshtastic --set rotary1_event_press KEY_SELECT + ``` + ```bash title="Unset rotary1 event press" + meshtastic --set rotary1_event_press "" + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ## Details -See "Software / Plugins / Canned messages" for details! + + +Configuring the rotary encoder plugin require attaching the compatible hardware. ## Examples @@ -90,21 +384,18 @@ Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup. ``` - :::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. ::: - :::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. ::: - :::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. ::: diff --git a/docs/software/settings/router.md b/docs/software/settings/router.md index 68e29028..2baeca3b 100644 --- a/docs/software/settings/router.md +++ b/docs/software/settings/router.md @@ -21,26 +21,7 @@ import TabItem from '@theme/TabItem'; Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight) -## Details - -Toggling `is_router` changes your device settings in the following ways. - -| Setting | `is_router` Default | Normal Default | -| :-----: | :-----------------: | :------------: | -| `send_owner_interval` | 2 | 4 | -| `position_broadcast_secs` | 12 hours | 15 minutes | -| `wait_bluetooth_secs` | 1 | 60 | -| `mesh_sds_timeout_secs` | NODE_DELAY_FOREVER | 2 hours | -| `phone_sds_timeout_sec` | NODE_DELAY_FOREVER | 2 hours | -| `ls_secs` | 1 day | 5 minutes | - -### Altered Behaviors -#### Screen Wake -#### Bluetooth - -## Examples - -### Set Router +#### Enable/Disable router mode - ```bash title="Set Router" + ```bash title="Enable router mode" meshtastic --set is_router true ``` + ```bash title="Disable router mode" + meshtastic --set is_router false + ``` @@ -79,3 +63,21 @@ Configuring this setting is not yet available for the selected platform. If this + + +## Details + +Toggling `is_router` changes your device settings in the following ways. + +| Setting | `is_router` Default | Normal Default | +| :-----: | :-----------------: | :------------: | +| `send_owner_interval` | 2 | 4 | +| `position_broadcast_secs` | 12 hours | 15 minutes | +| `wait_bluetooth_secs` | 1 | 60 | +| `mesh_sds_timeout_secs` | NODE_DELAY_FOREVER | 2 hours | +| `phone_sds_timeout_sec` | NODE_DELAY_FOREVER | 2 hours | +| `ls_secs` | 1 day | 5 minutes | + +### Altered Behaviors +#### Screen Wake +#### Bluetooth diff --git a/docs/software/settings/serial-plugin.md b/docs/software/settings/serial-plugin.md index 0c73f944..199386f4 100644 --- a/docs/software/settings/serial-plugin.md +++ b/docs/software/settings/serial-plugin.md @@ -30,26 +30,260 @@ Once plugin settings are changed, a **reset** is required for them to take effec Enables the plugin. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### serialplugin_echo + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### serialplugin_mode + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### serialplugin_rxd + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### serialplugin_timeout + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### serialplugin_txd + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ## Details ## Examples diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index d38946b5..c8563320 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -35,22 +35,221 @@ Once plugin settings are changed, a **reset** is required for them to take effec Enables the plugin. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### store_forward_plugin_heartbeat + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + + ### store_forward_plugin_history_return_max + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + + ### store_forward_plugin_history_return_window + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + + ### store_forward_plugin_records + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + + ## Details ### How it works @@ -111,44 +310,3 @@ Available Commands: | SFm | Send a 240 byte payload (Used for testing) | The Store and Forward plugin will only service one client at a time. If a second client requests messages while the S&F is busy, the S&F will send a private message to the second client that they will need to wait. - - - -## Examples - - - - - TODO - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - diff --git a/docs/software/settings/wifi.md b/docs/software/settings/wifi.md index 7c0f7c66..12747e74 100644 --- a/docs/software/settings/wifi.md +++ b/docs/software/settings/wifi.md @@ -34,14 +34,140 @@ The first time your device restarts after enabling the WiFi access point, it wil A boolean value that toggles the [Software Access Point](#software-access-point) +#### Enable/Disable Software Access Point + + + + ```bash title="Enable SoftAP" + meshtastic --set wifi_ap_mode true + ``` + ```bash title="Disable SoftAP" + meshtastic --set wifi_ap_mode false + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### wifi_password In [SoftAP](#software-access-point) mode, this is the password to access your device's WiFi. In [Client](#wifi-client) mode, this is your WiFi Networks password. This string is case sensitive. + + + + ```bash title="Set WiFi password" + meshtastic --set wifi_password mypassword + ``` + ```bash title="Set WiFi password (with spaces)" + meshtastic --set wifi_password "my password" + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### wifi_ssid In [SoftAP](#software-access-point) mode, this is the SSID broadcast to access your device's WiFi. In [Client](#wifi-client) mode, this is your WiFi Networks SSID. This string is case sensitive. + + + + ```bash title="Set WiFi network" + meshtastic --set wifi_ssid mynetwork + ``` + ```bash title="Set WiFi network (with spaces)" + meshtastic --set wifi_ssid "my network" + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ## Details ### Software Access Point From a005e656d1d1f68f73947ad8a6b3699c4770c58c Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 10:58:56 -0700 Subject: [PATCH 02/14] alphabetized tables --- docs/software/settings/canned-message-plugin.md | 2 +- docs/software/settings/environmental-measurment-plugin.md | 2 +- docs/software/settings/external-notification-plugin.md | 2 +- docs/software/settings/gps.md | 2 +- docs/software/settings/misc.md | 2 +- docs/software/settings/mqtt.md | 4 ++-- docs/software/settings/rotary-encoder-plugin.md | 6 +++--- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/software/settings/canned-message-plugin.md b/docs/software/settings/canned-message-plugin.md index 86764493..251038af 100644 --- a/docs/software/settings/canned-message-plugin.md +++ b/docs/software/settings/canned-message-plugin.md @@ -23,8 +23,8 @@ Once plugin settings are changed, a **reset** is required for them to take effec | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | -| canned_message_plugin_enabled | `true`, `false` | `false` | | canned_message_plugin_allow_input_source | `rotEnc1`, `_any` | `_any` | +| canned_message_plugin_enabled | `true`, `false` | `false` | | canned_message_plugin_messages | `string` | `""` | | canned_message_plugin_send_bell | `true`, `false` | `false` | diff --git a/docs/software/settings/environmental-measurment-plugin.md b/docs/software/settings/environmental-measurment-plugin.md index d13a9213..7a0093c0 100644 --- a/docs/software/settings/environmental-measurment-plugin.md +++ b/docs/software/settings/environmental-measurment-plugin.md @@ -23,8 +23,8 @@ Once plugin settings are changed, a **reset** is required for them to take effec | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | -| environmental_measurement_plugin_measurement_enabled | `true`, `false` | `false` | | environmental_measurement_plugin_display_farenheit | `true`, `false` | `false` | +| environmental_measurement_plugin_measurement_enabled | `true`, `false` | `false` | | environmental_measurement_plugin_read_error_count_threshold | `integer` | `0` | | environmental_measurement_plugin_recovery_interval | `integer` (seconds) | `0` | | environmental_measurement_plugin_screen_enabled | `true`, `false` | `0` | diff --git a/docs/software/settings/external-notification-plugin.md b/docs/software/settings/external-notification-plugin.md index 58eb71ee..af9d1f74 100644 --- a/docs/software/settings/external-notification-plugin.md +++ b/docs/software/settings/external-notification-plugin.md @@ -23,10 +23,10 @@ Once plugin settings are changed, a **reset** is required for them to take effec | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | -| ext_notification_plugin_enabled | `true`, `false` | `false` | | ext_notification_plugin_active | `true`, `false` | `false` | | ext_notification_plugin_alert_bell | `true`, `false` | `false` | | ext_notification_plugin_alert_message | `true`, `false` | `false` | +| ext_notification_plugin_enabled | `true`, `false` | `false` | | ext_notification_plugin_output | `integer` | `0` | | ext_notification_plugin_output_ms | `integer` (milliseconds) | `0` | diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index 87ac094f..db8a8253 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -22,8 +22,8 @@ GPS is provided by either the device or your paired phone. More than likely, you | gps_accept_2d | `true`, `false` | `false` | | gps_attempt_time | `integer` (seconds) | `0` (see note) | | gps_format | `GpsFormatDec`, `GpsFormatDMS`, `GpsFormatUTM`, `GpsFormatMGRS`, `GpsFormatOLC`, `GpsFormatOSGR` | `GpsFormatDec` | -| gps_operation | `GpsOpUnset`, ~~`GpsOpStationary`~~, `GpsOpMobile`, `GpsOpTimeOnly`, `GpsOpDisabled` | `GpsOpUnset` | | gps_max_dop | `integer` | `0` | +| gps_operation | `GpsOpUnset`, ~~`GpsOpStationary`~~, `GpsOpMobile`, `GpsOpTimeOnly`, `GpsOpDisabled` | `GpsOpUnset` | | gps_update_interval | `integer` (seconds) | `0` (see note) | | location_share | `LocUnset`, `LocEnabled`, `LocDisabled` | `LocUnset` | | position_broadcast_secs | `integer` (seconds) | `0` (see note) | diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index fa11ed4b..b5048e35 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -20,8 +20,8 @@ import TabItem from '@theme/TabItem'; | factory_reset | `true`, `false` | `false` | | frequency_offset | real numbers | `0` | | ignore_incoming | `string` – list of node nums to ignore | `0` | -| serial_disabled | `true`, `false` | `false` | | hop_limit | real numbers | 0| +| serial_disabled | `true`, `false` | `false` | ### auto_screen_carousel_secs diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index dd8d251d..63c8286b 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -25,12 +25,12 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | +| downlink_enabled | `true`, `false` | `false` | | mqtt_disabled | `true`, `false` | `false` | -| mqtt_server | `string` | `""` | | mqtt_password | `string` | `""` | +| mqtt_server | `string` | `""` | | mqtt_username | `string` | `""` | | uplink_enabled | `true`, `false` | `false` | -| downlink_enabled | `true`, `false` | `false` | ### mqtt_disabled diff --git a/docs/software/settings/rotary-encoder-plugin.md b/docs/software/settings/rotary-encoder-plugin.md index 71db1c1e..03a0b650 100644 --- a/docs/software/settings/rotary-encoder-plugin.md +++ b/docs/software/settings/rotary-encoder-plugin.md @@ -26,12 +26,12 @@ Once plugin settings are changed, a **reset** is required for them to take effec | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | rotary1_enabled | `true`, `false` | `false` | -| rotary1_pin_a | `integer` | (not defined) | -| rotary1_pin_b | `integer` | (not defined) | -| rotary1_pin_press | `integer` | (not defined) | | rotary1_event_cw | `InputEventChar` | (not defined) | | rotary1_event_ccw | `InputEventChar` | (not defined) | | rotary1_event_press | `InputEventChar` | (not defined) | +| rotary1_pin_a | `integer` | (not defined) | +| rotary1_pin_b | `integer` | (not defined) | +| rotary1_pin_press | `integer` | (not defined) | ### rotary1_enabled Enable the rotary encoder #1 From dab825c0821116a045cdec3a1a917a301b97117a Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 11:02:10 -0700 Subject: [PATCH 03/14] added mqtt encryption setting --- docs/software/settings/mqtt.md | 52 ++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 63c8286b..6eae95c9 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -27,6 +27,7 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) | :-----: | :---------------: | :-----: | | downlink_enabled | `true`, `false` | `false` | | mqtt_disabled | `true`, `false` | `false` | +| mqtt_encryption_enabled | `true`, `false` | `false` | | mqtt_password | `string` | `""` | | mqtt_server | `string` | `""` | | mqtt_username | `string` | `""` | @@ -79,6 +80,57 @@ Configuring this setting is not yet available for the selected platform. If this +### mqtt_encryption_enabled + +Determines whether or not the device sends the packets encrypted to/from your MQTT server. + +:::tip +If you are using the default Meshtastic MQTT server, this setting will take no effect. All packets will continue to be encrypted regardless of this setting. Only custom servers will honor this setting. +::: + +#### Enable/Disable MQTT Encryption + + + + ```bash title="Enable MQTT Encryption (Default)" + meshtastic --set mqtt_encryption_enabled false + ``` + ```bash title="Disable MQTT Encryption" + meshtastic --set mqtt_encryption_enabled true + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### mqtt_server The server to use for our MQTT global message gateway feature. If not set, the default server will be used From 3431df8b1eb2a6aa6131303cbff5f023c0d07e74 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 11:02:19 -0700 Subject: [PATCH 04/14] removed spaces from table --- docs/software/settings/range-test-plugin.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/software/settings/range-test-plugin.md b/docs/software/settings/range-test-plugin.md index 02bdb810..44cd9450 100644 --- a/docs/software/settings/range-test-plugin.md +++ b/docs/software/settings/range-test-plugin.md @@ -17,11 +17,11 @@ Once plugin settings are changed, a **reset** is required for them to take effec ## Settings -| Setting | Acceptable Values | Default | -| :-----------------------: | :-----------------: | :-----: | -| range_test_plugin_enabled | `true`, `false` | `false` | -| range_test_plugin_save | `true`, `false` | `false` | -| range_test_plugin_sender | `integer` (Seconds) | `0` | +| Setting | Acceptable Values | Default | +| :-----: | :---------------: | :-----: | +| range_test_plugin_enabled | `true`, `false` | `false` | +| range_test_plugin_save | `true`, `false` | `false` | +| range_test_plugin_sender | `integer` (Seconds) | `0` | ### range_test_plugin_enabled From 829862a33a425303800dad91ffe8461975231eee Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 11:04:57 -0700 Subject: [PATCH 05/14] moved uplink_enabled and downlink_enabled from channels to mqtt --- docs/software/settings/channel.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/software/settings/channel.md b/docs/software/settings/channel.md index 24693841..210e1f22 100644 --- a/docs/software/settings/channel.md +++ b/docs/software/settings/channel.md @@ -16,21 +16,11 @@ Channel settings are an integral part of the way your devices communicate across | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | -| downlink_enabled | `true`, `false` | `false` | | id | `integer` | `0` | | modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | TODO | | name | `string` | `""` | | psk | `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `none`, `default`, `random` | `1` | | region | `Unset`, `US`, `EU433`, `EU865`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` | `Unset` | -| uplink_enabled | `true`, `false` | `false` | - -### downlink_enabled - -If `true`, messages seen on the internet will be forwarded to the local mesh through a gateway node. See [MQTT settings](mqtt) for more details. - -:::caution -This is in active development and not ready for casual users. Testing only. -::: ### id @@ -324,7 +314,3 @@ Configuring this setting is not yet available for the selected platform. If this - -### uplink_enabled - -If `true`, messages on the mesh will be sent to the public internet by any gateway node. See [MQTT settings](mqtt) for more details. From e74cb880de9e82d976b561f9ac573888dbf902b6 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 12:46:12 -0700 Subject: [PATCH 06/14] alphabetize settings --- .../settings/canned-message-plugin.md | 97 ++++--- .../environmental-measurment-plugin.md | 91 +++--- .../settings/external-notification-plugin.md | 90 +++--- docs/software/settings/gps.md | 94 +++---- docs/software/settings/mqtt.md | 16 +- docs/software/settings/power.md | 4 - .../settings/rotary-encoder-plugin.md | 264 +++++++++--------- 7 files changed, 324 insertions(+), 332 deletions(-) diff --git a/docs/software/settings/canned-message-plugin.md b/docs/software/settings/canned-message-plugin.md index 251038af..2a8a2513 100644 --- a/docs/software/settings/canned-message-plugin.md +++ b/docs/software/settings/canned-message-plugin.md @@ -28,55 +28,6 @@ Once plugin settings are changed, a **reset** is required for them to take effec | canned_message_plugin_messages | `string` | `""` | | canned_message_plugin_send_bell | `true`, `false` | `false` | -### canned_message_plugin_enabled - -Enables the plugin. - -:::tip -Using the canned message plugin requires you set up the [rotary encoder plugin](rotary-encoder-plugin). See [prerequisites](#prerequisites) below. -::: -#### Enable/Disable the plugin - - - -```bash title="Enable Canned Message Plugin" -meshtastic --set canned_message_plugin_enabled true -``` -```bash title="Disable Canned Message Plugin" -meshtastic --set canned_message_plugin_enabled false -``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### canned_message_plugin_allow_input_source Input event source accepted by the canned message plugin. @@ -128,6 +79,54 @@ Configuring this setting is not yet available for the selected platform. If this +### canned_message_plugin_enabled + +Enables the plugin. + +:::tip +Using the canned message plugin requires you set up the [rotary encoder plugin](rotary-encoder-plugin). See [prerequisites](#prerequisites) below. +::: +#### Enable/Disable the plugin + + + +```bash title="Enable Canned Message Plugin" +meshtastic --set canned_message_plugin_enabled true +``` +```bash title="Disable Canned Message Plugin" +meshtastic --set canned_message_plugin_enabled false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### canned_message_plugin_messages diff --git a/docs/software/settings/environmental-measurment-plugin.md b/docs/software/settings/environmental-measurment-plugin.md index 7a0093c0..14cb2dad 100644 --- a/docs/software/settings/environmental-measurment-plugin.md +++ b/docs/software/settings/environmental-measurment-plugin.md @@ -32,52 +32,6 @@ Once plugin settings are changed, a **reset** is required for them to take effec | environmental_measurement_plugin_sensor_type | `0-6` | `0` | | environmental_measurement_plugin_update_interval | `integer` (seconds) | `0` | -### environmental_measurement_plugin_measurement_enabled - -Enables the plugin. - -#### Enable/Disable the plugin - - - -```bash title="Enable Plugin" -meshtastic --set environmental_measurement_plugin_measurement_enabled true -``` -```bash title="Disable Plugin" -meshtastic --set environmental_measurement_plugin_measurement_enabled false -``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### environmental_measurement_plugin_display_farenheit The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting. @@ -125,6 +79,51 @@ Configuring this setting is not yet available for the selected platform. If this +### environmental_measurement_plugin_measurement_enabled + +Enables the plugin. + +#### Enable/Disable the plugin + + + +```bash title="Enable Plugin" +meshtastic --set environmental_measurement_plugin_measurement_enabled true +``` +```bash title="Disable Plugin" +meshtastic --set environmental_measurement_plugin_measurement_enabled false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### environmental_measurement_plugin_read_error_count_threshold diff --git a/docs/software/settings/external-notification-plugin.md b/docs/software/settings/external-notification-plugin.md index af9d1f74..aa9b619c 100644 --- a/docs/software/settings/external-notification-plugin.md +++ b/docs/software/settings/external-notification-plugin.md @@ -30,52 +30,6 @@ Once plugin settings are changed, a **reset** is required for them to take effec | ext_notification_plugin_output | `integer` | `0` | | ext_notification_plugin_output_ms | `integer` (milliseconds) | `0` | -### ext_notification_plugin_enabled - -Enables the plugin. - -#### Enable/Disable the plugin - - - -```bash title="Enable Plugin" -meshtastic --set ext_notification_plugin_enabled true -``` -```bash title="Disable Plugin" -meshtastic --set ext_notification_plugin_enabled false -``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### ext_notification_plugin_active Specifies whether the external circuit is triggered when the device's GPIO is low or high. @@ -214,7 +168,51 @@ Configuring this setting is not yet available for the selected platform. If this +### ext_notification_plugin_enabled +Enables the plugin. + +#### Enable/Disable the plugin + + + +```bash title="Enable Plugin" +meshtastic --set ext_notification_plugin_enabled true +``` +```bash title="Disable Plugin" +meshtastic --set ext_notification_plugin_enabled false +``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### ext_notification_plugin_output diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index db8a8253..4738cd5d 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -140,6 +140,53 @@ Configuring this setting is not yet available for the selected platform. If this +### gps_attempt_time + +Determines the amount of time that a GPS fix should be allowed to take. The default is every 30 seconds. If you increase this value, it will allow the device that amount of time in seconds to acquire coordinates. If the device is unable to get a fix, it will turn off until the next interval. GPS coordinates are updated every [`gps_update_interval`](#gps_update_interval) seconds. + +#### Change GPS attempt time frequency + + + + ```bash title="Set GPS attempt time to default (30 seconds)" + meshtastic --set gps_attempt_time 0 + ``` + ```bash title="Set GPS attempt time to 45 seconds" + meshtastic --set gps_attempt_time 45 + ``` + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### gps_format Determines how the GPS coordinates are displayed on the OLED screen. @@ -193,53 +240,6 @@ Configuring this setting is not yet available for the selected platform. If this -### gps_attempt_time - -Determines the amount of time that a GPS fix should be allowed to take. The default is every 30 seconds. If you increase this value, it will allow the device that amount of time in seconds to acquire coordinates. If the device is unable to get a fix, it will turn off until the next interval. GPS coordinates are updated every [`gps_update_interval`](#gps_update_interval) seconds. - -#### Change GPS attempt time frequency - - - - ```bash title="Set GPS attempt time to default (30 seconds)" - meshtastic --set gps_attempt_time 0 - ``` - ```bash title="Set GPS attempt time to 45 seconds" - meshtastic --set gps_attempt_time 45 - ``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### gps_max_dop Determines GPS maximum DOP accepted (dilution of precision) Set a rejection threshold for GPS readings based on their precision, relative to the GPS rated accuracy (which is typically ~3m) Solutions above this value will be treated as retryable errors! Useful range is between 1 - 64 (3m - <~200m) By default (if zero), accept all GPS readings diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 6eae95c9..94bc0ec7 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -33,6 +33,10 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) | mqtt_username | `string` | `""` | | uplink_enabled | `true`, `false` | `false` | +### downlink_enabled + +This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages from the MQTT server specified [here](#mqtt_server) to the mesh from this device. + ### mqtt_disabled If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as `uplink_enabled` or `downlink_enabled`. But if this flag is set, all MQTT features will be disabled and no servers will be contacted. @@ -131,6 +135,10 @@ Configuring this setting is not yet available for the selected platform. If this +### mqtt_password + +MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password (TODO - find default password). + ### mqtt_server The server to use for our MQTT global message gateway feature. If not set, the default server will be used @@ -185,10 +193,6 @@ Configuring this setting is not yet available for the selected platform. If this -### mqtt_password - -MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password (TODO - find default password). - ### mqtt_username MQTT username to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default username (TODO - find default username). @@ -197,10 +201,6 @@ MQTT username to use (most useful for a custom MQTT server). If using a custom s This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages to whatever MQTT server is specified in [mqtt_server](#mqtt_server). -### downlink_enabled - -This is a channel specific setting. If your channel has this set to `true` and you are connected to WiFi, the device will forward along messages from the MQTT server specified [here](#mqtt_server) to the mesh from this device. - ## Details diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 6e8b805d..79b0d853 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -113,10 +113,6 @@ For instance the default interval of 4 will send the node owner information for Wait number of seconds for Bluetooth - Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 1 minute -### is_always_powered - -If the device is plugged into the wall (not from battery), you may consider using this setting to always keep the device from sleeping. This is a useful setting if you are on ESP32 and using the Wifi options. - ## Examples -### rotary1_pin_a -GPIO pin for rotary encoder A port. - -#### Specify rotary1 pin a - - - -:::note -Replace `GPIO` below with the GPIO number from hardware setup. -::: - - ```bash title="Specify rotary1 pin a" - meshtastic --set rotary1_pin_a GPIO - ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### rotary1_pin_b -GPIO pin for rotary encoder B port. - -#### Specify rotary1 pin b - - - -:::note -Replace `GPIO` below with the GPIO number from hardware setup. -::: - - ```bash title="Specify rotary1 pin b" - meshtastic --set rotary1_pin_b GPIO - ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### rotary1_pin_press -GPIO pin for rotary encoder Press port. - -#### Specify rotary1 pin press - - - -:::note -Replace `GPIO` below with the GPIO number from hardware setup. -::: - - ```bash title="Specify rotary1 pin press" - meshtastic --set rotary1_pin_press GPIO - ``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### rotary1_event_cw Generate input event on CW of this kind. @@ -349,6 +217,138 @@ Configuring this setting is not yet available for the selected platform. If this +### rotary1_pin_a +GPIO pin for rotary encoder A port. + +#### Specify rotary1 pin a + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + + ```bash title="Specify rotary1 pin a" + meshtastic --set rotary1_pin_a GPIO + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### rotary1_pin_b +GPIO pin for rotary encoder B port. + +#### Specify rotary1 pin b + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + + ```bash title="Specify rotary1 pin b" + meshtastic --set rotary1_pin_b GPIO + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +### rotary1_pin_press +GPIO pin for rotary encoder Press port. + +#### Specify rotary1 pin press + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + + ```bash title="Specify rotary1 pin press" + meshtastic --set rotary1_pin_press GPIO + ``` + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ## Details From 90b81a4c0a9d6fdb764aa3127ba85290f35e2f35 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 12:58:04 -0700 Subject: [PATCH 07/14] typo --- docs/software/settings/power.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 79b0d853..0105d03b 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -43,7 +43,7 @@ For a description and more information on what exactly all of these mean, please | wait_bluetooth_secs | `integer` (seconds) | `0` | :::note -When you the following settings to `0` they assume the following defaults: +When you change the following settings to `0` they assume the following defaults: - `ls_secs`: 1 hour - `mesh_sds_timeout_secs`: 2 hours From 98cbaf2ff9a580ce3872c7503cce7bde3db5bd7f Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 13:01:32 -0700 Subject: [PATCH 08/14] remove todo --- docs/software/settings/wifi.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/software/settings/wifi.md b/docs/software/settings/wifi.md index 12747e74..4cb6d44a 100644 --- a/docs/software/settings/wifi.md +++ b/docs/software/settings/wifi.md @@ -218,7 +218,23 @@ meshtastic --set wifi_ssid "my wifi ssid" --set wifi_password "my wifi password" - TODO +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: From af4aa977b46ac0c7f58596e6a3abc8b96da60789 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 13:24:12 -0700 Subject: [PATCH 09/14] updated table --- docs/software/settings/channel.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/software/settings/channel.md b/docs/software/settings/channel.md index 210e1f22..96cf9289 100644 --- a/docs/software/settings/channel.md +++ b/docs/software/settings/channel.md @@ -17,7 +17,7 @@ Channel settings are an integral part of the way your devices communicate across | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | id | `integer` | `0` | -| modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | TODO | +| modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | `Bw125Cr45Sf128` | | name | `string` | `""` | | psk | `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `none`, `default`, `random` | `1` | | region | `Unset`, `US`, `EU433`, `EU865`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` | `Unset` | @@ -73,12 +73,14 @@ The channel `id` must be an integer. ### modem_config -| Setting | Name | Bandwidth | Coding Rate | Spread Factor | Speed | +| Setting | Name (Range/Speed) | Bandwidth | Coding Rate | Spread Factor | Speed | | :-----: | :--: | :-------: | :---------: | :-----------: | :-----: | -| `Bw125Cr45Sf128` | ShortSlow | 125 kHz | 4/5 | 7 = 128chips/symbol | 5.469 kbps | -| `Bw500Cr45Sf128` | ShortFast | 500 kHz | 4/5 | 7 = 128chips/symbol | 21.875 kbps | -| `Bw31_25Cr48Sf512` | LongFast | 31.25 kHz | 4/8 | 9 = 512chips/symbol | 275 bps | -| `Bw125Cr48Sf4096` | LongSlow | 125 kHz | 4/8 | 12 = 4096chips/symbol | 183 bps | +| `Bw500Cr45Sf128` | Short/Fast | 500 kHz | 4/5 | 7 = 128chips/symbol | 18.89 kbps | +| `Bw125Cr45Sf128` | Short/Slow | 125 kHz | 4/5 | 7 = 128chips/symbol | 4.69 kbps | +| `Bw250Cr47Sf1024` | Medium/Fast | 250 kHz | 4/7 | 10 = 1024chips/symbol | 1.2 kbps | +| `Bw250Cr46Sf2048` | Medium/Slow | 250 kHz | 4/6 | 11 = 2048chips/symbol | 0.75 kbps | +| `Bw31_25Cr48Sf512` | Long/Fast | 31.25 kHz | 4/8 | 9 = 512chips/symbol | 0.19 kbps | +| `Bw125Cr48Sf4096` | Long/Slow | 125 kHz | 4/8 | 12 = 4096chips/symbol | 0.13 kbps | #### Set Modem Date: Wed, 2 Feb 2022 13:46:00 -0700 Subject: [PATCH 10/14] add placeholders --- docs/software/settings/power.md | 603 +++++++++++++++++++++++++++++++- 1 file changed, 594 insertions(+), 9 deletions(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 0105d03b..516d9535 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -57,61 +57,646 @@ When you change the following settings to `0` they assume the following defaults ### charge_current -Sets the current of the battery charger +Sets the current of the battery charger. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### is_always_powered Circumvents the logic block for determining whether the device is powered or not. Useful for devices with finicky ADC issues on the battery sense pins. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### is_low_power If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. YOU DO NOT NEED TO SET THIS IF YOU'VE set is_router (it is implied in that case). + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### is_router -Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight) +Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight). + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### ls_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 3600 +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 3600. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### mesh_sds_timeout_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### min_wake_secs -Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds +Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### on_battery_shutdown_after_secs If non-zero, the device will fully power off this many seconds after external power is removed. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### phone_sds_timeout_sec -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### phone_timeout_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 15 minutes +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 15 minutes. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### screen_on_secs Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one minute. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### sds_secs -Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one year +Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one year. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ### send_owner_interval This sets how often to send the database of node owner information with other nodes in the mesh (per mesh network ping). + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + For instance the default interval of 4 will send the node owner information for every 4 mesh network pings. This information is also transmitted after the node first boots up. + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + ### wait_bluetooth_secs -Wait number of seconds for Bluetooth - Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 1 minute +Wait number of seconds for Bluetooth - Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 1 minute. + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + + +:::info +Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +::: + + + ## Examples From ac42a13d5a092f1ddd8dae589025b6edcc40c76f Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 13:48:24 -0700 Subject: [PATCH 11/14] moved to admonition --- docs/software/settings/power.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 516d9535..8b0ba961 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -143,7 +143,11 @@ Configuring this setting is not yet available for the selected platform. If this ### is_low_power -If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. YOU DO NOT NEED TO SET THIS IF YOU'VE set is_router (it is implied in that case). +If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible. + +:::note +You do **not** need to set this if you've set `is_router` (it is implied in that case). +::: Date: Wed, 2 Feb 2022 16:29:56 -0700 Subject: [PATCH 12/14] added power examples --- docs/software/settings/power.md | 243 +++++++++++++++----------------- 1 file changed, 111 insertions(+), 132 deletions(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 8b0ba961..9b99c6bb 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -59,6 +59,8 @@ When you change the following settings to `0` they assume the following defaults Sets the current of the battery charger. +#### Specify charge_current + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Unset charge current" + meshtastic --set charge_current MAUnset + ``` + ```bash title="Set charge current" + meshtastic --set charge_current MA100 + ``` @@ -102,6 +107,7 @@ Configuring this setting is not yet available for the selected platform. If this Circumvents the logic block for determining whether the device is powered or not. Useful for devices with finicky ADC issues on the battery sense pins. +#### Enable/Disable is_always_powered -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable is_always_powered" + meshtastic --set is_always_powered true + ``` + ```bash title="Disable is_always_powered" + meshtastic --set is_always_powered false + ``` @@ -149,6 +158,7 @@ If set, we are powered from a low-current source (i.e. solar), so even if it loo You do **not** need to set this if you've set `is_router` (it is implied in that case). ::: +#### Enable/Disable is_low_power -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable is_low_power" + meshtastic --set is_low_power true + ``` + ```bash title="Disable is_low_power" + meshtastic --set is_low_power false + ``` @@ -192,6 +205,8 @@ Configuring this setting is not yet available for the selected platform. If this Are we operating as a router. Changes behavior in the following ways: The device will only sleep for critically low battery level (i.e. always tries to stay alive for the mesh) In the future routing decisions will preferentially route packets through nodes with this attribute (because assumed good line of sight). + +#### Enable/Disable is_router -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Enable is_router" + meshtastic --set is_router true + ``` + ```bash title="Disable is_router" + meshtastic --set is_router false + ``` @@ -235,6 +253,7 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 3600. +#### Configure ls_secs -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set ls_secs to default (1 hour/3600 seconds)" + meshtastic --set ls_secs 0 + ``` + ```bash title="Set ls_secs to 120 seconds" + meshtastic --set ls_secs 120 + ``` @@ -278,6 +300,7 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable. +#### Configure mesh_sds_timeout_secs -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set mesh_sds_timeout_secs to default (2 hour/7200 seconds)" + meshtastic --set mesh_sds_timeout_secs 0 + ``` + ```bash title="Set mesh_sds_timeout_secs to 120 seconds" + meshtastic --set mesh_sds_timeout_secs 120 + ``` + ```bash title="Disable mesh_sds_timeout_secs (using MAXUINT)" + meshtastic --set mesh_sds_timeout_secs 4294967295 + ``` @@ -321,6 +350,8 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds. +#### Configure min_wake_secs + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set min_wake_secs to default (10 seconds)" + meshtastic --set min_wake_secs 0 + ``` + ```bash title="Set min_wake_secs to 120 seconds" + meshtastic --set min_wake_secs 120 + ``` @@ -364,6 +398,7 @@ Configuring this setting is not yet available for the selected platform. If this If non-zero, the device will fully power off this many seconds after external power is removed. +#### Enable/Disable on_battery_shutdown_after_secs -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Disable on_battery_shutdown_after_secs" + meshtastic --set on_battery_shutdown_after_secs 0 + ``` + ```bash title="Set device to shutdown after 120 seconds on battery" + meshtastic --set on_battery_shutdown_after_secs 120 + ``` @@ -407,6 +445,7 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable. +#### Enable/Disable phone_sds_timeout_sec -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set phone_sds_timeout_sec to default (2 hours)" + meshtastic --set phone_sds_timeout_sec 0 + ``` + ```bash title="Disable phone_sds_timeout_sec" + meshtastic --set phone_sds_timeout_sec 4294967295 + ``` + ```bash title="Set phone_sds_timeout_sec to 120 seconds" + meshtastic --set phone_sds_timeout_sec 120 + ``` @@ -450,6 +495,8 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 15 minutes. +#### Configure phone_timeout_secs + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set phone_timeout_secs to default (15 minutes)" + meshtastic --set phone_timeout_secs 0 + ``` + ```bash title="Set phone_timeout_secs to 120 seconds" + meshtastic --set phone_timeout_secs 120 + ``` @@ -493,6 +543,8 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one minute. +#### Configure screen_on_secs + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set screen_on_secs to default (1 minute)" + meshtastic --set screen_on_secs 0 + ``` + ```bash title="Set screen_on_secs to 120 seconds" + meshtastic --set screen_on_secs 120 + ``` @@ -536,6 +591,8 @@ Configuring this setting is not yet available for the selected platform. If this Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of one year. +#### Configure sds_secs + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set sds_secs to default (1 year)" + meshtastic --set sds_secs 0 + ``` + ```bash title="Set sds_secs to 120 seconds" + meshtastic --set sds_secs 120 + ``` @@ -579,6 +639,8 @@ Configuring this setting is not yet available for the selected platform. If this This sets how often to send the database of node owner information with other nodes in the mesh (per mesh network ping). +#### Configure send_owner_interval + -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: + ```bash title="Set send_owner_interval to default (every 4 network pings)" + meshtastic --set send_owner_interval 0 + ``` + ```bash title="Set send_owner_interval to every 10 network pings" + meshtastic --set send_owner_interval 10 + ``` @@ -620,49 +685,11 @@ Configuring this setting is not yet available for the selected platform. If this For instance the default interval of 4 will send the node owner information for every 4 mesh network pings. This information is also transmitted after the node first boots up. - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - ### wait_bluetooth_secs Wait number of seconds for Bluetooth - Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of 1 minute. +#### Configure wait_bluetooth_secs -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -## Examples - - - - -```bash -meshtastic --set mesh_sds_timeout_secs 0 -``` - -Note: Probably only want to set the wait_bluetooth_secs this high during testing: - -```bash -meshtastic --set wait_bluetooth_secs 28800 -``` - -```bash -meshtastic --set is_always_powered true -``` + ```bash title="Set wait_bluetooth_secs to default (60 seconds)" + meshtastic --set wait_bluetooth_secs 0 + ``` + ```bash title="Set wait_bluetooth_secs to 120 seconds" + meshtastic --set wait_bluetooth_secs 120 + ``` From c103d81e4f9394359d1aa2d90116eda1026326e2 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 2 Feb 2022 16:34:17 -0700 Subject: [PATCH 13/14] reformatted psk docs --- docs/software/settings/channel.md | 21 +++------------------ 1 file changed, 3 insertions(+), 18 deletions(-) diff --git a/docs/software/settings/channel.md b/docs/software/settings/channel.md index 96cf9289..a27a160f 100644 --- a/docs/software/settings/channel.md +++ b/docs/software/settings/channel.md @@ -178,30 +178,15 @@ A channel `id` must be set in order to name a channel. ### psk - - - - - - :::note -Selecting a number from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. +Selecting `1`-`10` from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. ::: | Setting | Behavior | | :-----: | :------: | -| `0` | Disable Encryption | -| `1` | Default Encryption | +| `none`/`0` | Disable Encryption | +| `default`/`1` | Default Encryption (use the weak encryption key) | | `2`-`10` | Default Encryption, except with 1-9 added to the last byte | - - - - - -| Setting | Behavior | -| :-----: | :------: | -| `none` | Disable Encryption | -| `default` | Default Encryption (use the weak encryption key) | | `random` | Generate a secure 256-bit encryption key. Use this setting for private communication. | :::tip From c79a8f53b9bdd51b24130140e0d2cec3410bf33b Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 3 Feb 2022 16:59:11 -0700 Subject: [PATCH 14/14] fixed encryption --- docs/software/settings/channel.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/software/settings/channel.md b/docs/software/settings/channel.md index a27a160f..08f6135a 100644 --- a/docs/software/settings/channel.md +++ b/docs/software/settings/channel.md @@ -179,15 +179,15 @@ A channel `id` must be set in order to name a channel. ### psk :::note -Selecting `1`-`10` from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. +Selecting a `default` or any of the `simple` values from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. ::: | Setting | Behavior | | :-----: | :------: | -| `none`/`0` | Disable Encryption | -| `default`/`1` | Default Encryption (use the weak encryption key) | -| `2`-`10` | Default Encryption, except with 1-9 added to the last byte | +| `none` | Disable Encryption | +| `default` | Default Encryption (use the weak encryption key) | | `random` | Generate a secure 256-bit encryption key. Use this setting for private communication. | +| `simple0`- `simple254` | Uses a single byte encoding for encryption | :::tip If you use Meshtastic for exchanging messages you don't want other people to see, `random` is the setting you should use. @@ -211,10 +211,15 @@ If you use Meshtastic for exchanging messages you don't want other people to see ```bash title="Set encryption to random on PRIMARY channel" meshtastic --ch-set psk random --ch-index 0 ``` + ```bash title="Set encryption to single byte on PRIMARY channel" + meshtastic --ch-set psk simple15 --ch-index 0 + ``` + ```bash title="Set encryption to your own key on PRIMARY channel" + meshtastic --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --ch-index 0 + ``` ```bash title="Disable encryption on PRIMARY channel" meshtastic --ch-set psk none --ch-index 0 ``` -