Texecom Event Schemas

JSON Schema Documentation

Power Monitoring Battery Status Read Payload

Payload emitted when the observer lambda intercepts a GET /api/status/power_monitoring/battery. Captures the current battery state classification derived by the firmware from ADC threshold comparisons.

$idhttps://schemas.texecom-prod.com/v2/events/payload/cloud/internal/power_monitoring/battery/status_read/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
serialString
hardwareIdString
batteryStateString
batteryVoltageAdcInteger

serial

Description Panel serial number extracted from the MQTT topic path (device/{serial}/...).
TypeString
Required Yes

hardwareId

Description Panel primary key in the device service DB, resolved via serial lookup (device.hardware.hardware_id).
TypeString
Required Yes
Format uuid

batteryState

Description Classified battery state derived from ADC threshold comparisons. Priority: missing > flat > low > normal.
TypeString
Required Yes
Enum
  • normal
  • low
  • flat
  • missing

batteryVoltageAdc

Description Raw ADC reading used for state classification. Compared against BatteryThresholdConfig: low_adc (6343), flat_adc (9928), presence_adc (9996).
TypeInteger
Required Yes

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/cloud/internal/power_monitoring/battery/status_read/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Power Monitoring Battery Status Read Payload",
    "description": "Payload emitted when the observer lambda intercepts a GET /api/status/power_monitoring/battery. Captures the current battery state classification derived by the firmware from ADC threshold comparisons.",
    "type": "object",
    "properties": {
        "serial": {
            "description": "Panel serial number extracted from the MQTT topic path (device/{serial}/...).",
            "type": "string"
        },
        "hardwareId": {
            "description": "Panel primary key in the device service DB, resolved via serial lookup (device.hardware.hardware_id).",
            "type": "string",
            "format": "uuid"
        },
        "batteryState": {
            "description": "Classified battery state derived from ADC threshold comparisons. Priority: missing > flat > low > normal.",
            "type": "string",
            "enum": [
                "normal",
                "low",
                "flat",
                "missing"
            ]
        },
        "batteryVoltageAdc": {
            "description": "Raw ADC reading used for state classification. Compared against BatteryThresholdConfig: low_adc (6343), flat_adc (9928), presence_adc (9996).",
            "type": "integer"
        }
    },
    "required": [
        "serial",
        "hardwareId",
        "batteryState",
        "batteryVoltageAdc"
    ],
    "additionalProperties": false
}