Add Olimex ESP32-C6-EVB + PN532 NFC driver and web UI
- New driver: app/drivers/olimex_esp32_c6_evb_pn532/ - Full relay/input control (inherits base behaviour) - get_nfc_status(), get_nfc_config(), set_nfc_config() methods - manifest.json with NFC hardware metadata (UEXT1 pins, card standard) - NFC management routes (boards.py): - GET /boards/<id>/nfc — management page - GET /boards/<id>/nfc/status_json — live JSON (polled every 3 s) - POST /boards/<id>/nfc/config — save auth UID / relay / timeout - POST /boards/<id>/nfc/enroll — enrol last-seen card with one click - New template: templates/boards/nfc.html - Live reader status (PN532 ready, access state, last UID) - Quick Enroll: present card → Refresh → Enrol in one click - Manual Settings: type/paste UID, pick relay, set absence timeout - detail.html: NFC Access Control button shown for pn532 board type
This commit is contained in:
1
app/drivers/olimex_esp32_c6_evb_pn532/__init__.py
Normal file
1
app/drivers/olimex_esp32_c6_evb_pn532/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Olimex ESP32-C6-EVB with PN532 NFC reader driver package."""
|
||||
184
app/drivers/olimex_esp32_c6_evb_pn532/driver.py
Normal file
184
app/drivers/olimex_esp32_c6_evb_pn532/driver.py
Normal file
@@ -0,0 +1,184 @@
|
||||
"""Olimex ESP32-C6-EVB + PN532 NFC reader board driver.
|
||||
|
||||
Hardware
|
||||
--------
|
||||
- 4 relays (outputs)
|
||||
- 4 digital inputs
|
||||
- PN532 NFC reader connected via UEXT1 (UART/HSU mode)
|
||||
UEXT1 pin 3 = GPIO4 → PN532 RXD
|
||||
UEXT1 pin 4 = GPIO5 → PN532 TXD
|
||||
DIP1 = 0, DIP2 = 0 (HSU mode)
|
||||
- HTTP REST API served directly by the board on port 80
|
||||
|
||||
API endpoints
|
||||
-------------
|
||||
POST /relay/on?relay=<n> → {"state": true}
|
||||
POST /relay/off?relay=<n> → {"state": false}
|
||||
POST /relay/toggle?relay=<n> → {"state": <new>}
|
||||
GET /relay/status?relay=<n> → {"state": <bool>}
|
||||
GET /input/status?input=<n> → {"state": <bool>}
|
||||
POST /register?callback_url=<url> → {"status": "ok"}
|
||||
GET /nfc/status → {"initialized": bool, "card_present": bool,
|
||||
"last_uid": str, "access_state": str,
|
||||
"auth_uid": str, "relay_num": int,
|
||||
"pulse_ms": int}
|
||||
GET /nfc/config → {"auth_uid": str, "relay_num": int, "pulse_ms": int}
|
||||
POST /nfc/config?auth_uid=&relay=&pulse_ms= → {"status": "ok", ...}
|
||||
|
||||
Webhook (board → server)
|
||||
------------------------
|
||||
The board POSTs to the registered callback_url whenever an input changes:
|
||||
POST <callback_url>
|
||||
{"input": <n>, "state": <bool>}
|
||||
|
||||
The board also POSTs an NFC card event on every card detection:
|
||||
POST <callback_url>
|
||||
{"type": "nfc_card", "uid": "<UID>", "uptime": <seconds>}
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import urllib.parse
|
||||
import requests
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from app.drivers.base import BoardDriver
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from app.models.board import Board
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
_TIMEOUT = 3
|
||||
|
||||
|
||||
def _get(url: str) -> dict | None:
|
||||
try:
|
||||
r = requests.get(url, timeout=_TIMEOUT)
|
||||
r.raise_for_status()
|
||||
return r.json()
|
||||
except Exception as exc:
|
||||
logger.debug("GET %s → %s", url, exc)
|
||||
return None
|
||||
|
||||
|
||||
def _post(url: str) -> dict | None:
|
||||
try:
|
||||
r = requests.post(url, timeout=_TIMEOUT)
|
||||
r.raise_for_status()
|
||||
return r.json()
|
||||
except Exception as exc:
|
||||
logger.debug("POST %s → %s", url, exc)
|
||||
return None
|
||||
|
||||
|
||||
class OlimexESP32C6EVBPn532Driver(BoardDriver):
|
||||
"""Driver for the Olimex ESP32-C6-EVB board with PN532 NFC reader."""
|
||||
|
||||
DRIVER_ID = "olimex_esp32_c6_evb_pn532"
|
||||
DISPLAY_NAME = "Olimex ESP32-C6-EVB + PN532 NFC"
|
||||
DESCRIPTION = "4 relays · 4 digital inputs · PN532 NFC reader (UEXT1/HSU) · HTTP REST + webhook callbacks"
|
||||
DEFAULT_NUM_RELAYS = 4
|
||||
DEFAULT_NUM_INPUTS = 4
|
||||
FIRMWARE_URL = "https://github.com/OLIMEX/ESP32-C6-EVB"
|
||||
|
||||
# ── relay control ─────────────────────────────────────────────────────────
|
||||
|
||||
def get_relay_status(self, board: "Board", relay_num: int) -> bool | None:
|
||||
data = _get(f"{board.base_url}/relay/status?relay={relay_num}")
|
||||
return bool(data["state"]) if data is not None else None
|
||||
|
||||
def set_relay(self, board: "Board", relay_num: int, state: bool) -> bool:
|
||||
action = "on" if state else "off"
|
||||
return _post(f"{board.base_url}/relay/{action}?relay={relay_num}") is not None
|
||||
|
||||
def toggle_relay(self, board: "Board", relay_num: int) -> bool | None:
|
||||
data = _post(f"{board.base_url}/relay/toggle?relay={relay_num}")
|
||||
return bool(data["state"]) if data is not None else None
|
||||
|
||||
# ── poll ──────────────────────────────────────────────────────────────────
|
||||
|
||||
def poll(self, board: "Board") -> dict:
|
||||
_offline = {"relay_states": {}, "input_states": {}, "is_online": False}
|
||||
|
||||
relay_states: dict = {}
|
||||
input_states: dict = {}
|
||||
|
||||
if board.num_relays > 0:
|
||||
probe = _get(f"{board.base_url}/relay/status?relay=1")
|
||||
if probe is None:
|
||||
return _offline
|
||||
relay_states["relay_1"] = bool(probe.get("state", False))
|
||||
elif board.num_inputs > 0:
|
||||
probe = _get(f"{board.base_url}/input/status?input=1")
|
||||
if probe is None:
|
||||
return _offline
|
||||
input_states["input_1"] = bool(probe.get("state", False))
|
||||
else:
|
||||
return _offline
|
||||
|
||||
for n in range(2, board.num_relays + 1):
|
||||
data = _get(f"{board.base_url}/relay/status?relay={n}")
|
||||
if data is not None:
|
||||
relay_states[f"relay_{n}"] = bool(data.get("state", False))
|
||||
|
||||
input_start = 2 if (board.num_relays == 0 and board.num_inputs > 0) else 1
|
||||
for n in range(input_start, board.num_inputs + 1):
|
||||
data = _get(f"{board.base_url}/input/status?input={n}")
|
||||
if data is not None:
|
||||
input_states[f"input_{n}"] = bool(data.get("state", True))
|
||||
|
||||
return {
|
||||
"relay_states": relay_states,
|
||||
"input_states": input_states,
|
||||
"is_online": True,
|
||||
}
|
||||
|
||||
# ── webhook registration ──────────────────────────────────────────────────
|
||||
|
||||
def register_webhook(self, board: "Board", callback_url: str) -> bool:
|
||||
url = f"{board.base_url}/register?callback_url={callback_url}"
|
||||
ok = _post(url) is not None
|
||||
if ok:
|
||||
logger.info("Webhook registered on board '%s' → %s", board.name, callback_url)
|
||||
else:
|
||||
logger.warning("Webhook registration failed for board '%s'", board.name)
|
||||
return ok
|
||||
|
||||
# ── NFC access control ────────────────────────────────────────────────────
|
||||
|
||||
def get_nfc_status(self, board: "Board") -> dict | None:
|
||||
"""Return current NFC reader status (last UID, access_state, auth config)."""
|
||||
return _get(f"{board.base_url}/nfc/status")
|
||||
|
||||
def get_nfc_config(self, board: "Board") -> dict | None:
|
||||
"""Return current NFC access-control configuration from the board."""
|
||||
return _get(f"{board.base_url}/nfc/config")
|
||||
|
||||
def set_nfc_config(
|
||||
self,
|
||||
board: "Board",
|
||||
auth_uid: str = "",
|
||||
relay_num: int = 1,
|
||||
pulse_ms: int = 3000,
|
||||
) -> bool:
|
||||
"""Push NFC access-control config to the board.
|
||||
|
||||
auth_uid: authorized card UID (e.g. "04:AB:CD:EF"); empty = no card authorized.
|
||||
relay_num: which relay to open on a matching card (1-4).
|
||||
pulse_ms: absence timeout — relay closes this many ms after card is removed (100-60000).
|
||||
"""
|
||||
url = (
|
||||
f"{board.base_url}/nfc/config"
|
||||
f"?auth_uid={urllib.parse.quote(auth_uid.upper())}"
|
||||
f"&relay={relay_num}"
|
||||
f"&pulse_ms={pulse_ms}"
|
||||
)
|
||||
result = _post(url)
|
||||
if result:
|
||||
logger.info(
|
||||
"NFC config pushed to board '%s': uid='%s' relay=%d pulse=%dms",
|
||||
board.name, auth_uid, relay_num, pulse_ms,
|
||||
)
|
||||
else:
|
||||
logger.warning("NFC config push failed for board '%s'", board.name)
|
||||
return result is not None
|
||||
28
app/drivers/olimex_esp32_c6_evb_pn532/manifest.json
Normal file
28
app/drivers/olimex_esp32_c6_evb_pn532/manifest.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"driver_id": "olimex_esp32_c6_evb_pn532",
|
||||
"display_name": "Olimex ESP32-C6-EVB + PN532 NFC",
|
||||
"description": "Olimex ESP32-C6-EVB board with 4 relays, 4 digital inputs, and a PN532 NFC reader connected via UEXT1 (HSU/UART mode). Communicates via HTTP REST API with webhook callbacks. Supports NFC card access control.",
|
||||
"manufacturer": "Olimex",
|
||||
"chip": "ESP32-C6 WROOM-1",
|
||||
"default_num_relays": 4,
|
||||
"default_num_inputs": 4,
|
||||
"firmware_url": "https://github.com/OLIMEX/ESP32-C6-EVB",
|
||||
"nfc": {
|
||||
"reader": "NXP PN532",
|
||||
"interface": "UART/HSU via UEXT1",
|
||||
"uext1_pin3_gpio": 4,
|
||||
"uext1_pin4_gpio": 5,
|
||||
"card_standard": "ISO14443A / Mifare"
|
||||
},
|
||||
"api": {
|
||||
"relay_on": "POST /relay/on?relay={n}",
|
||||
"relay_off": "POST /relay/off?relay={n}",
|
||||
"relay_toggle": "POST /relay/toggle?relay={n}",
|
||||
"relay_status": "GET /relay/status?relay={n}",
|
||||
"input_status": "GET /input/status?input={n}",
|
||||
"register": "POST /register?callback_url={url}",
|
||||
"nfc_status": "GET /nfc/status",
|
||||
"nfc_config": "GET /nfc/config",
|
||||
"nfc_config_set": "POST /nfc/config?auth_uid={uid}&relay={n}&pulse_ms={ms}"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user