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 GPL-3.0

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

API Documentation

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, and upgrading mypy running in CI to --strict
  • 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
  • data storage & processing
    • there should be a standardized way of recording packets for later use, debugging, etc.
    • a persistence layer could also keep track of nodes beyond nodedb, as the apps do
    • 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.5.11.tar.gz (254.1 kB view details)

Uploaded Source

Built Distribution

meshtastic-2.5.11-py3-none-any.whl (299.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-2.5.11.tar.gz
  • Upload date:
  • Size: 254.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for meshtastic-2.5.11.tar.gz
Algorithm Hash digest
SHA256 89ccf0f1f1fb2c1520a58b8ad416d90825ee5fd725760fd0a1dc54057163ebe6
MD5 60d49ddba36758ed3d20aa0d771c099f
BLAKE2b-256 caeb6bdf7d76e271dec7a5af60a6ce86c68249dc85d93da16b4e70eceefdf409

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-2.5.11-py3-none-any.whl
  • Upload date:
  • Size: 299.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for meshtastic-2.5.11-py3-none-any.whl
Algorithm Hash digest
SHA256 4e2034a608d649b43f0f33474830d24ddfb899a18e023743a4958b3f48ba28c8
MD5 413b692dc592544802e48d82f95c5792
BLAKE2b-256 a98f9f36c756e0523fdf56f1d7d65ba888d7c5d0b9dab6dafbc31ebbf77ed6e3

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