cloud.smarthq.service.dryer.config.cycle.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 a commercial dryer cycle configuration.

Example Device Response (Digital Twin API)¶

Service representing Commercial Laundry FL & TLS2 Dryer dry times cycle configuration.

{
  "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.config.cycle.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.dry.time",
      "supportedCommands": [
        "cloud.smarthq.command.dryer.config.cycle.v1.set.time"
      ],
      "state": {
        "optionHeatMediumMinutes": 50.0,
        "optionHeatNoneMinutes": 50.0,
        "adjustmentHeatMediumMinutes": 10.0,
        "adjustmentHeatLowMinutes": 10.0,
        "optionHeatHighMinutes": 50.0,
        "adjustmentHeatNoneMinutes": 10.0,
        "adjustmentHeatHighMinutes": 10.0,
        "optionHeatLowMinutes": 50.0
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dryer",
      "config": {
        "optionHeatHighDefault": 40.0,
        "adjustmentHeatHighDefault": 6.0,
        "totalTimeMaximum": 90.0,
        "optionHeatMediumDefault": 40.0,
        "optionHeatLowDefault": 40.0,
        "optionHeatNoneDefault": 40.0,
        "supportedOptions": [
          "cloud.smarthq.type.laundry.option.heat.high",
          "cloud.smarthq.type.laundry.option.heat.medium",
          "cloud.smarthq.type.laundry.option.heat.low",
          "cloud.smarthq.type.laundry.option.heat.noheat"
        ],
        "personality": "cloud.smarthq.type.laundry.personality.frontload",
        "adjustmentHeatNoneDefault": 6.0,
        "adjustmentHeatMediumDefault": 6.0,
        "configUnits": "cloud.smarthq.type.laundry.commercial.units.minutes",
        "supportedAdjustments": [
          "cloud.smarthq.type.laundry.option.heat.high",
          "cloud.smarthq.type.laundry.option.heat.medium",
          "cloud.smarthq.type.laundry.option.heat.low",
          "cloud.smarthq.type.laundry.option.heat.noheat"
        ],
        "adjustmentHeatLowDefault": 6.0,
        "totalTimeMinimum": 1.0
      },
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

Service representing Commercial Laundry FL & TLS2 Dryer dry temperatures cycle configuration.

{
  "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.config.cycle.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.dry.temperature",
      "supportedCommands": [
        "cloud.smarthq.command.dryer.config.cycle.v1.set.temperature"
      ],
      "state": {
        "optionHeatLowCelsiusConverted": 50.0,
        "optionHeatMediumCelsiusConverted": 60.0,
        "optionHeatLowFahrenheit": 122.0,
        "optionHeatMediumFahrenheit": 140.0,
        "optionHeatHighCelsiusConverted": 65.0,
        "optionHeatHighFahrenheit": 149.0
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.dryer",
      "config": {
        "fahrenheitMaximum": 149.0,
        "optionHeatMediumCelsiusDefaultConverted": 60.0,
        "optionHeatHighFahrenheitDefault": 149.0,
        "optionHeatLowFahrenheitDefault": 122.0,
        "fahrenheitMinimum": 32.0,
        "supportedOptions": [
          "cloud.smarthq.type.laundry.option.heat.high",
          "cloud.smarthq.type.laundry.option.heat.medium",
          "cloud.smarthq.type.laundry.option.heat.low"
        ],
        "personality": "cloud.smarthq.type.laundry.personality.frontload",
        "optionHeatHighCelsiusDefaultConverted": 65.0,
        "configUnits": "cloud.smarthq.type.laundry.commercial.units.temperature",
        "celsiusMaximumConverted": 65.0,
        "optionHeatLowCelsiusDefaultConverted": 50.0,
        "celsiusMinimumConverted": 0.0,
        "optionHeatMediumFahrenheitDefault": 140.0
      },
      "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	Minimum	Maximum	Calculated
adjustmentHeatHighDefault	INTEGER	No	0	100
adjustmentHeatLowDefault	INTEGER	No	0	100
adjustmentHeatMediumDefault	INTEGER	No	0	100
adjustmentHeatNoneDefault	INTEGER	No	0	100
celsiusMaximumConverted	DOUBLE	No			Yes
celsiusMinimumConverted	DOUBLE	No			Yes
configUnits	CONFIG_UNIT	Yes
fahrenheitMaximum	DOUBLE	No
fahrenheitMinimum	DOUBLE	No
optionHeatHighCelsiusDefaultConverted	DOUBLE	No			Yes
optionHeatHighDefault	INTEGER	No	0	100
optionHeatHighFahrenheitDefault	DOUBLE	No
optionHeatLowCelsiusDefaultConverted	DOUBLE	No			Yes
optionHeatLowDefault	INTEGER	No	0	100
optionHeatLowFahrenheitDefault	DOUBLE	No
optionHeatMediumCelsiusDefaultConverted	DOUBLE	No			Yes
optionHeatMediumDefault	INTEGER	No	0	100
optionHeatMediumFahrenheitDefault	DOUBLE	No
optionHeatNoneDefault	INTEGER	No	0	100
personality	LAUNDRY_PERSONALITY	Yes
supportedAdjustments	SET<LAUNDRY_HEAT_OPTION>	No
supportedOptions	SET<LAUNDRY_CYCLE_OPTION>	No
totalTimeMaximum	INTEGER	No	0	100
totalTimeMinimum	INTEGER	No	0	100

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	Maximum	Calculated
adjustmentHeatHighMinutes	INTEGER	No	0	100
adjustmentHeatLowMinutes	INTEGER	No	0	100
adjustmentHeatMediumMinutes	INTEGER	No	0	100
adjustmentHeatNoneMinutes	INTEGER	No	0	100
disabled	BOOLEAN	No
optionHeatHighCelsiusConverted	DOUBLE	No			Yes
optionHeatHighFahrenheit	DOUBLE	No
optionHeatHighMinutes	INTEGER	No	0	100
optionHeatLowCelsiusConverted	DOUBLE	No			Yes
optionHeatLowFahrenheit	DOUBLE	No
optionHeatLowMinutes	INTEGER	No	0	100
optionHeatMediumCelsiusConverted	DOUBLE	No			Yes
optionHeatMediumFahrenheit	DOUBLE	No
optionHeatMediumMinutes	INTEGER	No	0	100
optionHeatNoneMinutes	INTEGER	No	0	100

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.config.cycle.v1.set.time¶

Command used to set cycle dry times on Commercial Laundry dryers.

Field Name	Property Type	Required	Maximum
adjustmentHeatHighMinutes	INTEGER	No	100
adjustmentHeatLowMinutes	INTEGER	No	100
adjustmentHeatMediumMinutes	INTEGER	No	100
adjustmentHeatNoneMinutes	INTEGER	No	100
optionHeatHighMinutes	INTEGER	No	100
optionHeatLowMinutes	INTEGER	No	100
optionHeatMediumMinutes	INTEGER	No	100
optionHeatNoneMinutes	INTEGER	No	100

Example Commands¶

Command to set the cycle dry times on Commercial Laundry washers.

{
  "command": {
    "optionHeatMediumMinutes": 50.0,
    "commandType": "cloud.smarthq.command.dryer.config.cycle.v1.set.time",
    "optionHeatNoneMinutes": 50.0,
    "adjustmentHeatMediumMinutes": 10.0,
    "adjustmentHeatLowMinutes": 10.0,
    "optionHeatHighMinutes": 50.0,
    "adjustmentHeatNoneMinutes": 10.0,
    "adjustmentHeatHighMinutes": 10.0,
    "optionHeatLowMinutes": 50.0
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.dry.time",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.dryer",
  "serviceType": "cloud.smarthq.service.dryer.config.cycle.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.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

cloud.smarthq.command.dryer.config.cycle.v1.set.temperature¶

Command used to set cycle dry temperatures on Commercial Laundry FL dryers.

Field Name	Property Type	Required
optionHeatHighCelsius	DOUBLE	No
optionHeatHighFahrenheit	DOUBLE	No
optionHeatLowCelsius	DOUBLE	No
optionHeatLowFahrenheit	DOUBLE	No
optionHeatMediumCelsius	DOUBLE	No
optionHeatMediumFahrenheit	DOUBLE	No

Example Commands¶

Command to set the cycle dry temperaratures on a Commercial Laundry FL dryer.

{
  "command": {
    "commandType": "cloud.smarthq.command.dryer.config.cycle.v1.set.temperature",
    "optionHeatLowFahrenheit": 122.0,
    "optionHeatMediumFahrenheit": 140.0,
    "optionHeatHighFahrenheit": 149.0
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.dry.temperature",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.dryer",
  "serviceType": "cloud.smarthq.service.dryer.config.cycle.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.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.

INTEGER¶

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

CONFIG_UNIT¶

CONFIG_UNIT	Documentation
cloud.smarthq.type.laundry.commercial.units.minutes	Minutes
cloud.smarthq.type.laundry.commercial.units.rpm	Revolutions per Minute
cloud.smarthq.type.laundry.commercial.units.temperature	Temperature

LAUNDRY_PERSONALITY¶

LAUNDRY_PERSONALITY	Documentation
cloud.smarthq.type.laundry.personality.frontload	Front Load
cloud.smarthq.type.laundry.personality.topload	Top Load
cloud.smarthq.type.laundry.personality.topload.series2	Top Load Series2
cloud.smarthq.type.laundry.personality.unknown	Unknown

SET<LAUNDRY_CYCLE_OPTION>¶

SET<LAUNDRY_CYCLE_OPTION>	Documentation
cloud.smarthq.type.laundry.option.heat.disabled	Disabled
cloud.smarthq.type.laundry.option.heat.extralow	Extra Low
cloud.smarthq.type.laundry.option.heat.high	High
cloud.smarthq.type.laundry.option.heat.low	Low
cloud.smarthq.type.laundry.option.heat.medium	Medium
cloud.smarthq.type.laundry.option.heat.noheat	No Heat
cloud.smarthq.type.laundry.option.heat.unknown	Unknown
cloud.smarthq.type.laundry.option.rinse.extra	Extra Rinse
cloud.smarthq.type.laundry.option.soil.disabled	Disabled
cloud.smarthq.type.laundry.option.soil.extraheavy	Extra Heavy
cloud.smarthq.type.laundry.option.soil.extralight	Extra Light
cloud.smarthq.type.laundry.option.soil.heavy	Heavy
cloud.smarthq.type.laundry.option.soil.light	Light
cloud.smarthq.type.laundry.option.soil.medium	Medium
cloud.smarthq.type.laundry.option.soil.normal	Normal
cloud.smarthq.type.laundry.option.soil.unknown	Unknown

SET<LAUNDRY_HEAT_OPTION>¶

SET<LAUNDRY_HEAT_OPTION>	Documentation
cloud.smarthq.type.laundry.option.heat.disabled	Disabled
cloud.smarthq.type.laundry.option.heat.extralow	Extra Low
cloud.smarthq.type.laundry.option.heat.high	High
cloud.smarthq.type.laundry.option.heat.low	Low
cloud.smarthq.type.laundry.option.heat.medium	Medium
cloud.smarthq.type.laundry.option.heat.noheat	No Heat
cloud.smarthq.type.laundry.option.heat.unknown	Unknown