{"id":35054816,"url":"https://github.com/fcrespel/rf433-api","last_synced_at":"2026-04-27T19:33:54.793Z","repository":{"id":238372112,"uuid":"796416957","full_name":"fcrespel/rf433-api","owner":"fcrespel","description":"REST API to use an RF 433 MHz transmitter as a remote control","archived":false,"fork":false,"pushed_at":"2026-02-01T18:38:03.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-02-02T03:05:47.740Z","etag":null,"topics":["api","chacon","dio","fastapi","rest","rf433"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fcrespel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-05-05T21:36:21.000Z","updated_at":"2026-02-01T18:38:06.000Z","dependencies_parsed_at":"2024-05-05T22:32:09.592Z","dependency_job_id":null,"html_url":"https://github.com/fcrespel/rf433-api","commit_stats":null,"previous_names":["fcrespel/rc-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fcrespel/rf433-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcrespel%2Frf433-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcrespel%2Frf433-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcrespel%2Frf433-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcrespel%2Frf433-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fcrespel","download_url":"https://codeload.github.com/fcrespel/rf433-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fcrespel%2Frf433-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32352398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T17:12:42.749Z","status":"ssl_error","status_checked_at":"2026-04-27T17:12:41.658Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","chacon","dio","fastapi","rest","rf433"],"created_at":"2025-12-27T09:52:37.880Z","updated_at":"2026-04-27T19:33:54.788Z","avatar_url":"https://github.com/fcrespel.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RF433 REST API\n\nREST API to use an RF 433 MHz transmitter as a remote control. It currently only supports the Chacon DIO 1.0 and Chacon 54662 protocols.\n\nIt has only been tested on an ODROID-C4 board and uses an ODROID-specific WiringPi version. It should be easy to adapt it for other boards (e.g. Raspberry Pi).\n\n## Installation\n\nExecute the following commands on a Debian or Ubuntu system to install the required dependencies:\n```\napt-get update\napt-get install -y build-essential python3-dev python3-pip\npip install -r requirements.txt\n```\n\n## Usage\n\nFirst, connect an RF 433 MHz transmitter to the GPIO pin of your choice. Take note of the corresponding WiringPi pin number (see [pinout.xyz](https://pinout.xyz/pinout/wiringpi)).\n\n### Server\n\nExecute the following command to run the server locally:\n\n```\n./app/server.py\n```\n\nYou may then go to http://127.0.0.1:8001 to browse the documentation and test the API.\n\nThe following arguments are available:\n\n```\n./app/server.py [-h] [-a ADDRESS] [-p PORT] [-g GPIO] [-l LOG_LEVEL]\n\nOptional arguments:\n  -h, --help                           Show help message and exit\n  -a ADDRESS, --address ADDRESS        Address to bind to (default: 127.0.0.1)\n  -p PORT, --port PORT                 Port to listen on (default: 8001)\n  -g GPIO, --gpio GPIO                 GPIO WiringPi pin number (default: 0)\n  -l LOG_LEVEL, --log-level LOG_LEVEL  Log level: CRITICAL, ERROR, WARNING, INFO, DEBUG (default: INFO)\n```\n\nA Docker image is also available for the arm64 architecture:\n\n```\ndocker run -it --rm --privileged -p 8001:8001 ghcr.io/fcrespel/rf433-api:master [-h] [-a ADDRESS] [-p PORT] [-g GPIO] [-l LOG_LEVEL]\n```\n\nYou may want to run it in the background using commands such as the following:\n\n```\n# Create and start container\ndocker run -d --name rf433-api --privileged -p 127.0.0.1:8001:8001 ghcr.io/fcrespel/rf433-api:master\n\n# Stop server\ndocker stop rf433-api\n\n# Start server\ndocker start rf433-api\n\n# Show live logs\ndocker logs -f rf433-api\n```\n\nNOTE: the API port is not secured, make sure to only expose it locally or to trusted clients.\n\n### Client\n\nYou may call the API with any HTTP client such as curl:\n\n```\n# Replace 12345678 with the actual Chacon DIO 1.0 sender code (arbitrary 26-bit integer)\n\n# Get button 1 status:\ncurl -sSf -XGET http://127.0.0.1:8001/chacondio10/12345678/1\n\n# Set button 1 to ON:\ncurl -sSf -XPUT http://127.0.0.1:8001/chacondio10/12345678/1 -d 1\n\n# Set button 1 to OFF:\ncurl -sSf -XPUT http://127.0.0.1:8001/chacondio10/12345678/1 -d 0\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffcrespel%2Frf433-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffcrespel%2Frf433-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffcrespel%2Frf433-api/lists"}