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

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.5.4.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

meshtastic-0.5.4-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-0.5.4.tar.gz
  • Upload date:
  • Size: 16.8 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.5.4.tar.gz
Algorithm Hash digest
SHA256 7a88e6e109bcd8e8dbb6ae4bc54004198dbbc2feab93ecb539a6276d294c7c20
MD5 64bd023c218ab4485171e43d18244e0b
BLAKE2b-256 6c2e527255a7ec9f63caa11a4006d6a41b26a4861ccb6e0f7265abe97c34b26f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 17.1 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.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 998f640f7097a27a8b20a624d0375268f51e476746cc5be00cfce5c0d504ddaa
MD5 65ab7cbf204919680aa5f0361db00dc5
BLAKE2b-256 055dcf783935d08059b417fdd4b4518e16c775f1092ab1be37332f13fbb082ee

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