{"id":20548640,"url":"https://github.com/smilyorg/rfmqtt","last_synced_at":"2025-03-06T05:25:33.619Z","repository":{"id":75930393,"uuid":"94268094","full_name":"SmilyOrg/rfmqtt","owner":"SmilyOrg","description":"RF 433MHz to MQTT bridge. NewKaku protocol and tested only on Raspberry Pi 2.","archived":false,"fork":false,"pushed_at":"2017-06-22T01:41:38.000Z","size":14,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-16T16:26:45.132Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","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/SmilyOrg.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}},"created_at":"2017-06-13T23:40:43.000Z","updated_at":"2021-06-14T08:12:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"28c1a9c7-72ee-4559-83a1-4c19e3da33c2","html_url":"https://github.com/SmilyOrg/rfmqtt","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmilyOrg%2Frfmqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmilyOrg%2Frfmqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmilyOrg%2Frfmqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SmilyOrg%2Frfmqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SmilyOrg","download_url":"https://codeload.github.com/SmilyOrg/rfmqtt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242152690,"owners_count":20080333,"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":[],"created_at":"2024-11-16T02:14:07.735Z","updated_at":"2025-03-06T05:25:33.610Z","avatar_url":"https://github.com/SmilyOrg.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"rfmqtt - RF 433MHz to MQTT bridge.\r\n\r\n# Compiling\r\n\r\n1. Change your working directory to the project directory.\r\n2. Create a build directory, e.g. `mkdir build`.\r\n3. Change to the build directory, e.g. `cd build`.\r\n4. Use CMake to create project files, e.g. `cmake ..` to create a `Makefile` or\r\n`cmake -GNinja ..` to create a Ninja build file.\r\n5. Compile the code, e.g. `make -j4` or `ninja`. This takes several minutes on\r\na Raspberry Pi 2.\r\n6. After successful compilation, the `rfmqtt` executable should be ready and\r\nwaiting in the build directory.\r\n\r\nFor everyday use, you might want to build as a `Release` or `RelWithDebInfo`\r\nbuild type to be more efficient on resources.\r\n\r\n# Setup\r\n\r\n1. Download or compile the `rfmqtt` binary and example `config.yaml`.\r\n2. Configure your MQTT connection, RF devices and mappings in `config.yaml`.\r\n\r\n# Installing (optional)\r\n\r\n## As a CLI app\r\n\r\n1. Copy `rfmqtt` to `/usr/local/bin` to install `rfmqtt` to be used globally,\r\ne.g. `cp rfmqtt /usr/local/bin`.\r\n2. Copy `config.yaml` to `~/.config/rfmqtt/config.yaml` for it to be picked up\r\nautomatically, e.g. `cp config.yaml ~/.config/rfmqtt/`.\r\n\r\nThe config file will also get picked up in the working directory and other\r\ndirs defined by the \"XDG Base Directory Specification\". You can also use the\r\n`--config` command line option to set a custom path.\r\n\r\n## As a service\r\n1. Copy `rfmqtt` to `/usr/local/bin` if you want to use the default\r\nservice configuration, e.g. `cp rfmqtt /usr/local/bin`.\r\n2. Copy `config.yaml` to `/etc/xdg/rfmqtt/config.yaml` for it to be picked up\r\nautomatically,\r\ne.g. `mkdir /etc/xdg/rfmqtt; cp config.yaml /etc/xdg/rfmqtt/`.\r\n3. Copy `service/rfmqtt.service` to `/etc/systemd/system/`,\r\ne.g. `sudo cp service/rfmqtt.service /etc/systemd/system/`.\r\n4. Run `sudo systemctl daemon-reload` to refresh services. This should be done\r\nevery time you change the `.service` file.\r\n\r\n# Running\r\n\r\n## As a program\r\n\r\n1. Run `rfmqtt` if installed or `./rfmqtt` to run from working directory.\r\n\r\nSee `./rfmqtt -h` for more info on command line arguments.\r\n\r\n## As a service\r\n\r\n1. Install as a service if you haven't already.\r\n2. Run `sudo systemctl start rfmqtt.service` to start the service.\r\n3. Now it should always run in the background automatically.\r\n\r\nYou can use `status` in place of `start` to see the status of the service.\r\nAlso useful are `stop` and `restart`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmilyorg%2Frfmqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmilyorg%2Frfmqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmilyorg%2Frfmqtt/lists"}