mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 22:19:46 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #427 from r41d/settingsfix

Browse source 
Correct some device settings doc issues
This commit is contained in:
Garth Vander Houwen 2022-10-06 07:33:57 -07:00 committed by GitHub
parent 9cd0723cfb 5566eccc90
commit b1f6b125c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 51 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/hardware/supported/lora.mdx
View file

@ -7,7 +7,7 @@ sidebar_position: 2
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
LILYGO® Lora23 v1-2.1 * Versions other than 2.1 not reccomended with a battery LILYGO® Lora23 v1-2.1 * Versions other than 2.1 not recommended with a battery
<Tabs <Tabs
groupId="t-lora" groupId="t-lora"

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>

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

@ -20,14 +20,14 @@ Acceptable values:
| :-------: | :---------------------------------------------------------------------------------------: | | :-------: | :---------------------------------------------------------------------------------------: |
| `CLIENT` | Client (default) - 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. | | `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` | 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. | | `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 ### Serial Console
Acceptable values: `true` or `false` Acceptable values: `true` or `false`
Disabling this will disable the SerialConsole by not initilizing the StreamAPI Disabling this will disable the SerialConsole by not initializing the StreamAPI
### Debug Log ### Debug Log
Acceptable values: `true` or `false` Acceptable values: `true` or `false`

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

@ -5,16 +5,15 @@ 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.
| 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. |
| [Position](position) | Positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. | | [Network](network) | Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, WiFi Mode and NTP Server. |
| [Position](position) | Position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, 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. |

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

@ -22,8 +22,8 @@ Sets the region for your node. Default is `unset`.
| :-------: | :---------------------------------------------------------------------------------------: | | :-------: | :---------------------------------------------------------------------------------------: |
| `unset` | Unset | | `unset` | Unset |
| `us` | United States | | `us` | United States |
| `eu433` | European Union 433mhz | | `eu433` | European Union 433MHz |
| `eu868` | European Union 868mhz | | `eu868` | European Union 868MHz |
| `cn` | China | | `cn` | China |
| `jp` | Japan | | `jp` | Japan |
| `anz` | Australia & New Zealand | | `anz` | Australia & New Zealand |
@ -31,7 +31,7 @@ Sets the region for your node. Default is `unset`.
| `tw` | Taiwan | | `tw` | Taiwan |
| `ru` | Russia | | `ru` | Russia |
| `in` | India | | `in` | India |
| `nz865` | New Zealand 865mhz | | `nz865` | New Zealand 865MHz |
| `th` | Thailand | | `th` | Thailand |
@ -41,7 +41,7 @@ Sets the region for your node. Default is `unset`.
### Transmit Power ### Transmit Power
If zero then, use default max legal continuous power (ie. something that won't burn out the radio hardware) If zero then, use default max legal continuous power (i.e. something that won't burn out the radio hardware)
In most cases you should use zero here. Units are in dBm. In most cases you should use zero here. Units are in dBm.
@ -73,7 +73,7 @@ Defaults to false
### Ignore Incoming Array ### Ignore Incoming Array
For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send droped on receive (by router.cpp) For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send dropped on receive (by router.cpp)
## LoRa Config Client Availability ## LoRa Config Client Availability
@ -103,7 +103,7 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
LoRa config conmmands are available in the python CLI. Example commands are below: LoRa config commands are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :----------: | :---------------------------------------------------------------------------: | :---------------: | | :----------: | :---------------------------------------------------------------------------: | :---------------: |

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

@ -26,7 +26,7 @@ The NTP server used if IP networking is available.
Set to `0.pool.ntp.org` by default. (Max Length: 33) Set to `0.pool.ntp.org` by default. (Max Length: 33)
### Wifi Enabled ### WiFi Enabled
Enables or Disables WiFi. Enables or Disables WiFi.

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

@ -7,9 +7,9 @@ sidebar_label: Position
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
The positon config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Postion, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf. The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf.
Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a gps or internet connection for time. Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a GPS or internet connection for time.
## Position Config Values ## Position Config Values
@ -101,7 +101,7 @@ All position config values are available on iOS, iPadOS and macOS at Settings >
</TabItem> </TabItem>
<TabItem value="cli"> <TabItem value="cli">
All Position config conmmands are available in the python CLI. Example commands are below: All Position config commands are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: | | :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: |

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

@ -30,7 +30,7 @@ Automatically shut down a device after a defined time period if power is lost.
### ADC Multiplier Override ### ADC Multiplier Override
**Fixes issues on Heltec v2** **Fixes issues on Heltec v2**
Ratio of voltage divider for battery pin eg. 3.20 (R1=100k, R2=220k) Ratio of voltage divider for battery pin e.g. 3.20 (R1=100k, R2=220k)
Overrides the ADC_MULTIPLIER defined in the firmware device variant file for battery voltage calculation. Overrides the ADC_MULTIPLIER defined in the firmware device variant file for battery voltage calculation.

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