cloud.smarthq.service.cooking.advantium¶
Description¶
Service for advantium cooking.
Example Device Response (Digital Twin API)¶
Service representing the functionality of the advantium cook request
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.advantium.android",
"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.advantium",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.advantium.cookrequest",
"supportedCommands": [
"cloud.smarthq.command.cooking.advantium.start",
"cloud.smarthq.command.cooking.advantium.stop",
"cloud.smarthq.command.cooking.advantium.pause",
"cloud.smarthq.command.cooking.advantium.resume",
"cloud.smarthq.command.cooking.advantium.update"
],
"state": {
"doorClosed": true,
"choiceTreeSelections11": 255.0,
"recipeIndex": 2.242838244E9,
"choiceTreeSelections10": 255.0,
"microwavePowerLevel": 5.0,
"lowerHeaterPowerLevel": 6.0,
"upperHeaterPowerLevel": 7.0,
"cookAction": "cloud.smarthq.type.advantium.cookaction.start",
"warmMode": "cloud.smarthq.type.advantium.warmmode.off",
"advantiumCookMode": "cloud.smarthq.type.advantium.cookmode.convection.bake",
"terminationReason": "cloud.smarthq.type.advantium.terminationreason.unknown",
"targetTemperatureFahrenheit": 392.0,
"choiceTreeSelections5": 255.0,
"choiceTreeSelections4": 2.0,
"choiceTreeSelections3": 1.0,
"choiceTreeSelections2": 2.0,
"choiceTreeSelections1": 3.0,
"choiceTreeSelections0": 0.0,
"oveLightActive": false,
"sensingActive": false,
"convectionPowerLevel": 4.0,
"preheatStatus": "cloud.smarthq.type.advantium.preheatstatus.preheat.complete",
"remoteCookRequestID": 100.0,
"coolingFanActive": true,
"choiceTreeSelections9": 255.0,
"remoteMenuSelectionStatus": "cloud.smarthq.type.advantium.remotemenuselectionstatus.remote.requested",
"choiceTreeSelections8": 255.0,
"choiceTreeSelections7": 255.0,
"choiceTreeSelections6": 255.0
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.advantium.android",
"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 |
|---|---|---|
| advantiumCookMode | ADVANTIUM_COOK_MODE | Yes |
| choiceTreeSelections0 | INTEGER | Yes |
| choiceTreeSelections1 | INTEGER | Yes |
| choiceTreeSelections10 | INTEGER | Yes |
| choiceTreeSelections11 | INTEGER | Yes |
| choiceTreeSelections2 | INTEGER | Yes |
| choiceTreeSelections3 | INTEGER | Yes |
| choiceTreeSelections4 | INTEGER | Yes |
| choiceTreeSelections5 | INTEGER | Yes |
| choiceTreeSelections6 | INTEGER | Yes |
| choiceTreeSelections7 | INTEGER | Yes |
| choiceTreeSelections8 | INTEGER | Yes |
| choiceTreeSelections9 | INTEGER | Yes |
| convectionPowerLevel | INTEGER | Yes |
| cookAction | ADVANTIUM_COOK_ACTION | Yes |
| coolingFanActive | BOOLEAN | Yes |
| disabled | BOOLEAN | No |
| doorClosed | BOOLEAN | Yes |
| lowerHeaterPowerLevel | INTEGER | Yes |
| microwavePowerLevel | INTEGER | Yes |
| oveLightActive | BOOLEAN | Yes |
| preheatStatus | ADVANTIUM_PREHEAT_STATUS | Yes |
| recipeIndex | LONG | Yes |
| remoteCookRequestID | INTEGER | Yes |
| remoteMenuSelectionStatus | ADVANTIUM_REMOTE_MENU_SELECTION_STATUS | Yes |
| sensingActive | BOOLEAN | Yes |
| targetTemperatureFahrenheit | DOUBLE | Yes |
| terminationReason | ADVANTIUM_TERMINATION_REASON | Yes |
| upperHeaterPowerLevel | INTEGER | Yes |
| warmMode | ADVANTIUM_WARM_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.cooking.advantium.pause¶
Command used to pause the advantium
Example Commands¶
Command to pause the advantium unit.
{
"command": {
"commandType": "cloud.smarthq.command.cooking.advantium.pause"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.advantium.cookrequest",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.advantium.android",
"serviceType": "cloud.smarthq.service.cooking.advantium"
}
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.cooking.advantium.resume¶
Command used to resume the advantium
Example Commands¶
Command to resume the advantium unit.
{
"command": {
"commandType": "cloud.smarthq.command.cooking.advantium.resume"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.advantium.cookrequest",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.advantium.android",
"serviceType": "cloud.smarthq.service.cooking.advantium"
}
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.cooking.advantium.start¶
Command used to start the advantium
| Field Name | Property Type | Required | Minimum Items | Maximum Items |
|---|---|---|---|---|
| advantiumCookMode | ADVANTIUM_COOK_MODE | No | ||
| choiceTreeSelections | TIER_ARRAY | No | 0 | 255 |
| convectionPowerLevel | INTEGER | No | ||
| cookTime | INTEGER | No | ||
| lowerHeaterPowerLevel | INTEGER | No | ||
| microwavePowerLevel | INTEGER | No | ||
| recipeIndex | LONG | No | ||
| remoteMenuItemSelected | BOOLEAN | Yes | ||
| sensorDH | INTEGER | No | ||
| sensorK | INTEGER | No | ||
| sensorMaxT1 | INTEGER | No | ||
| sensorT1PowerLevel | INTEGER | No | ||
| sensorT2PowerLevel | INTEGER | No | ||
| targetTemperatureFahrenheit | DOUBLE | No | ||
| upperHeaterPowerLevel | INTEGER | No | ||
| warmMode | ADVANTIUM_WARM_MODE | No |
Example Commands¶
Command to start the advantium unit.
{
"command": {
"remoteMenuItemSelected": true,
"commandType": "cloud.smarthq.command.cooking.advantium.start",
"recipeIndex": 123456.0,
"choiceTreeSelections": [
0.0,
3.0,
2.0,
1.0,
2.0,
255.0,
255.0,
255.0,
255.0,
255.0,
255.0,
255.0
]
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.advantium.cookrequest",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.advantium.android",
"serviceType": "cloud.smarthq.service.cooking.advantium"
}
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.cooking.advantium.stop¶
Command used to stop the advantium
Example Commands¶
Command to stop the advantium unit.
{
"command": {
"commandType": "cloud.smarthq.command.cooking.advantium.stop"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.advantium.cookrequest",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.advantium.android",
"serviceType": "cloud.smarthq.service.cooking.advantium"
}
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.cooking.advantium.update¶
Command used to update the advantium
| Field Name | Property Type | Required | Minimum Items | Maximum Items |
|---|---|---|---|---|
| advantiumCookMode | ADVANTIUM_COOK_MODE | No | ||
| choiceTreeSelections | TIER_ARRAY | No | 0 | 255 |
| convectionPowerLevel | INTEGER | No | ||
| cookTime | INTEGER | No | ||
| lowerHeaterPowerLevel | INTEGER | No | ||
| microwavePowerLevel | INTEGER | No | ||
| recipeIndex | LONG | No | ||
| remoteMenuItemSelected | BOOLEAN | Yes | ||
| sensorDH | INTEGER | No | ||
| sensorK | INTEGER | No | ||
| sensorMaxT1 | INTEGER | No | ||
| sensorT1PowerLevel | INTEGER | No | ||
| sensorT2PowerLevel | INTEGER | No | ||
| targetTemperatureFahrenheit | DOUBLE | No | ||
| upperHeaterPowerLevel | INTEGER | No | ||
| warmMode | ADVANTIUM_WARM_MODE | No |
Example Commands¶
Command to update the advantium unit.
{
"command": {
"remoteMenuItemSelected": true,
"commandType": "cloud.smarthq.command.cooking.advantium.update",
"recipeIndex": 234567.0,
"choiceTreeSelections": [
1.0,
2.0,
3.0,
0.0,
1.0,
255.0,
255.0,
255.0,
255.0,
255.0,
255.0,
255.0
]
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.advantium.cookrequest",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.advantium.android",
"serviceType": "cloud.smarthq.service.cooking.advantium"
}
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.
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.
LONG¶
Value must be a long. Field specific restrictions such as a minimum and maximum may apply depending on the field.
TIER_ARRAY¶
TODO: Newly defined type needs documentation written.
ADVANTIUM_COOK_ACTION¶
| ADVANTIUM_COOK_ACTION | Documentation |
|---|---|
| cloud.smarthq.type.advantium.cookaction.pause | Pause |
| cloud.smarthq.type.advantium.cookaction.resume | Resume |
| cloud.smarthq.type.advantium.cookaction.start | Start |
| cloud.smarthq.type.advantium.cookaction.stop | Stop |
| cloud.smarthq.type.advantium.cookaction.updated | Updated |
ADVANTIUM_COOK_MODE¶
| ADVANTIUM_COOK_MODE | Documentation |
|---|---|
| cloud.smarthq.type.advantium.cookmode.broil | Broil |
| cloud.smarthq.type.advantium.cookmode.convection.bake | Convection bake |
| cloud.smarthq.type.advantium.cookmode.microwave | Microwave |
| cloud.smarthq.type.advantium.cookmode.microwave.sensor | Microwave sensor |
| cloud.smarthq.type.advantium.cookmode.microwave.slow.cook | Microwave slow cook |
| cloud.smarthq.type.advantium.cookmode.microwave.staged | Microwave staged |
| cloud.smarthq.type.advantium.cookmode.no.mode | No mode |
| cloud.smarthq.type.advantium.cookmode.precision.cook | Precision cook |
| cloud.smarthq.type.advantium.cookmode.precision.cook.custom | Precision cook custom |
| cloud.smarthq.type.advantium.cookmode.precision.cook.staged | Precision cook staged |
| cloud.smarthq.type.advantium.cookmode.proof | Proof |
| cloud.smarthq.type.advantium.cookmode.steam.clean | Steam clean |
| cloud.smarthq.type.advantium.cookmode.toast | Toast |
| cloud.smarthq.type.advantium.cookmode.warm | Warm |
ADVANTIUM_PREHEAT_STATUS¶
| ADVANTIUM_PREHEAT_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.advantium.preheatstatus.no.preheat | No preheat |
| cloud.smarthq.type.advantium.preheatstatus.preheat.active | Preheat active |
| cloud.smarthq.type.advantium.preheatstatus.preheat.complete | Preheat complete |
ADVANTIUM_REMOTE_MENU_SELECTION_STATUS¶
| ADVANTIUM_REMOTE_MENU_SELECTION_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.advantium.remotemenuselectionstatus.host.requested | Host requested |
| cloud.smarthq.type.advantium.remotemenuselectionstatus.invalid.choice.tree | Invalid choice tree |
| cloud.smarthq.type.advantium.remotemenuselectionstatus.invalid.recipe.id | Invalid recipe id |
| cloud.smarthq.type.advantium.remotemenuselectionstatus.remote.requested | Remote requested |
| cloud.smarthq.type.advantium.remotemenuselectionstatus.unknown | Unknown |
ADVANTIUM_TERMINATION_REASON¶
| ADVANTIUM_TERMINATION_REASON | Documentation |
|---|---|
| cloud.smarthq.type.advantium.terminationreason.cook.time.completed | Cook time completed |
| cloud.smarthq.type.advantium.terminationreason.door.opened.while.sensing | Door opened while sensing |
| cloud.smarthq.type.advantium.terminationreason.fault | Fault |
| cloud.smarthq.type.advantium.terminationreason.max.time.shutoff | Max time shut off |
| cloud.smarthq.type.advantium.terminationreason.unknown | Unknown |
| cloud.smarthq.type.advantium.terminationreason.user.canceled | User canceled |
ADVANTIUM_WARM_MODE¶
| ADVANTIUM_WARM_MODE | Documentation |
|---|---|
| cloud.smarthq.type.advantium.warmmode.crisp | Crisp |
| cloud.smarthq.type.advantium.warmmode.moist | Moist |
| cloud.smarthq.type.advantium.warmmode.off | Off |