esprfid/esp-rfid-py

Alternative ESP-RFID firmware.

esp-rfid-py

Firmware for property access systems for common microcontrollers like ESP8266.

Inspired by ESP-RFID, written in Micro Python ((Pycopy)[https://github.com/pfalcon/pycopy] fork).

Status

This project is in experimental stage.

Compared to official ESP-RFID firmware lacks a lot of elementary features. Implemented features needs testing, but even at this stage should have less bugs.

Features

• Supports multiple Wiegand readers
• Supports multiple relays with different configurations
• Master card - use "admin" tag to add new tags
• Can run on all platforms supported by MicroPython (theoretically, tested on ESP8266 and ESP32)
• Can be controlled and send logs over MQTT
• HTTP API
• MQTT client (access log, heartbeat, open, cards management)
• Cards import and export to JSON by REPL

Complete list of features is in example config file.

Goals

Scalable and reliable modular, events-based and asynchronous architecture which allows:

• enable only needed features by plugins
• code being less bug prone
• easy coding of new features (e.g. integrations to bigger systems)
• thanks to Python the code is much easier to read and maintain

Current disadvantages

• Missing features and worse usability compared to ESP-RFID for now - it have to be configured in config files and database managed in REPL by calling Python API.
• MicroPython consumes much more RAM, so some features will be almost impossible on ESP8266 (embedded web interface).
• Will not support a many plugins enabled at one time (because of RAM).
• Missing compatibility with ESP-RFID export files (because current MicroPython Wiegand library encodes data differently).

esp-rfid-py's Issues

Documentation

While this is still heavily a work in progress, can we get some extra documentation, such as Airtable format?

While I know it isn't complete, and is missing fields to be added later, here is what I have worked out for anyone wishing to try it.
Note: Make the Devices table first.

Table: Devices
    Fields:
        Name: Single line text

Table: Tags
    Fields:
        UID: Single line text
        Name: Single line text
        Enabled: Checkbox
        Devices: Link to another record
            Table To Link: Devices
            Allow linking to multiple records: Enabled
            Limit record selection to a view: Default/Disabled

Note: For anyone that also runs a local nginx webserver, this should help you get around the HTTPS issue by creating an HTTP version of it.

server {
    listen 80;
    listen [::]:80;

    server_name airtable.example.com;
    
    location / {
        proxy_set_header Host api.airtable.com;
        proxy_ssl_verify off;
        proxy_pass_request_headers on;
        proxy_pass https://api.airtable.com;
    }
}