Skip to main content

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

Endrpi logo

power on test unit tests coverage CodeQL

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

pip3 install -U endrpi && endrpi

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

endrpi-1.0.0b22.tar.gz (374.8 kB view details)

Uploaded Source

Built Distribution

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

endrpi-1.0.0b22-py3-none-any.whl (397.0 kB view details)

Uploaded Python 3

File details

Details for the file endrpi-1.0.0b22.tar.gz.

File metadata

  • Download URL: endrpi-1.0.0b22.tar.gz
  • Upload date:
  • Size: 374.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.11

File hashes

Hashes for endrpi-1.0.0b22.tar.gz
Algorithm Hash digest
SHA256 b2f86ff1e3e6e42852f6f17286e9351930122890742cdc68011a6f43635aef0c
MD5 c048ba031a4dbe7579efdd5f59f70358
BLAKE2b-256 4a269f93caa34ca14f3c18853d35c14a43dc8c971e8d39f0d5219f58c5cba372

See more details on using hashes here.

File details

Details for the file endrpi-1.0.0b22-py3-none-any.whl.

File metadata

  • Download URL: endrpi-1.0.0b22-py3-none-any.whl
  • Upload date:
  • Size: 397.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.7.11

File hashes

Hashes for endrpi-1.0.0b22-py3-none-any.whl
Algorithm Hash digest
SHA256 ecb8ded19422d1de4308c6881e6455a862f36d781f457dba7c788f7e9236b6ea
MD5 bb7973bd31885ac60706afd30ca145bd
BLAKE2b-256 de4e339715993fb9c4cd857ca2ab3448be85cbc13c430c1394f6637d5a46d947

See more details on using hashes here.

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