Meshtastic project website and documentation
Find a file
2021-02-22 09:37:11 +11:00
assets Icons for readme 2021-02-16 21:31:33 +11:00
README.md Add meshtastic-python description & fix formatting 2021-02-22 09:37:11 +11:00

Meshtastic

Website   •   Forum   •   Slack   •   App

What is Meshtastic?

Meshtastic® is a project that lets you use inexpensive GPS mesh radios as an extensible, super long battery life mesh GPS communicator. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of your private mesh can always see the location and distance of all other members and any text messages sent to your group chat.

The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.

Getting started

Description, should mention:

You will require atleast one of these devices

  • Link to device compatability table on meshtastic/meshtastic-device
  • Link to flashing instructions

Community

Description, should mention:

Software

Description

Meshtastic App

The official Meshtastic Android app, It provides messaging, channel configuration and a real time map. It also has inbuilt functionality for updating device firmware over Bluetooth

Meshtastic Device

The paramount Meshtastic project, the device firmware itself. Runs on supported hardware that allows the creation of mesh networks at any scale

Meshtastic.js

TypeScript library for interfacting with Meshtastic, built with RxJs and ProtoBuf.js

Meshtastic-python

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