Skip to content

cloud.smarthq.service.washer.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 washer cycle configuration.

Example Device Response (Digital Twin API)

Service representing Commercial Laundry TLS2 Washer wash time cycle configuration.

{
  "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.washer.config.cycle.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.wash.time",
      "supportedCommands": [
        "cloud.smarthq.command.washer.config.cycle.v1.set.time"
      ],
      "state": {
        "cycleWashWhitesDelta": 2.0,
        "cycleWashColorsDelta": 3.0,
        "cycleWashColors": 9.0,
        "cycleWashSpeedDelta": 1.0,
        "cycleWashDeepClean": 13.0,
        "cycleWashDelicates": 8.0,
        "cycleWashDelicatesDelta": 2.0,
        "cycleWashDeepCleanDelta": 2.0,
        "cycleWashWhites": 10.0,
        "cycleWashTowels": 11.0,
        "cycleWashTowelsDelta": 1.0,
        "disabled": false,
        "cycleWashSpeed": 5.0
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.washer",
      "config": {
        "cycleWashColorsMiddleMaximum": 9.0,
        "cycleWashDelicatesMiddleMaximum": 14.0,
        "cycleWashDeepCleanMiddleMaximum": 14.0,
        "cycleWashDeepCleanTotalMinimum": 4.0,
        "supportedCycles": [
          "cloud.smarthq.type.laundry.cycle.colors",
          "cloud.smarthq.type.laundry.cycle.whites",
          "cloud.smarthq.type.laundry.cycle.towelssheets",
          "cloud.smarthq.type.laundry.cycle.delicates",
          "cloud.smarthq.type.laundry.cycle.speedwash",
          "cloud.smarthq.type.laundry.cycle.deepclean"
        ],
        "cycleWashSpeedTotalMinimum": 4.0,
        "cycleWashTowelsMiddleMinimum": 5.0,
        "personality": "cloud.smarthq.type.laundry.personality.topload.series2",
        "cycleWashDelicatesTotalMinimum": 4.0,
        "cycleWashSpeedTotalMaximum": 12.0,
        "cycleWashSpeedMiddleMinimum": 5.0,
        "cycleWashDelicatesMiddleMinimum": 5.0,
        "cycleWashTowelsTotalMaximum": 12.0,
        "cycleWashDeepCleanTotalMaximum": 15.0,
        "cycleWashDelicatesTotalMaximum": 15.0,
        "cycleWashWhitesTotalMinimum": 4.0,
        "cycleWashTowelsMiddleMaximum": 11.0,
        "cycleWashTowelsTotalMinimum": 4.0,
        "cycleWashWhitesMiddleMinimum": 5.0,
        "cycleWashWhitesTotalMaximum": 12.0,
        "cycleWashSpeedMiddleMaximum": 11.0,
        "cycleWashColorsMiddleMinimum": 5.0,
        "configUnits": "cloud.smarthq.type.laundry.commercial.units.minutes",
        "cycleWashColorsTotalMaximum": 12.0,
        "cycleWashDeepCleanMiddleMinimum": 5.0,
        "cycleWashWhitesMiddleMaximum": 11.0,
        "cycleWashColorsTotalMinimum": 4.0
      },
      "lastStateTime": "2022-03-04T12:12:12.123Z"
    }
  ],
  "userId": "000000000000000"
}

Service representing Commercial Laundry FL Washer spin speed cycle configuration.

