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.

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

This version

1.1.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-1.1.1.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

meshtastic-1.1.1-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-1.1.1.tar.gz
  • Upload date:
  • Size: 23.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/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.6

File hashes

Hashes for meshtastic-1.1.1.tar.gz
Algorithm Hash digest
SHA256 2292e30d5f236434dd97b4b95024f3b27681781da831cac8e253365bc7945bb3
MD5 12d1063985fa372f8b3a37c3a54e808d
BLAKE2b-256 72eedf4244c5a6cf0915e8ae330f2af770347dad74a2212edc8ad1abe7e4c005

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 28.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/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.6

File hashes

Hashes for meshtastic-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae961bbf722b2d4d609f2baf3113fc7df29fafdba75ee490270b5c437a4431b6
MD5 e5a493e0c0454f78ade09992dcaae777
BLAKE2b-256 baa4170615f289db68f6177d7404e53b000f5850a5fc7fcf6b3c376985aee7aa

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