add first cut at docs

This commit is contained in:
geeksville
2020-04-28 14:51:39 -07:00
parent 981c65033a
commit bbbd33e292
11 changed files with 2938 additions and 236 deletions

View File

@@ -1,8 +1,8 @@
# Meshtastic-python
A python client for using Meshtastic devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
A python client for using Meshtastic devices. This small library (and example application) provides an easy API for sending and receiving messages over mesh radios. It also provides access to any of the operations/data available in the device user interface or the Android application. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in.
You probably don't want this yet because it is a pre-alpha WIP.
For the API documentation [click here](./doc/meshtastic/index.html).
For the rough notes/implementation plan see [TODO](./TODO.md).