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.9.1

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

Uploaded Source

Built Distribution

meshtastic-0.9.1-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-0.9.1.tar.gz
  • Upload date:
  • Size: 18.9 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.1.tar.gz
Algorithm Hash digest
SHA256 e03d3b84a73a47cd99f773c333b68255fd4297d65599757033a7b7c9b34f4f3e
MD5 7db145a9a5b8b8d7f873e90b341f229f
BLAKE2b-256 9f8c0e6b4b0139abcbc9d2272a0d0ff0c9bc50d0e6aa99ab1cb72c6e313011a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 19.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0be7c9c4c005ba2e5b19a9a504ef8f050044096a9eee900a6471a223b87a8596
MD5 92185b09f2e24335b18e4ec5c04b3f2a
BLAKE2b-256 d5157e2af842a145d0fd8cc8a149011cac4d8f81ea78a3bf510177129cedd3db

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