cloud.smarthq.service.cooking.burner.status.v1¶
Description¶
Service to show cooking burner status
Example Device Response (Digital Twin API)¶
Service example to model the cooktop burner state service.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.range.gas",
"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.burner.status.v1",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.cooking",
"supportedCommands": [],
"state": {
"cooktopStatus": "cloud.smarthq.type.cooking.cooktop.status.on",
"uiConfiguration": "cloud.smarthq.type.cooking.cooktop.ui.mechanical.knob",
"energySource": "cloud.smarthq.type.cooking.energy.gas"
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.range.gas",
"config": {
"leftFrontSupported": true,
"leftFrontBridgeModeSupported": true,
"leftFrontWarmingZoneSupported": 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 |
|---|---|---|
| centerFrontBridgeModeSupported | BOOLEAN | No |
| centerFrontSupported | BOOLEAN | No |
| centerFrontWarmingZoneSupported | BOOLEAN | No |
| centerLeftFrontBridgeModeSupported | BOOLEAN | No |
| centerLeftFrontSupported | BOOLEAN | No |
| centerLeftFrontWarmingZoneSupported | BOOLEAN | No |
| centerLeftRearBridgeModeSupported | BOOLEAN | No |
| centerLeftRearSupported | BOOLEAN | No |
| centerLeftRearWarmingZoneSupported | BOOLEAN | No |
| centerRearBridgeModeSupported | BOOLEAN | No |
| centerRearSupported | BOOLEAN | No |
| centerRearWarmingZoneSupported | BOOLEAN | No |
| centerRightFrontBridgeModeSupported | BOOLEAN | No |
| centerRightFrontSupported | BOOLEAN | No |
| centerRightFrontWarmingZoneSupported | BOOLEAN | No |
| centerRightRearBridgeModeSupported | BOOLEAN | No |
| centerRightRearSupported | BOOLEAN | No |
| centerRightRearWarmingZoneSupported | BOOLEAN | No |
| leftFrontBridgeModeSupported | BOOLEAN | No |
| leftFrontSupported | BOOLEAN | No |
| leftFrontWarmingZoneSupported | BOOLEAN | No |
| leftRearBridgeModeSupported | BOOLEAN | No |
| leftRearSupported | BOOLEAN | No |
| leftRearWarmingZoneSupported | BOOLEAN | No |
| rightFrontBridgeModeSupported | BOOLEAN | No |
| rightFrontSupported | BOOLEAN | No |
| rightFrontWarmingZoneSupported | BOOLEAN | No |
| rightRearBridgeModeSupported | BOOLEAN | No |
| rightRearSupported | BOOLEAN | No |
| rightRearWarmingZoneSupported | BOOLEAN | No |
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 |
|---|---|---|
| centerFrontActive | BOOLEAN | No |
| centerFrontClosedLoop | BOOLEAN | No |
| centerFrontPowerLevel | INTEGER | No |
| centerFrontbridgeMode | BOOLEAN | No |
| centerFrontpreheat | BOOLEAN | No |
| centerLeftFrontActive | BOOLEAN | No |
| centerLeftFrontClosedLoop | BOOLEAN | No |
| centerLeftFrontPowerLevel | INTEGER | No |
| centerLeftFrontbridgeMode | BOOLEAN | No |
| centerLeftFrontpreheat | BOOLEAN | No |
| centerLeftRearActive | BOOLEAN | No |
| centerLeftRearBridgeMode | BOOLEAN | No |
| centerLeftRearClosedLoop | BOOLEAN | No |
| centerLeftRearPowerLevel | INTEGER | No |
| centerLeftRearpreheat | BOOLEAN | No |
| centerRearActive | BOOLEAN | No |
| centerRearBridgeMode | BOOLEAN | No |
| centerRearClosedLoop | BOOLEAN | No |
| centerRearPowerLevel | INTEGER | No |
| centerRearpreheat | BOOLEAN | No |
| centerRightFrontActive | BOOLEAN | No |
| centerRightFrontClosedLoop | BOOLEAN | No |
| centerRightFrontPowerLevel | INTEGER | No |
| centerRightFrontbridgeMode | BOOLEAN | No |
| centerRightFrontpreheat | BOOLEAN | No |
| centerRightRearActive | BOOLEAN | No |
| centerRightRearBridgeMode | BOOLEAN | No |
| centerRightRearClosedLoop | BOOLEAN | No |
| centerRightRearPowerLevel | INTEGER | No |
| centerRightRearpreheat | BOOLEAN | No |
| cooktopStatus | COOKING_COOKTOP_STATUS | No |
| energySource | COOKING_ENERGY_SOURCE | No |
| leftFrontActive | BOOLEAN | No |
| leftFrontPowerLevel | INTEGER | No |
| leftFrontbridgeMode | BOOLEAN | No |
| leftFrontclosedLoop | BOOLEAN | No |
| leftFrontpreheat | BOOLEAN | No |
| leftRearActive | BOOLEAN | No |
| leftRearPowerLevel | INTEGER | No |
| leftRearbridgeMode | BOOLEAN | No |
| leftRearclosedLoop | BOOLEAN | No |
| leftRearpreheat | BOOLEAN | No |
| rightFrontActive | BOOLEAN | No |
| rightFrontBridgeMode | BOOLEAN | No |
| rightFrontClosedLoop | BOOLEAN | No |
| rightFrontPowerLevel | INTEGER | No |
| rightFrontpreheat | BOOLEAN | No |
| rightRearActive | BOOLEAN | No |
| rightRearBridgeMode | BOOLEAN | No |
| rightRearClosedLoop | BOOLEAN | No |
| rightRearPowerLevel | INTEGER | No |
| rightRearPreheat | BOOLEAN | No |
| uiConfiguration | COOKING_COOKTOP_UI | No |
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.
COOKING_COOKTOP_STATUS¶
| COOKING_COOKTOP_STATUS | Documentation |
|---|---|
| cloud.smarthq.type.cooking.cooktop.status.igniting | Igniting |
| cloud.smarthq.type.cooking.cooktop.status.notsupported | Not Supported |
| cloud.smarthq.type.cooking.cooktop.status.off | Off |
| cloud.smarthq.type.cooking.cooktop.status.on | On |
| cloud.smarthq.type.cooking.cooktop.status.unknown | Unknown |
COOKING_COOKTOP_UI¶
| COOKING_COOKTOP_UI | Documentation |
|---|---|
| cloud.smarthq.type.cooking.cooktop.ui.glass.touch | Glass Touch |
| cloud.smarthq.type.cooking.cooktop.ui.glass.touch.wingboard | Glass Touch Wingboard |
| cloud.smarthq.type.cooking.cooktop.ui.mechanical.knob | Mechanical Knob |
| cloud.smarthq.type.cooking.cooktop.ui.mechanical.knob.autoreignition | Mechanical Knob with autoreignition |
| cloud.smarthq.type.cooking.cooktop.ui.mechanical.knob.ovenlight.knob | Mechanical Knob with oven light knob |
| cloud.smarthq.type.cooking.cooktop.ui.mechanical.knob.warmingzone.button | Mechanical Knob with warming zone button |
| cloud.smarthq.type.cooking.cooktop.ui.mechanical.knob.without.feedback | Mechanical Knob without feedback |
| cloud.smarthq.type.cooking.cooktop.ui.none | None |
| cloud.smarthq.type.cooking.cooktop.ui.tactile.wingboard | Tactile WingBoard |
| cloud.smarthq.type.cooking.cooktop.ui.three.knob.wingboard | Three Knob Wingboard |
| cloud.smarthq.type.cooking.cooktop.ui.two.knob.wingboard | Two Knob Wingboard |
COOKING_ENERGY_SOURCE¶
| COOKING_ENERGY_SOURCE | Documentation |
|---|---|
| cloud.smarthq.type.cooking.energy.gas | Gas |
| cloud.smarthq.type.cooking.energy.induction | Induction |
| cloud.smarthq.type.cooking.energy.none | None |
| cloud.smarthq.type.cooking.energy.radiant | Radiant |