mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-27 14:39:54 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

add chain tip, fix formating, add missing tables

Browse source
This commit is contained in:
rcarteraz 2023-01-06 19:56:47 -07:00 committed by Thomas Göttgens
parent acfcc50214
commit 301c055312
10 changed files with 169 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -88,6 +88,16 @@ All Bluetooth module config options are available in the python CLI. Example com
| `bluetooth.mode` | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` |
| `bluetooth.fixedPin` | `integer` (6 digits) | `123456` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set bluetooth.enabled true --set bluetooth.fixed_pin 111111
```
:::
```shell title="Enable/Disable Bluetooth Module"
meshtastic --set bluetooth.enabled true
meshtastic --set bluetooth.enabled false

10
docs/configuration/device-config/channels.mdx
View file

@ -130,6 +130,16 @@ Channel settings are only available on Apple platforms by scanning QR codes.
All Channel config options are available in the python CLI. Example commands are below:
:::
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --ch-set name "My Channel" --ch-set psk random --ch-set uplink_enabled true --ch-index 4
```
:::
**Id**
```shell title="Set the PRIMARY channel ID"

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

@ -28,12 +28,12 @@ Acceptable values:
### Serial Console
Acceptable values: `true` or `false`
Disabling this will disable the SerialConsole by not initializing the StreamAPI
Disabling this will disable the SerialConsole by not initializing the StreamAPI.
### Debug Log
Acceptable values: `true` or `false`
By default we turn off logging as soon as an API client connects Set this to true to leave the debug log outputting even when API is active.
By default we turn off logging as soon as an API client connects. Set this to true to leave the debug log outputting even when API is active.
## Device Config Client Availability
@ -44,7 +44,6 @@ values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
@ -68,8 +67,28 @@ All device config options other than NTP Server are available on iOS, iPadOS and
</TabItem>
<TabItem value="cli">
:::info
All device config options are available in the python CLI. Example commands are below:
:::
| Setting | Acceptable Values | Default |
|--------------------------|----------------------------------------------------|----------|
| device.debug_log_enabled | `true`, `false` | `false` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT` | `CLIENT` |
| device.serial_enabled | `true`, `false` | `true` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set device.role CLIENT --set device.debug_log_enabled true
```
:::
```shell title="Set the role to client"
meshtastic --set device.role CLIENT
```
@ -83,14 +102,7 @@ meshtastic --set device.debug_log_enabled true
```
</TabItem>
<TabItem value="flasher">
:::danger
No device config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
<TabItem value="web">
:::info
All device config options are available in the Web UI.

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

@ -61,7 +61,6 @@ values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
@ -85,8 +84,32 @@ All display config options are available on iOS, iPadOS and macOS at Settings >
</TabItem>
<TabItem value="cli">
:::info
All display config options are available in the python CLI. Example commands are below:
:::
| Setting | Acceptable Values | Default |
|-----------------------------------|--------------------------------------------|------------------------------|
| display.auto_screen_carousel_secs | `integer` | Default of `0` is 10 minutes |
| display.compass_north_top | `false`, `true` | `false` |
| display.flip_screen | `fasle`, `true` | `false` |
| display.gps_format | `DEC`, `DMS`, `UTM`, `MGRS`, `OLC`, `OSGR` | `DEC` |
| display.oled | `OLED_AUTO`, `OLED_SSD1306`, `OLED_SH1106` | `OLED_AUTO` |
| display.screen_on_secs | `integer` | Default of `0` is off. |
| display.units | `METRIC`, `IMPERIAL` | `METRIC` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set display.screen_on_secs 120 --set display.gps_format UTM
```
:::
```shell title="Set Screen On Duration (Default of 0 is 10 minutes)"
meshtastic --set display.screen_on_secs 0
meshtastic --set display.screen_on_secs 120
@ -103,14 +126,7 @@ meshtastic --set display.gps_format UTM
```
</TabItem>
<TabItem value="flasher">
:::info
No display config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
<TabItem value="web">
:::info
All display config options are available in the Web UI.

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

@ -104,23 +104,61 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS
</TabItem>
<TabItem value="cli">
:::info
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`, `LORA_24` | `UNSET` |
| lora.hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3` |
| lora.override_duty_cycle | `false`, `true` | `false` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set lora.region US --set lora.modem_preset LONG_FAST
```
:::
```shell title="Set Modem Preset"
meshtastic --set lora.modem_preset LONG_FAST
meshtastic --set lora.modem_preset MEDIUM_FAST
```
```shell title="Set Region"
meshtastic --set lora.region US
meshtastic --set lora.region EU_433
```
```shell title="Set Hop Limit"
meshtastic --set lora.hop_limit 2
```
```shell title="Override Duty Cycle"
meshtastic --set lora.override_duty_cycle true
meshtastic --set lora.override_duty_cycle false
```
</TabItem>
<TabItem value="flasher">
:::info
No LoRa config options are available in the Flasher.
Only `lora.region` can be set via the GUI flasher. Refer to other clients for any other config.
:::
</TabItem>
<TabItem value="web">
</TabItem>
<TabItem value="web">
:::info
All LoRa config options are available in the Web UI.

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

