Endpoints for Raspberry Pi (Endrpi) is a web API server for the Raspberry Pi that provides basic statuses and GPIO controls through a collection of HTTP endpoints.
Project description
Endpoints for Raspberry Pi (Endrpi) is a web API server for the Raspberry Pi that provides basic statuses and GPIO controls through a collection of HTTP endpoints.
Powered by Fast API, GPIO Zero, and others.
Features
REST API
- Reads system statuses such as temperature, memory usage, throttling, etc.
- Reads/updates GPIO pin state, function, and pull
- Generates interactive documentation via Swagger UI
Websocket
- Maintains a persistent, low-latency connection
- Mirrors the REST API through a request/response action pattern
Requirements
≥ Python 3.7
≥ Raspberry Pi 3
- Compatible with the standard Raspberry Pi OS image
- Previous Raspberry Pi versions may work but have not been verified
Quickstart
1. Clone project
git clone https://github.com/persanix-llc/endrpi-server.git && cd endrpi-server
2. Install dependencies
pip3 install -r requirements.txt
3. Start server
python3 endr.py
Project documentation
Project documentation is hosted at https://endrpi.io.
The project documentation source can be found at https://github.com/persanix-llc/endrpi-docs.
License
Licensed under the Apache License, Version 2.0.
Copyright © 2020 - 2021 Persanix LLC. All rights reserved.
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.