cloud.smarthq.service.pou.alert¶

State

A list of the states this service can be in.

Go There
Data Types

All the data types used for this service.

Go There

Description¶

Service that represents the POU alerts.

Example Device Response (Digital Twin API)¶

Alerts state of the POU water filter sensor

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.sensor.waterfilter.pou",
  "gatewayId": "0000000000000000000000000000000000000000000000000000000000000000",
  "kind": "device#item",
  "lastPresenceTime": "2022-03-04T12:12:12.123Z",
  "lastSyncTime": "2022-03-04T12:12:12.123Z",
  "presence": "OFFLINE",
  "removable": true,
  "services": [
    {
      "serviceType": "cloud.smarthq.service.pou.alert",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.alert",
      "supportedCommands": [],
      "state": {
        "leak": false,
        "freeze": true,
        "replace": false,
        "lowbattery": false,
        "order": true
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.sensor.waterfilter.pou",
      "config": {},
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

State¶

The following are properties for the device state report as part of the "state" object for each individual service.

Field Name	Property Type	Required
disabled	BOOLEAN	No
freeze	BOOLEAN	No
leak	BOOLEAN	No
lowbattery	BOOLEAN	No
order	BOOLEAN	No
replace	BOOLEAN	No

Data Types¶

BOOLEAN¶

Value must be either true or false.