cloud.smarthq.service.dishwasher.favorites¶
Description¶
Service for Dish favorite modes
Example Device Response (Digital Twin API)¶
Service for controlling Dishwasher.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.dishwasher",
"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.dishwasher.favorites",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.favorites",
"supportedCommands": [
"cloud.smarthq.command.dishwasher.favorites.set"
],
"state": {
"washZone": "cloud.smarthq.type.dishwasher.washzone.upper",
"washTemp": "cloud.smarthq.type.dishwasher.washtemp.options.none",
"delayStartInMinutes": 0.0,
"validStoredSettings": true,
"selectedCycleIndex": 1.0,
"silverWarewash": false,
"steam": false,
"bottleBlast": false,
"heatedDry": "cloud.smarthq.type.dishwasher.heateddry.none"
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.dishwasher",
"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 |
|---|---|---|
| bottleBlast | BOOLEAN | Yes |
| delayStartInMinutes | INTEGER | Yes |
| heatedDry | DISHWASHER_HEATED_DRY | Yes |
| selectedCycleIndex | INTEGER | Yes |
| silverWarewash | BOOLEAN | Yes |
| steam | BOOLEAN | Yes |
| validStoredSettings | BOOLEAN | Yes |
| washTemp | DISHWASHER_WASH_TEMP_OPTIONS | Yes |
| washZone | DISHWASHER_WASH_ZONE | 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.dishwasher.favorites.set¶
Command used to set a favorite mode on a dishwasher. The specific config for the mode service determines which properties can be used and which ones are required.
| Field Name | Property Type | Required |
|---|---|---|
| bottleBlast | BOOLEAN | Yes |
| delayStartInMinutes | INTEGER | Yes |
| heatedDry | DISHWASHER_HEATED_DRY | Yes |
| selectedCycleIndex | INTEGER | Yes |
| silverWarewash | BOOLEAN | Yes |
| steam | BOOLEAN | Yes |
| washTemp | DISHWASHER_WASH_TEMP_OPTIONS | Yes |
| washZone | DISHWASHER_WASH_ZONE | Yes |
Example Commands¶
Command to set a favorite on dishwasher.
{
"command": {
"commandType": "cloud.smarthq.command.dishwasher.favorites.set",
"washZone": "cloud.smarthq.type.dishwasher.washzone.upper",
"washTemp": "cloud.smarthq.type.dishwasher.washtemp.options.none",
"delayStartInMinutes": 0.0,
"selectedCycleIndex": 1.0,
"silverWarewash": true,
"steam": true,
"bottleBlast": true,
"heatedDry": "cloud.smarthq.type.dishwasher.heateddry.none"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.favorites",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.dishwasher",
"serviceType": "cloud.smarthq.service.dishwasher.favorites"
}
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.
DISHWASHER_HEATED_DRY¶
| DISHWASHER_HEATED_DRY | Documentation |
|---|---|
| cloud.smarthq.type.dishwasher.heateddry.addedheat | Added Heat |
| cloud.smarthq.type.dishwasher.heateddry.maxdry | Max Dry |
| cloud.smarthq.type.dishwasher.heateddry.none | None |
DISHWASHER_WASH_TEMP_OPTIONS¶
| DISHWASHER_WASH_TEMP_OPTIONS | Documentation |
|---|---|
| cloud.smarthq.type.dishwasher.washtemp.options.boost | Boost |
| cloud.smarthq.type.dishwasher.washtemp.options.none | None |
| cloud.smarthq.type.dishwasher.washtemp.options.sani | Sani |
| cloud.smarthq.type.dishwasher.washtemp.options.saniandboost | Sani and Boost |
DISHWASHER_WASH_ZONE¶
| DISHWASHER_WASH_ZONE | Documentation |
|---|---|
| cloud.smarthq.type.dishwasher.washzone.both | Both |
| cloud.smarthq.type.dishwasher.washzone.lower | Lower |
| cloud.smarthq.type.dishwasher.washzone.upper | Upper |