Skip to content

cloud.smarthq.service.door

  • 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 doors.

Example Device Response (Digital Twin API)

Doors state of the refrigerator.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.refrigerator",
  "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.door",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.door",
      "supportedCommands": [],
      "state": {
        "topRightOpen": true,
        "middleOpen": false,
        "bottomRightOpen": true,
        "topLeftOpen": false,
        "bottomLeftOpen": false
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.refrigerator",
      "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
bottomLeftOpen BOOLEAN No
bottomOpen BOOLEAN No
bottomRightOpen BOOLEAN No
disabled BOOLEAN No
leftOpen BOOLEAN No
middleOpen BOOLEAN No
rightOpen BOOLEAN No
singleOpen BOOLEAN No
topLeftOpen BOOLEAN No
topOpen BOOLEAN No
topRightDoorInDoorOpen BOOLEAN No
topRightOpen BOOLEAN No

Data Types

BOOLEAN

Value must be either true or false.