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:

pip3 install 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.sendData("hello world")

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.

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meshtastic-0.5.1-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-0.5.1.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5

File hashes

Hashes for meshtastic-0.5.1.tar.gz
Algorithm Hash digest
SHA256 8ed52fe4d06cb0e40b2f619d52c08e2349b16f23ce5d946afd7149695563f477
MD5 e76919be75d8df87e15b0a3dba385f52
BLAKE2b-256 9bbe92c72d42820b5cb8617e43907a55f10b2595e18d1551cb963a2f30a7d8fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.7.5

File hashes

Hashes for meshtastic-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 adb1960f6bcf88fec5b2114fbbe8c5869af700b6d6a4ff66044e96381efff55b
MD5 457b78e5ce1670108d8a2a1b595d8bda
BLAKE2b-256 642fa28f19b81ddd64396bdad2b1525bc146d4810c9984a431303dec23f95080

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page