Skip to main content

Python API & client shell for talking to Meshtastic devices

Project description

Meshtastic Logo

Meshtastic Python

A Python library and client for use with Meshtastic devices.

codecov PyPI - Downloads CI CLA assistant Fiscal Contributors GPL-3.0

Overview

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.

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

Uploaded Source

Built Distribution

meshtastic-2.6.4-py3-none-any.whl (319.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for meshtastic-2.6.4.tar.gz
Algorithm Hash digest
SHA256 308ca54b666b680499e3025bbff50c1f40fe60a31c3ab9982a44ddeae2e9a012
MD5 698ff2c0603ea58e5d06f385c7f3754e
BLAKE2b-256 a7886e94dc64d7e059ba89bb507d975a22326d9dec1e525a0f01e4f5a6d958e3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for meshtastic-2.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c7e42686daa25f6d4dc3edb6bb23db1be58ccef605cd97732a1f225df4674d40
MD5 a23d857cd96c406e05f0c27232d248bd
BLAKE2b-256 876da67f2905a6f0f32ff26600553d5bc46dd910f85ba5329f6e2a711e08c414

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