Merge branch 'meshtastic:master' into master

This commit is contained in:
Jm Casler 2021-12-15 10:23:03 -08:00 committed by GitHub
commit aecdaa9074
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 30 additions and 16 deletions

View file

@ -69,22 +69,22 @@ Meshtastic encodes the radio channel and PSK in the channel's URL. All nodes mus
:::
```bash
meshtastic --ch-set name mychan --ch-set channel_num 4 --info
meshtastic --ch-set name mychan --ch-index 1 --ch-set channel_num 4 --info
```
You can even set the channel preshared key to a particular AES128 or AES256 sequence.
```bash
meshtastic --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --info
meshtastic --ch-index 1 --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --info
```
Use `--ch-set psk none` to turn off encryption.
Use `--ch-set psk none --ch-index 0` to turn off encryption.
Use `--ch-set psk random` will assign a new (high quality) random AES256 key to the primary channel (similar to what the Android app does when making new channels).
Use `--ch-set psk random --ch-index 0` will assign a new (high quality) random AES256 key to the primary channel (similar to what the Android app does when making new channels).
Use `--ch-set psk default` to restore the standard 'default' (minimally secure, because it is in the source code for anyone to read) AES128 key.
Use `--ch-set psk default --ch-index 0` to restore the standard 'default' (minimally secure, because it is in the source code for anyone to read) AES128 key.
All `ch-set` commands will default to the primary channel at index 0, but can be applied to other channels with the `ch-index` parameter:
All `ch-set` commands need to have the `ch-index` parameter specified:
```bash
meshtastic --ch-index 1 --ch-set name mychan --ch-set channel_num 4 --info

View file

@ -109,8 +109,8 @@ If `true`, messages on the mesh will be sent to the public internet by any gatew
]}>
<TabItem value="cli">
```bash title="Set channel ID"
meshtastic --ch-set id 1234
```bash title="Set the PRIMARY channel ID"
meshtastic --ch-set id 1234 --ch-index 0
```
</TabItem>
@ -135,12 +135,12 @@ The channel `id` must be an integer.
]}>
<TabItem value="cli">
```bash title="Set channel name"
meshtastic --ch-set name MyChannel
```bash title="Set channel name for the PRIMARY channel"
meshtastic --ch-set name MyChannel --ch-index 0
```
```bash title="Set channel name with spaces"
meshtastic --ch-set name "My Channel"
```bash title="Set channel name for the PRIMARY channel with spaces"
meshtastic --ch-set name "My Channel" --ch-index 0
```
</TabItem>
<TabItem value="android">
@ -165,7 +165,7 @@ A channel `id` must be set in order to name a channel.
<TabItem value="cli">
```bash title="Set psk"
meshtastic --ch-set psk default
meshtastic --ch-set psk default --ch-index 0
```
<!--- TODO random and none --->
@ -192,7 +192,7 @@ See [`psk`](#psk) for details.
<TabItem value="cli">
```bash title="Set Modem - LongSlow"
meshtastic --ch-set modem_config Bw125Cr48Sf4096
meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0
```
</TabItem>
<TabItem value="android">

View file

@ -64,7 +64,7 @@ meshtastic --set mqtt_server 192.168.123.234
```
```bash title="Enable MQTT server to mesh"
meshtastic --set is_downlink_enabled True
meshtastic --ch-set uplink_enabled true --ch-set downlink_enabled true
```
```bash title="View raw encoded messages using mosquitto"

View file

@ -18,6 +18,7 @@ meshtastic --set mesh_sds_timeout_secs 4294967295
```
:::note
See MAXUINT from `mesh_sds_timeout_secs` below:
:::
For a description and more information on what exactly all of these mean, please refer to [Power Management State Machine](../other/power)
@ -99,7 +100,11 @@ For instance the default interval of 4 will send the node owner information for
### wait_bluetooth_secs
Power management state machine option. See the [power page](../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](../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
@ -114,6 +119,15 @@ Power management state machine option. See the [power page](../other/power) for
```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
```
</TabItem>