Skip to main content

Python API & client shell for talking to Meshtastic devices

Project description

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.

Full documentation including examples and installation instructions here.

But suffice it to say, it is really easy:

pip3 install meshtastic

then run the following python3 code:

import meshtastic
interface = meshtastic.StreamInterface() # By default will try to find a meshtastic device, otherwise provide a device path like /dev/ttyUSB0
interface.sendText("hello mesh") # or sendData to send binary data, see documentations for other options.

For the rough notes/implementation plan see TODO.

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 of a 'complete' application that uses the meshtastic python API.

Required device software version

This API and tool both require that the device is running Meshtastic 0.6.0 or later.

Project details


Release history Release notifications | RSS feed

This version

0.6.7

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meshtastic-0.6.7.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

meshtastic-0.6.7-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file meshtastic-0.6.7.tar.gz.

File metadata

  • Download URL: meshtastic-0.6.7.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for meshtastic-0.6.7.tar.gz
Algorithm Hash digest
SHA256 a996845da3b381386ace484cd03a75cdd539b3b2c96705197b0c69d041a40ae0
MD5 4a57ea8ad058bb1dde740d5e019cdd2c
BLAKE2b-256 ab3439bab05f11fc525f21952f12b9619b2ff7c28bdf2ae20b42801d71c8659a

See more details on using hashes here.

File details

Details for the file meshtastic-0.6.7-py3-none-any.whl.

File metadata

  • Download URL: meshtastic-0.6.7-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for meshtastic-0.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 987742561770533b71d21e764cb54ef66e8c5b1225ec7f036e8082b35be94872
MD5 b25866babec2333cb427460c98b95413
BLAKE2b-256 32e91b61057419c3c48bf83d66383139e99dc1748dfb204e8029b58e08040a9c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page