mirror/python
1
0
Fork 0
mirror of https://github.com/meshtastic/python.git synced 2025-12-30 19:37:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
geeksville
2020-04-28 15:15:05 -07:00
parent e0ad07a891
commit 370d5da604
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -4,4 +4,23 @@ A python client for using Meshtastic devices. This small library (and example ap
Full documentation including examples and installation instructions [here](https://meshtastic.github.io/Meshtastic-python/meshtastic/index.html).
But suffice it to say, it is really easy:
```
pip3 install meshtastic
```
then run the following python3 code:
```
import meshtastic
interface = StreamInterface() # By default will try to find a meshtastic device, otherwise provide a device path like /dev/ttyUSB0
interface.sendData("hello world")
```
For the rough notes/implementation plan see [TODO](./TODO.md).
## Command line tool
This pip package will also install a "meshtastic" commandline executable, which displays packets sent over the network as JSON and lets you see serial debugging information from the meshtastic devices. The source code for this tool is also a good [example](./meshtastic/__main__.py) of a 'complete' application that uses the meshtastic python API.