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 --set wait_bluetooth_secs 28800
Connected to radio...
Setting preference wait_bluetooth_secs to 28800
Writing modified preferences to device...

Or to configure an ESP32 based board to join a wifi network as a station (wifi support in the device code is coming soon):

meshtastic --set wifi_ap_mode false --setstr wifi_ssid mywifissid --setstr wifi_password mywifipsw

Or to configure an ESP32 to run as a Wifi access point:

meshtastic --set wifi_ap_mode true --setstr wifi_ssid mywifissid --setstr wifi_password mywifipsw

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

Uploaded Source

Built Distribution

meshtastic-1.0.13-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-1.0.13.tar.gz
  • Upload date:
  • Size: 22.3 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.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for meshtastic-1.0.13.tar.gz
Algorithm Hash digest
SHA256 8864d74bedf3864214af16475d15a483419d0225755dabdd7d599fc9e8fa7723
MD5 8918470ce1698fe58932fc65ecc35e7e
BLAKE2b-256 5945c676ed660690ac27a66a714f81ebb4081e5d54982acdabc6a8970391474c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-1.0.13-py3-none-any.whl
  • Upload date:
  • Size: 26.4 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.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.2

File hashes

Hashes for meshtastic-1.0.13-py3-none-any.whl
Algorithm Hash digest
SHA256 d2eef0c20bfc3550d9d30eed066632c19c08172c11d5b0484695472028d4b29c
MD5 f319f4d663b4f1b9c4b8507ff0198db8
BLAKE2b-256 94055eebbff84f9c6204bbae9bcaebb5ff30374fea4b86a660d94a68fd96d747

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