mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-25 05:34:11 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Device Config Updates

Browse source
This commit is contained in:
Thomas Göttgens 2022-11-09 10:50:40 +01:00
parent 3f8bf17870
commit 0083d60ec0
7 changed files with 60 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/blocks/_lora-regions.mdx
View file

@ -13,4 +13,5 @@
| `RU` | Russia |
| `IN` | India |
| `NZ_865` | New Zealand 865MHz |
| `TH` | Thailand |
| `TH` | Thailand |
| `LORA_24` | 2.4 GHz band worldwide |

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

@ -10,11 +10,15 @@ import TabItem from '@theme/TabItem';
The Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN Value. Bluetooth config uses an admin message sending a `Config.Bluetooth` protobuf.
:::info
On ESP32 Bluetooth will be disabled if WiFi is enabled. The WiFi setting takes precedence.
:::
## Bluetooth Config Values
### Enabled
Enables Bluetooth
Enables Bluetooth.
### Pairing Mode
@ -26,7 +30,7 @@ Finally, `NO_PIN` disables PIN authentication.
### 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. For all other pairing modes, this number is ignored.
## Configure Bluetooth Config

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

@ -19,7 +19,7 @@ Acceptable values:
| Value | Description |
| :-------: | :---------------------------------------------------------------------------------------: |
| `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. |
| `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. |

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

@ -16,27 +16,41 @@ The display config options are: Screen On Duration, Auto Carousel Interval, Alwa
How long the screen remains on after the user button is pressed or messages are received.
### Auto Carousel Interval
Automatically toggles to the next page on the screen like a carousel, based the specified interval.
### Always Point North
If this is set, the compass heading on the screen outside of the circle will always point north. This feature is off by default and the top of display represents your heading direction, the North indicator will move around the circle.
### GPS Format
The format used to display GPS coordinates on the device screen.
Acceptable values:
| Value | Description |
| :-------: | :--------------------------: |
| `gpsFormatDec` | Decimal Degrees |
| `gpsFormatDms` | Degrees Minutes Seconds |
| `gpsFormatUtm` | Universal Transverse Mercator |
| `gpsFormatMgrs` | Military Grid Reference System |
| `gpsFormatOlc` | Open Location Code (Plus Codes) |
| `gpsFormatOsgr` | Ordnance Survey Grid Reference |
| `DEC` | Decimal Degrees |
| `DMS` | Degrees Minutes Seconds |
| `UTM` | Universal Transverse Mercator |
| `MGRS` | Military Grid Reference System |
| `OLC` | Open Location Code (Plus Codes) |
| `OSGR` | Ordnance Survey Grid Reference |
### Prefered display units
switch between `METRIC` (default) and `IMPERIAL` units
### Flip Screen
If enabled, the screen will be rotated 180 degrees, for cases that mount the screen upside down
### OLED Defintion
The type of OLED Controller is auto-detected by default, but can be defined with this setting if the auto-detection fails.
Acceptable values:
| Value | Description |
| :-------: | :--------------------------: |
| `OLED_AUTO` | Auto detect display controller |
| `OLED_SSD1306` | Always use SSD1306 driver |
| `OLED_SH1106` | Always use SH1106 driver |
## Device Config Client Availability
@ -80,7 +94,7 @@ meshtastic --set display.auto_screen_carousel_secs 120
```
```shell title="Specify GPS format on device screen"
meshtastic --set display.gps_format GpsFormatUTM
meshtastic --set display.gps_format UTM
```
</TabItem>

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

@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import LoRaRegions from '../../blocks/_lora-regions.mdx';
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.
The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Channel Number and Ignore Incoming Array. LoRa config uses an admin message sending a `Config.LoRa` protobuf.
## LoRa Config Values
@ -18,13 +18,15 @@ You must set your device's `lora.region` setting. This will ensure that you are
:::
### Region
Sets the region for your node. Default is `unset`.
Sets the region for your node. Default is `unset`. As long as this is not set, the node screen will display a message and not transmit any packets.
<LoRaRegions />
### Modem Preset
Use a sensible default for the modem. Default is `unset` which equates to `LONG_FAST`. Also 'Use Presets' has to be defined, which is the default. If 'Use Presets' is not defined, the modem will be configured manually with Bandwidth, Spread Factor, and Coding Rate.
### Max Hops
Maximum number of hops. This can't be greater than 7. Default is 3 which should be fine for most applications. _**Really, 3 is fine.**_
### Transmit Power
@ -36,7 +38,7 @@ In most cases you should use zero here. Units are in dBm.
Bandwidth in MHz
Certain bandwidth numbers are 'special' and will be converted to the appropriate floating point value: 31 -> 31.25MHz
Certain bandwidth numbers are 'special' and will be converted by the device firmware to the appropriate floating point value: 31 -> 31.25MHz
### Spread Factor
@ -56,7 +58,10 @@ A frequency offset that is added to to the calculated band center frequency. Use
Allows you to enable and disable transmit (TX) from the LoRa radio. Useful for hot-swapping antennas and other tests.
Defaults to false
Defaults to true
### Channel Number
This is controlling the actual hardware frequency the radio is transmitting on. A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region). If this is ZERO/UNSET then the rule is "use the old channel name hash based algorithm to derive the channel number".
### Ignore Incoming Array
@ -95,7 +100,7 @@ LoRa config commands are available in the python CLI. Example commands are below
| Setting | Acceptable Values | Default |
| :----------: | :---------------------------------------------------------------------------: | :---------------: |
| lora.modem_preset | `LONG_FAST`, `LONG_SLOW`, `VERY_LONG_SLOW`, `MEDIUM_SLOW`, `MEDIUM_FAST`, `SHORT_SLOW`, `SHORT_FAST` | `LONG_FAST` |
| lora.region | `UNSET`, `US`, `EU_433`, `EU_868`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` ,`IN`, `NZ_865`, `TH` | `UNSET` |
| lora.region | `UNSET`, `US`, `EU_433`, `EU_868`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` ,`IN`, `NZ_865`, `TH`, `LORA_24` | `UNSET` |
| lora.hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3` |
</TabItem>
<TabItem value="flasher">

