From 6415f97a14addaa170127f1c4a878a8f0a540b98 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:02:03 -0700 Subject: [PATCH 01/19] fixed admonition to not take up the whole page --- 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 5e8cb61e..a0b17c67 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -51,7 +51,7 @@ When you the following settings to `0` they assume the following defaults: - `screen_on_secs`: 1 minute - `sds_secs`: 1 year - `wait_bluetooth_secs`: 1 minute - ::: +::: ### charge_current From bac23a36899c81ead0dc1d1cd9aead1b08d1e209 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:10:09 -0700 Subject: [PATCH 02/19] removed linebreaks --- docs/software/settings/canned-message-plugin.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/software/settings/canned-message-plugin.md b/docs/software/settings/canned-message-plugin.md index d2b74b99..d9db6c5e 100644 --- a/docs/software/settings/canned-message-plugin.md +++ b/docs/software/settings/canned-message-plugin.md @@ -9,9 +9,7 @@ import TabItem from '@theme/TabItem'; ## Overview -The CannedMessage Plugin will allow you to send messages to the mesh network -from the device without using the phone app. -You can predefine text messages to choose from. +The CannedMessage Plugin will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from. Please also follow settings of Rotary Encoder to configure input source! @@ -46,8 +44,8 @@ ExternalNotificationPlugin can benefit from this feature. ## Details -See "Software / Plugins / Canned messages" for details! +See "Software / Plugins / Canned messages" for details! ## Examples -See "Software / Plugins / Canned messages" for examples! +See "Software / Plugins / Canned messages" for examples! From eaf2453459549a09ba04d98a60c238ac6f406df6 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:39:38 -0700 Subject: [PATCH 03/19] added mqtt_password --- docs/software/settings/mqtt.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 913d40a9..8d39c25f 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) | :-----------------: | :---------------: | :-----: | | mqtt_disabled | `true`, `false` | `false` | | mqtt_server | `string` | `""` | +| mqtt_password | `string` | `""` | | is_uplink_enabled | `true`, `false` | `false` | | is_downlink_enabled | `true`, `false` | `false` | @@ -38,6 +39,10 @@ If a meshtastic node is able to reach the internet it will normally attempt to g The server to use for our MQTT global message gateway feature. If not set, the default server will be used +### 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). + ### is_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`. From a8d243060eb654304011fac563005cb5f3871c92 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:39:53 -0700 Subject: [PATCH 04/19] added mqtt_username --- docs/software/settings/mqtt.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 8d39c25f..3e677205 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -28,6 +28,7 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) | mqtt_disabled | `true`, `false` | `false` | | mqtt_server | `string` | `""` | | mqtt_password | `string` | `""` | +| mqtt_username | `string` | `""` | | is_uplink_enabled | `true`, `false` | `false` | | is_downlink_enabled | `true`, `false` | `false` | @@ -43,6 +44,10 @@ The server to use for our MQTT global message gateway feature. If not set, the d 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). + ### is_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`. From 985dbbea9444b31c85e8e2f0770ee937186ca033 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:43:25 -0700 Subject: [PATCH 05/19] added gps_accept_2d --- docs/software/settings/gps.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index a762f695..0d3f72dc 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -19,6 +19,7 @@ GPS is provided by either the device or your paired phone. More than likely, you | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | fixed_position | `true`, `false` | `false` | +| gps_accept_2d | `true`, `false` | `false` | | gps_attempt_time | `integer` (seconds) | `0` (see note) | | gps_operation | `GpsOpUnset`, ~~`GpsOpStationary`~~, `GpsOpMobile`, `GpsOpTimeOnly`, `GpsOpDisabled` | `GpsOpUnset` | | gps_update_interval | `integer` (seconds) | `0` (see note) | @@ -38,6 +39,10 @@ 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. +### 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). + ### 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. @@ -84,7 +89,7 @@ The GPS updates will be sent out every `position_broadcast_secs`, with either th 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. +`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`. From 0bdd6bf172444d323dcc59893afe806e7f1fa999 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:51:40 -0700 Subject: [PATCH 06/19] Added gps_format --- docs/software/settings/gps.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index 0d3f72dc..4c3a3b39 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -21,6 +21,7 @@ GPS is provided by either the device or your paired phone. More than likely, you | fixed_position | `true`, `false` | `false` | | 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_update_interval | `integer` (seconds) | `0` (see note) | | location_share | `LocUnset`, `LocEnabled`, `LocDisabled` | `LocUnset` | @@ -43,6 +44,19 @@ If set, this node is at a fixed position. The device will generate GPS updates a 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). +### gps_format + +Determines how the GPS coordinates are displayed on the OLED screen. + +| Value | Description | +| :---: | :---------: | +| GpsFormatDec | GPS coordinates are displayed in the normal decimal degrees format: DD.DDDDDD DDD.DDDDDD | +| GpsFormatDMS | GPS coordinates are displayed in the degrees minutes seconds format: DD°MM'SS"C DDD°MM'SS"C, where C is the compass point representing the locations quadrant | +| GpsFormatUTM | GPS coordinates are displayed in Universal Transverse Mercator format: ZZB EEEEEE NNNNNNN, where Z is zone, B is band, E is easting, N is northing | +| GpsFormatMGRS | GPS coordinates are displayed in Military Grid Reference System format: ZZB CD EEEEE NNNNN, where Z is zone, B is band, C is the east 100k square, D is the north 100k square, E is easting, N is northing | +| 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 | + ### 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. From a529eb6aaea49544b47b9df66d576f6067c1d989 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 15:55:00 -0700 Subject: [PATCH 07/19] added gps_max_dop --- docs/software/settings/gps.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index 4c3a3b39..a2891ef9 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -23,6 +23,7 @@ GPS is provided by either the device or your paired phone. More than likely, you | 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_update_interval | `integer` (seconds) | `0` (see note) | | location_share | `LocUnset`, `LocEnabled`, `LocDisabled` | `LocUnset` | | position_broadcast_secs | `integer` (seconds) | `0` (see note) | @@ -61,6 +62,10 @@ Determines how the GPS coordinates are displayed on the OLED screen. 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. +### 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 + ### gps_operation How the GPS hardware in the device is operated. From 82cabeb30b86bbce42c8d821ea158d0c2ed7e199 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:16:22 -0700 Subject: [PATCH 08/19] removed extra column and extra spacing --- docs/software/settings/power.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index a0b17c67..d7414337 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -25,20 +25,20 @@ For a description and more information on what exactly all of these mean, please ## Settings -| Setting | Acceptable Values | Default | -| :-------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` | -| is_low_power | `true`, `false` | `false` | 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). | -| is_router | `true`, `false` | `false` | -| ls_secs | `integer` (seconds) | `0` (see note) | -| mesh_sds_timeout_secs | `integer` (seconds) | `0` | -| min_wake_secs | `integer` (seconds) | `0` | -| phone_sds_timeout_sec | `integer` (seconds) | `0` | Power management state machine option. See the [power page](/docs/software/other/power) for details. 0 for default of two hours, use the value of MAXUINT or 4294967295 to disable | -| phone_timeout_secs | `integer` (seconds) | `0` | -| screen_on_secs | `integer` (seconds) | `0` | -| sds_secs | `integer` (seconds) | `0` | -| send_owner_interval | `integer` (sent every x network pings) | `4` | -| wait_bluetooth_secs | `integer` (seconds) | `0` | +| Setting | Acceptable Values | Default | +| :-----: | :---------------: | :-----: | +| charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` | +| is_low_power | `true`, `false` | `false` | +| is_router | `true`, `false` | `false` | +| ls_secs | `integer` (seconds) | `0` | +| mesh_sds_timeout_secs | `integer` (seconds) | `0` | +| min_wake_secs | `integer` (seconds) | `0` | +| phone_sds_timeout_sec | `integer` (seconds) | `0` | +| phone_timeout_secs | `integer` (seconds) | `0` | +| screen_on_secs | `integer` (seconds) | `0` | +| sds_secs | `integer` (seconds) | `0` | +| send_owner_interval | `integer` (sent every x network pings) | `4` | +| wait_bluetooth_secs | `integer` (seconds) | `0` | :::note When you the following settings to `0` they assume the following defaults: From 2c2c66d914174b6440f75c40e141b6c1e6a16853 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:16:54 -0700 Subject: [PATCH 09/19] added is_always_powered --- docs/software/settings/power.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index d7414337..00815972 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -28,6 +28,7 @@ For a description and more information on what exactly all of these mean, please | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` | +| is_always_powered | `true`, `false` | `false` | | is_low_power | `true`, `false` | `false` | | is_router | `true`, `false` | `false` | | ls_secs | `integer` (seconds) | `0` | @@ -57,6 +58,10 @@ When you the following settings to `0` they assume the following defaults: Sets the current of the battery charger +### 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. + ### 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). From 63538a4eb6720ec61f6ace9dd047744efe8f9129 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:19:56 -0700 Subject: [PATCH 10/19] added on_battery_shutdown_after_secs --- docs/software/settings/power.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/power.md b/docs/software/settings/power.md index 00815972..441a0091 100644 --- a/docs/software/settings/power.md +++ b/docs/software/settings/power.md @@ -34,6 +34,7 @@ For a description and more information on what exactly all of these mean, please | ls_secs | `integer` (seconds) | `0` | | mesh_sds_timeout_secs | `integer` (seconds) | `0` | | min_wake_secs | `integer` (seconds) | `0` | +| on_battery_shutdown_after_secs | `integer` (seconds) | `0` | | phone_sds_timeout_sec | `integer` (seconds) | `0` | | phone_timeout_secs | `integer` (seconds) | `0` | | screen_on_secs | `integer` (seconds) | `0` | @@ -82,6 +83,10 @@ Power management state machine option. See the [power page](/docs/software/other Power management state machine option. See the [power page](/docs/software/other/power)for details. 0 for default of 10 seconds +### on_battery_shutdown_after_secs + +If non-zero, the device will fully power off this many seconds after external power is removed. + ### 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 From ac3c95c605f59797df7448c331865f719451391f Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:24:41 -0700 Subject: [PATCH 11/19] added store_forward_plugin_heartbeat --- docs/software/settings/store-and-forward-plugin.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index 1525a3c5..52036e10 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -22,12 +22,17 @@ Because of the increased network traffic for this overhead, it's not advised to | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | store_forward_plugin_enabled | `true`, `false` | `false` | +| store_forward_plugin_heartbeat | | | | store_forward_plugin_records | integer | `0` | ### store_forward_plugin_enabled Enables the plugin. +### store_forward_plugin_heartbeat + + + ### store_forward_plugin_records From a75ee51930742e1dae439a885a9b01266c5d8c1e Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:25:07 -0700 Subject: [PATCH 12/19] added store_forward_plugin_history_return_max --- docs/software/settings/store-and-forward-plugin.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index 52036e10..7da2a47e 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -23,6 +23,7 @@ Because of the increased network traffic for this overhead, it's not advised to | :-----: | :---------------: | :-----: | | store_forward_plugin_enabled | `true`, `false` | `false` | | store_forward_plugin_heartbeat | | | +| store_forward_plugin_history_return_max | | | | store_forward_plugin_records | integer | `0` | ### store_forward_plugin_enabled @@ -33,6 +34,10 @@ Enables the plugin. +### store_forward_plugin_history_return_max + + + ### store_forward_plugin_records From 2c5f9ce5fedd630ef11b32fc35befa6fade0f442 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:25:24 -0700 Subject: [PATCH 13/19] added store_forward_plugin_history_return_window --- docs/software/settings/store-and-forward-plugin.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index 7da2a47e..5b2b6b5c 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -24,6 +24,7 @@ Because of the increased network traffic for this overhead, it's not advised to | store_forward_plugin_enabled | `true`, `false` | `false` | | store_forward_plugin_heartbeat | | | | store_forward_plugin_history_return_max | | | +| store_forward_plugin_history_return_window | | | | store_forward_plugin_records | integer | `0` | ### store_forward_plugin_enabled @@ -38,6 +39,10 @@ Enables the plugin. +### store_forward_plugin_history_return_window + + + ### store_forward_plugin_records From 1289e4cf2c341e5be24f255929a6b479963b423f Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:34:58 -0700 Subject: [PATCH 14/19] added position_flags --- docs/software/settings/gps.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/software/settings/gps.md b/docs/software/settings/gps.md index a2891ef9..0bc77340 100644 --- a/docs/software/settings/gps.md +++ b/docs/software/settings/gps.md @@ -28,6 +28,7 @@ GPS is provided by either the device or your paired phone. More than likely, you | location_share | `LocUnset`, `LocEnabled`, `LocDisabled` | `LocUnset` | | position_broadcast_secs | `integer` (seconds) | `0` (see note) | | position_broadcast_smart | `true`, `false` | `false` | +| position_flags | `POS_UNDEFINED`, `POS_ALTITUDE`, `POS_ALT_MSL`, `POS_GEO_SEP`, `POS_DOP`, `POS_HVDOP`, `PDOP`, `POS_BATTERY`, `POS_SATINVIEW`, `POS_SEQ_NOS`, `POS_TIMESTAMP` | `POS_UNDEFINED` | :::note On `gps_attempt_time`, `gps_update_interval`, & `position_broadcast_secs` when you set these to `0` you are not disabling these features. @@ -125,6 +126,23 @@ The table below is a summary computed values from the algorithm. 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 From 5acb51467d797b67db685f1130b1e85091216f30 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:36:48 -0700 Subject: [PATCH 15/19] added auto_screen_carousel_secs --- docs/software/settings/misc.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/software/settings/misc.md b/docs/software/settings/misc.md index 25407136..2d5eaab2 100644 --- a/docs/software/settings/misc.md +++ b/docs/software/settings/misc.md @@ -15,6 +15,7 @@ import TabItem from '@theme/TabItem'; | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | +| auto_screen_carousel_secs | `integer` (seconds) | `0` | | debug_log_enabled | `true`, `false` | `false` | | factory_reset | `true`, `false` | `false` | | frequency_offset | real numbers | `0` | @@ -22,6 +23,11 @@ import TabItem from '@theme/TabItem'; | serial_disabled | `true`, `false` | `false` | | hop_limit | real numbers | 0| + +### auto_screen_carousel_secs + +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. + ### 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. From cf1010b4750315ad10651d05cbbdda5515a6f6bc Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 26 Jan 2022 16:51:11 -0700 Subject: [PATCH 16/19] added some parameters to store-and-forward --- docs/software/settings/store-and-forward-plugin.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/software/settings/store-and-forward-plugin.md b/docs/software/settings/store-and-forward-plugin.md index 5b2b6b5c..b94c92d9 100644 --- a/docs/software/settings/store-and-forward-plugin.md +++ b/docs/software/settings/store-and-forward-plugin.md @@ -22,9 +22,9 @@ Because of the increased network traffic for this overhead, it's not advised to | Setting | Acceptable Values | Default | | :-----: | :---------------: | :-----: | | store_forward_plugin_enabled | `true`, `false` | `false` | -| store_forward_plugin_heartbeat | | | -| store_forward_plugin_history_return_max | | | -| store_forward_plugin_history_return_window | | | +| store_forward_plugin_heartbeat | `true`, `false` | TODO - look up default setting | +| store_forward_plugin_history_return_max | `integer` | `0` | +| store_forward_plugin_history_return_window | `integer` | `0` | | store_forward_plugin_records | integer | `0` | ### store_forward_plugin_enabled From 2b7edb98fedb76cc5d15544ac8068810b3be076a Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 27 Jan 2022 10:24:14 -0700 Subject: [PATCH 17/19] removed spacing --- docs/software/settings/mqtt.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 3e677205..6f87c596 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -23,14 +23,14 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) ## Settings -| Setting | Acceptable Values | Default | -| :-----------------: | :---------------: | :-----: | -| mqtt_disabled | `true`, `false` | `false` | -| mqtt_server | `string` | `""` | -| mqtt_password | `string` | `""` | -| mqtt_username | `string` | `""` | -| is_uplink_enabled | `true`, `false` | `false` | -| is_downlink_enabled | `true`, `false` | `false` | +| Setting | Acceptable Values | Default | +| :-----: | :---------------: | :-----: | +| mqtt_disabled | `true`, `false` | `false` | +| mqtt_server | `string` | `""` | +| mqtt_password | `string` | `""` | +| mqtt_username | `string` | `""` | +| is_uplink_enabled | `true`, `false` | `false` | +| is_downlink_enabled | `true`, `false` | `false` | ### mqtt_disabled From 593406b2f1a79e9d087fd999f6defaf4a1719c96 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 27 Jan 2022 10:26:02 -0700 Subject: [PATCH 18/19] removed "is_" from uplink_enabled and downlink_enabled --- docs/software/settings/mqtt.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 6f87c596..6bbb9930 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -29,12 +29,12 @@ Be sure to checkout this [MQTT](https://meshtastic.org/docs/software/other/mqtt) | mqtt_server | `string` | `""` | | mqtt_password | `string` | `""` | | mqtt_username | `string` | `""` | -| is_uplink_enabled | `true`, `false` | `false` | -| is_downlink_enabled | `true`, `false` | `false` | +| uplink_enabled | `true`, `false` | `false` | +| downlink_enabled | `true`, `false` | `false` | ### mqtt_disabled -If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as `is_uplink_enabled` or `is_downlink_enabled`. But if this flag is set, all MQTT features will be disabled and no servers will be contacted. +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. ### mqtt_server @@ -48,11 +48,11 @@ MQTT password to use (most useful for a custom MQTT server). If using a custom s 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). -### is_uplink_enabled +### 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`. -### is_downlink_enabled +### 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. From 24f284194e7ada9f93bcb6ca0feafe0b8d6f05d4 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 27 Jan 2022 10:31:30 -0700 Subject: [PATCH 19/19] add link to channel --- docs/software/settings/mqtt.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/software/settings/mqtt.md b/docs/software/settings/mqtt.md index 6bbb9930..5e0d81dd 100644 --- a/docs/software/settings/mqtt.md +++ b/docs/software/settings/mqtt.md @@ -50,11 +50,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`. +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). ### 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. +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). ## Details