cloud.smarthq.service.filter.v1¶

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 for filter details and state.

Example Device Response (Digital Twin API)¶

Water Filter State Service.

{
  "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.filter.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.state",
      "supportedCommands": [
        "cloud.smarthq.command.filter.v1.set"
      ],
      "state": {
        "expired": false,
        "usagePercent": 80.0,
        "type": "cloud.smarthq.type.filter.carbon"
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.waterfilter",
      "config": {
        "supportedFilterTypes": [
          "cloud.smarthq.type.filter.carbon",
          "cloud.smarthq.type.filter.unknown",
          "cloud.smarthq.type.filter.inhibiting.scale"
        ]
      },
      "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
expirationElapsedTimeUnits	TIME_UNITS	No
supportedFilterTypes	STRING_ARRAY	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	Minimum
disabled	BOOLEAN	No
expirationElapsedTime	INTEGER	No	0
expired	BOOLEAN	No
type	FILTER_TYPE	No
usagePercent	INTEGER	No	0

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.filter.v1.set¶

Command to set the filter type.

Field Name	Property Type	Required
type	FILTER_TYPE	Yes

Example Commands¶

Reset water filter

{
  "command": {
    "commandType": "cloud.smarthq.command.filter.v1.set",
    "type": "cloud.smarthq.type.filter.carbon"
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.state",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.waterfilter",
  "serviceType": "cloud.smarthq.service.filter.v1"
}

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.badrequest	The request was invalid.
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.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.

INTEGER¶

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

STRING_ARRAY¶

Value must be an array of strings.

FILTER_TYPE¶

FILTER_TYPE	Documentation
cloud.smarthq.type.filter.carbon	Carbon Filter
cloud.smarthq.type.filter.inhibiting.scale	Scale Inhibiting Filter
cloud.smarthq.type.filter.unknown	Unknown

TIME_UNITS¶

TIME_UNITS	Documentation
cloud.smarthq.type.timeunits.hours	Hours
cloud.smarthq.type.timeunits.minutes	Minutes
cloud.smarthq.type.timeunits.seconds	Seconds