cloud.smarthq.service.cooking.history¶
Description¶
Service to consolidate data from several services to track the cooking history of the device.
Example Device Response (Digital Twin API)¶
Service representing the a cooking state from several services.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.smoker",
"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.cooking.history",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.cooking",
"supportedCommands": [],
"state": {
"mode": "cloud.smarthq.domain.cooking.food.salmon",
"cavityTemperatureCelsiusConverted": 121.11111111111111,
"probeTemperatureFahrenheit": 250.0,
"cavityTemperatureFahrenheit": 250.0,
"probeTemperatureCelsiusConverted": 121.11111111111111,
"cookingStatus": "cloud.smarthq.type.cookingstatus.smoke",
"probePresence": "cloud.smarthq.type.mode.presence.ready",
"runStatus": "cloud.smarthq.type.runstatus.active"
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.smoker",
"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 | Calculated |
|---|---|---|---|
| cavityTemperatureCelsiusConverted | DOUBLE | No | Yes |
| cavityTemperatureFahrenheit | DOUBLE | No | |
| cookTimeInitial | INTEGER | No | |
| cookingStatus | COOKING_STATUS | No | |
| mode | COOKING_MODE_DOMAIN | Yes | |
| numericOptionValue | DOUBLE | No | |
| probePresence | MODE | No | |
| probeTemperatureCelsiusConverted | DOUBLE | No | Yes |
| probeTemperatureFahrenheit | DOUBLE | No | |
| runStatus | RUN_STATUS | Yes |
Data Types¶
DOUBLE¶
Value must be an double. Field specific restrictions such as a minimum and maximum may apply depending on the field.
INTEGER¶
Value must be an integer. Field specific restrictions such as a minimum and maximum may apply depending on the field.
COOKING_MODE_DOMAIN¶
| COOKING_MODE_DOMAIN | Documentation |
|---|---|
| cloud.smarthq.domain.cooking.airfry | The air fry cooking mode |
| cloud.smarthq.domain.cooking.bagel | The bagel cooking mode |
| cloud.smarthq.domain.cooking.bake | The bake cooking mode |
| cloud.smarthq.domain.cooking.bake.auto | The auto bake cooking mode |
| cloud.smarthq.domain.cooking.bake.auto.biscuits | The auto bake biscuits cooking mode |
| cloud.smarthq.domain.cooking.bake.auto.frozenfrenchfries | The auto bake frozenfrenchfries cooking mode |
| cloud.smarthq.domain.cooking.bake.auto.frozenpizza | The auto bake frozenpizza cooking mode |
| cloud.smarthq.domain.cooking.bake.auto.muffins | The auto bake muffins cooking mode |
| cloud.smarthq.domain.cooking.beverage | The beverage cooking mode |
| cloud.smarthq.domain.cooking.broil | The broil cooking mode |
| cloud.smarthq.domain.cooking.cake | The cake cooking mode |
| cloud.smarthq.domain.cooking.cavity.lower | The lower door open |
| cloud.smarthq.domain.cooking.cavity.upper | The upper door open |
| cloud.smarthq.domain.cooking.convection.bake | The convection bake cooking mode |
| cloud.smarthq.domain.cooking.convection.roast | The convection roast cooking mode |
| cloud.smarthq.domain.cooking.cookie | The cookie cooking mode |
| cloud.smarthq.domain.cooking.crispfinish | The crisp finish cooking mode |
| cloud.smarthq.domain.cooking.custom | The custom cooking mode |
| cloud.smarthq.domain.cooking.defrost.auto.sensed | The auto defrost sensed cooking mode |
| cloud.smarthq.domain.cooking.defrost.auto.weight | The auto defrost weight(pounds) cooking mode |
| cloud.smarthq.domain.cooking.defrost.time | The defrost by time cooking mode |
| cloud.smarthq.domain.cooking.defrost.weight | The defrost by weight cooking mode |
| cloud.smarthq.domain.cooking.dehydrate | The dehydrate cooking mode |
| cloud.smarthq.domain.cooking.dinnerplate | The dinner plate cooking mode |
| cloud.smarthq.domain.cooking.extended | Domain for Cooking Extended |
| cloud.smarthq.domain.cooking.food.brisket | The cooking mode for brisket |
| cloud.smarthq.domain.cooking.food.chicken | The cooking mode for chicken |
| cloud.smarthq.domain.cooking.food.porkbutt | The cooking mode for pork butt |
| cloud.smarthq.domain.cooking.food.porkrib | The cooking mode for pork rib |
| cloud.smarthq.domain.cooking.food.salmon | The cooking mode for salmon |
| cloud.smarthq.domain.cooking.food.wings | The cooking mode for wings |
| cloud.smarthq.domain.cooking.multi.stage | The multi stage cooking mode |
| cloud.smarthq.domain.cooking.off | The off cooking mode |
| cloud.smarthq.domain.cooking.pizza | The pizza cooking mode |
| cloud.smarthq.domain.cooking.popcorn | The popcorn cooking mode |
| cloud.smarthq.domain.cooking.potato | The potato cooking mode |
| cloud.smarthq.domain.cooking.proof | The proof cooking mode |
| cloud.smarthq.domain.cooking.protein.chicken | The protein chicken cooking mode |
| cloud.smarthq.domain.cooking.protein.fish | The protein fish cooking mode |
| cloud.smarthq.domain.cooking.protein.groundbeef | The protein ground beef cooking mode |
| cloud.smarthq.domain.cooking.reheat | The reheat cooking mode |
| cloud.smarthq.domain.cooking.roast | The roast cooking mode |
| cloud.smarthq.domain.cooking.roast.auto | The auto roast cooking mode |
| cloud.smarthq.domain.cooking.roast.auto.beef | The auto roast beef cooking mode |
| cloud.smarthq.domain.cooking.roast.auto.pork | The auto roast pork cooking mode |
| cloud.smarthq.domain.cooking.roast.auto.turkey.breasts | The auto roast turkey breasts cooking mode |
| cloud.smarthq.domain.cooking.roast.auto.whole.chicken | The auto roast whole chicken cooking mode |
| cloud.smarthq.domain.cooking.slowcook | The slow cook cooking mode |
| cloud.smarthq.domain.cooking.steam | The steam cooking mode |
| cloud.smarthq.domain.cooking.temperature | The Cooking temperature domain for toggle service |
| cloud.smarthq.domain.cooking.timed | The timed (microwave) cooking mode |
| cloud.smarthq.domain.cooking.toast | The toast cooking mode |
| cloud.smarthq.domain.cooking.unknown | Unknown |
| cloud.smarthq.domain.cooking.vegetable.canned | The canned vegetable cooking mode |
| cloud.smarthq.domain.cooking.vegetable.fresh | The fresh vegetable cooking mode |
| cloud.smarthq.domain.cooking.vegetable.frozen | The frozen vegetable cooking mode |
| cloud.smarthq.domain.cooking.warm | The warm cooking mode |
| cloud.smarthq.domain.cooking.warm.auto | The auto warm cooking mode |
COOKING_STATUS¶
| COOKING_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.cookingstatus.cook | Cook |
| cloud.smarthq.type.cookingstatus.cook.complete | Cook complete |
| cloud.smarthq.type.cookingstatus.cook.complete.soon | Cook complete soon |
| cloud.smarthq.type.cookingstatus.off | Off |
| cloud.smarthq.type.cookingstatus.pause | Pause |
| cloud.smarthq.type.cookingstatus.pending | Pending |
| cloud.smarthq.type.cookingstatus.preheat | Preheat |
| cloud.smarthq.type.cookingstatus.preheat.complete | Preheat complete |
| cloud.smarthq.type.cookingstatus.smoke | Smoke |
| cloud.smarthq.type.cookingstatus.smoke.decrease | Smoke decrease |
| cloud.smarthq.type.cookingstatus.smoke.increase | Smoke increase |
| cloud.smarthq.type.cookingstatus.smoke.pause | Smoke pause |
| cloud.smarthq.type.cookingstatus.unknown | Unknown |
MODE¶
| MODE | Documentation |
|---|---|
| cloud.smarthq.type.mode.presence.absent | Presence absent |
| cloud.smarthq.type.mode.presence.offline | Offline |
| cloud.smarthq.type.mode.presence.online | Online |
| cloud.smarthq.type.mode.presence.ready | Presence ready |
| cloud.smarthq.type.mode.presence.requested | Presence requested |
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 |