Skip to content

cloud.smarthq.service.stainremoval

  • 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 Stain Removal.

Example Device Response (Digital Twin API)

Service for stain removal for laundry.

{
  "adapterId": "0000000000000000000000000000000000000000",
  "alertTypes": [],
  "createdDateTime": "2022-03-04T12:12:12.123Z",
  "deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
  "deviceType": "cloud.smarthq.device.washer",
  "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.stainremoval",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.laundry.stainremoval",
      "supportedCommands": [
        "cloud.smarthq.command.stainremoval.mode.set"
      ],
      "state": {
        "mode": "cloud.smarthq.type.laundry.stain.grass",
        "featureVersion": 1.0,
        "on": true
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.washer",
      "config": {
        "supportedModes": [
          "cloud.smarthq.type.laundry.stain.off",
          "cloud.smarthq.type.laundry.stain.blood",
          "cloud.smarthq.type.laundry.stain.grass",
          "cloud.smarthq.type.laundry.stain.dirt",
          "cloud.smarthq.type.laundry.stain.tomato",
          "cloud.smarthq.type.laundry.stain.beverages",
          "cloud.smarthq.type.laundry.stain.oily"
        ]
      },
      "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
supportedModes SET<LAUNDRY_STAIN_REMOVAL_GUIDE> 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
featureVersion INTEGER Yes
mode LAUNDRY_STAIN_REMOVAL_GUIDE 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.stainremoval.mode.set

Command used to set the new mode on the Stain Removal service.

Rules Engine Allowed Domains:

  • cloud.smarthq.domain.laundry.stainremoval
Field Name Property Type Required
mode LAUNDRY_STAIN_REMOVAL_GUIDE Yes

Example Commands

Command to set the Stain Removal Type.

{
  "command": {
    "mode": "cloud.smarthq.type.laundry.stain.grass",
    "commandType": "cloud.smarthq.command.stainremoval.mode.set"
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.laundry.stainremoval",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.washer",
  "serviceType": "cloud.smarthq.service.stainremoval"
}

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.

LAUNDRY_STAIN_REMOVAL_GUIDE

LAUNDRY_STAIN_REMOVAL_GUIDE Documentation
cloud.smarthq.type.laundry.stain.beverages Beverages
cloud.smarthq.type.laundry.stain.blood Blood
cloud.smarthq.type.laundry.stain.dirt Dirt
cloud.smarthq.type.laundry.stain.grass Grass
cloud.smarthq.type.laundry.stain.off Off
cloud.smarthq.type.laundry.stain.oily Oily
cloud.smarthq.type.laundry.stain.tomato Tomato
cloud.smarthq.type.laundry.stain.unknown Unknown

SET<LAUNDRY_STAIN_REMOVAL_GUIDE>

SET<LAUNDRY_STAIN_REMOVAL_GUIDE> Documentation
cloud.smarthq.type.laundry.stain.beverages Beverages
cloud.smarthq.type.laundry.stain.blood Blood
cloud.smarthq.type.laundry.stain.dirt Dirt
cloud.smarthq.type.laundry.stain.grass Grass
cloud.smarthq.type.laundry.stain.off Off
cloud.smarthq.type.laundry.stain.oily Oily
cloud.smarthq.type.laundry.stain.tomato Tomato
cloud.smarthq.type.laundry.stain.unknown Unknown