Developer API Reference

ALAZ Gateway and Core Unit expose a full-featured REST + WebSocket + Diagnostic API running on your local network. No cloud required — everything lives on your hardware.

🔌

Gateway Diagnostic API Endpoints

Accessible via the local IP of each ALAZ Gateway device from any browser or HTTP client:

Endpoint Method Description
/diagGETFull diagnostic bundle (all modules)
/diag/radioGETESP-NOW radio stats (RSSI, packet drops)
/diag/snapGETInstant state snapshot (all module states)
/diag/eventsGETLast 128 event ring (ACK, timeout, connection)
/sysGETSystem health (heap, CPU, uptime, WiFi RSSI)
/nodesGETFull node registry (metrics, bank ID, RSSI)
/cmdPOSTSend relay command (node_id, relay_id, state)
/cfg/mapping_v1.jsonGETBank mapping configuration
🔄

Core Unit WebSocket & REST

Real-Time WebSocket

The Core maintains persistent WebSocket connections to all Gateways. Sensor data streams with <20ms latency. HTTP fallback activates on disconnection.

📡

Prometheus Telemetry

The /ts/summary.txt endpoint outputs Prometheus-compatible time-series data. Ready for Grafana integration out of the box.

🔄

OTA Updates

Every Gateway and Sensor node supports wireless firmware updates (OTA) via the portal interface. No physical field access required.

🔧

Relay Node Diagnostics

Every Relay Node exposes diagnostic data via its local AP portal during pairing and configuration:

Endpoint Contents
/diagACK queue, TX ok/fail, rate-limit counters, last ACK latency (ms)
/diag (mem)Internal heap: free/largest/min + frag%, PSRAM: free/largest/min

📖 Swagger Documentation

Comprehensive Swagger/OpenAPI documentation and integration guides are currently in preparation.