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

Merge pull request #385 from meshtastic/1_3_28_updates

Browse source 
Module Config CLI Updates
This commit is contained in:
Garth Vander Houwen 2022-08-03 08:19:40 -07:00 committed by GitHub
parent d556bd6684 4a3b4c27da
commit ad0a92f92f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 123 additions and 125 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -67,14 +67,12 @@ Device config is not available for Android.
:::info
All device config options other than NTP Server are available on iOS, iPadOS and macOS at Settings > Radio Configuration > Device.
WiFi related settings are not available on Apple OS's.
:::
</TabItem>
<TabItem value="cli">
No device config options are available in the python CLI. Example commands are below:
All device config options are available in the python CLI. Example commands are below:
```shell title="Set the role to client"
meshtastic --set device.role client

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

@ -60,7 +60,7 @@ All display config options are available on iOS, iPadOS and macOS at Settings >
</TabItem>
<TabItem value="cli">
No display config options are available in the python CLI. Example commands are below:
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 display.screen_on_secs 0

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

@ -103,7 +103,7 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS
</TabItem>
<TabItem value="cli">
Select LoRa config conmmands are available in the python CLI. Example commands are below:
LoRa config conmmands are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :----------: | :---------------------------------------------------------------------------: | :---------------: |
@ -122,7 +122,7 @@ No lora config options are available in the Flasher.
<TabItem value="web">
:::info
No lora config options are available in the Web UI.
All lora config options are available in the Web UI.
:::
</TabItem>

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

@ -101,7 +101,7 @@ All position config values except for postion flag are available on iOS, iPadOS
</TabItem>
<TabItem value="cli">
No Position config conmmands are available in the python CLI. Example commands are below:
All Position config conmmands are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: |
@ -174,7 +174,7 @@ No position config options are available in the Flasher.
<TabItem value="web">
:::info
No position config options are available in the Web UI.
All position config options are available in the Web UI.
:::
</TabItem>

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

@ -9,7 +9,7 @@ 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.
Power settings are advanced configuration, most users should choose a role under Device Config to manage power for their device.
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
@ -99,7 +99,7 @@ Power config is not available on Apple OS's.
</TabItem>
<TabItem value="cli">
No Power config options are available in the python CLI.
All Power config options are available in the python CLI.
| Setting | Acceptable Values | Default |
| :----------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------: |
@ -166,7 +166,7 @@ Power config is not available in the Flasher.
<TabItem value="web">
:::info
No power config options are available in the Web UI.
All power config options are available in the Web UI.
:::
</TabItem>

80
docs/settings/moduleconfig/canned-message.mdx
View file

@ -101,33 +101,33 @@ All canned message module config options are available on iOS, iPadOS and macOS
<TabItem value="cli">
:::info
No canned message module config options are available in the python CLI.
All canned message module config options are available in the python CLI.
:::
Example commands are below:
| Setting | Acceptable Values | Default |
| :--------------------------------------: | :---------------: | :-----: |
| canned_message_module_enabled | `true`, `false` | `false` |
| canned_message_module_send_bell | `true`, `false` | `false` |
| canned_message_module_allow_input_source | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb`, `faceskb` | `_any` |
| canned_message_module_messages | `string` | `""` |
| (Messages)\* | `string` | `""` |
| inputbroker_event_cw | `InputEventChar` | (not defined) |
| inputbroker_event_ccw | `InputEventChar` | (not defined) |
| inputbroker_event_press | `InputEventChar` | (not defined) |
| inputbroker_pin_a | `integer` | (not defined) |
| inputbroker_pin_b | `integer` | (not defined) |
| inputbroker_pin_press | `integer` | (not defined) |
| Setting | Acceptable Values | Default |
| :--------------------------------------: | :---------------: | :-----------: |
| canned_message.enabled | `true`, `false` | `false` |
| canned_message.send_bell | `true`, `false` | `false` |
| canned_message.allow_input_source | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb`, `faceskb` | `_any` |
| canned_message.messages | `string` | `""` |
| (Messages)\* | `string` | `""` |
| canned_message.inputbroker_event_cw | `InputEventChar` | (not defined) |
| canned_message.inputbroker_event_ccw | `InputEventChar` | (not defined) |
| canned_message.inputbroker_event_press | `InputEventChar` | (not defined) |
| canned_message.inputbroker_pin_a | `integer` | (not defined) |
| canned_message.inputbroker_pin_b | `integer` | (not defined) |
| canned_message.inputbroker_pin_press | `integer` | (not defined) |
```shell title="Enable/Disable the Canned Message Module"
meshtastic --set canned_message_module_enabled true
meshtastic --set canned_message_module_enabled false
meshtastic --set canned_message.enabled true
meshtastic --set canned_message.enabled false
```
```shell title="Enable/Disable send bell character"
meshtastic --set canned_message_module_send_bell true
meshtastic --set canned_message_module_send_bell false
meshtastic --set canned_message.send_bell true
meshtastic --set canned_message.send_bell false
```
```shell title="Set Messages"
@ -135,8 +135,8 @@ meshtastic --set-canned-message "I need an alpinist!|Call Me|Roger Roger|Keep Ca
```
```shell title="Set Input Source"
meshtastic --set canned_message_module_allow_input_source "_any"
meshtastic --set canned_message_module_allow_input_source "rotEnc1"
meshtastic --set canned_message.allow_input_source "_any"
meshtastic --set canned_message.allow_input_source "rotEnc1"
```
```shell title="Enable/Disable rotary1"
@ -144,33 +144,33 @@ meshtastic --set
```
```shell title="Set/Unset Encoder Pin A"
meshtastic --set inputbroker_pin_a 17
meshtastic --set inputbroker_pin_a 0
meshtastic --set canned_message.inputbroker_pin_a 17
meshtastic --set canned_message.inputbroker_pin_a 0
```
```shell title="Set/Unset Encoder Pin B"
meshtastic --set inputbroker_pin_b 39
meshtastic --set inputbroker_pin_b 0
meshtastic --set canned_message.inputbroker_pin_b 39
meshtastic --set canned_message.inputbroker_pin_b 0
```
```shell title="Set/Unset Encoder Pin Press"
meshtastic --set inputbroker_pin_press 21
meshtastic --set inputbroker_pin_press 0
meshtastic --set canned_message.inputbroker_pin_press 21
meshtastic --set canned_message.inputbroker_pin_press 0
```
```shell title="Set/Unset Input Broker CW Event"
meshtastic --set inputbroker_event_cw KEY_UP
meshtastic --set inputbroker_event_cw ""
meshtastic --set canned_message.inputbroker_event_cw KEY_UP
meshtastic --set canned_message.inputbroker_event_cw ""
```
```shell title="Set/Unset Input Broker CCW Event"
meshtastic --set inputbroker_event_ccw KEY_DOWN
meshtastic --set inputbroker_event_ccw ""
meshtastic --set canned_message.inputbroker_event_ccw KEY_DOWN
meshtastic --set canned_message.inputbroker_event_ccw ""
```
```shell title="Set/Unset Input Broker Press Event"
meshtastic --set inputbroker_event_press KEY_SELECT
meshtastic --set inputbroker_event_press ""
meshtastic --set canned_message.inputbroker_event_press KEY_SELECT
meshtastic --set canned_message.inputbroker_event_press ""
```
</TabItem>
<TabItem value="flasher">
@ -183,7 +183,7 @@ No canned message test module config options are available in the Flasher.
<TabItem value="web">
:::info
No canned message test module config options are available in the Web UI.
All canned message module config options are available in the Web UI.
:::
</TabItem>
@ -251,13 +251,13 @@ Replace each `GPIO` (x3) below with the GPIO numbers from your hardware setup.
:::
```shell title="Canned Message Module - Required Rotary Encoder Module Settings"
meshtastic --set rotary1_pin_a GPIO
meshtastic --set rotary1_pin_b GPIO
meshtastic --set rotary1_pin_press GPIO
meshtastic --set rotary1_event_cw KEY_UP
meshtastic --set rotary1_event_ccw KEY_DOWN
meshtastic --set rotary1_event_press KEY_SELECT
meshtastic --set rotary1_enabled True
meshtastic --set canned_message.rotary1_pin_a GPIO
meshtastic --set canned_message.rotary1_pin_b GPIO
meshtastic --set canned_message.rotary1_pin_press GPIO
meshtastic --set canned_message.rotary1_event_cw KEY_UP
meshtastic --set canned_message.rotary1_event_ccw KEY_DOWN
meshtastic --set canned_message.rotary1_event_press KEY_SELECT
meshtastic --set canned_message.rotary1_enabled True
```

42
docs/settings/moduleconfig/external-notification.mdx
View file

@ -69,42 +69,42 @@ All external notification module config options are available on iOS, iPadOS and
All external noftification module config options are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :-----------------------------------: | :----------------------: | :-----: |
| ext_notification_module_enabled | `true`, `false` | `false` |
| ext_notification_module_active | `true`, `false` | `false` |
| ext_notification_module_alert_bell | `true`, `false` | `false` |
| ext_notification_module_alert_message | `true`, `false` | `false` |
| ext_notification_module_output | `integer` | `0` |
| ext_notification_module_output_ms | `integer` (milliseconds) | `0` |
| Setting | Acceptable Values | Default |
| :----------------------------: | :----------------------: | :-----: |
| ext_notification.enabled | `true`, `false` | `false` |
| ext_notification.active | `true`, `false` | `false` |
| ext_notification.alert_bell | `true`, `false` | `false` |
| ext_notification.alert_message | `true`, `false` | `false` |
| ext_notification.output | `integer` | `0` |
| ext_notification.output_ms | `integer` (milliseconds) | `0` |
```shell title="Enable/Disable External Notification Module"
meshtastic --set ext_notification_module_enabled true
meshtastic --set ext_notification_module_enabled false
meshtastic --set ext_notification.enabled true
meshtastic --set ext_notification.enabled false
```
```shell title="Enable/Disable alert on incoming bell"
meshtastic --set ext_notification_module_alert_bell true
meshtastic --set ext_notification_module_alert_bell false
meshtastic --set ext_notification.alert_bell true
meshtastic --set ext_notification.alert_bell false
```
```shell title="Set GPIO active high / low (defalut of false is low)"
meshtastic --set ext_notification_module_active false
meshtastic --set ext_notification_module_active true
meshtastic --set ext_notification.active false
meshtastic --set ext_notification.active true
```
```shell title="Enable/Disable alert on incoming message"
meshtastic --set ext_notification_module_alert_message true
meshtastic --set ext_notification_module_alert_message false
meshtastic --set ext_notification.alert_message true
meshtastic --set ext_notification.alert_message false
```
```shell title="Set GPIO to monitor to 21"
meshtastic --set ext_notification_module_output 21
meshtastic --set ext_notification.output 21
```
```shell title="Set monitored GPIO output duration (default of 0 is 1000ms)"
meshtastic --set ext_notification_module_output_ms 0
meshtastic --set ext_notification_module_output_ms 1500
meshtastic --set ext_notification.output_ms 0
meshtastic --set ext_notification.output_ms 1500
```
</TabItem>
<TabItem value="flasher">
@ -117,7 +117,7 @@ External Notification module config is not available in the Flasher.
<TabItem value="web">
:::info
External Notification module config is not available for the Web UI.
All External Notification module config is available for the Web UI.
:::
</TabItem>
@ -140,7 +140,7 @@ We support being alerted on two events:
2. Incoming Text Message that contains the ASCII bell character. At present, only the Python API can send an ASCII bell character, but more support may be added in the future.
:::info
The bell character is ASCII 0x07. Include 0x07 anywhere in the text message and with ext_notification_module_alert_bell enabled, we will issue an external notification.
The bell character is ASCII 0x07. Include 0x07 anywhere in the text message and with ext_notification.alert_bell enabled, we will issue an external notification.
:::
## External Hardware

30
docs/settings/moduleconfig/range-test.mdx
View file

@ -59,26 +59,26 @@ No range test module config options are available in the python CLI. Example com
| Setting | Acceptable Values | Default |
| :-----------------------: | :-----------------: | :-----: |
| range_test_module_enabled | `true`, `false` | `false` |
| range_test_module_save | `true`, `false` | `false` |
| range_test_module_sender | `integer` (Seconds) | `0` |
| range_test.enabled | `true`, `false` | `false` |
| range_test.save | `true`, `false` | `false` |
| range_test.sender | `integer` (Seconds) | `0` |
```shell title="Enable / Disable the range test"
meshtastic --set range_test_module_enabled true
meshtastic --set range_test_module_enabled false
meshtastic --set range_test.enabled true
meshtastic --set range_test.enabled false
```
```shell title="Enable / Disable range test save"
meshtastic --set range_test_module_save true
meshtastic --set range_test_module_save false
meshtastic --set range_test.save true
meshtastic --set range_test.save false
```
```shell title="Enable range test sender (send every 60 seconds)"
meshtastic --set range_test_module_sender 60
meshtastic --set range_test.sender 60
```
```shell title="Disable range test sender"
meshtastic --set range_test_module_sender 0
meshtastic --set range_test.sender 0
```
</TabItem>
@ -121,12 +121,12 @@ http://198.168.0.15
### Recommended Sender Settings
| Radio Setting | `range_test_module_sender` |
| :-----------: | :------------------------: |
| Long Slow | 60 |
| Long Alt | 30 |
| Medium | 15 |
| Short Fast | 15 |
| Radio Setting | `range_test.sender` |
| :-----------: | :-----------------: |
| Long Slow | 60 |
| Long Alt | 30 |
| Medium | 15 |
| Short Fast | 15 |

42
docs/settings/moduleconfig/serial.mdx
View file

@ -75,32 +75,32 @@ All serial module config options are available on iOS, iPadOS and macOS at Setti
</TabItem>
<TabItem value="cli">
No serial module config options are available in the python CLI. Example commands are below:
All serial module config options are available in the python CLI. Example commands are below:
| Setting | Acceptable Values | Default |
| :-------------------: | :-----------------: | :-----: |
| serial_module_enabled | `true`, `false` | `false` |
| serial_module_echo | `true`, `false` | `false` |
| serial_module_mode | `modeDefault` `modeSimple` `modeProto` | `modeDefault` |
| serial_module_rxd | GPIO Pin Number 1-39 | Default of `0` is Unset |
| serial_module_txd | GPIO Pin Number 1-39 | Defaunlt of `0` is Unset |
| serial_module_baud | `baudDefault` `baud110` `baud300` `baud600` `baud1200` `baud2400` `baud4800` `baud9600` `baud19200` `baud38400` `baud57600` `baud115200` `baud230400` `baud460800` `baud576000` `baud921600` | `baudDefault` |
| serial_module_timeout | `integer` (seconds) | `0` |
| serial.enabled | `true`, `false` | `false` |
| serial.echo | `true`, `false` | `false` |
| serial.mode | `modeDefault` `modeSimple` `modeProto` | `modeDefault` |
| serial.rxd | GPIO Pin Number 1-39 | Default of `0` is Unset |
| serial.txd | GPIO Pin Number 1-39 | Defaunlt of `0` is Unset |
| serial.baud | `baudDefault` `baud110` `baud300` `baud600` `baud1200` `baud2400` `baud4800` `baud9600` `baud19200` `baud38400` `baud57600` `baud115200` `baud230400` `baud460800` `baud576000` `baud921600` | `baudDefault` |
| serial.timeout | `integer` (seconds) | `0` |
```shell title="Enable / Disable Module"
meshtastic --set serial_module_enabled true
meshtastic --set serial_module_enabled false
meshtastic --set serial.enabled true
meshtastic --set serial.enabled false
```
```shell title="Enable / Disable Echo"
meshtastic --set serial_module_echo true
meshtastic --set serial_module_echo false
meshtastic --set serial.echo true
meshtastic --set serial.echo false
```
```shell title="Set Mode"
meshtastic --set serial_module_mode modeDefault
meshtastic --set serial_module_mode modeProto
meshtastic --set serial.mode modeDefault
meshtastic --set serial.mode modeProto
```
```shell title="Set RXD to GPIO pin number 7"
@ -112,26 +112,26 @@ meshtastic --set serial_module_txd 28
```
```shell title="Set Baud Rate"
meshtastic --set serial_module_baud baudDefault
meshtastic --set serial_module_baud baud576000
meshtastic --set serial.baud baudDefault
meshtastic --set serial.baud baud576000
```
```shell title="Set Timeout to 15 seconds"
meshtastic --set serial_module_timeout 15
meshtastic --set serial.timeout 15
```
</TabItem>
<TabItem value="flasher">
:::info
No serial test module config options are available in the Flasher.
No serial module config options are available in the Flasher.
:::
</TabItem>
<TabItem value="web">
:::info
No serial test module config options are available in the Web UI.
All serial module config options are available in the Web UI.
:::
</TabItem>
@ -149,10 +149,10 @@ Default is to use RX GPIO 16 and TX GPIO 17.
### Basic Usage:
1. Enable the module by setting `serial_module_enabled` to `1`.
2. Set the pins (`serial_module_rxd` / `serial_module_rxd`) for your preferred RX and TX GPIO pins. On tbeam boards it is recommended to use:
2. Set the pins (`serial.rxd` / `serial.txd`) for your preferred RX and TX GPIO pins. On tbeam boards it is recommended to use:
- RXD 35
- TXD 15
3. Set `serial_module_timeout` to the amount of time to wait before we consider your packet as "done".
3. Set `serial.timeout` to the amount of time to wait before we consider your packet as "done".
4. (Optional) In serial_module.h set the port to `PortNum_TEXT_MESSAGE_APP`if you want to send messages to/from the general text message channel.
5. Connect to your device over the serial interface at `38400 8N1`.
6. Send a packet up to 240 bytes in length. This will get relayed over the mesh network.

34
docs/settings/moduleconfig/telemetry.mdx
View file

@ -85,39 +85,39 @@ All telemetry module config options are available on iOS, iPadOS and macOS at Se
</TabItem>
<TabItem value="cli">
No telemetry module config options are available in the python CLI. Example commands are below:
All telemetry module config options are available in the python CLI. Example commands are below:
## Settings
| Setting | Acceptable Values | Default |
| :-----------------------------------------------------: | :-----------------: | :-----: |
| telemetry_module_device_update_interval | `integer` (seconds) | `0` |
| telemetry_module_environment_display_fahrenheit | `true`, `false` | `false` |
| telemetry_module_environment_measurement_enabled | `true`, `false` | `false` |
| telemetry_module_environment_screen_enabled | `true`, `false` | `0` |
| telemetry_module_environment_update_interval | `integer` (seconds) | `0` |
| telemetry.device_update_interval | `integer` (seconds) | `0` |
| 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` |
```shell title="Set module update intervals (Default of 0 is 5 Minutes)"
meshtastic --set telemetry_module_device_update_interval 0
meshtastic --set telemetry.device_update_interval 0
// Device Metrics Two Minutes
meshtastic --set telemetry_module_device_update_interval 120
meshtastic --set telemetry.device_update_interval 120
// Environment Metrics Two Minutes
meshtastic --set telemetry_module_environment_update_interval 120
meshtastic --set telemetry.environment_update_interval 120
````
```shell title="Enable/Disable Environment Module"
meshtastic --set telemetry_module_environment_measurement_enabled true
meshtastic --set telemetry_module_environment_measurement_enabled false
meshtastic --set telemetry.environment_measurement_enabled true
meshtastic --set telemetry.environment_measurement_enabled false
```
```shell title="Enable/Disable on device screen"
meshtastic --set telemetry_module_environment_screen_enabled true
meshtastic --set telemetry_module_environment_screen_enabled false
meshtastic --set telemetry.environment_screen_enabled true
meshtastic --set telemetry.environment_screen_enabled false
```
```shell title="Enable / Disable Display Farenheit"
meshtastic --set telemetry_module_environment_display_fahrenheit true
meshtastic --set telemetry_module_environment_display_fahrenheit false
meshtastic --set telemetry.environment_display_fahrenheit true
meshtastic --set telemetry.environment_display_fahrenheit false
````
</TabItem>
@ -131,7 +131,7 @@ No telemetry module config options are available in the Flasher.
<TabItem value="web">
:::info
No telemetry module config options are available in the Web UI.
All telemetry module config options are available in the Web UI.
:::
</TabItem>
@ -155,7 +155,7 @@ Steps:
- configure the device:
```shell
meshtastic --set telemetry_module_measurement_enabled true --set telemetry_module_screen_enabled true --set telemetry_module_display_farenheit true
meshtastic --set telemetry.measurement_enabled true --set telemetry.screen_enabled true --set telemetry.display_farenheit true
```
:::tip