cloud.smarthq.service.double¶

Configuration

Describes boundaries and fixed properties for the service.

Go There
State

A list of the states this service can be in.

Go There
Commands

How to change the state of the service.

Go There
Data Types

All the data types used for this service.

Go There

Description¶

Service to model a 64-bit double value with associated units.

Example Device Response (Digital Twin API)¶

Service representing the water flow rate of a Home Water Filter

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.waterfilter",
  "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.double",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.flowrate",
      "supportedCommands": [
        "cloud.smarthq.command.double.set"
      ],
      "state": {
        "valueDouble": 1.75
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.waterfilter",
      "config": {
        "doubleUnits": "cloud.smarthq.type.doubleunits.gpm"
      },
      "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
defaultDouble	DOUBLE	No
doubleUnits	DOUBLE_UNITS	Yes
maximumDouble	DOUBLE	No
minimumDouble	DOUBLE	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
valueDouble	DOUBLE	Yes

Commands¶

The following are properties for both the Digital Twin API to send a command to the device as well as the properties passed as part of a command to the gateway to be processed by the device itself.

cloud.smarthq.command.double.set¶

Command to set a new value for the double service.

Field Name	Property Type	Required
valueDouble	DOUBLE	Yes

Example Commands¶

Command to set the flow rate

{
  "command": {
    "commandType": "cloud.smarthq.command.double.set",
    "valueDouble": 200.5
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.flowrate",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.waterfilter",
  "serviceType": "cloud.smarthq.service.double"
}

Supported Outcomes¶

Each service has an allow listed set of outcomes that the device may return when asked to execute a command.

Outcome	Documentation
cloud.smarthq.outcome.developererror	Only used when there is a server side bug
cloud.smarthq.outcome.deviceoffline	The device is offline.
cloud.smarthq.outcome.forbidden	The request is forbidden due to permissions.
cloud.smarthq.outcome.internalerror	The server had an issue processing the request
cloud.smarthq.outcome.missingconfig	The service config is missing
cloud.smarthq.outcome.missingstate	The service state is missing
cloud.smarthq.outcome.notallowed	The command is not allowed.
cloud.smarthq.outcome.notfound	The request is forbidden due to permissions.
cloud.smarthq.outcome.notsupported	The command is not supported.
cloud.smarthq.outcome.outofbounds	General out of bounds error
cloud.smarthq.outcome.servicedisabled	Feature is currently disabled
cloud.smarthq.outcome.success	Successful request
cloud.smarthq.outcome.timeout	The server experienced timeout waiting for a response from the gateway

Data Types¶

BOOLEAN¶

Value must be either true or false.

DOUBLE¶

Value must be an double. Field specific restrictions such as a minimum and maximum may apply depending on the field.

DOUBLE_UNITS¶

DOUBLE_UNITS	Documentation
cloud.smarthq.type.doubleunits.gpm	Gallons per minute
cloud.smarthq.type.doubleunits.unitless	unitless