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

Uploaded Source

Built Distribution

meshtastic-0.7.6-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-0.7.6.tar.gz
  • Upload date:
  • Size: 17.9 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.7.6.tar.gz
Algorithm Hash digest
SHA256 430fa71c6ca1dec6e727f73366a153af7cd593c5bc57d432e65b4736702f6a4d
MD5 5bf908e30f953f313dd42439f72284fd
BLAKE2b-256 b6b3ecdd5f60af5f30d3c2ae8c803491663dc8c5678d0cbad46857ad0ec6065c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 18.2 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.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 bf3811520aaaa7edb0d4de6d9c69a50eee0e754fe45713dc39e2be277507e9d5
MD5 8e9fae2d8cd92336b39f7bdbd801dbb5
BLAKE2b-256 0d3cfecebe5b320cbc66437574181cda814d2dd44a54fd72c990ca99b0850d3a

See more details on using hashes here.

Supported by

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