mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-19 23:57:31 -07:00
Merge pull request #585 from rcarteraz/update-roles
Update Device Configuration
This commit is contained in:
Ben Meadors
GitHub
commit
7d6357f867
|
|
@ -14,16 +14,32 @@ 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:
|
||||
|
||||
| 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) - 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.
|
||||
|
||||
### 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) - 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. |
|
||||
|
||||
### Serial Console
|
||||
|
||||
|
|
@ -83,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
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue