cloud.smarthq.service.dishwasher.state.v1¶
Description¶
Service to model the dishwasher state is used in conjunction with the dishwasher mode service. This service represents the top level state of a dishwasher.
Example Device Response (Digital Twin API)¶
state Service of 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.v1",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.dishwasher",
"supportedCommands": [
"cloud.smarthq.command.dishwasher.state.v1.start",
"cloud.smarthq.command.dishwasher.state.v1.stop",
"cloud.smarthq.command.dishwasher.state.v1.pause"
],
"state": {
"mode": "cloud.smarthq.domain.dishwasher.autosense",
"cycleIndication": "cloud.smarthq.type.dishwasher.cycle.indication.no.change",
"runStatus": "cloud.smarthq.type.runstatus.active"
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.dishwasher",
"config": {
"remoteStartSupported": true
},
"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 |
---|---|---|
remoteStartSupported | BOOLEAN | Yes |
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 |
---|---|---|
boostTemperature | BOOLEAN | No |
bottleWash | BOOLEAN | No |
canStart | BOOLEAN | No |
cycleIndication | CYCLE_INDICATION | Yes |
delayStart | INTEGER | No |
disabled | BOOLEAN | No |
heatedDry | DISHWASHER_HEATED_DRY | No |
mode | DISHWASHER_MODE_DOMAIN | Yes |
remoteEnable | BOOLEAN | No |
runStatus | RUN_STATUS | Yes |
sani | BOOLEAN | No |
silverwareWash | BOOLEAN | No |
steam | BOOLEAN | No |
washZone | DISHWASHER_WASH_ZONE | 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.dishwasher.state.v1.start¶
Command used to start/resume a dishwasher that canStart.
Example Commands¶
dishwasher start/resume command
{
"command": {
"commandType": "cloud.smarthq.command.dishwasher.state.v1.start"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.dishwasher",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.dishwasher",
"serviceType": "cloud.smarthq.service.dishwasher.state.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.dishwasher.state.v1.stop¶
Command used to stop a dishwasher.
Example Commands¶
dishwasher stop command
{
"command": {
"commandType": "cloud.smarthq.command.dishwasher.state.v1.stop"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.dishwasher",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.dishwasher",
"serviceType": "cloud.smarthq.service.dishwasher.state.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.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.dishwasher.state.v1.pause¶
Command used to pause a dishwasher.
Example Commands¶
dishwasher pause command
{
"command": {
"commandType": "cloud.smarthq.command.dishwasher.state.v1.pause"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.dishwasher",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.dishwasher",
"serviceType": "cloud.smarthq.service.dishwasher.state.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.
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_MODE_DOMAIN¶
DISHWASHER_MODE_DOMAIN | Documentation |
---|---|
cloud.smarthq.domain.dishwasher.auto | The Auto dishwasher cycle |
cloud.smarthq.domain.dishwasher.autosense | The Auto Sense dishwasher cycle |
cloud.smarthq.domain.dishwasher.autowash | The Auto Wash dishwasher cycle |
cloud.smarthq.domain.dishwasher.babycare | The Baby Care dishwasher cycle |
cloud.smarthq.domain.dishwasher.brand.cascade.platinumplus | The Cascade Platinum Plus dishwasher cycle |
cloud.smarthq.domain.dishwasher.china | The China dishwasher cycle |
cloud.smarthq.domain.dishwasher.cookware | The cookware dishwasher cycle |
cloud.smarthq.domain.dishwasher.crystal | The Crystal dishwasher cycle |
cloud.smarthq.domain.dishwasher.custom | The Custom Dishwasher Cycle |
cloud.smarthq.domain.dishwasher.delicate | The Delicate dishwasher cycle |
cloud.smarthq.domain.dishwasher.dishwasher.cleaning | The Dishwasher Cleaning dishwasher cycle |
cloud.smarthq.domain.dishwasher.eco | The Eco dishwasher cycle |
cloud.smarthq.domain.dishwasher.everyday | The Everyday dishwasher cycle |
cloud.smarthq.domain.dishwasher.express | The Express dishwasher cycle |
cloud.smarthq.domain.dishwasher.gentle | The gentle dishwasher cycle |
cloud.smarthq.domain.dishwasher.glass | The Glass dishwasher cycle |
cloud.smarthq.domain.dishwasher.heavy | The Heavy dishwasher cycle |
cloud.smarthq.domain.dishwasher.heavyduty | The HeavyDuty dishwasher cycle |
cloud.smarthq.domain.dishwasher.hydrosave | The HydroSave dishwasher cycle |
cloud.smarthq.domain.dishwasher.intense | The Intense dishwasher cycle |
cloud.smarthq.domain.dishwasher.light | The Light dishwasher cycle |
cloud.smarthq.domain.dishwasher.medium | The Medium dishwasher cycle |
cloud.smarthq.domain.dishwasher.normal | The Normal dishwasher cycle |
cloud.smarthq.domain.dishwasher.pots | The Pots dishwasher cycle |
cloud.smarthq.domain.dishwasher.preprinse | The PrepRinse dishwasher cycle |
cloud.smarthq.domain.dishwasher.quick | The Quick dishwasher cycle |
cloud.smarthq.domain.dishwasher.quiet | The Quiet dishwasher cycle |
cloud.smarthq.domain.dishwasher.quiet2 | The Quiet2 dishwasher cycle |
cloud.smarthq.domain.dishwasher.rinse | The Rinse dishwasher cycle |
cloud.smarthq.domain.dishwasher.smart | The Smart dishwasher cycle |
cloud.smarthq.domain.dishwasher.steam | The Steam dishwasher cycle |
cloud.smarthq.domain.dishwasher.timed.hours.1 | The 1 Hour Wash dishwasher cycle |
cloud.smarthq.domain.dishwasher.timed.hours.1.and.dry | The 1 Hr Wash and Dry dishwasher cycle |
cloud.smarthq.domain.dishwasher.timed.minutes.30 | The 30 Minutes dishwasher cycle |
cloud.smarthq.domain.dishwasher.timesaver | The Time Saver dishwasher cycle |
cloud.smarthq.domain.dishwasher.unknown | Undefined |
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.delayed | Delayed |
cloud.smarthq.type.runstatus.endofcycle | End of Cycle |
cloud.smarthq.type.runstatus.idle | Idle |
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 |