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

Merge pull request #416 from meshtastic/bluetooth_config

Browse source 
Bluetooth config and recent proto updates cleanup
This commit is contained in:
Garth Vander Houwen 2022-09-23 07:04:54 -07:00 committed by GitHub
parent f7159eca91 69a53cca3e
commit fb06f8bc91
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 75 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -21,13 +21,57 @@ Enables bluetooth
If your pairing mode is set to fixed PIN this is the value of that fixed 6 digit pin. Default value is 123456
## Bluetooth Module Config Client Availability
<Tabs
groupId="settings"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
:::info
Bluetooth module config is not available for Android.
:::
</TabItem>
<TabItem value="apple">
:::info
All bluetooth config values are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position.
:::
</TabItem>
<TabItem value="cli">
All bluetooth module config options are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :-----------------------: | :-----------------: | :-----: |
| bluetooth.enabled | `true`, `false` | `true` |
| bluetooth.mode | `RandomPin`, `FixedPin`, `NoPin` | `RandomPin` |
| bluetooth.mode | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` |
| bluetooth.fixedPin | `integer` 6 Digits | `123456` |
```shell title="Enable/Disable Bluetooth Module"
meshtastic --set bluetooth.enabled true
meshtastic --set mqtt.enabled false
```
```shell title="Set a fixed pin"
meshtastic --set bluetooth.mode FIXED_PIN
meshtastic --set bluetooth.fixed_pin 111111
```
</TabItem>
<TabItem value="web">
:::info
All bluettoth module config options are available for the Web UI.
:::
</TabItem>
</Tabs>

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

@ -27,7 +27,7 @@ Acceptable values:
### Serial Console
Acceptable values: `true` or `false`
On by default. If set to true this will disable the serial console by not initilizing the StreamAPI.
Disabling this will disable the SerialConsole by not initilizing the StreamAPI
### Debug Log
Acceptable values: `true` or `false`
@ -39,11 +39,6 @@ Acceptable value: `string`
NTP server to use if WiFi is conneced, defaults to `0.pool.ntp.org`
### Factory Reset
Acceptable values: `true` or `false`
This setting is never saved to disk, but if set, all device settings will be returned to factory defaults.
## Device Config Client Availability
<Tabs
@ -79,7 +74,7 @@ meshtastic --set device.role Client
```
```shell title="Disable serial console"
meshtastic --set device.serial_disabled true
meshtastic --set device.serial_enabled false
```
```shell title="Enable debug logging"

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

@ -7,7 +7,7 @@ sidebar_label: LoRa
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Disabled and Ignore Incoming Array. LoRa config uses an admin message sending a `Config.LoRa` protobuf.
The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled and Ignore Incoming Array. LoRa config uses an admin message sending a `Config.LoRa` protobuf.
## LoRa Config Values
@ -65,9 +65,9 @@ This parameter is for advanced users with advanced test equipment, we do not rec
A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors.
### Transmit Disabled
### Transmit Enabled
Disable transmit (TX) from the LoRa radio. Useful for hot-swapping antennas and other tests.
Allows you to enable and disable transmit (TX) from the LoRa radio. Useful for hot-swapping antennas and other tests.
Defaults to false

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"