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.SerialInterface() # 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.
interface.close()

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 set a node at a fixed position and never power up the GPS.

meshtastic --setlat 25.2 --setlon -16.8 --setalt 120

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

For a full list of preferences which can be set (and their documentation) see here.

FAQ/common problems

This is a collection of common questions and answers from our friendly forum.

Permission denied: ‘/dev/ttyUSB0’

This indicates an OS permission problem for access by your user to the USB serial port. Typically this is fixed by the following.

sudo usermod -a -G dialout <username>

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

Uploaded Source

Built Distribution

meshtastic-1.1.27-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-1.1.27.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for meshtastic-1.1.27.tar.gz
Algorithm Hash digest
SHA256 7aebfa5b7e35c0c3712c6f229108b87b358ab41e17efe62ca5a1fdd1ffdd54e8
MD5 a49d36734575bacdb38b2b2fa520d0ee
BLAKE2b-256 655c8295e638a83641b77012203a9b00ab60c64cc7e81b775673ebea3713c0f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-1.1.27-py3-none-any.whl
  • Upload date:
  • Size: 37.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for meshtastic-1.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 30da6ee780deb89172634991bd6efc5b35389cd6c61fd2d9b0c3243a7bead478
MD5 e42a25cdcb44dd61d5732279cdf6a23a
BLAKE2b-256 344366734be1d9792511beedc8b47eaef0a6bab54807411153f02f87e2fbca15

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