cloud.smarthq.service.dishwasher.state.legacy¶
Description¶
Service to model the dishwasher legacy state. This service represents the top level state of a dishwasher.
Example Device Response (Digital Twin API)¶
state Service of legacy 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.state.legacy",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.dishwasher",
"supportedCommands": [],
"state": {
"shortNameMode": "AUTOSENSE",
"cycleIndication": "cloud.smarthq.type.dishwasher.cycle.indication.no.change",
"runStatus": "cloud.smarthq.type.runstatus.active"
},
"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 | Minimum | Maximum |
|---|---|---|---|---|
| bottleWash | BOOLEAN | No | ||
| cycleIndication | CYCLE_INDICATION | No | ||
| delayStart | INTEGER | No | -2147483648 | 2147483647 |
| disabled | BOOLEAN | No | ||
| heatedDry | DISHWASHER_HEATED_DRY | No | ||
| runStatus | RUN_STATUS | No | ||
| shortNameMode | STRING | No | ||
| steam | BOOLEAN | No | ||
| washTemp | DISHWASHER_WASH_TEMP | No | ||
| washZone | DISHWASHER_WASH_ZONE | No |
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.
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.
CYCLE_INDICATION¶
| CYCLE_INDICATION | Documentation |
|---|---|
| cloud.smarthq.type.dishwasher.cycle.indication.auto.hot.start.1 | Auto Hot Start 1 |
| cloud.smarthq.type.dishwasher.cycle.indication.auto.hot.start.2 | Auto Hot Start 2 |
| cloud.smarthq.type.dishwasher.cycle.indication.auto.hot.start.3 | Auto Hot Start 3 |
| cloud.smarthq.type.dishwasher.cycle.indication.cycle.inactive | Cycle Inactive |
| cloud.smarthq.type.dishwasher.cycle.indication.divertercal | DiverterCal |
| cloud.smarthq.type.dishwasher.cycle.indication.drying | Drying |
| cloud.smarthq.type.dishwasher.cycle.indication.end.of.cycle | End of Cycle |
| cloud.smarthq.type.dishwasher.cycle.indication.end.prewash.1 | End PreWash 1 |
| cloud.smarthq.type.dishwasher.cycle.indication.final.rinse | Final Rinse |
| cloud.smarthq.type.dishwasher.cycle.indication.final.rinse.fill | Final Rinse Fill |
| cloud.smarthq.type.dishwasher.cycle.indication.mainwash | MainWash |
| cloud.smarthq.type.dishwasher.cycle.indication.no.change | No Change |
| cloud.smarthq.type.dishwasher.cycle.indication.pause | Pause |
| cloud.smarthq.type.dishwasher.cycle.indication.prewash | PreWash |
| cloud.smarthq.type.dishwasher.cycle.indication.prewash.1 | PreWash 1 |
| cloud.smarthq.type.dishwasher.cycle.indication.rinsing | Rinsing |
| cloud.smarthq.type.dishwasher.cycle.indication.sanitizing | Sanitizing |
| cloud.smarthq.type.dishwasher.cycle.indication.sensing | Sensing |
| cloud.smarthq.type.dishwasher.cycle.indication.turbiditycal | TurbidityCal |
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¶
| DISHWASHER_WASH_TEMP | Documentation |
|---|---|
| cloud.smarthq.type.dishwasher.washtemp.boost | Boost |
| cloud.smarthq.type.dishwasher.washtemp.none | None |
| cloud.smarthq.type.dishwasher.washtemp.onlysani | Only Sani |
| cloud.smarthq.type.dishwasher.washtemp.sani | Sani |
| cloud.smarthq.type.dishwasher.washtemp.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 |
RUN_STATUS¶
| RUN_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.runstatus.active | Active |
| cloud.smarthq.type.runstatus.complete | Complete |
| cloud.smarthq.type.runstatus.delay.pause | Delay Pause |
| cloud.smarthq.type.runstatus.delayed | Delayed |
| cloud.smarthq.type.runstatus.endofcycle | End of Cycle |
| cloud.smarthq.type.runstatus.feeding | Feeding |
| cloud.smarthq.type.runstatus.idle | Idle |
| cloud.smarthq.type.runstatus.in.progress | In Progress |
| cloud.smarthq.type.runstatus.off | Off |
| cloud.smarthq.type.runstatus.paused | Paused |
| cloud.smarthq.type.runstatus.running.480p | Running 480p |
| cloud.smarthq.type.runstatus.running.720p | Running 720p |
| cloud.smarthq.type.runstatus.standby | Standby |
| cloud.smarthq.type.runstatus.stopped | Stopped |
| cloud.smarthq.type.runstatus.unknown | Unknown |