mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-09 23:24:10 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

update device/lora/display .mdx pages

Browse source
This commit is contained in:
rcarteraz 2023-05-09 11:31:11 -07:00 committed by Sacha Weatherstone
parent eccbe9dc34
commit 823cfc3051
3 changed files with 27 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/configuration/device-config/device.mdx
View file

@ -62,6 +62,10 @@ This is the GPIO pin number that will be used for the PWM buzzer, if your device
This is the number of seconds between NodeInfo message broadcasts from the device. The device will still respond ad-hoc to NodeInfo messages when a response is wanted.
### Double Tap as Button Press
This option will enable a double tap, when a supported accelerometer is attached to the device, to be treated as a button press.
## Device Config Client Availability
<Tabs
@ -100,15 +104,16 @@ All device config options are available in the python CLI. Example commands are
:::
| Setting | Acceptable Values | Default |
| ------------------------------- | ----------------------------------------------------------------------------------- | ----------------- |
| device.debug_log_enabled | `true`, `false` | `false` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT`, `REPEATER`, `TRACKER`, `SENSOR` | `CLIENT` |
| device.rebroadcast_mode | `ALL`, `ALL_SKIP_DECODING`, `LOCAL_ONLY` | `ALL` |
| device.serial_enabled | `true`, `false` | `true` |
| device.button_gpio | `0` - `34` | `0` |
| device.buzzer_gpio | `0` - `34` | `0` |
| device.node_info_broadcast_secs | `0` - `UINT MAX` | `10800` (3 hours) |
| Setting | Acceptable Values | Default |
| --------------------------------- | ----------------------------------------------------------------------------------- | ----------------- |
| device.debug_log_enabled | `true`, `false` | `false` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT`, `REPEATER`, `TRACKER`, `SENSOR` | `CLIENT` |
| device.rebroadcast_mode | `ALL`, `ALL_SKIP_DECODING`, `LOCAL_ONLY` | `ALL` |
| device.serial_enabled | `true`, `false` | `true` |
| device.button_gpio | `0` - `34` | `0` |
| device.buzzer_gpio | `0` - `34` | `0` |
| device.node_info_broadcast_secs | `0` - `UINT MAX` | `10800` (3 hours) |
| device.double_tap_as_button_press | `false`, `true` | `false` |
:::tip

5
docs/configuration/device-config/display.mdx
View file

@ -68,6 +68,10 @@ The display mode can be set to `NORMAL` (default), `TWOCOLOR` or `INVERTED`. The
The heading can be hard to read when 'INVERTED' or 'TWOCOLOR' display mode is used. This setting will make the heading bold, so it is easier to read.
### Wake on Tap or Motion
This option enables the ability to wake the device screen when motion, such as a tap on the device, is detected via an attached accelerometer.
## Device Config Client Availability
<Tabs
@ -117,6 +121,7 @@ All display config options are available in the python CLI. Example commands are
| display.units | `METRIC`, `IMPERIAL` | `METRIC` |
| display.displaymode | `NORMAL`, `TWOCOLOR`, `INVERTED` | `NORMAL` |
| display.heading_bold | `false`, `true` | `false` |
| display.wake_on_tap_or_motion | `false`, `true` | `false` |
:::tip

8
docs/configuration/device-config/lora.mdx
View file

@ -111,6 +111,14 @@ For testing it is useful sometimes to force a node to never listen to particular
Setting this option to 'true' means the device will ignore the hourly duty cycle limit in Europe. This means that you might violate regulations if the device transmits too much. By default, this option is set to 'false,' which means the device will stop sending data when it reaches the hourly limit and will start again when it is allowed to do so.
### SX126x RX Boosted Gain
This is an option specific to the SX126x chip series which allows the chip to consume a small amount of additional power to increase RX sensitivity.
### Override Frequency
This parameter is for advanced users and licensed HAM radio operators. When enabled, the channel calculation will be ignored, and the set frequency will be used instead (frequency_offset still applies). This will allow you to use out-of-band frequencies. Please respect your local laws and regulations. If you are a license HAM operator, make sure you enable HAM mode and turn off encryption.
## LoRa Config Client Availability
<Tabs