mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-10 23:54:17 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #424 from meshtastic/proto_cleanup

Browse source 
Proto cleanup
This commit is contained in:
Garth Vander Houwen 2022-09-30 10:48:03 -07:00 committed by GitHub
parent 3fd7fc2292 ea5d7a2b8e
commit a5c0e92ad4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 23 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/settings/config/bluetooth.mdx
View file

@ -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"

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

@ -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
<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:
```shell title="Set the role to client"
meshtastic --set device.role Client
meshtastic --set device.role CLIENT
```
```shell title="Disable serial console"
@ -81,10 +76,6 @@ meshtastic --set device.serial_enabled false
meshtastic --set device.debug_log_enabled true
```
```shell title="Factory reset your radio"
meshtastic --set device.factory_reset true
```
</TabItem>
<TabItem value="flasher">

0
docs/settings/config/wifi.mdx → docs/settings/config/network.mdx
View file

6
docs/settings/config/position.mdx
View file

@ -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)"
@ -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
```

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:
| 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'
```
</TabItem>
<TabItem value="flasher">