@ -65,12 +65,11 @@ The first time your device restarts after enabling WiFi or Ethernet, it will tak
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="cli"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
@ -98,8 +97,12 @@ Network config is not available on Apple OS's.
<TabItem value="cli">
:::info
All Network config options are available in the python CLI.
:::
| Setting | Acceptable Values | Default |
| :-----------: | :---------------: | :-----: |
| network.ntp_server | string | `0.pool.ntp.org` |
@ -107,6 +110,16 @@ All Network config options are available in the python CLI.
| network.wifi_psk | string | `""` |
| network.wifi_ssid | string | `""` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set network.wifi_enabled true --set network.wifi_ssid "my network" --set network.wifi_psk mypassword
```
:::
```shell title="Set NTP Server"
meshtastic --set network.ntp_server "0.pool.ntp.org"
```
@ -131,14 +144,6 @@ meshtastic --set network.wifi_psk "my password"
</TabItem>
<TabItem value="flasher">
:::info
All Network config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info

29
docs/configuration/device-config/position.mdx
View file

@ -83,7 +83,6 @@ values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
@ -107,8 +106,12 @@ All position config values are available on iOS, iPadOS and macOS at Settings >
</TabItem>
<TabItem value="cli">
:::info
All Position config commands are available in the python CLI. Example commands are below:
:::
| Setting | Acceptable Values | Default |
| :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: |
| position.gps_enabled | `true`, `false` | `true` |
@ -119,6 +122,15 @@ All Position config commands are available in the python CLI. Example commands a
| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes |
| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one. **This is especially important for position values to ensure they are set at the same time and avoid being overwritten by subsequent commands.**
```shell title="Example:"
meshtastic --set position.fixed_position true --setlat 37.8651 --setlon -119.5383
```
:::
```shell title="Set GPS update interval (Default of 0 is 30 seconds)"
meshtastic --set position.gps_update_interval 0
@ -160,30 +172,19 @@ meshtastic --set position.broadcast_secs 60
It may take some time to see that the change has taken effect. The GPS location is updated according to the value specified on `gps_update_interval` and the mesh will be notified of the new position in relation to the `position_broadcast_secs` value.
:::
:::tip
Include each flag desired separated by a single space.
:::
```shell title="Set / Unset Position Flags"
meshtastic --pos-fields ALTITUDE ALTITUDE_MSL
meshtastic --pos-fields UNSET
```
</TabItem>
<TabItem value="flasher">
:::info
No position config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
<TabItem value="web">
:::info
All position config options are available in the Web UI.
:::
</TabItem>
</TabItem>
</Tabs>
:::caution

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

@ -74,7 +74,6 @@ values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
@ -99,8 +98,12 @@ Power config is not available on Apple OS's.
</TabItem>
<TabItem value="cli">
:::info
All Power config options are available in the python CLI.
:::
| Setting | Acceptable Values | Default |
| :----------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------: |
| power.is_power_saving | `true`, `false` | `false` |
@ -112,6 +115,15 @@ All Power config options are available in the python CLI.
| power.ls_secs | `integer` (seconds) | Default of `0` is 1 hour |
| power.min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set power.is_power_saving true --set power.on_battery_shutdown_after_secs 120
```
:::
```shell title="Enable / Disable Power Saving"
meshtastic --set power.is_power_saving true
@ -150,14 +162,7 @@ meshtastic --set power.min_wake_secs 0
meshtastic --set power.min_wake_secs 120
```
</TabItem>
<TabItem value="flasher">
:::info
Power config is not available in the Flasher.
:::
</TabItem>
<TabItem value="web">
<TabItem value="web">
:::info
All power config options are available in the Web UI.

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

@ -44,7 +44,6 @@ values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Flasher', value: 'flasher'},
{label: 'Web', value: 'web'},
]}>
@ -71,10 +70,24 @@ User Config options are available for Android.
<TabItem value="cli">
:::info
All User config options are available in the python CLI. Example commands are below:
:::
Please see instructions for [Enabling HAM License](/docs/software/python/cli/usage#ham-radio-support)
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set-owner 'your node name' --set-owner-short 'NODE'
```
:::
```shell title="Set the LongName Value"
meshtastic --set-owner 'your node name'
```
@ -89,14 +102,6 @@ meshtastic --set-ham 'CALLSIGN'
</TabItem>
<TabItem value="flasher">
:::info
No User config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info

4
docs/configuration/module-config/telemetry.mdx
View file

@ -103,11 +103,11 @@ All telemetry module config options are available in the python CLI. Example com
| Setting | Acceptable Values | Default |
| :-----------------------------------------------------: | :-----------------: | :-----: |
| telemetry.device_update_interval | `integer` (seconds) | `900` |
| telemetry.device_update_interval | `integer` (seconds) | Default `0` is 15 minutes. |
| telemetry.environment_display_fahrenheit | `true`, `false` | `false` |
| telemetry.environment_measurement_enabled | `true`, `false` | `false` |
| telemetry.environment_screen_enabled | `true`, `false` | `0` |
| telemetry.environment_update_interval | `integer` (seconds) | `0` |
| telemetry.environment_update_interval | `integer` (seconds) | Default `0` is 15 minutes. |
:::tip