Skip to content

cloud.smarthq.service.demandresponse.state.v1

  • 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 status of an appliance with respect to demand response event

Example Device Response (Digital Twin API)

Example Service to read the status of an appliance with respect to demand response.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.ptac",
  "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.demandresponse.state.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.demandresponse",
      "supportedCommands": [],
      "state": {
        "eventId": "b5a1d4d3f5f5d1d1e6f5e5a5f5e5d1d1",
        "systemStatus": "cloud.smarthq.type.demandresponse.systemstatus.curtailed",
        "energyState": "cloud.smarthq.type.demandresponse.energystate.running"
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.appliance",
      "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
energyState DEMAND_RESPONSE_ENERGY_STATE Yes
eventId STRING No
systemStatus DEMAND_RESPONSE_SYSTEM_STATUS Yes

Data Types

BOOLEAN

Value must be either true or false.

STRING

Value must be a sequence of characters, inserted between " and " (double quotes). Field specific restrictions such as a regular expression may apply depending on the field.

DEMAND_RESPONSE_ENERGY_STATE

DEMAND_RESPONSE_ENERGY_STATE Documentation
cloud.smarthq.type.demandresponse.energystate.idle Idle, appliance is in off mode
cloud.smarthq.type.demandresponse.energystate.running Running, appliance is operating

DEMAND_RESPONSE_SYSTEM_STATUS

DEMAND_RESPONSE_SYSTEM_STATUS Documentation
cloud.smarthq.type.demandresponse.systemstatus.cancelduetoerrororconnectionloss Demand response event cancelled due to error/connection loss
cloud.smarthq.type.demandresponse.systemstatus.curtailed Curtailed, demand response event in effect
cloud.smarthq.type.demandresponse.systemstatus.normal Normal, no demand response event in effect
cloud.smarthq.type.demandresponse.systemstatus.unabletosatisfydemand Unable to satisfy demand
cloud.smarthq.type.demandresponse.systemstatus.useroverride User override