From 9ea05a9a4b27ba3073a9667d43f4f9d41e032905 Mon Sep 17 00:00:00 2001 From: Mike Kinney Date: Fri, 10 Dec 2021 20:04:10 -0800 Subject: [PATCH 1/3] 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 ``` From 7ed15cb6495424ea241b5ee08c9b0a58396ce750 Mon Sep 17 00:00:00 2001 From: Mike Kinney Date: Sun, 12 Dec 2021 16:49:13 -0800 Subject: [PATCH 2/3] add some power cli examples --- website/docs/software/settings/power.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/website/docs/software/settings/power.md b/website/docs/software/settings/power.md index e29bb517..52840333 100644 --- a/website/docs/software/settings/power.md +++ b/website/docs/software/settings/power.md @@ -99,7 +99,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 +118,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 ``` From 0254bcf680de12ac78faae94554124af4652025c Mon Sep 17 00:00:00 2001 From: andrekir Date: Wed, 15 Dec 2021 09:29:36 -0300 Subject: [PATCH 3/3] mqtt uplink & downlink typo & power.md bad note syntax --- website/docs/software/settings/mqtt.md | 2 +- website/docs/software/settings/power.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/software/settings/mqtt.md b/website/docs/software/settings/mqtt.md index 5714ba26..a63bba51 100644 --- a/website/docs/software/settings/mqtt.md +++ b/website/docs/software/settings/mqtt.md @@ -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" diff --git a/website/docs/software/settings/power.md b/website/docs/software/settings/power.md index 52840333..3f5ad2fc 100644 --- a/website/docs/software/settings/power.md +++ b/website/docs/software/settings/power.md @@ -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)