Skip to content

cloud.smarthq.service.dryer.mycycle

  • 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 My Cycle

Example Device Response (Digital Twin API)

MyCycle Service for Laundry.

{
  "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.mycycle",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.laundry.mycycle",
      "supportedCommands": [
        "cloud.smarthq.command.dryer.mycycle.mode.set"
      ],
      "state": {
        "myCycles": [
          {
            "fabricRefresh": 0.0,
            "timedDry": 1.0,
            "dampAlert": 1.0,
            "dryness": 2.0,
            "temperature": 1.0,
            "ecoDry": 1.0,
            "timeLevel": 1.0,
            "tangleControl": 1.0,
            "cycle": "cloud.smarthq.type.laundry.cycle.bulkyitems",
            "reduceStatic": 1.0,
            "wrinkleCare": 1.0,
            "sanitize": 1.0
          },
          {
            "fabricRefresh": 1.0,
            "timedDry": 1.0,
            "dampAlert": 1.0,
            "dryness": 1.0,
            "temperature": 1.0,
            "ecoDry": 0.0,
            "timeLevel": 1.0,
            "tangleControl": 0.0,
            "cycle": "cloud.smarthq.type.laundry.cycle.quickrinse",
            "reduceStatic": 0.0,
            "wrinkleCare": 0.0,
            "sanitize": 1.0
          }
        ]
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dryer",
      "config": {},
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

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
myCycles MYCYCLES No

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.mycycle.mode.set

Command to set the new mode for dryer my cycle.

Rules Engine Allowed Domains:

  • cloud.smarthq.domain.laundry.mycycle
Field Name Property Type Required
dampAlert INTEGER No
dryness INTEGER No
ecoDry INTEGER No
fabricRefresh INTEGER No
laundryAction STRING Yes
myCycle STRING Yes
reduceStatic INTEGER No
sanitize INTEGER No
signal INTEGER No
tangleControl INTEGER No
temperature INTEGER No
timeLevel INTEGER No
timedDry INTEGER No
wrinkleCare INTEGER No

Example Commands

MyCycle set command.

{
  "command": {
    "timedDry": 600.0,
    "fabricRefresh": 1.0,
    "laundryAction": "cloud.smarthq.type.laundry.mycycle.action.save",
    "commandType": "cloud.smarthq.command.dryer.mycycle.mode.set",
    "dampAlert": 0.0,
    "timeLevel": 2.0,
    "myCycle": "cloud.smarthq.type.laundry.cycle.basketclean",
    "dryness": 1.0,
    "temperature": 1.0,
    "ecoDry": 1.0,
    "tangleControl": 0.0,
    "signal": 54.0,
    "reduceStatic": 1.0,
    "wrinkleCare": 0.0,
    "sanitize": 1.0
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.laundry.mycycle",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.dryer",
  "serviceType": "cloud.smarthq.service.dryer.mycycle"
}

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

Data Types

INTEGER

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

STRING

Value must be a sequence of characters, inserted between " and " (double quotes). Field specific restrictions such as a regular expression may apply depending on the field.

MYCYCLES

Value must be a JSON array with json objects which attributes are: - cycle: Enum Value - temperature: Enum value - dryness: Enum value - ecoDry: boolean value - wrinklecare: boolean value - reduceStatic: boolean value - tangleControl: boolean value - fabricRefresh: Enum value