mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-27 22:49:45 -08:00
Add user config options
This commit is contained in:
Garth Vander Houwen
parent
529d5c5188
commit
e74ab73da5
|
|
@ -13,9 +13,10 @@ Default settings values are prefered whenever possible as they consume no bandwi
|
|||
|:----:|:-----------:|
|
||||
| [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, and GPS Format. |
|
||||
| [LoRa](lora) | LoRa config options are: Region, Modem Preset, and Number of Hops. |
|
||||
| [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. |
|
||||
| [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: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. |
|
||||
| [WiFi](wifi) | WiFi config options are: AP Mode, Hidden AP, SSID and Password. |
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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, and Number of Hops. 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 Disabled and Ignore Incoming Array. LoRa config uses an admin message sending a `Config.LoRa` protobuf.
|
||||
|
||||
## LoRa Config Values
|
||||
|
||||
|
|
@ -39,6 +39,41 @@ Sets the region for your node. Default is `unset`.
|
|||
|
||||
### Max Hops
|
||||
|
||||
### Transmit Power
|
||||
|
||||
If zero then, use default max legal continuous power (ie. something that won't burn out the radio hardware)
|
||||
|
||||
In most cases you should use zero here. Units are in dBm.
|
||||
|
||||
### Bandwidth
|
||||
|
||||
Bandwidth in MHz
|
||||
|
||||
Certain bandwidth numbers are 'special' and will be converted to the appropriate floating point value: 31 -> 31.25MHz
|
||||
|
||||
### Spread Factor
|
||||
|
||||
A number from 7 to 12. Indicates the number of chirps per symbol as 1<<spread_factor.
|
||||
|
||||
### Coding Rate
|
||||
|
||||
The denominator of the coding rate. ie for 4/8, the value is 8. 5/8 the value is 5.
|
||||
|
||||
### Frequency Offset
|
||||
|
||||
This parameter is for advanced users with advanced test equipment, we do not recommend most users use it.
|
||||
|
||||
A frequency offset that is added to to the calculated band center frequency. Used to correct for crystal calibration errors.
|
||||
|
||||
### Transmit Disabled
|
||||
|
||||
Disable transmit (TX) from the LoRa radio. Useful for hot-swapping antennas and other tests.
|
||||
|
||||
Defaults to false
|
||||
|
||||
### 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)
|
||||
|
||||
## LoRa Config Client Availability
|
||||
|
||||
|
|
@ -48,7 +83,7 @@ defaultValue="flasher"
|
|||
values={[
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'Apple', value: 'apple'},
|
||||
{label: 'Command Line', value: 'cli'},
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Flasher', value: 'flasher'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
|
|
|
|||
86
docs/settings/config/user.mdx
Normal file
86
docs/settings/config/user.mdx
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
---
|
||||
id: user
|
||||
title: User Configuration
|
||||
sidebar_label: User
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The user config options are: Short Name, Long Name, Licensed Operator, Transmit Power at Antenna Connector, Antenna Gain and Antenna Azimuth. User config uses an admin message sending a `User` protobuf.
|
||||
|
||||
## User Config Values
|
||||
|
||||
### Short Name
|
||||
|
||||
### Long Name
|
||||
|
||||
### Licensed Operator
|
||||
|
||||
### Transmit Power at Antenna Connector
|
||||
|
||||
### Antenna Gain
|
||||
|
||||
### Antenna Azimuth
|
||||
|
||||
## Device Config Client Availability
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="flasher"
|
||||
values={[
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'Apple', value: 'apple'},
|
||||
{label: 'Command Line', value: 'cli'},
|
||||
{label: 'Flasher', value: 'flasher'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Long Name can be edited on Android.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="apple">
|
||||
|
||||
:::info
|
||||
Short Name and Long Name user config options are available on iOS, iPadOS and macOS at Settings > Radio Configuration > User.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli">
|
||||
|
||||
All display config options are available in the python CLI. Example commands are below:
|
||||
|
||||
```shell title="Set Screen On Duration (Default of 0 is 10 minutes)"
|
||||
meshtastic --set screen_on_secs 0
|
||||
meshtastic --set screen_on_secs 120
|
||||
```
|
||||
|
||||
```shell title="Set Auto Carousel Interval (Default of 0 is Off)"
|
||||
meshtastic --set auto_screen_carousel_secs 0
|
||||
// Set to 2 Minutes (120 Seconds)
|
||||
meshtastic --set auto_screen_carousel_secs 120
|
||||
```
|
||||
|
||||
```shell title="Specify GPS format on device screen"
|
||||
meshtastic --set gps_format GpsFormatUTM
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="flasher">
|
||||
|
||||
:::info
|
||||
User config is not available in the Flasher.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
User config is not available in the Web UI.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
id: external-notification
|
||||
title: External Notification Module Settings
|
||||
title: External Notification Module Configuration
|
||||
sidebar_label: External Notification
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ Modules are included in the firmware and allow users to extend the functionality
|
|||
| [Canned Message](canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. |
|
||||
| [External Notification](external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) |
|
||||
| [Input Broker](input-broker) | Attach and define input devices such as external keyboards and rotary encoders. |
|
||||
| [Range Test](range-test-module) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. |
|
||||
| [Range Test](range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. |
|
||||
| [Serial Module](serial) | Send messages across the mesh by sending strings over a serial port. |
|
||||
| [Store and Forward](store-and-forward) | Set a designated node to store messages and resend them to nodes with intermittent connection to a mesh. |
|
||||
| [Telemetry](telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. |
|
||||
|
|
|
|||
Loading…
Reference in a new issue