mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-25 21:54:20 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #137 from mkinney/update_docs_for_ch_set_change

Browse source 
update docs to reflect new --ch-index arg requirement
This commit is contained in:
Jm Casler 2021-12-10 22:41:39 -08:00 committed by GitHub
parent 682cfe2fe7 9ea05a9a4b
commit 10f9be0193
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
website/docs/software/python/cli.md
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

16
website/docs/software/settings/channel.md
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">