jvimedia / Meshtastic-Web-API

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Meshtastic Web API

Docs Test Coverage Status Docker Build Docker Pulls License


Overview

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

Documentation

Wiki

Documentation on installation, configuration, usage, and more can be found on the wiki.

Github Pages

Searchable documentation is deployed on Github pages and can be found here.

Local Deployments

Endpoints are documented using Swagger via RestX 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

License

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

About

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

License:GNU General Public License v3.0


Languages

Language:Python 98.6%Language:Dockerfile 0.9%Language:Shell 0.4%Language:PowerShell 0.2%