cloud.smarthq.service.mode¶
Description¶
Service to model a mode that represents a selection from a pre-defined list of options. The available options are defined by an enumeration and then the service config selects which of those are available.
Example Device Response (Digital Twin API)¶
Mode Service for Hood Light Brightness.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.hood",
"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.mode",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.brightness",
"supportedCommands": [
"cloud.smarthq.command.mode.set"
],
"state": {
"mode": "cloud.smarthq.type.mode.off"
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.hood.light",
"config": {
"ordered": true,
"supportedModes": [
"cloud.smarthq.type.mode.off",
"cloud.smarthq.type.mode.dim",
"cloud.smarthq.type.mode.high"
]
},
"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 |
|---|---|---|
| ordered | BOOLEAN | No |
| supportedModes | SET<MODE> | 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 |
|---|---|---|
| disabled | BOOLEAN | No |
| mode | MODE | 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.mode.set¶
Command used to set the new mode on the mode service.
| Field Name | Property Type | Required |
|---|---|---|
| mode | MODE | Yes |
Example Commands¶
Command to set the hood light mode.
{
"command": {
"mode": "cloud.smarthq.type.mode.off",
"commandType": "cloud.smarthq.command.mode.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.brightness",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.hood.light",
"serviceType": "cloud.smarthq.service.mode"
}
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 |
| cloud.smarthq.outcome.unavailablemode | The mode is unavailable. |
Data Types¶
BOOLEAN¶
Value must be either true or false.
MODE¶
| MODE | Documentation |
|---|---|
| cloud.smarthq.type.mode.auto | Automatic |
| cloud.smarthq.type.mode.beep | Beep |
| cloud.smarthq.type.mode.beverages | Beverages |
| cloud.smarthq.type.mode.blocked | Blocked |
| cloud.smarthq.type.mode.blood | Blood |
| cloud.smarthq.type.mode.boost | Boost |
| cloud.smarthq.type.mode.bypass | Bypass |
| cloud.smarthq.type.mode.cancel | Cancel |
| cloud.smarthq.type.mode.celsius | Celsius |
| cloud.smarthq.type.mode.circulate | Circulate |
| cloud.smarthq.type.mode.clean | Clean |
| cloud.smarthq.type.mode.closed | Closed |
| cloud.smarthq.type.mode.cold | Cold |
| cloud.smarthq.type.mode.colors | Colors |
| cloud.smarthq.type.mode.complete | Complete |
| cloud.smarthq.type.mode.continuous | Continuous |
| cloud.smarthq.type.mode.control.centraldesk | Central Desk Control |
| cloud.smarthq.type.mode.control.occupancy | Occupancy Control |
| cloud.smarthq.type.mode.convertibledrawer.mode1 | Convertible Drawer Mode 1 |
| cloud.smarthq.type.mode.convertibledrawer.mode2 | Convertible Drawer Mode 2 |
| cloud.smarthq.type.mode.convertibledrawer.mode3 | Convertible Drawer Mode 3 |
| cloud.smarthq.type.mode.convertibledrawer.mode4 | Convertible Drawer Mode 4 |
| cloud.smarthq.type.mode.convertibledrawer.mode5 | Convertible Drawer Mode 5 |
| cloud.smarthq.type.mode.convertibledrawer.mode6 | Convertible Drawer Mode 6 |
| cloud.smarthq.type.mode.convertibledrawer.mode7 | Convertible Drawer Mode 7 |
| cloud.smarthq.type.mode.cooking.cavity.lower | The lower door open |
| cloud.smarthq.type.mode.cooking.cavity.upper | The upper door open |
| cloud.smarthq.type.mode.cool | Cool |
| cloud.smarthq.type.mode.cool.quiet | Cool Quiet |
| cloud.smarthq.type.mode.cool.turbo | Cool Turbo |
| cloud.smarthq.type.mode.cycle | Cycle |
| cloud.smarthq.type.mode.dim | Dim |
| cloud.smarthq.type.mode.dirt | Dirt |
| cloud.smarthq.type.mode.disable | Disable |
| cloud.smarthq.type.mode.drain | Drain |
| cloud.smarthq.type.mode.electriconly | Electric Only |
| cloud.smarthq.type.mode.enable | Enable |
| cloud.smarthq.type.mode.error | Error |
| cloud.smarthq.type.mode.expired | Expired |
| cloud.smarthq.type.mode.expiringsoon | Expiring Soon |
| cloud.smarthq.type.mode.extraheavy | Extra Heavy |
| cloud.smarthq.type.mode.extrahot | Extra Hot |
| cloud.smarthq.type.mode.extralight | Extra Light |
| cloud.smarthq.type.mode.fahrenheit | Fahrenheit |
| cloud.smarthq.type.mode.fill | Fill |
| cloud.smarthq.type.mode.good | Good |
| cloud.smarthq.type.mode.grass | Grass |
| cloud.smarthq.type.mode.heat | Heat |
| cloud.smarthq.type.mode.heatpump.boost | Boost Heat Pump |
| cloud.smarthq.type.mode.heatpump.only | Heat Pump Only |
| cloud.smarthq.type.mode.heavy | Heavy |
| cloud.smarthq.type.mode.high | High |
| cloud.smarthq.type.mode.highdemand | High Demand |
| cloud.smarthq.type.mode.hot | Hot |
| cloud.smarthq.type.mode.hour.12 | Hour 12 |
| cloud.smarthq.type.mode.hour.24 | Hour 24 |
| cloud.smarthq.type.mode.hybrid | Hybrid |
| cloud.smarthq.type.mode.icemaker.addwater | Add water |
| cloud.smarthq.type.mode.icemaker.bin.full | Ice bin full |
| cloud.smarthq.type.mode.icemaker.bin.missing | Ice bin missing |
| cloud.smarthq.type.mode.icemaker.cleaning | Cleaning |
| cloud.smarthq.type.mode.icemaker.defrosting | Defrosting |
| cloud.smarthq.type.mode.icemaker.idle | Idle |
| cloud.smarthq.type.mode.icemaker.lid.open | Lid open |
| cloud.smarthq.type.mode.icemaker.makingice | Making ice |
| cloud.smarthq.type.mode.icemaker.missingwatersource | Missing water source |
| cloud.smarthq.type.mode.inapplianceloadreduction | In Appliance Load Reduction Mode |
| cloud.smarthq.type.mode.initial.inspection | Inspection |
| cloud.smarthq.type.mode.intemperatureoffset | In Temperature Offset Mode |
| cloud.smarthq.type.mode.intemporaryloadincrease | In Temporary Load Increase mode |
| cloud.smarthq.type.mode.invalid | Invalid |
| cloud.smarthq.type.mode.leak | Leak |
| cloud.smarthq.type.mode.light | Light |
| cloud.smarthq.type.mode.low | Low |
| cloud.smarthq.type.mode.mainwash | Main Wash |
| cloud.smarthq.type.mode.manual | Manual |
| cloud.smarthq.type.mode.medium | Medium |
| cloud.smarthq.type.mode.merv13 | MERV13 Filter |
| cloud.smarthq.type.mode.needsattention | Needs Attention |
| cloud.smarthq.type.mode.needsreplaced | Needs replaced |
| cloud.smarthq.type.mode.none | None |
| cloud.smarthq.type.mode.normal | Normal |
| cloud.smarthq.type.mode.off | Off |
| cloud.smarthq.type.mode.oily | Oily |
| cloud.smarthq.type.mode.on | On |
| cloud.smarthq.type.mode.open | Open |
| cloud.smarthq.type.mode.open.all | Open all |
| cloud.smarthq.type.mode.open.any | Open any |
| cloud.smarthq.type.mode.other | Other |
| cloud.smarthq.type.mode.postwash | Post Wash |
| cloud.smarthq.type.mode.presence.absent | Presence absent |
| cloud.smarthq.type.mode.presence.ready | Presence ready |
| cloud.smarthq.type.mode.presence.requested | Presence requested |
| cloud.smarthq.type.mode.prewash | Pre Wash |
| cloud.smarthq.type.mode.profile | Profile |
| cloud.smarthq.type.mode.ready | Ready |
| cloud.smarthq.type.mode.remote | Remote |
| cloud.smarthq.type.mode.standard | Standard |
| cloud.smarthq.type.mode.start | Start |
| cloud.smarthq.type.mode.tapcold | Tap Cold |
| cloud.smarthq.type.mode.temporary | Temporary |
| cloud.smarthq.type.mode.tomato | Tomato |
| cloud.smarthq.type.mode.traffic.light | Traffic light |
| cloud.smarthq.type.mode.transition | Transition |
| cloud.smarthq.type.mode.unknown | Unknown |
| cloud.smarthq.type.mode.warm | Warm |
SET<MODE>¶
| SET<MODE> | Documentation |
|---|---|
| cloud.smarthq.type.mode.auto | Automatic |
| cloud.smarthq.type.mode.beep | Beep |
| cloud.smarthq.type.mode.beverages | Beverages |
| cloud.smarthq.type.mode.blocked | Blocked |
| cloud.smarthq.type.mode.blood | Blood |
| cloud.smarthq.type.mode.boost | Boost |
| cloud.smarthq.type.mode.bypass | Bypass |
| cloud.smarthq.type.mode.cancel | Cancel |
| cloud.smarthq.type.mode.celsius | Celsius |
| cloud.smarthq.type.mode.circulate | Circulate |
| cloud.smarthq.type.mode.clean | Clean |
| cloud.smarthq.type.mode.closed | Closed |
| cloud.smarthq.type.mode.cold | Cold |
| cloud.smarthq.type.mode.colors | Colors |
| cloud.smarthq.type.mode.complete | Complete |
| cloud.smarthq.type.mode.continuous | Continuous |
| cloud.smarthq.type.mode.control.centraldesk | Central Desk Control |
| cloud.smarthq.type.mode.control.occupancy | Occupancy Control |
| cloud.smarthq.type.mode.convertibledrawer.mode1 | Convertible Drawer Mode 1 |
| cloud.smarthq.type.mode.convertibledrawer.mode2 | Convertible Drawer Mode 2 |
| cloud.smarthq.type.mode.convertibledrawer.mode3 | Convertible Drawer Mode 3 |
| cloud.smarthq.type.mode.convertibledrawer.mode4 | Convertible Drawer Mode 4 |
| cloud.smarthq.type.mode.convertibledrawer.mode5 | Convertible Drawer Mode 5 |
| cloud.smarthq.type.mode.convertibledrawer.mode6 | Convertible Drawer Mode 6 |
| cloud.smarthq.type.mode.convertibledrawer.mode7 | Convertible Drawer Mode 7 |
| cloud.smarthq.type.mode.cooking.cavity.lower | The lower door open |
| cloud.smarthq.type.mode.cooking.cavity.upper | The upper door open |
| cloud.smarthq.type.mode.cool | Cool |
| cloud.smarthq.type.mode.cool.quiet | Cool Quiet |
| cloud.smarthq.type.mode.cool.turbo | Cool Turbo |
| cloud.smarthq.type.mode.cycle | Cycle |
| cloud.smarthq.type.mode.dim | Dim |
| cloud.smarthq.type.mode.dirt | Dirt |
| cloud.smarthq.type.mode.disable | Disable |
| cloud.smarthq.type.mode.drain | Drain |
| cloud.smarthq.type.mode.electriconly | Electric Only |
| cloud.smarthq.type.mode.enable | Enable |
| cloud.smarthq.type.mode.error | Error |
| cloud.smarthq.type.mode.expired | Expired |
| cloud.smarthq.type.mode.expiringsoon | Expiring Soon |
| cloud.smarthq.type.mode.extraheavy | Extra Heavy |
| cloud.smarthq.type.mode.extrahot | Extra Hot |
| cloud.smarthq.type.mode.extralight | Extra Light |
| cloud.smarthq.type.mode.fahrenheit | Fahrenheit |
| cloud.smarthq.type.mode.fill | Fill |
| cloud.smarthq.type.mode.good | Good |
| cloud.smarthq.type.mode.grass | Grass |
| cloud.smarthq.type.mode.heat | Heat |
| cloud.smarthq.type.mode.heatpump.boost | Boost Heat Pump |
| cloud.smarthq.type.mode.heatpump.only | Heat Pump Only |
| cloud.smarthq.type.mode.heavy | Heavy |
| cloud.smarthq.type.mode.high | High |
| cloud.smarthq.type.mode.highdemand | High Demand |
| cloud.smarthq.type.mode.hot | Hot |
| cloud.smarthq.type.mode.hour.12 | Hour 12 |
| cloud.smarthq.type.mode.hour.24 | Hour 24 |
| cloud.smarthq.type.mode.hybrid | Hybrid |
| cloud.smarthq.type.mode.icemaker.addwater | Add water |
| cloud.smarthq.type.mode.icemaker.bin.full | Ice bin full |
| cloud.smarthq.type.mode.icemaker.bin.missing | Ice bin missing |
| cloud.smarthq.type.mode.icemaker.cleaning | Cleaning |
| cloud.smarthq.type.mode.icemaker.defrosting | Defrosting |
| cloud.smarthq.type.mode.icemaker.idle | Idle |
| cloud.smarthq.type.mode.icemaker.lid.open | Lid open |
| cloud.smarthq.type.mode.icemaker.makingice | Making ice |
| cloud.smarthq.type.mode.icemaker.missingwatersource | Missing water source |
| cloud.smarthq.type.mode.inapplianceloadreduction | In Appliance Load Reduction Mode |
| cloud.smarthq.type.mode.initial.inspection | Inspection |
| cloud.smarthq.type.mode.intemperatureoffset | In Temperature Offset Mode |
| cloud.smarthq.type.mode.intemporaryloadincrease | In Temporary Load Increase mode |
| cloud.smarthq.type.mode.invalid | Invalid |
| cloud.smarthq.type.mode.leak | Leak |
| cloud.smarthq.type.mode.light | Light |
| cloud.smarthq.type.mode.low | Low |
| cloud.smarthq.type.mode.mainwash | Main Wash |
| cloud.smarthq.type.mode.manual | Manual |
| cloud.smarthq.type.mode.medium | Medium |
| cloud.smarthq.type.mode.merv13 | MERV13 Filter |
| cloud.smarthq.type.mode.needsattention | Needs Attention |
| cloud.smarthq.type.mode.needsreplaced | Needs replaced |
| cloud.smarthq.type.mode.none | None |
| cloud.smarthq.type.mode.normal | Normal |
| cloud.smarthq.type.mode.off | Off |
| cloud.smarthq.type.mode.oily | Oily |
| cloud.smarthq.type.mode.on | On |
| cloud.smarthq.type.mode.open | Open |
| cloud.smarthq.type.mode.open.all | Open all |
| cloud.smarthq.type.mode.open.any | Open any |
| cloud.smarthq.type.mode.other | Other |
| cloud.smarthq.type.mode.postwash | Post Wash |
| cloud.smarthq.type.mode.presence.absent | Presence absent |
| cloud.smarthq.type.mode.presence.ready | Presence ready |
| cloud.smarthq.type.mode.presence.requested | Presence requested |
| cloud.smarthq.type.mode.prewash | Pre Wash |
| cloud.smarthq.type.mode.profile | Profile |
| cloud.smarthq.type.mode.ready | Ready |
| cloud.smarthq.type.mode.remote | Remote |
| cloud.smarthq.type.mode.standard | Standard |
| cloud.smarthq.type.mode.start | Start |
| cloud.smarthq.type.mode.tapcold | Tap Cold |
| cloud.smarthq.type.mode.temporary | Temporary |
| cloud.smarthq.type.mode.tomato | Tomato |
| cloud.smarthq.type.mode.traffic.light | Traffic light |
| cloud.smarthq.type.mode.transition | Transition |
| cloud.smarthq.type.mode.unknown | Unknown |
| cloud.smarthq.type.mode.warm | Warm |