add some missing commands

This commit is contained in:
pdxlocations 2023-07-26 23:33:02 -07:00
parent 13886d2422
commit c66e4e36bb

View file

@ -18,6 +18,27 @@ Shows a help message that describes the arguments.
meshtastic -h meshtastic -h
``` ```
### --configure
Configure all of the radio configuration from a yaml file.
```shell title="Usage"
meshtastic --configure example_config.yaml
```
### --export-config
Export the configuration of the device. (to be consumed by the '--configure' command).
To create to a file with the connected device's configuration, this command's output must be piped to a yaml file.
```shell title="Usage"
meshtastic --export-config > example_config.yaml
```
```title="Usage"shell
meshtastic --export-config
```
### --port PORT ### --port PORT
The port the Meshtastic device is connected to, i.e. `/dev/ttyUSB0`, `/dev/cu.wchusbserial`, `COM4` etc. if unspecified, meshtastic will try to find it. Important to use when multiple devices are connected to ensure you call the command for the correct device. The port the Meshtastic device is connected to, i.e. `/dev/ttyUSB0`, `/dev/cu.wchusbserial`, `COM4` etc. if unspecified, meshtastic will try to find it. Important to use when multiple devices are connected to ensure you call the command for the correct device.
@ -51,6 +72,38 @@ Read and display the radio config information.
meshtastic --port /dev/ttyUSB0 --info meshtastic --port /dev/ttyUSB0 --info
``` ```
### --set-canned-message
Set the canned message plugin messages separated by pipes `|` (up to 200 characters).
```shell title="Usage"
meshtastic --set-canned-message "I need an alpinist!|Call Me|Roger Roger|Keep Calm|On my way"
```
### --get-canned-message
Show the canned message plugin message.
```shell title="Usage"
meshtastic --get-canned-message
```
### --set-ringtone RINGTONE
Set the Notification Ringtone (up to 230 characters).
```shell title="Usage"
meshtastic --set-ringtone "LeisureSuit:d=16,o=6,b=56:f.5,f#.5,g.5,g#5,32a#5,f5,g#.5,a#.5,32f5,g#5,32a#5,g#5,8c#.,a#5,32c#,a5,a#.5,c#.,32a5,a#5,32c#,d#,8e,c#.,f.,f.,f.,f.,f,32e,d#,8d,a#.5,e,32f,e,32f,c#,d#.,c#"
```
### --get-ringtone
Show the stored ringtone.
```shell title="Usage"
meshtastic --get-ringtone
```
### --nodes ### --nodes
Prints a node list in a pretty, formatted table. Prints a node list in a pretty, formatted table.
@ -67,19 +120,21 @@ Displays the QR code that corresponds to the current channel.
meshtastic --qr meshtastic --qr
``` ```
### --get GET ### --get [config_section].[option]
Gets a preferences field. Gets a preferences field.
Configuration values are described in: [Configuration](https://meshtastic.org/docs/settings).
```shell title="Usage" ```shell title="Usage"
meshtastic --get lora.region meshtastic --get lora.region
``` ```
### --set [config_section].[option] [value] ### --set [config_section].[option]  [value]
Sets a preferences field. Sets a preferences field.
Configuration values are described in this section: [Configuration Sections](https://meshtastic.org/docs/settings/config) Configuration values are described in: [Configuration](https://meshtastic.org/docs/settings).
```shell title="Usage" ```shell title="Usage"
meshtastic --set lora.region Unset meshtastic --set lora.region Unset
@ -95,7 +150,7 @@ meshtastic --seturl https://www.meshtastic.org/c/GAMiIE67C6zsNmlWQ-KE1tKt0fRKFci
### --ch-index CH_INDEX ### --ch-index CH_INDEX
Set the specified channel index Set the specified channel index.
```shell title="Usage" ```shell title="Usage"
meshtastic --ch-index 1 --ch-disable meshtastic --ch-index 1 --ch-disable
@ -141,17 +196,57 @@ Set a channel parameter.
meshtastic --ch-set id 1234 --ch-index 0 meshtastic --ch-set id 1234 --ch-index 0
``` ```
### --ch-vlongslow
Change to the very long-range and slow channel.
```shell title="Usage"
meshtastic --ch-vlongslow
```
### --ch-longslow ### --ch-longslow
Change to the standard long-range (but slow) channel. Change to the long-range and slow channel.
```shell title="Usage" ```shell title="Usage"
meshtastic --ch-longslow meshtastic --ch-longslow
``` ```
### --ch-longfast
Change to the default long-range and fast channel.
```shell title="Usage"
meshtastic --ch-longfast
```
### --ch-medslow
Change to the medium-range and slow channel.
```shell title="Usage"
meshtastic --ch-medslow
```
### --ch-medfast
Change to the medium-range and fast channel.
```shell title="Usage"
meshtastic --ch-medfast
```
### --ch-shortslow
Change to the short-range and slow channel.
```shell title="Usage"
meshtastic --ch-shortslow
```
### --ch-shortfast ### --ch-shortfast
Change to the standard fast (but short range) channel. Change to the short-range and fast channel.
```shell title="Usage" ```shell title="Usage"
meshtastic --ch-shortfast meshtastic --ch-shortfast
@ -162,7 +257,15 @@ meshtastic --ch-shortfast
Set device owner name. Set device owner name.
```shell title="Usage" ```shell title="Usage"
meshtastic --dest '!28979058' --set-owner "MeshyJohn" meshtastic --set-owner "MeshyJohn"
```
### --set-owner-short SET_OWNER_SHORT
Set device owner short name.
```shell title="Usage"
meshtastic --set-owner-short "MJ"
``` ```
### --set-ham SET_HAM ### --set-ham SET_HAM
@ -175,7 +278,7 @@ meshtastic --set-ham KI1345
### --dest DEST ### --dest DEST
The destination node id for any sent commands The destination node id for any sent commands.
```shell title="Usage" ```shell title="Usage"
meshtastic --dest '!28979058' --set-owner "MeshyJohn" meshtastic --dest '!28979058' --set-owner "MeshyJohn"
@ -183,7 +286,7 @@ meshtastic --dest '!28979058' --set-owner "MeshyJohn"
### --sendtext SENDTEXT ### --sendtext SENDTEXT
Send a text message. Can specify a channel index ('--ch-index') or a destination ('--dest') Send a text message. Can specify a channel index ('--ch-index') or a destination ('--dest').
```shell title="Usage" ```shell title="Usage"
meshtastic --sendtext "Hello Mesh!" meshtastic --sendtext "Hello Mesh!"
@ -197,6 +300,22 @@ Send a ping message (which requests a reply).
meshtastic --sendping meshtastic --sendping
``` ```
### --traceroute TRACEROUTE
Traceroute from connected node to a destination. You need pass the destination ID as argument. Only nodes that have the encryption key can be traced.
```shell title="Usage"
meshtastic --traceroute 'ba4bf9d0'
```
### --ack
Use in combination with --sendtext to wait for an acknowledgment.
```shell title="Usage"
meshtastic --sendtext "Hello Mesh!" --ack
```
### --reboot ### --reboot
Tell the destination node to reboot. Tell the destination node to reboot.
@ -205,6 +324,30 @@ Tell the destination node to reboot.
meshtastic --dest '!28979058' --reboot meshtastic --dest '!28979058' --reboot
``` ```
### --shutdown
Tell the destination node to shutdown.
```shell title="Usage"
meshtastic --dest '!28979058' --shutdown
```
### --factory-reset
Tell the destination node to install the default config.
```shell title="Usage"
meshtastic --dest '!28979058' --factory-reset
```
### --reset-nodedb
Tell the destination node clear its list of nodes.
```shell title="Usage"
meshtastic --dest '!28979058' --reset-nodedb
```
### --reply ### --reply
Reply to received messages. Reply to received messages.
@ -309,46 +452,10 @@ Show program's version number and exit.
meshtastic --version meshtastic --version
``` ```
### --configure
Configure all of the radio configuration from a yaml file.
```shell title="Usage"
meshtastic --configure example_config.yaml
```
### --export-config
Export the configuration of the device. (to be consumed by the '--configure' command)
To create to a file with the connected device's configuration, this command's output must be piped to a yaml file
```shell title="Usage"
meshtastic --export-config > example_config.yaml
```
```title="Usage"shell
meshtastic --export-config
```
### --support ### --support
Print out info that would be helpful supporting any issues. Print out info that would be helpful supporting any issues.
```shell title="Usage" ```shell title="Usage"
meshtastic --support meshtastic --support
``` ```
## Deprecated Arguments
### --setchan
Deprecated - use "--ch-set param value" instead.
### --set-router
Deprecated - use "--set is_router true" instead.
### --unset-router
Deprecated - use "--set is_router false" instead.