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

fixes based on feedback

Browse source
This commit is contained in:
pdxlocations 2023-07-28 21:51:18 -07:00
parent b54231cd57
commit 07078bc013
1 changed files with 30 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
docs/software/python-cli/index.mdx
View file

@ -17,15 +17,6 @@ Shows a help message that describes the arguments.
```shell title="Usage"
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).
@ -39,6 +30,15 @@ meshtastic --export-config > example_config.yaml
```title="Usage"shell
meshtastic --export-config
```
### --configure
Configure radio using a yaml file.
```shell title="Usage"
meshtastic --configure example_config.yaml
```
### --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.
@ -120,13 +120,14 @@ Displays the QR code that corresponds to the current channel.
meshtastic --qr
```
### --get [config_section].[option]
### --get [config_section]
Gets a preferences field.
Configuration values are described in: [Configuration](https://meshtastic.org/docs/settings).
```shell title="Usage"
meshtastic --get lora
meshtastic --get lora.region
```
@ -198,7 +199,7 @@ meshtastic --ch-set id 1234 --ch-index 0
### --ch-vlongslow
Change to the very long-range and slow channel.
Change modem preset to `VERY_LONG_SLOW`.
```shell title="Usage"
meshtastic --ch-vlongslow
@ -206,7 +207,7 @@ meshtastic --ch-vlongslow
### --ch-longslow
Change to the long-range and slow channel.
Change modem preset to `LONG_SLOW`.
```shell title="Usage"
meshtastic --ch-longslow
@ -214,7 +215,7 @@ meshtastic --ch-longslow
### --ch-longfast
Change to the default long-range and fast channel.
Change modem preset to (the default) `LONG_FAST`.
```shell title="Usage"
meshtastic --ch-longfast
@ -222,7 +223,7 @@ meshtastic --ch-longfast
### --ch-medslow
Change to the medium-range and slow channel.
Change modem preset to `MEDIUM_SLOW`.
```shell title="Usage"
meshtastic --ch-medslow
@ -230,7 +231,7 @@ meshtastic --ch-medslow
### --ch-medfast
Change to the medium-range and fast channel.
Change modem preset to `MEDIUM_FAST`.
```shell title="Usage"
meshtastic --ch-medfast
@ -238,7 +239,7 @@ meshtastic --ch-medfast
### --ch-shortslow
Change to the short-range and slow channel.
Change modem preset to `SHORT_SLOW`.
```shell title="Usage"
meshtastic --ch-shortslow
@ -246,7 +247,7 @@ meshtastic --ch-shortslow
### --ch-shortfast
Change to the short-range and fast channel.
Change modem preset to `SHORT_FAST`.
```shell title="Usage"
meshtastic --ch-shortfast
@ -262,7 +263,7 @@ meshtastic --set-owner "MeshyJohn"
### --set-owner-short SET_OWNER_SHORT
Set device owner short name.
Set device owner short name (4 characters max).
```shell title="Usage"
meshtastic --set-owner-short "MJ"
@ -278,7 +279,7 @@ meshtastic --set-ham KI1345
### --dest DEST
The destination node id for any sent commands.
The destination node id for any sent commands. Used for [Remote Node Administration](/docs/configuration/remote-admin)
```shell title="Usage"
meshtastic --dest '!28979058' --set-owner "MeshyJohn"
@ -302,7 +303,7 @@ 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.
Traceroute from connected node to a destination. You need pass the destination ID as an argument. Only nodes that have the encryption key can be traced.
```shell title="Usage"
meshtastic --traceroute 'ba4bf9d0'
@ -310,7 +311,7 @@ meshtastic --traceroute 'ba4bf9d0'
### --ack
Use in combination with --sendtext to wait for an acknowledgment.
Used in combination with --sendtext to wait for an acknowledgment.
```shell title="Usage"
meshtastic --sendtext "Hello Mesh!" --ack
@ -318,34 +319,34 @@ meshtastic --sendtext "Hello Mesh!" --ack
### --reboot
Tell the destination node to reboot.
Tell the node to reboot.
```shell title="Usage"
meshtastic --dest '!28979058' --reboot
meshtastic --reboot
```
### --shutdown
Tell the destination node to shutdown.
Tell the node to shutdown.
```shell title="Usage"
meshtastic --dest '!28979058' --shutdown
meshtastic --shutdown
```
### --factory-reset
Tell the destination node to install the default config.
Tell the node to install the default config.
```shell title="Usage"
meshtastic --dest '!28979058' --factory-reset
meshtastic --factory-reset
```
### --reset-nodedb
Tell the destination node clear its list of nodes.
Tell the node to clear its list of nodes.
```shell title="Usage"
meshtastic --dest '!28979058' --reset-nodedb
meshtastic --reset-nodedb
```
### --reply