{
  "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.washer.config.cycle.v1",
      "lastSyncTime": "2022-03-04T12:12:12.123Z",
      "domainType": "cloud.smarthq.domain.spin.speed",
      "supportedCommands": [
        "cloud.smarthq.command.washer.config.cycle.v1.set.spinspeed"
      ],
      "state": {
        "cycleWashCold": 1050.0,
        "cycleWashHot": 800.0,
        "disabled": false,
        "cycleWashWarm": 1050.0
      },
      "serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
      "serviceDeviceType": "cloud.smarthq.device.washer",
      "config": {
        "supportedCycles": [
          "cloud.smarthq.type.laundry.cycle.coldwash",
          "cloud.smarthq.type.laundry.cycle.warmwash",
          "cloud.smarthq.type.laundry.cycle.hotwash"
        ],
        "allowedValues": [
          800.0,
          1050.0
        ],
        "personality": "cloud.smarthq.type.laundry.personality.frontload",
        "configUnits": "cloud.smarthq.type.laundry.commercial.units.rpm"
      },
      "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
allowedValues INTEGER_ARRAY No
configUnits CONFIG_UNIT Yes
cycleWashColorsMiddleMaximum INTEGER No 0 100
cycleWashColorsMiddleMinimum INTEGER No 0 100
cycleWashColorsTotalMaximum INTEGER No 0 100
cycleWashColorsTotalMinimum INTEGER No 0 100
cycleWashDeepCleanMiddleMaximum INTEGER No 0 100
cycleWashDeepCleanMiddleMinimum INTEGER No 0 100
cycleWashDeepCleanTotalMaximum INTEGER No 0 100
cycleWashDeepCleanTotalMinimum INTEGER No 0 100
cycleWashDelicatesMiddleMaximum INTEGER No 0 100
cycleWashDelicatesMiddleMinimum INTEGER No 0 100
cycleWashDelicatesTotalMaximum INTEGER No 0 100
cycleWashDelicatesTotalMinimum INTEGER No 0 100
cycleWashSpeedMiddleMaximum INTEGER No 0 100
cycleWashSpeedMiddleMinimum INTEGER No 0 100
cycleWashSpeedTotalMaximum INTEGER No 0 100
cycleWashSpeedTotalMinimum INTEGER No 0 100
cycleWashTowelsMiddleMaximum INTEGER No 0 100
cycleWashTowelsMiddleMinimum INTEGER No 0 100
cycleWashTowelsTotalMaximum INTEGER No 0 100
cycleWashTowelsTotalMinimum INTEGER No 0 100
cycleWashWhitesMiddleMaximum INTEGER No 0 100
cycleWashWhitesMiddleMinimum INTEGER No 0 100
cycleWashWhitesTotalMaximum INTEGER No 0 100
cycleWashWhitesTotalMinimum INTEGER No 0 100
personality LAUNDRY_PERSONALITY Yes
supportedCycles SET<LAUNDRY_CYCLE> 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 Maximum
cycleWashCold INTEGER No 0 2000
cycleWashColors INTEGER No 0 100
cycleWashColorsDelta INTEGER No 0 100
cycleWashDeepClean INTEGER No 0 100
cycleWashDeepCleanDelta INTEGER No 0 100
cycleWashDelicates INTEGER No 0 100
cycleWashDelicatesDelta INTEGER No 0 100
cycleWashHot INTEGER No 0 2000
cycleWashSpeed INTEGER No 0 100
cycleWashSpeedDelta INTEGER No 0 100
cycleWashTowels INTEGER No 0 100
cycleWashTowelsDelta INTEGER No 0 100
cycleWashWarm INTEGER No 0 2000
cycleWashWhites INTEGER No 0 100
cycleWashWhitesDelta INTEGER No 0 100
disabled BOOLEAN 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.washer.config.cycle.v1.set.time

Command used to set cycle wash times on Commercial Laundry TLS2 washers.

Field Name Property Type Required Minimum Maximum
cycleWashColors INTEGER No 0 100
cycleWashColorsDelta INTEGER No 0 100
cycleWashDeepClean INTEGER No 0 100
cycleWashDeepCleanDelta INTEGER No 0 100
cycleWashDelicates INTEGER No 0 100
cycleWashDelicatesDelta INTEGER No 0 100
cycleWashSpeed INTEGER No 0 100
cycleWashSpeedDelta INTEGER No 0 100
cycleWashTowels INTEGER No 0 100
cycleWashTowelsDelta INTEGER No 0 100
cycleWashWhites INTEGER No 0 100
cycleWashWhitesDelta INTEGER No 0 100

Example Commands

Command to set the cycle wash times on a Commercial Laundry TLS2 Washer.

{
  "command": {
    "cycleWashWhitesDelta": 2.0,
    "commandType": "cloud.smarthq.command.washer.config.cycle.v1.set.time",
    "cycleWashColorsDelta": 3.0,
    "cycleWashColors": 9.0,
    "cycleWashSpeedDelta": 1.0,
    "cycleWashDeepClean": 13.0,
    "cycleWashDelicates": 8.0,
    "cycleWashDelicatesDelta": 2.0,
    "cycleWashDeepCleanDelta": 2.0,
    "cycleWashWhites": 10.0,
    "cycleWashTowels": 11.0,
    "cycleWashTowelsDelta": 1.0,
    "cycleWashSpeed": 5.0
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.wash.time",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.washer",
  "serviceType": "cloud.smarthq.service.washer.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.washer.config.cycle.v1.set.spinspeed

Command used to set cycle spin speeds on Commercial Laundry FL washers.

Field Name Property Type Required Minimum Maximum
cycleWashCold INTEGER No 0 2000
cycleWashHot INTEGER No 0 2000
cycleWashWarm INTEGER No 0 2000

Example Commands

Command to set the cycle spin speeds on a Commercial Laundry FL Washer.

{
  "command": {
    "cycleWashCold": 1050.0,
    "commandType": "cloud.smarthq.command.washer.config.cycle.v1.set.spinspeed",
    "cycleWashHot": 800.0,
    "cycleWashWarm": 1050.0
  },
  "deviceId": "00000000000000000000000000000000000000000000000000000000000000",
  "domainType": "cloud.smarthq.domain.spin.speed",
  "kind": "service#command",
  "serviceDeviceType": "cloud.smarthq.device.washer",
  "serviceType": "cloud.smarthq.service.washer.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.

INTEGER

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

INTEGER_ARRAY

Value must be an array of integers.

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>

SET<LAUNDRY_CYCLE> Documentation
cloud.smarthq.type.laundry.cycle.activewear Active Wear
cloud.smarthq.type.laundry.cycle.adaptivemysettings Adaptive Settings
cloud.smarthq.type.laundry.cycle.allergen Allergen
cloud.smarthq.type.laundry.cycle.antibacterial Antibacterial
cloud.smarthq.type.laundry.cycle.assistant Laundry Assistant
cloud.smarthq.type.laundry.cycle.autodampdry Auto Damp Dry
cloud.smarthq.type.laundry.cycle.autodry Auto Dry
cloud.smarthq.type.laundry.cycle.autoextradry Auto Extra Dry
cloud.smarthq.type.laundry.cycle.babycare Baby Care
cloud.smarthq.type.laundry.cycle.basketclean Basket Clean
cloud.smarthq.type.laundry.cycle.bulkybedding Bulky Bedding
cloud.smarthq.type.laundry.cycle.bulkyitems Bulky Items
cloud.smarthq.type.laundry.cycle.c20 20 C
cloud.smarthq.type.laundry.cycle.casuals Casuals
cloud.smarthq.type.laundry.cycle.casualswithsteam Casuals with Steam
cloud.smarthq.type.laundry.cycle.coldwash Cold Wash
cloud.smarthq.type.laundry.cycle.colors Colors
cloud.smarthq.type.laundry.cycle.coolair Cool Air
cloud.smarthq.type.laundry.cycle.cottons Cottons
cloud.smarthq.type.laundry.cycle.darks Dark Colors
cloud.smarthq.type.laundry.cycle.deepclean Deep Clean
cloud.smarthq.type.laundry.cycle.delicaterefresh Delicate Refresh
cloud.smarthq.type.laundry.cycle.delicates Delicates
cloud.smarthq.type.laundry.cycle.denim Denim
cloud.smarthq.type.laundry.cycle.dewrinkle DeWrinkle
cloud.smarthq.type.laundry.cycle.down Down
cloud.smarthq.type.laundry.cycle.downloadablecycle Download Cycle
cloud.smarthq.type.laundry.cycle.drainandspin Drain and Spin
cloud.smarthq.type.laundry.cycle.drumclean Drum Clean
cloud.smarthq.type.laundry.cycle.drumlight Drum Light
cloud.smarthq.type.laundry.cycle.durable Durable
cloud.smarthq.type.laundry.cycle.duvet Duvet
cloud.smarthq.type.laundry.cycle.easycare Easy Care
cloud.smarthq.type.laundry.cycle.easyiron Easy Iron
cloud.smarthq.type.laundry.cycle.eco Eco
cloud.smarthq.type.laundry.cycle.eco4060 Eco 40-60
cloud.smarthq.type.laundry.cycle.ecocool Eco Cool
cloud.smarthq.type.laundry.cycle.energysaver Energy Saver
cloud.smarthq.type.laundry.cycle.everyday Everyday
cloud.smarthq.type.laundry.cycle.express Express
cloud.smarthq.type.laundry.cycle.flexdispense The flex Dispense Adjustability
cloud.smarthq.type.laundry.cycle.freshen Freshen
cloud.smarthq.type.laundry.cycle.handwash Hand Wash
cloud.smarthq.type.laundry.cycle.heavy Heavy
cloud.smarthq.type.laundry.cycle.heavyduty Heavy Duty
cloud.smarthq.type.laundry.cycle.hotwash Hot Wash
cloud.smarthq.type.laundry.cycle.hygiene Hygiene
cloud.smarthq.type.laundry.cycle.jeans Jeans
cloud.smarthq.type.laundry.cycle.kidsitem Kids Item
cloud.smarthq.type.laundry.cycle.leather Leather
cloud.smarthq.type.laundry.cycle.light Light
cloud.smarthq.type.laundry.cycle.mix Mix
cloud.smarthq.type.laundry.cycle.mixed Mixed
cloud.smarthq.type.laundry.cycle.mixedrefresh Mixed Refresh
cloud.smarthq.type.laundry.cycle.moredry More dry
cloud.smarthq.type.laundry.cycle.morewater Incremental Fill
cloud.smarthq.type.laundry.cycle.mycycle The Remote My Cycle cycle
cloud.smarthq.type.laundry.cycle.nightdry Night Dry
cloud.smarthq.type.laundry.cycle.normal Normal
cloud.smarthq.type.laundry.cycle.normalormixed Normal or Mixed Load
cloud.smarthq.type.laundry.cycle.order.scent order scent
cloud.smarthq.type.laundry.cycle.order.tide order tide
cloud.smarthq.type.laundry.cycle.outdoor Outdoor
cloud.smarthq.type.laundry.cycle.outerwear Outerwear
cloud.smarthq.type.laundry.cycle.pantscrease Pants Crease
cloud.smarthq.type.laundry.cycle.permpress Perm Press
cloud.smarthq.type.laundry.cycle.powerclean Power Clean
cloud.smarthq.type.laundry.cycle.powersteam Power Steam
cloud.smarthq.type.laundry.cycle.preiron Pre Iron
cloud.smarthq.type.laundry.cycle.quick15 Quick 15
cloud.smarthq.type.laundry.cycle.quick30 Quick 30
cloud.smarthq.type.laundry.cycle.quickairfluff Quick or Airfluff
cloud.smarthq.type.laundry.cycle.quickcycle Quick Cycle
cloud.smarthq.type.laundry.cycle.quickdry Quick Dry
cloud.smarthq.type.laundry.cycle.quickrinse Quick Rinse
cloud.smarthq.type.laundry.cycle.quickwash Quick Wash
cloud.smarthq.type.laundry.cycle.quietwash Quiet
cloud.smarthq.type.laundry.cycle.rackdry Rack Dry
cloud.smarthq.type.laundry.cycle.rainorsnow Rain or Snow
cloud.smarthq.type.laundry.cycle.refresh Refresh
cloud.smarthq.type.laundry.cycle.rinseanddry Rinse and Dry
cloud.smarthq.type.laundry.cycle.rinseandspin Rinse and Spin
cloud.smarthq.type.laundry.cycle.sanitiserefresh Sanitise Refresh
cloud.smarthq.type.laundry.cycle.sanitize Sanitize
cloud.smarthq.type.laundry.cycle.sanitizeandallergen Sanitize + Allergen
cloud.smarthq.type.laundry.cycle.sanitizesteam Sanitize Steam
cloud.smarthq.type.laundry.cycle.sanitizewithoxi Sanitize with Oxi
cloud.smarthq.type.laundry.cycle.scent Scent
cloud.smarthq.type.laundry.cycle.selfclean Self Clean
cloud.smarthq.type.laundry.cycle.sheets Sheets
cloud.smarthq.type.laundry.cycle.shirts Shirts
cloud.smarthq.type.laundry.cycle.shirtsrefresh Shirts Refresh
cloud.smarthq.type.laundry.cycle.shoes Shoes
cloud.smarthq.type.laundry.cycle.silk Silk
cloud.smarthq.type.laundry.cycle.singleitem Single Item Wash
cloud.smarthq.type.laundry.cycle.smartdispense The smart Dispense Adjustability
cloud.smarthq.type.laundry.cycle.smartvent Smart Vent
cloud.smarthq.type.laundry.cycle.sneakers Sneakers
cloud.smarthq.type.laundry.cycle.soak Soak
cloud.smarthq.type.laundry.cycle.softtoys Soft Toys
cloud.smarthq.type.laundry.cycle.speeddry Speed Dry
cloud.smarthq.type.laundry.cycle.speedwash Speed Wash
cloud.smarthq.type.laundry.cycle.spinonly Spin Only
cloud.smarthq.type.laundry.cycle.sports Sports
cloud.smarthq.type.laundry.cycle.stainremoval Stain Removal
cloud.smarthq.type.laundry.cycle.stainwashwithsteam Stain Wash with Steam
cloud.smarthq.type.laundry.cycle.steamdewrinkle Steam Dewrinkle
cloud.smarthq.type.laundry.cycle.steamfresh Steam Fresh
cloud.smarthq.type.laundry.cycle.steamnormal Steam Normal
cloud.smarthq.type.laundry.cycle.steamrefresh Steam Refresh
cloud.smarthq.type.laundry.cycle.steamsanitize Steam Sanitize
cloud.smarthq.type.laundry.cycle.steamtowels Steam Towels
cloud.smarthq.type.laundry.cycle.steamwhites Steam Whites
cloud.smarthq.type.laundry.cycle.suitsorcoats Suits or Coats
cloud.smarthq.type.laundry.cycle.swimwear Swimwear
cloud.smarthq.type.laundry.cycle.synthetics Synthetics
cloud.smarthq.type.laundry.cycle.timeddry Timed Dry
cloud.smarthq.type.laundry.cycle.towels Towels
cloud.smarthq.type.laundry.cycle.towelssheets Towels or Sheets
cloud.smarthq.type.laundry.cycle.tubclean Tub Clean
cloud.smarthq.type.laundry.cycle.tumblecare Tumble Care
cloud.smarthq.type.laundry.cycle.ultradelicate Ultra Delicate
cloud.smarthq.type.laundry.cycle.ultrafreshvent Ultra Fresh Vent
cloud.smarthq.type.laundry.cycle.undefined Undefined
cloud.smarthq.type.laundry.cycle.warmup Warm Up
cloud.smarthq.type.laundry.cycle.warmwash Warm Wash
cloud.smarthq.type.laundry.cycle.washcomplete Wash complete
cloud.smarthq.type.laundry.cycle.washerlink Washer Link
cloud.smarthq.type.laundry.cycle.waterstation Water Station
cloud.smarthq.type.laundry.cycle.whites Whites
cloud.smarthq.type.laundry.cycle.wool Wool
cloud.smarthq.type.laundry.cycle.woolorknit Wool or Knit