{"id":22071489,"url":"https://github.com/zonque/nfceyboard","last_synced_at":"2026-04-29T09:05:10.566Z","repository":{"id":66926929,"uuid":"156275307","full_name":"zonque/NFCeyboard","owner":"zonque","description":"Simple Arduino based NFC-enabled key-board","archived":false,"fork":false,"pushed_at":"2018-11-06T12:43:11.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-20T17:49:07.809Z","etag":null,"topics":["esp8266","home-automation","iot-device","nfc"],"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/zonque.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":"2018-11-05T20:01:51.000Z","updated_at":"2018-11-06T12:43:12.000Z","dependencies_parsed_at":"2023-02-23T04:30:30.935Z","dependency_job_id":null,"html_url":"https://github.com/zonque/NFCeyboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zonque/NFCeyboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zonque%2FNFCeyboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zonque%2FNFCeyboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zonque%2FNFCeyboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zonque%2FNFCeyboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zonque","download_url":"https://codeload.github.com/zonque/NFCeyboard/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zonque%2FNFCeyboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32418201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T06:29:02.080Z","status":"ssl_error","status_checked_at":"2026-04-29T06:29:00.631Z","response_time":110,"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":["esp8266","home-automation","iot-device","nfc"],"created_at":"2024-11-30T20:31:49.978Z","updated_at":"2026-04-29T09:05:10.551Z","avatar_url":"https://github.com/zonque.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NFCeyboard\n\nThis project implements the firmware for a simple key-board that reads NFC tags\nattached to key ring and reports their presence to an MQTT server. Multiple MFRC522\nbased, SPI connected NFC readers are supported.\n\n## Operation\n\nThe firmware polls for NFC tags on each reader once per second. If a tag is not seen\nfor `NfcTagTimeoutSeconds` (5) seconds, it is reported as `away` in the MQTT broker.\nWhen it is seen, the topic is set to `home`.\n\n## Configuration\n\nBefore building the project, copy `src/config.h.template` to `src/config.h` and fill in\nthe following details.\n\n* The Wifi SSID and passphrase\n* The MQTT server to connect to\n* The NFC tags to listen to, along with the MQTT topic to use for reporting\n* The SS (chip-select) pins for each MFRC522 reader\n\n## Building the software\n\nThe project is implemented with PlatformIO. Please make sure to use a PlatformIO enabled\nenvironment when compiling.\n\n## Hardware wiring\n\nThe firmware is compatible to ESP8266 boards. To interface the NFC readers, connect them\nto the SPI pins of the hardware so that they all share the `MISO`, `MOSI` and `CLK` lines,\nalong with `VCC` (3.3V) and `GND`. Each NFC reader needs to be connected to a dedicated `SS`\n(chip-select) line. The configuration in `config.h` needs to specify these chip-select pins.\n\n## HomeAssistant\n\nAs the firmware communicates with its environment via an MQTT server, it can be easily\nintegrated into HomeAssistant installations.\n\nAdd your MQTT broker to `configuration.yaml`. For instance:\n\n```yaml\nmqtt:\n  broker: localhost\n```\n\nAnd then add a device for each tag that was configured in the firmware. For instance:\n\n```yaml\nnotify:\n- platform: mqtt\n  devices:\n    foo_key: 'key/foo'\n```\n\nFor more information, refer to the [HomeAssistant MQTT documentation](https://www.home-assistant.io/components/device_tracker.mqtt/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzonque%2Fnfceyboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzonque%2Fnfceyboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzonque%2Fnfceyboard/lists"}