Alexa.Cooking.FoodTemperatureController Interface
Implement the Alexa.Cooking.FoodTemperatureController capability interface so that users can control appliances that cook specific food items at specific food temperatures. If you want users to control appliances that cook by appliance temperature, use the TemperatureController interface instead. Typically you use the FoodTemperatureController interface in conjunction with the FoodTemperatureSensor (optional) and Cooking (mandatory) interfaces. For more information about cooking skills, see Build Smart Home Skills for Cooking Appliances.
For the list of locales that are supported for the Cooking.FoodTemperatureController interface, see List of Capability Interfaces and Supported Locales.
- Utterances
- Properties
- Discovery
- Directives
- State reporting
- Change reporting
- AddOrUpdateReport
- Related Topics
Utterances
When you use the Alexa.Cooking.FoodTemperatureController interface, the voice interaction model is already built for you. The following examples show some customer utterances:
Alexa, cook my roast to 125 degrees.
Alexa, reheat my chicken to 160 degrees.
After the customer says one of these utterances, Alexa sends a corresponding directive to your skill.
Properties
The Alexa.Cooking.FoodTemperatureController interface uses the targetFoodTemperature property as the primary property. The targetFoodTemperature property represents the target temperature of a food item that is cooking.
targetCookingTemperature property and the TemperatureController interface instead.Discovery
You describe endpoints that support Alexa.Cooking.FoodTemperatureController using the standard discovery mechanism described in Alexa.Discovery.
Set retrievable to true for the properties that you report when Alexa sends your skill a state report request. Set proactivelyReported to true for the properties that you proactively report to Alexa in a change report.
For the full list of display categories, see display categories.
In addition to the usual discovery response fields, for FoodTemperatureController, include a configuration object that contains the following fields.
| Field | Description | Type | Required |
|---|---|---|---|
supportsRemoteStart |
True if Alexa can start the device after a customer's voice command. When false, Alexa sends the CookByFoodTemperature directive to set the parameters for the cook session, and Alexa prompts the user to push start on the device. The default is false. |
Boolean | No |
supportedCookingModes |
The cooking modes that the device supports through this interface. Other cooking modes can be supported by the same appliance through other interfaces. | An array of cookingMode strings. | Yes |
supportedFoodTemperatureRange |
The range of temperatures that the device supports for the food. The range is an object that contains a minimumValue and a maximumValue, each of which is a temperature object. If you specify this range in your configuration, Alexa validates the temperature that the user requests. If you don't specify this range, you must validate the temperature that the user requests in your skill. |
Object | No |
Discover response example
The following example shows a Discover.Response message for a microwave endpoint that supports the FoodTemperatureController, FoodTemperatureSensor, and Cooking interfaces.
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "Discover.Response",
"payloadVersion": "3",
"messageId": "<message id>"
},
"payload": {
"endpoints": [
{
"endpointId": "<unique ID of the endpoint>",
"manufacturerName": "<the manufacturer name of the endpoint>",
"description": "<a description that is shown in the Alexa app>",
"friendlyName": "Oven",
"displayCategories": ["OVEN"],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking.FoodTemperatureController",
"version": "3",
"properties": {
"supported": [
{
"name": "targetFoodTemperature"
}
],
"proactivelyReported": true,
"retrievable": true
},
"configuration": {
"supportsRemoteStart": false,
"supportedCookingModes": [
"BAKE",
"ROAST"
],
"supportedFoodTemperatureRange": {
"minimumValue": {
"value": 90,
"scale": "FAHRENHEIT"
},
"maximumValue": {
"value": 210,
"scale": "FAHRENHEIT"
}
}
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking.FoodTemperatureSensor",
"version": "3",
"properties": {
"supported": [
{
"name": "foodTemperature"
}
],
"proactivelyReported": false,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking",
"version": "3",
"properties": {
"supported": [
{
"name": "cookingMode"
},
{
"name": "foodItem"
},
{
"name": "cookingTimeInterval"
}
],
"proactivelyReported": true,
"retrievable": true
},
"configuration": {
"supportsRemoteStart": false,
"supportedCookingModes": ["REHEAT", "DEFROST", "OFF"]
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}
Directives
CookByFoodTemperature directive
Support the CookByFoodTemperature directive so that customers can start a cooking session and specify the temperature of the food.
The following examples show customer utterances:
Alexa, bake my roast to 125 degrees.
Alexa, reheat my chicken to 160 degrees.
CookByFoodTemperature directive payload details
| Field | Description | Type |
|---|---|---|
targetFoodTemperature |
The target temperature that the food must reach. This field is always included in the payload. | A temperature object. |
cookingMode |
The cooking mode for the cooking session, such as BROIL. This is only included if the user specifies it. If cookingMode is not present, choose the default cooking mode for the device, such as BAKE. |
A cookingMode object. |
foodItem |
The food to cook. This field is only included if the user specifies it. | A foodItem object. |
CookByFoodTemperature directive example
{
"directive": {
"header": {
"namespace": "Alexa.Cooking.FoodTemperatureController",
"name": "CookByFoodTemperature",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "<an OAuth2 bearer token>"
},
"endpointId": "<endpoint id>",
"cookie": {}
},
"payload": {
"targetFoodTemperature": {
"value": 125,
"scale": "FAHRENHEIT"
},
"cookingMode": {
"BAKE"
},
"foodItem": {
"foodName": "Roast"
}
}
}
}
CookByFoodTemperature response event
If you handle a CookByFoodTemperature directive successfully, respond with an Alexa.Response event. In the context object, include the values of all relevant properties.
CookByFoodTemperature response event example
The following example shows a response to a CookByFoodTemperature directive. The context contains the values of all properties relevant to the current cooking action, even though some of the properties are defined by other interfaces.
You must include the cookingMode property. You must include the targetFoodTemperature property unless the cookingMode is OFF.
{
"event": {
"header": {
"namespace": "Alexa",
"name": "Response",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"endpointId": "<endpoint id>"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.Cooking.FoodTemperatureController",
"name": "targetFoodTemperature",
"value": {
"value": 125,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.FoodTemperatureSensor",
"name": "foodTemperature",
"value": {
"value": 125,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "cookingMode",
"value": "BAKE",
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "foodItem",
"value":{
"foodName": "Roast",
"foodCategory": "MEAT",
"foodQuantity":{
"@type": "Weight",
"value": "5.5",
"unit": "POUND"
}
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "cookingTimeInterval",
"value": {
"start": "2019-11-11T21:00:00Z",
"end": "2019-11-11T22:30:00Z"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
CookByFoodTemperature directive error handling
If you can't handle a CookByFoodTemperature directive successfully, respond with an Alexa.Cooking.ErrorResponse event. You can also respond with a generic Alexa.ErrorResponse event if your error is generic, and not specific to cooking.
State reporting
Alexa sends a ReportState directive to request information about the state of an endpoint. When Alexa sends a ReportState directive, you send a StateReport event in response. The response contains the current state of all retrievable properties in the context object. You identify your retrievable properties in your discovery response. For more information about state reports, see Understand State Reporting.
OFF, include the cooking mode property but no other properties in your StateReport response.StateReport response event example
{
"event": {
"header": {
"namespace": "Alexa",
"name": "StateReport",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"endpointId": "<endpoint id>"
},
"payload": {}
},
"context": {
"properties": [
{
"namespace": "Alexa.Cooking.FoodTemperatureController",
"name": "targetFoodTemperature",
"value": {
"value": 125,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.FoodTemperatureSensor",
"name": "foodTemperature",
"value": {
"value": 125,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "cookingMode",
"value": "BAKE",
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "foodItem",
"value":{
"foodName": "Roast",
"foodCategory": "MEAT",
"foodQuantity":{
"@type": "Weight",
"value": "5.5",
"unit": "POUND"
}
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "cookingTimeInterval",
"value": {
"start": "2019-11-11T21:00:00Z",
"end": "2019-11-11T22:30:00Z"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
Change reporting
You send a ChangeReport event to proactively report changes in the state of an endpoint. You identify the properties that you proactively report in your discovery response. For more information about change reports, see Understand State Reporting.
OFF, include the cooking mode property but no other properties in your ChangeReport.ChangeReport event example
{
"event": {
"header": {
"namespace": "Alexa",
"name": "ChangeReport",
"messageId": "<message id>",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "<an OAuth2 bearer token>"
},
"endpointId": "<endpoint id>"
},
"payload": {
"change": {
"cause": {
"type": "PERIODIC_POLL"
},
"properties": [
{
"namespace": "Alexa.Cooking.FoodTemperatureController",
"name": "targetFoodTemperature",
"value": {
"value": 125,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.FoodTemperatureSensor",
"name": "foodTemperature",
"value": {
"value": 125,
"scale": "FAHRENHEIT"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "cookingMode",
"value": "BAKE",
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "foodItem",
"value":{
"foodName": "Roast",
"foodCategory": "MEAT",
"foodQuantity":{
"@type": "Weight",
"value": "5.5",
"unit": "POUND"
}
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking",
"name": "cookingTimeInterval",
"value": {
"start": "2019-11-11T21:00:00Z",
"end": "2019-11-11T22:30:00Z"
},
"timeOfSample": "2019-11-11T21:20:45Z",
"uncertaintyInMilliseconds": 0
}
]
}
}
},
"context": {}
}
AddOrUpdateReport
You must proactively send an Alexa.Discovery.AddOrUpdateReport message if the feature support of your endpoint changes. For example, if the user changes the temperature scale from FAHRENHEIT to CELSIUS, or vice-versa, you must send an AddOrUpdateReport message. For more information, see AddOrUpdateReport event.
AddOrUpdateReport event example
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "AddOrUpdateReport",
"payloadVersion": "3",
"messageId": "<message id>"
},
"payload": {
"endpoints": [
{
"endpointId": "<unique ID of the endpoint>",
"manufacturerName": "<the manufacturer name of the endpoint>",
"description": "<a description that is shown in the Alexa app>",
"friendlyName": "Oven",
"displayCategories": ["OVEN"],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking.FoodTemperatureController",
"version": "3",
"properties": {
"supported": [
{
"name": "targetFoodTemperature"
}
],
"proactivelyReported": true,
"retrievable": true
},
"configuration": {
"supportsRemoteStart": false,
"supportedCookingModes": [
"BAKE",
"ROAST"
],
"supportedFoodTemperatureRange": {
"minimumValue": {
"value": 30,
"scale": "CELSIUS"
},
"maximumValue": {
"value": 100,
"scale": "CELSIUS"
}
}
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking.FoodTemperatureSensor",
"version": "3",
"properties": {
"supported": [
{
"name": "foodTemperature"
}
],
"proactivelyReported": false,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking",
"version": "3",
"properties": {
"supported": [
{
"name": "cookingMode"
},
{
"name": "cookingTimeInterval"
},
{
"name": "foodItem"
}
],
"proactivelyReported": true,
"retrievable": true
},
"configuration": {
"supportsRemoteStart": false,
"supportedCookingModes": ["REHEAT", "DEFROST", "OFF"]
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}
