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

Correct some device settings doc issues

Browse source
This commit is contained in:
Lennart Buhl 2022-10-05 15:10:46 +02:00
parent 2fdadc6d7b
commit 9b5bea347c
4 changed files with 35 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -17,6 +17,12 @@ Enables bluetooth
### Pairing Mode ### Pairing Mode
Specify pairing mode.
`RANDOM_PIN` generates a random PIN during runtime.
`FIXED_PIN` uses the fixed PIN that should then be additionally specified.
Finally, `NO_PIN` disables PIN authentication.
### Fixed PIN ### Fixed PIN
If your pairing mode is set to fixed PIN this is the value of that fixed 6 digit pin. Default value is 123456 If your pairing mode is set to fixed PIN this is the value of that fixed 6 digit pin. Default value is 123456
@ -53,9 +59,9 @@ All bluetooth module config options are available in the python CLI. Example com
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :-----------------------: | :-----------------: | :-----: | | :-----------------------: | :-----------------: | :-----: |
| bluetooth.enabled | `true`, `false` | `true` | | `bluetooth.enabled` | `true`, `false` | `true` |
| bluetooth.mode | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` | | `bluetooth.mode` | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` |
| bluetooth.fixedPin | `integer` 6 Digits | `123456` | | `bluetooth.fixedPin` | `integer` (6 digits) | `123456` |
```shell title="Enable/Disable Bluetooth Module" ```shell title="Enable/Disable Bluetooth Module"
meshtastic --set bluetooth.enabled true meshtastic --set bluetooth.enabled true
@ -70,7 +76,7 @@ meshtastic --set bluetooth.fixed_pin 111111
<TabItem value="web"> <TabItem value="web">
:::info :::info
All bluettoth module config options are available for the Web UI. All bluetooth module config options are available for the Web UI.
::: :::
</TabItem> </TabItem>

5
docs/settings/config/index.mdx
View file

@ -5,16 +5,17 @@ sidebar_label: Config Sections
sidebar_position: 1 sidebar_position: 1
--- ---
There are six config sections in the Meshtastic firmware, these are broken out so they can be sent as small admin messages over the mesh. There are several config sections in the Meshtastic firmware, these are broken out so they can be sent as small admin messages over the mesh.
Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh. Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh.
| Name | Description | | Name | Description |
|:----:|:-----------:| |:----:|:-----------:|
| [Bluetooth](bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. |
| [Device](device) | Device config options are: Device Role, Serial Output, Debug Log and Factory Reset. | | [Device](device) | Device config options are: Device Role, Serial Output, Debug Log and Factory Reset. |
| [Display](display) | Display config options are: Screen On Duration, Auto Carousel Interval, Always Point North, and GPS Format. | | [Display](display) | Display config options are: Screen On Duration, Auto Carousel Interval, Always Point North, and GPS Format. |
| [LoRa](lora) | 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](lora) | 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. |
| [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. |
| [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. | | [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. |
| [Power](power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. | | [Power](power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. |
| [User](user) | The user config options are: Long Name, Short Name, and Is Licensed | | [User](user) | The user config options are: Long Name, Short Name, and Is Licensed |
| [Network](network) | Network config options are: Wifi Enabled, WiFi SSID, Wifi PSK, WiFi Mode and NTP Server. |

22
docs/settings/index.mdx
View file

@ -14,10 +14,24 @@ In order to facilitate a more stable admin channel for remote management of node
Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh. Default settings values are prefered whenever possible as they consume no bandwidth when sent over the mesh.
## Config Sections ## [Config Sections](settings/config)
Meshtastic config is now broken into 6 sections. [Device](settings/config/device), [Display](settings/config/display), [LoRa](settings/config/lora), [Position](settings/config/position), [Power](settings/config/power), [User](settings/config/user) and [Network](settings/config/network). Meshtastic config is broken into several sections:
[Bluetooth](settings/config/bluetooth),
[Device](settings/config/device),
[Display](settings/config/display),
[LoRa](settings/config/lora),
[Network](settings/config/network),
[Position](settings/config/position),
[Power](settings/config/power) and
[User](settings/config/user).
## Module Config ## [Module Config](settings/moduleconfig)
Meshtastic includes the following modules: [Canned Messages](settings/moduleconfig/canned-message), [External Notification](settings/moduleconfig/external-notification), [Range Test](settings/moduleconfig/range-test), [Serial](settings/moduleconfig/serial), and [Telemetry (sensors)](settings/moduleconfig/telemetry). Meshtastic includes the following modules:
[Canned Messages](settings/moduleconfig/canned-message),
[External Notification](settings/moduleconfig/external-notification),
[MQTT](settings/moduleconfig/mqtt),
[Range Test](settings/moduleconfig/range-test),
[Serial](settings/moduleconfig/serial), and
[Telemetry (sensors)](settings/moduleconfig/telemetry).

2
docs/software/web/index.mdx
View file

@ -16,7 +16,7 @@ There are three ways of accessing the app:
## Compatibility ## Compatibility
The application will work in all major browsers, but specific functionality is limited in some cases, for the best experience we reccomend using [Google Chrome](https://www.google.com/chrome) The application will work in all major browsers, but specific functionality is limited in some cases, for the best experience we recommend using [Google Chrome](https://www.google.com/chrome).
### HTTP ### HTTP