cloud.smarthq.service.washer.mycycle¶
Description¶
Service for Washer My Cycle
Example Device Response (Digital Twin API)¶
MyCycle Service for Washer.
{
"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.mycycle",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.laundry.mycycle",
"supportedCommands": [
"cloud.smarthq.command.washer.mycycle.mode.set"
],
"state": {
"storedCycles": [
{
"spinLevel": 8.0,
"stainGuideRemoval": 6.0,
"waterTemperature": 7.0,
"flexDispenseMethod": 2.0,
"cycle": "cloud.smarthq.type.laundry.cycle.bulkyitems",
"fabricSoftener": 1.0,
"extraRinse": 1.0,
"powerCare": 5.0,
"noTangleWash": 1.0,
"trueRinse": 1.0,
"preWash": 2.0,
"autoSoakLevel": 4.0,
"soilLevel": 5.0,
"colorKeeper": 1.0,
"flexDispenseStage": 3.0,
"deepFill": 2.0
},
{
"spinLevel": 8.0,
"stainGuideRemoval": 6.0,
"waterTemperature": 7.0,
"flexDispenseMethod": 2.0,
"cycle": "cloud.smarthq.type.laundry.cycle.mycycle",
"fabricSoftener": 1.0,
"extraRinse": 1.0,
"powerCare": 5.0,
"noTangleWash": 1.0,
"trueRinse": 1.0,
"preWash": 2.0,
"autoSoakLevel": 4.0,
"soilLevel": 5.0,
"colorKeeper": 1.0,
"flexDispenseStage": 3.0,
"deepFill": 2.0
}
]
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.washer",
"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 |
|---|---|---|
| storedCycles | WASHER_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.washer.mycycle.mode.set¶
Command to set the new mode for washer my cycle.
Rules Engine Allowed Domains:
- cloud.smarthq.domain.laundry.mycycle
| Field Name | Property Type | Required |
|---|---|---|
| autoSoakLevel | INTEGER | No |
| colorKeeper | INTEGER | No |
| deepFill | INTEGER | No |
| extraRinse | INTEGER | No |
| fabricSoftener | INTEGER | No |
| flexDispenseMethod | INTEGER | No |
| flexDispenseStage | INTEGER | No |
| laundryAction | STRING | Yes |
| myCycle | STRING | Yes |
| noTangleWash | INTEGER | No |
| powerCare | INTEGER | No |
| preWash | INTEGER | No |
| requestedId | LONG | No |
| soilLevel | INTEGER | No |
| spinLevel | INTEGER | No |
| stainGuideRemoval | INTEGER | No |
| trueRinse | INTEGER | No |
| waterTemperature | INTEGER | No |
Example Commands¶
MyCycle set command.
{
"command": {
"laundryAction": "cloud.smarthq.type.laundry.mycycle.action.save",
"spinLevel": 8.0,
"commandType": "cloud.smarthq.command.washer.mycycle.mode.set",
"stainGuideRemoval": 6.0,
"waterTemperature": 7.0,
"flexDispenseMethod": 2.0,
"fabricSoftener": 1.0,
"extraRinse": 1.0,
"powerCare": 5.0,
"myCycle": "cloud.smarthq.type.laundry.cycle.basketclean",
"noTangleWash": 1.0,
"trueRinse": 1.0,
"preWash": 2.0,
"autoSoakLevel": 4.0,
"requestedId": 1.23456789E9,
"soilLevel": 5.0,
"colorKeeper": 1.0,
"flexDispenseStage": 3.0,
"deepFill": 2.0
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.laundry.mycycle",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.washer.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.
LONG¶
Value must be a long. Field specific restrictions such as a minimum and maximum may apply depending on the field.
WASHER_MYCYCLES¶
TODO: Newly defined type needs documentation written.