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

(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, 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

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.7.11)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for geeksville from gravatar.com geeksville Avatar for mianm from gravatar.com mianm Avatar for mkinney from gravatar.com mkinney

Credits

Author: Meshtastic Developers

License

GNU General Public License v3 (GPLv3) (GPL-3.0-only)

Requires

Python <3.13, >=3.8

Provides Extra

tunnel

Classifiers

Report project as malware

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

Uploaded Source

Built Distribution

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

meshtastic-2.3.13-py3-none-any.whl (224.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: meshtastic-2.3.13.tar.gz
  • Upload date:
  • Size: 187.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for meshtastic-2.3.13.tar.gz
Algorithm Hash digest
SHA256 a1269d5848afd49d7d7db76b7f1ca701a5e9d517d7d1891970cc4c7fb4dc83df
MD5 98b43487a813ddd70974cce5b267de03
BLAKE2b-256 4bcf65777c3b26c09183e9906207d11190a258a356e0c8c78e4b1fdefd109ad9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for meshtastic-2.3.13-py3-none-any.whl
Algorithm Hash digest
SHA256 5b9abccbfa6942ec10a1a333fa08d0c23c5cb24709c9cb9c807dcf87fa66e666
MD5 f22201549dd42fcc2439165e378d66fb
BLAKE2b-256 cca575fbc68bb5ae767755147c76c0284c554072c6151d67199ba21a0dad1f44

See more details on using hashes here.

Release history Release notifications | RSS feed

2.7.11

2.7.10

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0

2.5.12

2.5.11

2.5.10

2.5.9

2.5.8

2.5.7

2.5.6.post1

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.3

2.4.2

2.4.1

2.4.0

2.3.15

2.3.14

This release

2.3.13

2.3.12

2.3.11

2.3.10

2.3.9

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4.post1

2.3.4

2.3.3

2.3.2.post1

2.3.2

2.3.1

2.3.0

2.2.22

2.2.21

2.2.20

2.2.19

2.2.18

2.2.17

2.2.16

2.2.15

2.2.14

2.2.13

2.2.12

2.2.11

2.2.10

2.2.9

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.14

2.1.13

2.1.12

2.1.11

2.1.10

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

1.3.44

1.3.42

1.3.41

1.3.40

1.3.39

1.3.38

1.3.37

1.3.36

1.3.35

1.3.34a0 pre-release

1.3.33a0 pre-release

1.3.29

1.3a32 pre-release

1.3a31 pre-release

1.3a30 pre-release

1.3a28 pre-release

1.3a27 pre-release

1.3a26 pre-release

1.3a25 pre-release

1.3a24 pre-release

1.3a23 pre-release

1.3a22 pre-release

1.3a21 pre-release

1.3a20 pre-release

1.3a19 pre-release

1.3a18 pre-release

1.3a17 pre-release

1.3a16 pre-release

1.3a15 pre-release

1.3a14 pre-release

1.3a13 pre-release

1.3a12 pre-release

1.3a11 pre-release

1.3a10 pre-release

1.3a9 pre-release

1.3a8 pre-release

1.3a7 pre-release

1.3a6 pre-release

1.3a5 pre-release

1.3a4 pre-release

1.3a2 pre-release

1.3a1 pre-release

1.2.95

1.2.94

1.2.93

1.2.92

1.2.91

1.2.90

1.2.89

1.2.87

1.2.86

1.2.85

1.2.84

1.2.83

1.2.82

1.2.81

1.2.80

1.2.79

1.2.78

1.2.77

1.2.76

1.2.75

1.2.74

1.2.73

1.2.72

1.2.71

1.2.70

1.2.66

1.2.65

1.2.64

1.2.61

1.2.60

1.2.59

1.2.58

1.2.57

1.2.56

1.2.55

1.2.54

1.2.53

1.2.52

1.2.51

1.2.50

1.2.49

1.2.48

1.2.47

1.2.46

1.2.45 yanked

Reason this release was yanked:

error in pyyaml

1.2.44

1.2.43

1.2.41 yanked

Reason this release was yanked:

Protos didn't get build

1.2.40

1.2.39

1.2.36

1.2.35

1.2.34

1.2.33

1.2.32

1.2.31

1.2.30

1.2.29

1.2.25

1.2.23

1.2.20

1.2.19

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.0

1.1.50

1.1.49

1.1.46

1.1.45

1.1.44

1.1.33

1.1.32

1.1.31

1.1.30

1.1.29

1.1.28

1.1.27

1.1.26

1.1.25

1.1.24

1.1.23

1.1.22

1.1.21

1.1.20

1.1.7

1.1.6

1.1.1

1.1.0

1.0.15

1.0.14

1.0.13

1.0.12

1.0.11

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.9.2

0.9.1

0.7.9

0.7.8

0.7.7

0.7.6

0.7.5

0.7.3

0.7.2

0.6.7

0.5.4

0.5.3

0.5.1

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