mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-21 03:25:51 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

raldi edits

Browse source
This commit is contained in:
Foster Irwin 2022-03-14 20:34:50 -06:00
parent 5ec19ee6c6
commit 24be5f994f
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/getting-started/clients.md
View file

@ -14,6 +14,8 @@ There are many ways to connect to your newly flashed device. Below is a quicksta
The CLI is currently the best way to manage your settings. It is feature rich and well documented. The [settings pages](/docs/settings) have examples for each user preference for the device. The CLI is available as a standalone executable for Windows, Mac OS or linux or as part of the [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) project. If you'd like to use python to interface with a device, see the [API documentation](https://python.meshtastic.org). The CLI is currently the best way to manage your settings. It is feature rich and well documented. The [settings pages](/docs/settings) have examples for each user preference for the device. The CLI is available as a standalone executable for Windows, Mac OS or linux or as part of the [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) project. If you'd like to use python to interface with a device, see the [API documentation](https://python.meshtastic.org).
#### Installation
To install the prebuilt binary refer to: [Meshtastic-python standalone executable](/docs/software/python/python-standalone). To install the prebuilt binary refer to: [Meshtastic-python standalone executable](/docs/software/python/python-standalone).
To install/upgrade Meshtastic-python manually, see below: To install/upgrade Meshtastic-python manually, see below:
@ -30,14 +32,19 @@ pip install --upgrade meshtastic
Some installations of python may require you to substitute 'pip3' for the 'pip' command. Some installations of python may require you to substitute 'pip3' for the 'pip' command.
::: :::
After installing, run #### Verify Connection
``` bash title="Query nodes" After installing, run one of the following commands to see if the device is communicating correctly.
meshtastic --nodes
```bash title="View connected node info"
meshtastic --info meshtastic --info
``` ```
to see if the device is working. ```bash title="View nodes detected on mesh"
meshtastic --nodes
```
For more details about CLI usage, see the [settings](/docs/settings) pages or [CLI guide](/docs/software/python/python-cli).
### Mobile Client Downloads ### Mobile Client Downloads