Developer & Sysadmin Reference

Technical Documentation

Complete protocol specification, passive uptime tracking mechanism, and API integration guides for ETerminal.

1. Device Registration & First-Time Handshake

Hardware token registration and administrator authorization

When an ETerminal display launches for the first time, it provisions a persistent hardware token (TerminalUid) and registers with the enterprise cluster:

POST /API/Telemetry/SensorTerminals/Heartbeat
Content-Type: application/json

{
  "TerminalUid": "TV-8A4F-2900-B21",
  "DeviceName": "Sony Bravia 4K (Pharma Hall A)",
  "Platform": "Android",
  "AppVersion": "1.0.0"
}

sync_saved_locally

2. Passive Telemetry Stream & Uptime Tracking

Zero-spam in-memory state tracker with 5-minute DB throttle

Instead of firing noisy periodic ping requests, the wallboard automatically attaches the X-Terminal-Uid header to every routine telemetry polling request:

GET /API/Telemetry/GenericSensors/All
Authorization: Bearer <jwt-token>
X-Terminal-Uid: TV-8A4F-2900-B21

The backend base controller intercepts the header in OnActionExecuting, updating the RAM timestamp instantly. If no request is received for 5 minutes, the device is designated as Offline.

badge

3. Sensor Custodian Assignment

Delegated supervisor responsibility & personalized wallboard views

Sensors can be mapped to specific custodians in the Admin Console. On the terminal display, supervisors can toggle between viewing all organization sensors or filtering down strictly to the sensors they are personally assigned to monitor.