https://gitHub.com/bmswens/Meshtastic-Web-API

A web API to be hosted on devices connected to a Meshtastic node via serial connection.
https://gitHub.com/bmswens/Meshtastic-Web-API

flask flask-restful lora meshtastic swagger-ui

Last synced: 5 months ago
JSON representation

A web API to be hosted on devices connected to a Meshtastic node via serial connection.

• Host: GitHub
• URL: https://gitHub.com/bmswens/Meshtastic-Web-API
• Owner: bmswens
• License: gpl-3.0
• Created: 2022-12-21T02:58:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-10-07T09:19:35.000Z (8 months ago)
• Last Synced: 2025-10-07T11:32:35.781Z (8 months ago)
• Topics: flask, flask-restful, lora, meshtastic, swagger-ui
• Language: Python
• Homepage:
• Size: 87.9 KB
• Stars: 23
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-meshtastic - Meshtastic Web API - A RESTful interface to interact with a Meshtastic node via a serial connection. (Software Projects / Community Apps)

README

          
# Meshtastic Web API

[![Docs](https://img.shields.io/badge/Docs-Deployed-brightgreen)](https://bmswens.github.io/Meshtastic-Web-API/)

[![Test](https://github.com/bmswens/Meshtastic-REST-API/actions/workflows/Test.yml/badge.svg)](https://github.com/bmswens/Meshtastic-REST-API/actions/workflows/Test.yml)

[![Coverage Status](https://coveralls.io/repos/github/bmswens/Meshtastic-Web-API/badge.svg?branch=main)](https://coveralls.io/github/bmswens/Meshtastic-Web-API?branch=main)

[![Docker Build](https://img.shields.io/badge/Docker%20Build-Automated-brightgreen)](https://github.com/bmswens/Meshtastic-Web-API/actions/workflows/docker.yml)

[![Docker Pulls](https://img.shields.io/docker/pulls/bmswens/meshtastic-web-api)](https://hub.docker.com/repository/docker/bmswens/meshtastic-web-api)

[![License](https://img.shields.io/github/license/bmswens/Meshtastic-REST-API)](https://github.com/bmswens/Meshtastic-REST-API/blob/master/LICENSE)

---

## Overview

A web-based API to be hosted on devices connected to a [Meshtastic](https://github.com/meshtastic) node via serial connection.

## Documentation

### Wiki

Documentation on installation, configuration, usage, and more can be found [on the wiki](https://github.com/bmswens/Meshtastic-Web-API/wiki).

### Github Pages

Searchable documentation is deployed on Github pages and can be found [here](https://bmswens.github.io/Meshtastic-Web-API/).

### Local Deployments

Endpoints are documented using [Swagger](https://swagger.io/) via [RestX](https://flask-restx.readthedocs.io/en/latest/index.html) at the root URL and can be executed from there.

## Plans

- [ ] Implement all Python CLI functionality via HTTP

- [ ] Add websocket support for real time chat functionality

## Authors

* **Brandon Swenson**- *Initial work* - [bmswens](https://github.com/bmswens)

## License

This project, like Meshtastic, is licensed under the GNU General Public License - see the [LICENSE.txt](LICENSE.txt) file for details