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 (note, you must use pip version 20 or later):

pip3 install --upgrade 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.

You can also use this tool to set any of the device parameters which are stored in persistent storage. For instance, here's how to set the device to keep the bluetooth link alive for eight hours (any usage of the bluetooth protcol from your phone will reset this timer)

meshtastic --setpref wait_bluetooth_secs 28800
Connected to radio...
Setting preference wait_bluetooth_secs to 28800
Writing modified preferences to device...

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

Uploaded Source

Built Distribution

meshtastic-0.9.2-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-0.9.2.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2

File hashes

Hashes for meshtastic-0.9.2.tar.gz
Algorithm Hash digest
SHA256 eb74e2e6b8e8dbe8f48ab11331678dcb1c1f72817ff300055587834d6e13c92e
MD5 07ec0a16806f293230af45b03f03a87b
BLAKE2b-256 8e5d89a9a6cfdc1c74d6c6f5c1a43c9053b33692227eaa59d9ecf0fc6f6c19cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.2

File hashes

Hashes for meshtastic-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d0306f70eb162ad4437e5626806147f3fdd7683dd87ef4a1661e130f52fd272e
MD5 e26ce70181e41d57ad3283236d82da48
BLAKE2b-256 38e08598440c9404afc23e250559b08ba48833c4cfa5ba63f2e410bcab078906

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