Skip to content

cloud.smarthq.service.water.energy.estimates

  • Configuration


    Describes boundaries and fixed properties for the service.

    Go There

  • 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 for Water and Energy Consumption Static Estimates

Example Device Response (Digital Twin API)

Example of service for a water and energy static estimate

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.dishwasher",
  "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.water.energy.estimates",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.config.json",
      "supportedCommands": [],
      "state": {},
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dishwasher",
      "config": {
        "cycles": [
          {
            "name": "Baby Care",
            "index": 0.0,
            "waterEstimate": 4.0,
            "energyEstimate": 5.0
          }
        ]
      },
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

Configuration

The following are properties for the gateway/device sync as part of the "config" object for each individual service.

Field Name Property Type Required
cycles CYCLES No

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

Data Types

BOOLEAN

Value must be either true or false.

CYCLES

Value must be a JSON array with json objects which attributes are: - name: string value - index: integer value - energyEstimate: integer value - waterEstimate: integer value