mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Cleanup docs commands for user and device

Browse source
This commit is contained in:
Garth Vander Houwen 2022-09-30 09:43:26 -07:00
parent 3fd7fc2292
commit f19ea18213
2 changed files with 19 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/settings/config/device.mdx
View file

@ -7,7 +7,7 @@ sidebar_label: Device
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; 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 ## Device Config Values
@ -18,10 +18,10 @@ Acceptable values:
| Value | Description | | Value | Description |
| :-------: | :---------------------------------------------------------------------------------------: | | :-------: | :---------------------------------------------------------------------------------------: |
| `Client` | Client (default) - App connected client. | | `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. | | `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` | 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. | | `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 ### 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. 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 ## Device Config Client Availability
<Tabs <Tabs
@ -70,7 +65,7 @@ All device config options other than NTP Server are available on iOS, iPadOS and
All device config options are available in the python CLI. Example commands are below: All device config options are available in the python CLI. Example commands are below:
```shell title="Set the role to client" ```shell title="Set the role to client"
meshtastic --set device.role Client meshtastic --set device.role CLIENT
``` ```
```shell title="Disable serial console" ```shell title="Disable serial console"
@ -81,10 +76,6 @@ meshtastic --set device.serial_enabled false
meshtastic --set device.debug_log_enabled true meshtastic --set device.debug_log_enabled true
``` ```
```shell title="Factory reset your radio"
meshtastic --set device.factory_reset true
```
</TabItem> </TabItem>
<TabItem value="flasher"> <TabItem value="flasher">

19
docs/settings/config/user.mdx
View file

@ -67,14 +67,21 @@ values={[
All User config options are available in the python CLI. Example commands are below: 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) 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'
```
</TabItem> </TabItem>
<TabItem value="flasher"> <TabItem value="flasher">