Skip to content

cloud.smarthq.service.outdoorunit.info

  • 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 to model the outdoor unit model and serial number.

Example Device Response (Digital Twin API)

Example product info service for outdoor unit

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.airconditioner.outdoorunit",
  "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.outdoorunit.info",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.outdoor.product.info",
      "supportedCommands": [],
      "state": {
        "serialNumber": "S123",
        "modelNumber": "12345"
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.airconditioner.outdoorunit",
      "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
modelNumber STRING Yes
serialNumber STRING 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.