https://github.com/dfirebaugh/mqtt_rfid
a simple access control system that supports updating access over mqtt
https://github.com/dfirebaugh/mqtt_rfid
Last synced: 8 months ago
JSON representation
a simple access control system that supports updating access over mqtt
- Host: GitHub
- URL: https://github.com/dfirebaugh/mqtt_rfid
- Owner: dfirebaugh
- License: mit
- Created: 2023-06-24T22:53:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T15:38:25.000Z (almost 2 years ago)
- Last Synced: 2024-12-27T19:29:48.176Z (over 1 year ago)
- Language: Python
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MQTT-RFID
A simple access control system using the Raspberry Pi Pico W and the RFID-RC522 module.
## Overview
This project allows you to control access using RFID fobs and MQTT. You can add fobs using MQTT or manually write them to the Raspberry Pi Pico. The device is designed to remain operational even without network access or when unable to connect to the MQTT broker. It will continuously attempt to reconnect without interrupting its main functionality (controlling access to the door).
The device keeps an ACL in internal memory. It receives updates from the MQTT broker. It can publish a hash of the current ACL so that the server can verify that the ACL matches what the server expects it to have.
## Wiring
The Raspberry Pi Pico connects to the RC522 module via the SPI interface. The default pinouts are provided below:
| RFID Signal | Pico Pin |
|-------------|:--------:|
| SCK | GP2 |
| MOSI | GP3 |
| MISO | GP4 |
| RST | GP0 |
| SDA | GP1 |
## Dependencies
- MicroPython
- umqtt.simple (version: 1.3.4; installed to /lib/umqtt on the Raspberry Pi Pico)
> note: [Thonny](https://thonny.org/) can be a useful IDE for working with the Raspberry Pi Pico.
## MQTT Events
The device uses MQTT for communication. Here are the supported MQTT events:
### Subscriptions
| Topic | Payload | Notes |
|-------|---------|-------|
| `/acl` | n/a | The device will publish a `/acl_response` message. |
| `/adduser` | `uid of the RFID fob to add` | Adds the specified fob to the device's Access Control List (ACL). |
| `/removeuser` | `uid of the RFID fob to remove` | Removes the specified fob from the device's ACL. |
| `/open` | n/a | Opens the door. |
### Publish
| Topic | Payload | Notes |
|-------|---------|-------|
| `/acl_response` | `{'acl': ''}` | Allows the server to verify if the device has the correct ACL. |
| `/heartbeat` | `OK` | Allows the server to verify the device's network connection. |
| `/access_granted` | `uid of the fob that is granted access` | Used for logging purposes. |
| `/access_denied` | `uid of the fob that is denied access` | Used for logging purposes. |