cloud.smarthq.service.cooktop.sousvide¶
Description¶
Service to set cooktop sous vide cooking
Example Device Response (Digital Twin API)¶
cooktop sous vide cooking
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.oven",
"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.cooktop.sousvide",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.cooktop.sousvide",
"supportedCommands": [],
"state": {
"closedLoopCookingDeviceBattery": "cloud.smarthq.type.cooktop.device.battery.status.normal",
"clcTargetTemperature": 1.0,
"bluetoothConnectionStatus": "cloud.smarthq.type.bluetooth.connection.status.chefconnectperipheral",
"closedLoopCookingTargetTimeReached": true,
"bluetoothPairedStatus": "cloud.smarthq.type.bluetooth.paired.status.notpaired",
"clcCurrentTemperature": 1.0,
"clcDeviceStatusLast4DigitsofMACAddress": 1.0,
"elapsedClosedLoopCookingTime": 1.0
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.oven",
"config": {
"closedLoopCookingDeviceRemoteControlEnabled": true,
"cooktopBluetoothPeripheralDeviceIndex": 1.0,
"cooktopBluetoothPeripheralCooktopBurnerIndex": 1.0
},
"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 | Minimum | Maximum |
|---|---|---|---|---|
| closedLoopCookingDeviceRemoteControlEnabled | BOOLEAN | Yes | ||
| cooktopBluetoothPeripheralCooktopBurnerIndex | INTEGER | Yes | -2147483648 | 2147483647 |
| cooktopBluetoothPeripheralDeviceIndex | INTEGER | Yes | -2147483648 | 2147483647 |
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 |
|---|---|---|---|---|
| bluetoothConnectionStatus | BLUETOOTH_CONNECTION_STATUS | Yes | ||
| bluetoothPairedStatus | BLUETOOTH_PAIRED_STATUS | Yes | ||
| clcCurrentTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
| clcDeviceStatusLast4DigitsofMACAddress | INTEGER | Yes | -2147483648 | 2147483647 |
| clcTargetTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
| closedLoopCookingDeviceBattery | COOKTOP_DEVICE_BATTERY_STATUS | Yes | ||
| closedLoopCookingTargetTimeReached | BOOLEAN | Yes | ||
| elapsedClosedLoopCookingTime | INTEGER | Yes | -2147483648 | 2147483647 |
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.cooktop.sousvide.cooktime.target.set¶
Command used to sous vide target time cooktop cooking
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| targetClosedLoopCookingCookTime | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set cooktop sous vide cooking.
{
"command": {
"targetClosedLoopCookingCookTime": 1.0,
"commandType": "cloud.smarthq.command.cooktop.sousvide.cooktime.target.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.cooktop.sousvide",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.oven",
"serviceType": "cloud.smarthq.service.cooktop.sousvide"
}
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.cooktop.sousvide.closedloop.cook.timer.set¶
Command used to sous vide start timer cooktop cooking
| Field Name | Property Type | Required |
|---|---|---|
| startClosedLoopCookingCookTimer | BOOLEAN | No |
Example Commands¶
Command to set cooktop sous vide cooking.
{
"command": {
"commandType": "cloud.smarthq.command.cooktop.sousvide.closedloop.cook.timer.set",
"startClosedLoopCookingCookTimer": true
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.cooktop.sousvide",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.oven",
"serviceType": "cloud.smarthq.service.cooktop.sousvide"
}
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.
BLUETOOTH_CONNECTION_STATUS¶
| BLUETOOTH_CONNECTION_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.bluetooth.connection.status.BLEcentral | BLE Central For Commissioning |
| cloud.smarthq.type.bluetooth.connection.status.chefconnectperipheral | Chef Connect Peripheral |
| cloud.smarthq.type.bluetooth.connection.status.genericcentral | Generic Central |
| cloud.smarthq.type.bluetooth.connection.status.genericperipheral | Generic Peripheral |
| cloud.smarthq.type.bluetooth.connection.status.hestanpan | Hestan Pan |
| cloud.smarthq.type.bluetooth.connection.status.hestanpot | Hestan Pot |
| cloud.smarthq.type.bluetooth.connection.status.invalid | Invalid |
| cloud.smarthq.type.bluetooth.connection.status.paragonprobe | Paragon Probe |
BLUETOOTH_PAIRED_STATUS¶
| BLUETOOTH_PAIRED_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.bluetooth.paired.status.invalid | Invalid |
| cloud.smarthq.type.bluetooth.paired.status.notpaired | Not Paired and not currently connected |
| cloud.smarthq.type.bluetooth.paired.status.pairedandconnected | Paired and currently connected |
| cloud.smarthq.type.bluetooth.paired.status.pairednotconnected | Paired but not currently connected |
COOKTOP_DEVICE_BATTERY_STATUS¶
| COOKTOP_DEVICE_BATTERY_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.cooktop.device.battery.status.high | High |
| cloud.smarthq.type.cooktop.device.battery.status.invalid | Invalid |
| cloud.smarthq.type.cooktop.device.battery.status.low | Low |
| cloud.smarthq.type.cooktop.device.battery.status.normal | Normal |