From 9ea05a9a4b27ba3073a9667d43f4f9d41e032905 Mon Sep 17 00:00:00 2001 From: Mike Kinney Date: Fri, 10 Dec 2021 20:04:10 -0800 Subject: [PATCH] update docs to reflect new --ch-index arg requirement --- website/docs/software/python/cli.md | 12 ++++++------ website/docs/software/settings/channel.md | 16 ++++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/website/docs/software/python/cli.md b/website/docs/software/python/cli.md index 14e3e686..249b4c69 100644 --- a/website/docs/software/python/cli.md +++ b/website/docs/software/python/cli.md @@ -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 diff --git a/website/docs/software/settings/channel.md b/website/docs/software/settings/channel.md index c24e51a3..4b7854c3 100644 --- a/website/docs/software/settings/channel.md +++ b/website/docs/software/settings/channel.md @@ -109,8 +109,8 @@ If `true`, messages on the mesh will be sent to the public internet by any gatew ]}> - ```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 ``` @@ -135,12 +135,12 @@ The channel `id` must be an integer. ]}> - ```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 ``` @@ -165,7 +165,7 @@ A channel `id` must be set in order to name a channel. ```bash title="Set psk" - meshtastic --ch-set psk default + meshtastic --ch-set psk default --ch-index 0 ``` @@ -192,7 +192,7 @@ See [`psk`](#psk) for details. ```bash title="Set Modem - LongSlow" - meshtastic --ch-set modem_config Bw125Cr48Sf4096 + meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0 ```