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