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

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 is currently offline)

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

Uploaded Source

Built Distribution

meshtastic-2.3.7-py3-none-any.whl (174.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-2.3.7.tar.gz
  • Upload date:
  • Size: 149.3 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.7.tar.gz
Algorithm Hash digest
SHA256 9d151ed3cc99d7ad2882e4a10371345c38ef89156af5eb1bd554777f5cd88199
MD5 4f9613d3f6f5f4c4a1accca83ade3f4d
BLAKE2b-256 3c624f2b1f74a43df0d5579b4926be5f04346499dc06e56ea46a7584b942272a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: meshtastic-2.3.7-py3-none-any.whl
  • Upload date:
  • Size: 174.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for meshtastic-2.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b5d67e11c95cc2efaa9292f532b52c9e1bdb8759d2bb1756f00e20f69913bc18
MD5 7124645c4d12a74109bc5e7206f8c340
BLAKE2b-256 23cfee320819f267136f6b07dd68c32a494a3fa42b041d901dad5089a42245c9

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