Skip to main content

Python API & client shell for talking to Meshtastic devices

Project description

Meshtastic Python

codecov PyPI - Downloads CI CLA assistant Fiscal Contributors Vercel

Overview

A Python client for use with 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.

Getting Started Guide

Documentation/API Reference

Call for Contributors

This library and CLI has gone without a consistent maintainer for a while, and there's many improvements that could be made. We're all volunteers here and help is extremely appreciated, whether in implementing your own needs or helping maintain the library and CLI in general.

If you're interested in contributing but don't have specific things you'd like to work on, look at the roadmap below!

Roadmap

This should always be considered a list in progress and flux -- inclusion doesn't guarantee implementation, and exclusion doesn't mean something's not wanted. GitHub issues are a great place to discuss ideas.

  • Types
    • type annotations throughout the codebase
    • mypy running in CI to type-check new code
  • async-friendliness
  • CLI completeness & consistency
    • the CLI should support all features of the firmware
    • there should be a consistent output format available for shell scripting
  • CLI input validation & documentation
    • what arguments and options are compatible & incompatible with one another?
    • can the options be restructured in a way that is more self-documenting?
    • pubsub events should be documented clearly
  • helpers for third-party code
    • it should be easy to write a script that supports similar options to the CLI so many tools support the same ways of connecting to nodes
  • interactive client
  • data storage & processing
    • there should be a standardized way of recording packets for later use, debugging, etc.
    • a sqlite database schema and tools for writing to it may be a good starting point
    • enable maps, charts, visualizations

Stats

Alt

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-2.3.2.post1.tar.gz (78.0 kB view details)

Uploaded Source

Built Distribution

meshtastic-2.3.2.post1-py3-none-any.whl (94.0 kB view details)

Uploaded Python 3

File details

Details for the file meshtastic-2.3.2.post1.tar.gz.

File metadata

  • Download URL: meshtastic-2.3.2.post1.tar.gz
  • Upload date:
  • Size: 78.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for meshtastic-2.3.2.post1.tar.gz
Algorithm Hash digest
SHA256 e2f8a2195cf971f08c49ead9d70671a96fee1bdce49cac481db6488143dc23cc
MD5 cc12e0e26a36365f3e424d12369169ac
BLAKE2b-256 98d29bd5a20f9fe5fdf51fed9b7cbf6b9867325536692c1a9c2936a1225312a3

See more details on using hashes here.

File details

Details for the file meshtastic-2.3.2.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for meshtastic-2.3.2.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 6c7c8099aa9610a1052284b4dfa9bda8fe0a0705b1ffe0942606d7dd086b2b61
MD5 67fb89216827ea353b8f29dcd5989d17
BLAKE2b-256 072c3e9c0497efc2d017282568acdc8a2ed6deb007139ae96bc1ec518dc4ae97

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