From 41d1e1b8f11f0e369a450c8b0772b624b15ddae5 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Thu, 22 Sep 2022 18:51:41 -0700 Subject: [PATCH] more proto config change updates --- docs/settings/config/bluetooth.mdx | 44 ++++++++++++++++++++++++++++++ docs/settings/config/lora.mdx | 6 ++-- docs/settings/config/position.mdx | 18 ++++++------ 3 files changed, 56 insertions(+), 12 deletions(-) diff --git a/docs/settings/config/bluetooth.mdx b/docs/settings/config/bluetooth.mdx index 7c2fba84..974873f3 100644 --- a/docs/settings/config/bluetooth.mdx +++ b/docs/settings/config/bluetooth.mdx @@ -21,7 +21,35 @@ 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 + + + +:::info +Bluetooth module config is not available for Android. +::: + + + + +:::info +All bluetooth config values are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Position. +::: + + + + +All bluetooth module config options are available in the python CLI. Example commands are below: | Setting | Acceptable Values | Default | | :-----------------------: | :-----------------: | :-----: | @@ -29,5 +57,21 @@ If your pairing mode is set to fixed PIN this is the value of that fixed 6 digit | bluetooth.mode | `RandomPin`, `FixedPin`, `NoPin` | `RandomPin` | | 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 fixedPin +meshtastic --set bluetooth.FixedPin 111111 +``` + + +:::info +All bluettoth module config options are available for the Web UI. +::: + + + \ No newline at end of file diff --git a/docs/settings/config/lora.mdx b/docs/settings/config/lora.mdx index f8e010d1..5d596aa4 100644 --- a/docs/settings/config/lora.mdx +++ b/docs/settings/config/lora.mdx @@ -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 diff --git a/docs/settings/config/position.mdx b/docs/settings/config/position.mdx index 9ad163ff..ff7f5e45 100644 --- a/docs/settings/config/position.mdx +++ b/docs/settings/config/position.mdx @@ -59,17 +59,17 @@ The GPS updates will be sent out every Broadcast Interval, with either the actua | Value | Description | | :-----------: | :---------------------------------------------------------: | -| 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 | +| 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 | +| 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) | +| HEADING | Include positional heading (from GPS solution) | +| SPEED | Include positional speed (from GPS solution) |