Skip to content

cloud.smarthq.service.dryer.vent.health.mode

  • 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 Dryer Vent Health mode

Example Device Response (Digital Twin API)

Mode Service for Dryer Vent Health.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.dryer",
  "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.dryer.vent.health.mode",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.health",
      "supportedCommands": [
        "cloud.smarthq.command.dryer.vent.health.mode.set"
      ],
      "state": {
        "mode": "cloud.smarthq.type.mode.normal",
        "on": true
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dryer.vent",
      "config": {
        "ordered": true,
        "supportedModes": [
          "cloud.smarthq.type.mode.start",
          "cloud.smarthq.type.mode.complete",
          "cloud.smarthq.type.mode.cancel"
        ]
      },
      "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
ordered BOOLEAN No
supportedModes SET<MODE> Yes

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
mode MODE Yes
on BOOLEAN 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.dryer.vent.health.mode.set

Command used to set the new mode on the Dryer Vent Health mode service.

Field Name Property Type Required
mode MODE Yes

Example Commands

Command to set the vent health mode.

{
  "command": {
    "mode": "cloud.smarthq.type.mode.start",
    "commandType": "cloud.smarthq.command.dryer.vent.health.mode.set"
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.health",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.dryer.vent",
  "serviceType": "cloud.smarthq.service.dryer.vent.health.mode"
}

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.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
cloud.smarthq.outcome.unavailablemode The mode is unavailable.

Data Types

BOOLEAN

Value must be either true or false.

MODE

MODE Documentation
cloud.smarthq.type.mode.blocked Blocked
cloud.smarthq.type.mode.cancel Cancel
cloud.smarthq.type.mode.clean Clean
cloud.smarthq.type.mode.complete Complete
cloud.smarthq.type.mode.disable Disable
cloud.smarthq.type.mode.enable Enable
cloud.smarthq.type.mode.error Error
cloud.smarthq.type.mode.needsattention Needs Attention
cloud.smarthq.type.mode.normal Normal
cloud.smarthq.type.mode.start Start
cloud.smarthq.type.mode.unknown Unknown

SET<MODE>

SET<MODE> Documentation
cloud.smarthq.type.mode.blocked Blocked
cloud.smarthq.type.mode.cancel Cancel
cloud.smarthq.type.mode.clean Clean
cloud.smarthq.type.mode.complete Complete
cloud.smarthq.type.mode.disable Disable
cloud.smarthq.type.mode.enable Enable
cloud.smarthq.type.mode.error Error
cloud.smarthq.type.mode.needsattention Needs Attention
cloud.smarthq.type.mode.normal Normal
cloud.smarthq.type.mode.start Start
cloud.smarthq.type.mode.unknown Unknown