Skip to main content

System Operations API

The Systems Engine provides endpoints for basic device control and status monitoring. This page documents the request and response formats for these operations.

Health Check​

Retrieves comprehensive health information about the system, including CPU, RAM, battery, and storage status.

Endpoint​

GET /system/healthz

Response​

{
  "status": "healthy",
  "httpPort": 48008,
  "grpcPort": 48009,
  "host": "192.168.150.1",
  "battery": {
    "hasBattery": false,
    "cycleCount": 0,
    "isCharging": false,
    "designedCapacity": 0,
    "maxCapacity": 0,
    "currentCapacity": 0,
    "voltage": 0,
    "capacityUnit": "",
    "percent": 0,
    "timeRemaining": null,
    "acConnected": true,
    "type": "",
    "model": "",
    "manufacturer": "",
    "serial": ""
  },
  "cpu": {
    "load": 36.060097783805,
    "temperature": 78.538,
    "totalClockSpeed": 2.26,
    "currentClockSpeed": 2.03
  },
  "ram": {
    "total": 8002732032,
    "available": 4818616320,
    "free": 3177963520
  },
  "storage": {
    "total": 48870141952,
    "free": 8735977472
  }
}

Debug Command​

Sends a debug command to the system for diagnostics and troubleshooting.

Endpoint​

POST /system/debug/command

Request Body​

{
  "cmdResp": 4,
  "peripheral": 3,
  "peripheralChannels": 16515072,
  "parameter": [2],
  "data": [0],
  "packetType": 15
}

Schema​

{
  txnID: number,
  packetType: number,
  srcDevice: number,
  cmdResp: number,
  peripheral: number,
  peripheralChannels: number,
  parameter: [string],
  data: [string]
}

Response​

The response returns the result of the command execution.