mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-20 16:17:33 -07:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

More proto cleanup

Browse source
This commit is contained in:
Garth Vander Houwen 2022-09-22 15:41:33 -07:00
parent bca1cc334f
commit 19f359b3df
2 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -59,17 +59,17 @@ The GPS updates will be sent out every Broadcast Interval, with either the actua
| Value | Description |
| :-----------: | :---------------------------------------------------------: |
| POS_UNDEFINED | Required for compilation |
| POS_ALTITUDE | Include an altitude value (if available) |
| POS_ALT_MSL | Altitude value is MSL |
| POS_GEO_SEP | Include geoidal separation |
| POS_DOP | Include the DOP value ; PDOP used by default, see below |
| POS_HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of PDOP |
| POS_SATINVIEW | Include number of "satellites in view" |
| POS_SEQ_NOS | Include a sequence number incremented per packet |
| POS_TIMESTAMP | Include positional timestamp (from GPS solution) |
| POS_HEADING | Include positional heading (from GPS solution) |
| POS_SPEED | Include positional speed (from GPS solution) |
| UNSET | Required for compilation |
| ALTITUDE | Include an altitude value (if available) |
| ALTITUDE_MSL | Altitude value is MSL |
| GEOIDAL_SEPARATION | Include geoidal separation |
| DOP | Include the DOP value ; PDOP used by default, see below |
| HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of PDOP |
| SATINVIEW | Include number of "satellites in view" |
| SEQ_NO | Include a sequence number incremented per packet |
| TIMESTAMP | Include positional timestamp (from GPS solution) |
| HEADING | Include positional heading (from GPS solution) |
| SPEED | Include positional speed (from GPS solution) |
@ -95,7 +95,7 @@ Position config is not available for Android.
<TabItem value="apple">
:::info
All position config values except for postion flag are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position.
All position config values are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position.
:::
</TabItem>
@ -105,13 +105,13 @@ All Position config conmmands are available in the python CLI. Example commands
| Setting | Acceptable Values | Default |
| :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: |
| position.gps_disabled | `true`, `false` | `false` |
| position.gps_enabled | `true`, `false` | `true` |
| position.gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds |
| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds |
| position.fixed_position | `true`, `false` | `false` |
| position.broadcast_smart_disabled | `true`, `false` | `true` |
| position.broadcast_smart_enabled | `true`, `false` | `true` |
| position.broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes |
| position.flags | `POS_UNDEFINED`, `POS_ALTITUDE`, `POS_ALT_MSL`, `POS_GEO_SEP`, `POS_DOP`, `POS_HVDOP`, `PDOP`, `POS_BATTERY`, `POS_SATINVIEW`, `POS_SEQ_NOS`, `POS_TIMESTAMP`, `POS_HEADING`, `POS_SPEED` | `POS_UNDEFINED` |
| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` |
```shell title="Set GPS update interval (Default of 0 is 30 seconds)"
@ -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_disabled true
meshtastic --set position.broadcast_smart_disabled false
meshtastic --set position.broadcast_smart_enabled true
meshtastic --set position.broadcast_smart_enabled false
```
```shell title="Set Position Broadcast Interval (Default of 0 is 15 minutes)"
@ -159,8 +159,8 @@ Include each flag desired separated by a single space.
:::
```shell title="Set / Unset Position Flags"
meshtastic --pos-fields POS_ALTITUDE POS_ALT_MSL
meshtastic --pos-fields POS_UNDEFINED
meshtastic --pos-fields ALTITUDE POS_ALTITUDE_MSL
meshtastic --pos-fields UNSET
```
</TabItem>

12
docs/settings/moduleconfig/serial.mdx
View file

@ -81,10 +81,10 @@ All serial module config options are available in the python CLI. Example comman
| :-------------------: | :-----------------: | :-----: |
| serial.enabled | `true`, `false` | `false` |
| serial.echo | `true`, `false` | `false` |
| serial.mode | `modeDefault` `modeSimple` `modeProto` | `modeDefault` |
| serial.mode | `DEFAULT` `SIMPLE` `PROTO` `TEXTMSG` | `DEFAULT` |
| serial.rxd | GPIO Pin Number 1-39 | Default of `0` is Unset |
| serial.txd | GPIO Pin Number 1-39 | Defaunlt of `0` is Unset |
| serial.baud | `baudDefault` `baud110` `baud300` `baud600` `baud1200` `baud2400` `baud4800` `baud9600` `baud19200` `baud38400` `baud57600` `baud115200` `baud230400` `baud460800` `baud576000` `baud921600` | `baudDefault` |
| serial.baud | `BAUD_DEFAULT` `BAUD_110` `BAUD_300` `BAUD_600` `BAUD_1200` `BAUD_2400` `BAUD_4800` `BAUD_9600` `BAUD_19200` `BAUD_38400` `BAUD_57600` `BAUD_115200` `BAUD_230400` `BAUD_460800` `BAUD_576000` `BAUD_921600` | `BAUD_DEFAULT` |
| serial.timeout | `integer` (seconds) | `0` |
@ -99,8 +99,8 @@ meshtastic --set serial.echo false
```
```shell title="Set Mode"
meshtastic --set serial.mode modeDefault
meshtastic --set serial.mode modeProto
meshtastic --set serial.mode DEFAULT
meshtastic --set serial.mode PROTO
```
```shell title="Set RXD to GPIO pin number 7"
@ -112,8 +112,8 @@ meshtastic --set serial_module_txd 28
```
```shell title="Set Baud Rate"
meshtastic --set serial.baud baudDefault
meshtastic --set serial.baud baud576000
meshtastic --set serial.baud BAUD_DEFAULT
meshtastic --set serial.baud BAUD_576000
```
```shell title="Set Timeout to 15 seconds"