From f19ea182134cf36aab71b37d44cf63644f0bce3e Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Fri, 30 Sep 2022 09:43:26 -0700 Subject: [PATCH 1/4] Cleanup docs commands for user and device --- docs/settings/config/device.mdx | 21 ++++++--------------- docs/settings/config/user.mdx | 19 +++++++++++++------ 2 files changed, 19 insertions(+), 21 deletions(-) diff --git a/docs/settings/config/device.mdx b/docs/settings/config/device.mdx index e1e85441..89656957 100644 --- a/docs/settings/config/device.mdx +++ b/docs/settings/config/device.mdx @@ -7,7 +7,7 @@ sidebar_label: Device import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -The device config options are: Role, Serial Output, Debug Log, NTP Server and Factory Reset. Device config uses an admin message sending a `Config.Device` protobuf. +The device config options are: Role, Serial Output, and Debug Log. Device config uses an admin message sending a `Config.Device` protobuf. ## Device Config Values @@ -18,10 +18,10 @@ Acceptable values: | Value | Description | | :-------: | :---------------------------------------------------------------------------------------: | -| `Client` | Client (default) - App connected client. | -| `ClientMute` | 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. | -| `RouterClient` | 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. | +| `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. | ### Serial Console @@ -34,11 +34,6 @@ Acceptable values: `true` or `false` By default we turn off logging as soon as an API client connects Set this to true to leave the debug log outputting even when API is active. -### NTP Server -Acceptable value: `string` - -NTP server to use if WiFi is conneced, defaults to `0.pool.ntp.org` - ## Device Config Client Availability diff --git a/docs/settings/config/user.mdx b/docs/settings/config/user.mdx index 4bca4be5..3d7def12 100644 --- a/docs/settings/config/user.mdx +++ b/docs/settings/config/user.mdx @@ -67,14 +67,21 @@ values={[ All User config options are available in the python CLI. Example commands are below: -| Setting | Acceptable Values | Default | -| :-----------: | :---------------: | :-----: | -| LongName | string | auto-generated | -| ShortName | string | auto-generated | -| IsLicensed | bool | `false` | - Please see instructions for [Enabling HAM License](/docs/software/python/python-uses#ham-radio-support) +```shell title="Set the LongName Value" +meshtastic --set-owner 'your node name' +``` + +```shell title="Set the ShortName Value" +meshtastic --set-owner-short 'NODE' +``` + +```shell title="Enable Ham Mode, set name to license, disable encryption" +meshtastic --set-ham 'CALLSIGN' +``` + + From 601e87e595006baadf66f6038f2d41a52a671df0 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Fri, 30 Sep 2022 09:58:28 -0700 Subject: [PATCH 2/4] network updates --- docs/settings/config/bluetooth.mdx | 2 +- docs/settings/config/position.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/settings/config/bluetooth.mdx b/docs/settings/config/bluetooth.mdx index 6ed5792b..2d3d03b3 100644 --- a/docs/settings/config/bluetooth.mdx +++ b/docs/settings/config/bluetooth.mdx @@ -59,7 +59,7 @@ All bluetooth module config options are available in the python CLI. Example com ```shell title="Enable/Disable Bluetooth Module" meshtastic --set bluetooth.enabled true -meshtastic --set mqtt.enabled false +meshtastic --set bluetooth.enabled false ``` ```shell title="Set a fixed pin" diff --git a/docs/settings/config/position.mdx b/docs/settings/config/position.mdx index ff7f5e45..ce2267bb 100644 --- a/docs/settings/config/position.mdx +++ b/docs/settings/config/position.mdx @@ -159,7 +159,7 @@ Include each flag desired separated by a single space. ::: ```shell title="Set / Unset Position Flags" -meshtastic --pos-fields ALTITUDE POS_ALTITUDE_MSL +meshtastic --pos-fields ALTITUDE ALTITUDE_MSL meshtastic --pos-fields UNSET ``` From 8157385fb7d4b448b08044e41a1e142d345b0f2a Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Fri, 30 Sep 2022 10:00:14 -0700 Subject: [PATCH 3/4] Fix network page --- docs/settings/config/{wifi.mdx => network.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/settings/config/{wifi.mdx => network.mdx} (100%) diff --git a/docs/settings/config/wifi.mdx b/docs/settings/config/network.mdx similarity index 100% rename from docs/settings/config/wifi.mdx rename to docs/settings/config/network.mdx From ea5d7a2b8e99c1bb889d785e3a18c9a355baaaa7 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Fri, 30 Sep 2022 10:43:26 -0700 Subject: [PATCH 4/4] fix position smart CLI command --- docs/settings/config/position.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/settings/config/position.mdx b/docs/settings/config/position.mdx index ce2267bb..cef53197 100644 --- a/docs/settings/config/position.mdx +++ b/docs/settings/config/position.mdx @@ -141,8 +141,8 @@ meshtastic --set position.fixed_position false ``` ```shell title="Enable / Disable Smart position broadcast (Enabled by default)" -meshtastic --set position.broadcast_smart_enabled true -meshtastic --set position.broadcast_smart_enabled false +meshtastic --set position.position_broadcast_smart_enabled true +meshtastic --get position.position_broadcast_smart_enabled false ``` ```shell title="Set Position Broadcast Interval (Default of 0 is 15 minutes)"