18
docs/configuration/device-config/network.mdx
View file

@ -8,7 +8,7 @@ sidebar_label: Network
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, and NTP Server. Network config uses an admin message sending a `Config.Network` protobuf.
The Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, Ethernet Enabled, IPv4 Networking Mode, Static Address and NTP Server. Network config uses an admin message sending a `Config.Network` protobuf.
:::info
Enabling WiFi will disable Bluetooth. Only one connection method will work at a time.
@ -42,9 +42,23 @@ This is your WiFi Networks password.
Empty `""` by default. (Case Sensitive, Max Length: 64)
### Ethernet Enabled
Enables or Disables Ethernet.
Set to `false` (Disabled) by default.
### IPv4 Networking Mode
Set to `DHCP` by default. Change to `STATIC` to use a static IP address. Applies to both Ethernet and WiFi.
### IPv4 Static Address configuration
contains ip, gateway, subnet and dns server in case you want a static configuration.
:::tip
The first time your device restarts after enabling WiFi, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
The first time your device restarts after enabling WiFi or Ethernet, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse.
:::
## Network Config Client Availability

14
docs/configuration/device-config/power.mdx
View file

@ -8,18 +8,12 @@ sidebar_label: Power
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
The 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 config uses an admin message sending a `Config.Power` protobuf.
The power config options are: 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 config uses an admin message sending a `Config.Power` protobuf.
Power settings are advanced configuration, most users should choose a role under Device Config to manage power for their device and should never need to touch any of these settings.
## Power Config Values
### Charge Current
**Tbeam 1.1 only setting**
Sets the current of the battery charger using the AXP power chip on the Tbeam 1.1
### Power Saving
If set, we are powered from a low-current source (i.e. solar), so even if it looks like we have power flowing in we should try to minimize power consumption as much as possible.
@ -104,7 +98,6 @@ All Power config options are available in the python CLI.
| Setting | Acceptable Values | Default |
| :----------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------: |
| power.charge_current | `MAUnset`, `MA100`, `MA190`, `MA280`, `MA360`, `MA450`, `MA550`, `MA630`, `MA700`, `MA780`, `MA880`, `MA960`, `MA1000`, `MA1080`, `MA1160`, `MA1240`, `MA1320`: | `MAUnset` |
| power.is_power_saving | `true`, `false` | `false` |
| power.on_battery_shutdown_after_secs | `integer` (seconds) | Default of `0` is off |
| power.adc_multiplier_override | `2-4` (floating point value) | Default of `0` uses firmware values |
@ -115,11 +108,6 @@ All Power config options are available in the python CLI.
| power.min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds |
```shell title="Set / Unset charge current (Tbeam 1.1 only)"
meshtastic --set power.charge_current MAUnset
meshtastic --set power.charge_current MA100
```
```shell title="Enable / Disable Power Saving"
meshtastic --set power.is_power_saving true
meshtastic --set power.is_power_saving false