{"id":19152902,"url":"https://github.com/persanix-llc/endrpi-server","last_synced_at":"2025-05-07T05:47:01.080Z","repository":{"id":47147654,"uuid":"405400212","full_name":"persanix-llc/endrpi-server","owner":"persanix-llc","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.","archived":false,"fork":false,"pushed_at":"2023-05-23T02:14:30.000Z","size":468,"stargazers_count":3,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-19T19:05:27.989Z","etag":null,"topics":["api","fastapi","gpio","http-server","python3","raspberry-pi","rest-api","websocket"],"latest_commit_sha":null,"homepage":"https://endrpi.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/persanix-llc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-11T14:27:15.000Z","updated_at":"2022-05-10T06:07:42.000Z","dependencies_parsed_at":"2025-04-20T14:15:52.169Z","dependency_job_id":null,"html_url":"https://github.com/persanix-llc/endrpi-server","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persanix-llc%2Fendrpi-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persanix-llc%2Fendrpi-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persanix-llc%2Fendrpi-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/persanix-llc%2Fendrpi-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/persanix-llc","download_url":"https://codeload.github.com/persanix-llc/endrpi-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823685,"owners_count":21809707,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","fastapi","gpio","http-server","python3","raspberry-pi","rest-api","websocket"],"created_at":"2024-11-09T08:19:53.261Z","updated_at":"2025-05-07T05:47:01.012Z","avatar_url":"https://github.com/persanix-llc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Endrpi logo](https://assets.persanix.com/endrpi/logo-padded/logo-padded.svg)\n\n[![power on test](https://github.com/persanix-llc/endrpi-server/actions/workflows/power-on-test.yml/badge.svg)](https://github.com/persanix-llc/endrpi-server/actions/workflows/power-on-test.yml)\n[![unit tests](https://github.com/persanix-llc/endrpi-server/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/persanix-llc/endrpi-server/actions/workflows/unit-tests.yml)\n[![coverage](https://github.com/persanix-llc/endrpi-server/actions/workflows/coverage.yml/badge.svg)](https://github.com/persanix-llc/endrpi-server/actions/workflows/coverage.yml)\n[![CodeQL](https://github.com/persanix-llc/endrpi-server/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/persanix-llc/endrpi-server/actions/workflows/codeql-analysis.yml)\n\nEndpoints for Raspberry Pi (Endrpi) is a web API server for the [Raspberry Pi](https://raspberrypi.org)\nthat provides basic statuses and GPIO controls through a collection of HTTP endpoints.\n\nPowered by [Fast API](https://github.com/tiangolo/fastapi), \n[GPIO Zero](https://github.com/gpiozero/gpiozero), \nand [others](requirements.txt).\n\n## Features\n\n#### REST API\n* Reads system statuses such as temperature, memory usage, throttling, etc.\n* Reads/updates GPIO pin state, function, and pull \n* Generates interactive documentation via [Swagger UI](https://swagger.io/tools/swagger-ui)\n\n#### Websocket\n* Maintains a persistent, low-latency connection\n* Mirrors the REST API through a request/response action pattern\n\n## Requirements\n\n≥ Python 3.7\n\n≥ Raspberry Pi 3\n* Compatible with the standard [Raspberry Pi OS](https://www.raspberrypi.com/documentation/computers/os.html) image\n* Previous Raspberry Pi versions may work but have not been verified\n\n## Quickstart\n\n```\npip3 install -U endrpi \u0026\u0026 endrpi\n```\n\n## Example Request\n\nThe following request returns the temperature of the Raspberry Pi® System on Chip.\nRequest\n\n```GET http://localhost:5000/system/temperature```\n\nResponse\n\n```javascript\n{\n  \"systemOnChip\": {\n      \"quantity\": 45.622,\n      \"prefix\": null,\n      \"unitOfMeasurement\": \"CELSIUS\"\n  }\n}\n```\n\nEndrpi generates live, interactive API documentation. A complete list of REST endpoints can be found hosted at [localhost:5000/docs](http://localhost:5000/docs).\n\n## Project documentation\nProject documentation is hosted at [https://endrpi.io](https://endrpi.io).\n\nThe project documentation source can be found at \n[https://github.com/persanix-llc/endrpi-docs](https://github.com/persanix-llc/endrpi-docs).\n\n## License\n\nLicensed under the Apache License, Version 2.0.\n\nCopyright \u0026copy; 2020 - 2021 Persanix LLC. All rights reserved.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpersanix-llc%2Fendrpi-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpersanix-llc%2Fendrpi-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpersanix-llc%2Fendrpi-server/lists"}