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

This version

0.7.9

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

Uploaded Source

Built Distribution

meshtastic-0.7.9-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-0.7.9.tar.gz
  • Upload date:
  • Size: 18.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.9.tar.gz
Algorithm Hash digest
SHA256 8d7e08c9583be5826d3bce140862d80dbf96d7c2aed181a72aa13cae5d08c52f
MD5 1e6bfd9c0b7c0fadc3724237c1e14d0a
BLAKE2b-256 19ccc50167588d2decf815b5d18eede0343f2d697d92a172763622452cfa8591

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-0.7.9-py3-none-any.whl
  • Upload date:
  • Size: 18.9 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 0b449b97527d8999c8bb5d0cb8a4033e3cc25eed1497d7a9dc2aea7570983cb4
MD5 f8e7012f1a2825b617ede9439f6efb16
BLAKE2b-256 0ccde0e8540fc264a40c8629e1bb51d2fec9af6663feaa78dde3fee87f805ccb

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