From dae52cdb2155d4c2e8317252505d9b7e27e431b2 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Mon, 30 Jan 2023 08:26:56 -0700 Subject: [PATCH 1/8] update roles to add tracker and repeater add tracker and repeater roles --- docs/configuration/device-config/device.mdx | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index b27c4ae6..4ff78e6d 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -18,12 +18,16 @@ Sets the role of node. Acceptable values: -| Value | Description | -| :-------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `CLIENT` | Client (default) - App connected client. | -| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | -| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The WiFi/BLE radios and the OLED screen will be put to sleep. | -| `ROUTER_CLIENT` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | +| Value | Description | +| :-------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `CLIENT` | Client (default) - App connected client. | +| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | +| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The WiFi/BLE radios and the OLED screen will be put to sleep. | +| `ROUTER_CLIENT` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | +| `REPEATER`[^1] | Repeater - Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry or any other packet type. They will simply rebroadcast any mesh packets on the same frequency, channel num, spread factor, and coding rate.[^1] | +| `TRACKER`[^1] | Tracker - Position Mesh packets will be prioritized higher and sent more frequently by default.[^1] | + +[^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may evolve or change as work on them continues. ### Serial Console From 3bc85c9585de484c8c4694641f9472ef813b6de6 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Mon, 30 Jan 2023 09:32:18 -0700 Subject: [PATCH 2/8] add rebroadcast mode setting --- docs/configuration/device-config/device.mdx | 29 +++++++++++++++------ 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 4ff78e6d..01c13abe 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -27,7 +27,19 @@ Acceptable values: | `REPEATER`[^1] | Repeater - Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry or any other packet type. They will simply rebroadcast any mesh packets on the same frequency, channel num, spread factor, and coding rate.[^1] | | `TRACKER`[^1] | Tracker - Position Mesh packets will be prioritized higher and sent more frequently by default.[^1] | -[^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may evolve or change as work on them continues. +[^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues. + +### Rebroadcast Mode + +This setting defines the device's behavior for how messages are rebroadcasted. [^2] + +[^2]: This setting is new as of the 2.0.16 alpha release. It is still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues. + +| Value | Description | +| :-----------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `ALL` | ALL (Default) - Rebroadcast any observed message, whether it was on our private channel or from another mesh with the same lora params. | +| `All_SKIP_DECODING` | ALL_SKIP_DECODING - Same as behavior as ALL, but skips packet decoding and simply rebroadcasts them. **Only available with Repeater role.** | +| `LOCAL_ONLY` | LOCAL_ONLY - Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels. | ### Serial Console @@ -87,13 +99,14 @@ All device config options are available in the python CLI. Example commands are ::: -| Setting | Acceptable Values | Default | -| ------------------------ | -------------------------------------------------- | -------- | -| device.debug_log_enabled | `true`, `false` | `false` | -| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT` | `CLIENT` | -| device.serial_enabled | `true`, `false` | `true` | -| device.button_gpio | `0` - `34` | `0` | -| device.buzzer_gpio | `0` - `34` | `0` | +| Setting | Acceptable Values | Default | +| ------------------------ | ------------------------------------------------------------------------- | -------- | +| device.debug_log_enabled | `true`, `false` | `false` | +| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT`, `REPEATER`, `TRACKER` | `CLIENT` | +| device.rebroadcast_mode | `ALL`, `ALL_SKIP_DECODING`, `LOCAL_ONLY` | `ALL` | +| device.serial_enabled | `true`, `false` | `true` | +| device.button_gpio | `0` - `34` | `0` | +| device.buzzer_gpio | `0` - `34` | `0` | :::tip From 6bbd3fdd88fa825dd23951d6f7d1d9e228509d89 Mon Sep 17 00:00:00 2001 From: Jon Date: Mon, 30 Jan 2023 11:48:32 -0500 Subject: [PATCH 3/8] Charmin edits to Roles --- docs/configuration/device-config/device.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 01c13abe..1f9c09a6 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -18,14 +18,14 @@ Sets the role of node. Acceptable values: -| Value | Description | -| :-------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `CLIENT` | Client (default) - App connected client. | -| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | -| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. This node will not be used by client apps. The WiFi/BLE radios and the OLED screen will be put to sleep. | -| `ROUTER_CLIENT` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | -| `REPEATER`[^1] | Repeater - Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry or any other packet type. They will simply rebroadcast any mesh packets on the same frequency, channel num, spread factor, and coding rate.[^1] | -| `TRACKER`[^1] | Tracker - Position Mesh packets will be prioritized higher and sent more frequently by default.[^1] | +| Value | Description | +| :-------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `CLIENT` | Client (default) - App connected client. | +| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | +| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The WiFi/Bluetooth radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | +| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. WiFi/Bluetooth and OLED screen will not be put to sleep. | +| `REPEATER`[^1] | Repeater - Mesh packets will be re-broadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | +| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every 2 minutes. Smart Position Broadcast will default to off.[^1] | [^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues. From 30c75c1f9bffd3b5a640bc23c4b7147024617fd8 Mon Sep 17 00:00:00 2001 From: Jon Date: Mon, 30 Jan 2023 11:57:43 -0500 Subject: [PATCH 4/8] Rebroadcast --- docs/configuration/device-config/device.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 1f9c09a6..479dfb94 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -24,7 +24,7 @@ Acceptable values: | `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | | `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The WiFi/Bluetooth radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | | `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. WiFi/Bluetooth and OLED screen will not be put to sleep. | -| `REPEATER`[^1] | Repeater - Mesh packets will be re-broadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | +| `REPEATER`[^1] | Repeater - Mesh packets will be rebroadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | | `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every 2 minutes. Smart Position Broadcast will default to off.[^1] | [^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues. From 3d2efa5631f77beb88cd8b310da5660595a63a05 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Mon, 30 Jan 2023 10:06:10 -0700 Subject: [PATCH 5/8] fix typo --- docs/configuration/device-config/device.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 479dfb94..8826df52 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -14,7 +14,7 @@ The device config options are: Role, Serial Output, and Debug Log. Device config ### Role -Sets the role of node. +Sets the role of the node. Acceptable values: @@ -25,7 +25,7 @@ Acceptable values: | `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The WiFi/Bluetooth radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | | `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. WiFi/Bluetooth and OLED screen will not be put to sleep. | | `REPEATER`[^1] | Repeater - Mesh packets will be rebroadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | -| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every 2 minutes. Smart Position Broadcast will default to off.[^1] | +| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every two minutes. Smart Position Broadcast will default to off.[^1] | [^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues. From ecb26defd743f8e1a73f47e7253ec76525c45270 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Mon, 30 Jan 2023 10:34:30 -0700 Subject: [PATCH 6/8] change `all` description wording --- docs/configuration/device-config/device.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 8826df52..834352ca 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -37,7 +37,7 @@ This setting defines the device's behavior for how messages are rebroadcasted. [ | Value | Description | | :-----------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `ALL` | ALL (Default) - Rebroadcast any observed message, whether it was on our private channel or from another mesh with the same lora params. | +| `ALL` | ALL (Default) - This setting will rebroadcast ALL messages from its primary mesh as well as other meshes with the same modem settings, including when encryption settings differ. | | `All_SKIP_DECODING` | ALL_SKIP_DECODING - Same as behavior as ALL, but skips packet decoding and simply rebroadcasts them. **Only available with Repeater role.** | | `LOCAL_ONLY` | LOCAL_ONLY - Ignores observed messages from foreign meshes that are open or those which it cannot decrypt. Only rebroadcasts message on the nodes local primary / secondary channels. | From 46549929266999501d3f3439ee181e18b1e0ab4c Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Mon, 30 Jan 2023 11:15:30 -0700 Subject: [PATCH 7/8] update client description, ble/wifi --- docs/configuration/device-config/device.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 834352ca..784ddfcb 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -18,14 +18,14 @@ Sets the role of the node. Acceptable values: -| Value | Description | -| :-------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `CLIENT` | Client (default) - App connected client. | -| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | -| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The WiFi/Bluetooth radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | -| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. WiFi/Bluetooth and OLED screen will not be put to sleep. | -| `REPEATER`[^1] | Repeater - Mesh packets will be rebroadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | -| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every two minutes. Smart Position Broadcast will default to off.[^1] | +| Value | Description | +| :-------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). | +| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | +| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | +| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. | +| `REPEATER`[^1] | Repeater - Mesh packets will be rebroadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | +| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every two minutes. Smart Position Broadcast will default to off.[^1] | [^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues. From a9785726eafc290d064409251881cf4b129b6672 Mon Sep 17 00:00:00 2001 From: rcarteraz Date: Mon, 30 Jan 2023 14:10:38 -0700 Subject: [PATCH 8/8] update repeater verbiage --- docs/configuration/device-config/device.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 784ddfcb..1bda7dd0 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -18,14 +18,14 @@ Sets the role of the node. Acceptable values: -| Value | Description | -| :-------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). | -| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | -| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | -| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. | -| `REPEATER`[^1] | Repeater - Mesh packets will be rebroadcast by this device without showing the device as part of the mesh network. This role is useful for a cleaner mesh setup where users do not need information about the Repeater node, or to prevent direct messaging to an unmonitored Repeater. Channel and modem settings must be identical to the mesh network being repeated. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | -| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every two minutes. Smart Position Broadcast will default to off.[^1] | +| Value | Description | +| :-------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). | +| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. | +| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. | +| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. | +| `REPEATER`[^1] | Repeater - Mesh packets will prefer to be routed over this node. This role eliminates unnecessary overhead such as NodeInfo, DeviceTelemetry, and any other mesh packet, resulting in the device not appearing as part of the network. As such, direct messaging this node is not available, as it will not appear in your nodes list which results in a cleaner mesh network. Channel and modem settings of the mesh packets being repeated must be identical to the repeater's configuration. Please see Rebroadcast Mode for additional settings specific to this role.[^1] | +| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every two minutes. Smart Position Broadcast will default to off.[^1] | [^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues.