Alexa.Cooking.TemperatureController Interface 3

Implement the Alexa.Cooking.TemperatureController interface in your Alexa add-on so that users can control appliances that cook by appliance temperature, such as an oven or sous-vide. If you want users to control appliances that cook food items at specific food temperatures, use the FoodTemperatureController interface instead. Typically you use the TemperatureController interface in conjunction with the TemperatureSensor (optional) and Cooking (mandatory) interfaces. For more details about cooking add-ons, see Build Smart Home Add-ons for Cooking Appliances. For the list of languages that the TemperatureController interface supports, see List of Alexa Interfaces and Supported Languages. For the definitions of the message properties, see Alexa Interface Message and Property Reference.

Utterances

When you use the Alexa.Cooking.TemperatureController interface, the voice interaction model is already built for you. The following examples show some customer utterances:

English (All)

After the customer says one of these utterances, Alexa sends a corresponding directive to your add-on.

Reportable properties

The Alexa.Cooking.TemperatureController interface uses the targetCookingTemperature and preheatTimeInterval properties as the primary properties. The targetCookingTemperature property represents the temperature of a cooking appliance during a cooking session. The preheatTimeInterval property represents the time when preheating begins, and when it is expected to complete, expressed as a time interval.

Discovery

You describe endpoints that support Alexa.Cooking.TemperatureController using the standard discovery mechanism described in Alexa.Discovery. Set retrievable to true for the properties that you report when Alexa sends your add-on 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. To let Alexa know the health of your device, also implement the Alexa.EndpointHealth interface.

Configuration object

In addition to the usual discovery response fields, for TemperatureController, 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 `CookByTemperature` 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.	Array of CookingMode values	Yes
`supportedCookingTemperatureRange`	The range of temperatures that the device supports. 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 add-on.	Object	No

Discover response example

The following example shows a Discover.Response message for an oven that supports the TemperatureController, TemperatureSensor, and Cooking interfaces.

{
  "event": {
    "header": {
      "namespace": "Alexa.Discovery",
      "name": "Discover.Response",
      "payloadVersion": "3",
      "messageId": "Unique identifier, preferably a version 4 UUID"
    },
    "payload": {
      "endpoints": [
        {
          "endpointId": "Unique ID of the endpoint",
          "manufacturerName": "Manufacturer of the endpoint",
          "description": "Description to be shown in the Alexa app",
          "friendlyName": "Oven",
          "displayCategories": ["OVEN"],
          "cookie": {},
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Cooking.TemperatureController",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "targetCookingTemperature"
                  },
                  {
                    "name": "preheatTimeInterval"
                  }
                ],
                "proactivelyReported": true,
                "retrievable": true
              },
              "configuration": {
                "supportsRemoteStart": false,
                "supportedCookingModes": [
                  "BAKE",
                  "ROAST"
                ],
                "supportedCookingTemperatureRange": {
                  "minimumValue": "80 °C",
                  "maximumValue": "250 °C"
                }
              }
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Cooking.TemperatureSensor",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "cookingTemperature"
                  }
                ],
                "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.EndpointHealth",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "connectivity"
                  }
                ],
                "proactivelyReported": true,
                "retrievable": true
              }
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa",
              "version": "3"
            }
          ]
        }
      ]
    }
  }
}

Directives

Alexa sends the following Alexa.Cooking.TemperatureController interface directives to your add-on.

CookByTemperature directive

Support the CookByTemperature directive so that customers can start a cooking session and specify the cooking temperature. The following examples show customer utterances:

English (All)

CookByTemperature directive example

The following example illustrates a CookByTemperature directive that Alexa sends to your add-on.

{
  "directive": {
    "header": {
      "namespace": "Alexa.Cooking.TemperatureController",
      "name": "CookByTemperature",
      "messageId": "Unique version 4 UUID",
      "correlationToken": "Opaque correlation token",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "OAuth2.0 bearer token"
      },
      "endpointId": "Endpoint ID",
      "cookie": {}
    },
    "payload": {
      "targetCookingTemperature": {
          "value": 375,
          "scale": "FAHRENHEIT"
      },
      "cookingMode": {
        "BAKE"
      },
      "foodItem": {
          "foodName": "Chicken"
      }
    }
  }
}

CookByTemperature directive payload

Field	Description	Type
`targetCookingTemperature`	The target temperature for the cooking session. This field is always included in the payload.	Temperature object.
`cookingMode`	The cooking mode for the cooking session, such as `BROIL`. Included only if the user specifies it. If `cookingMode` is not present, choose the default cooking mode for the device, such as `BAKE`.	CookingMode object
`foodItem`	The food to cook. This field is only included if the user specifies it.	FoodItem object

CookByTemperature response

If you handle a CookByTemperature directive successfully, respond with an Alexa.Response event. In the context object, include the values of all relevant properties. The following example shows a response to a CookByTemperature directive. The context object contains the values of all properties relevant to the current cooking action, even though some of the properties are defined by other interfaces.

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "Response",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "correlationToken": "Opaque correlation token that matches the request",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "OAuth2.0 bearer token"
      },
      "endpointId": "Endpoint ID"
    },
    "payload": {}
  },
  "context": {
    "properties": [
      {
          "namespace": "Alexa.Cooking.TemperatureController",
          "name": "targetCookingTemperature",
          "value": {
              "value": 325,
              "scale": "FAHRENHEIT"
          },
          "timeOfSample": "2019-11-11T21:20:52.32Z",
          "uncertaintyInMilliseconds": 0
      },
      {
          "namespace": "Alexa.Cooking.TemperatureController",
          "name": "preheatTimeInterval",
          "value": {
            "start": "2019-11-11T20:30:00Z",
            "end": "2019-11-11T21:00:00Z"
          },
          "timeOfSample": "2019-11-11T21:20:52.32Z",
          "uncertaintyInMilliseconds": 0
      },
      {
        "namespace": "Alexa.Cooking.TemperatureSensor",
        "name": "cookingTemperature",
        "value": {
          "value": 325,
          "scale": "FAHRENHEIT"
        },
        "timeOfSample": "2019-11-11T21:20:52.32Z",
        "uncertaintyInMilliseconds": 0
      },
      {
         "namespace": "Alexa.Cooking",
         "name": "cookingMode",
         "value": "BAKE",
         "timeOfSample": "2019-11-11T21:20:52.32Z",
         "uncertaintyInMilliseconds": 0
      },
      {
         "namespace": "Alexa.Cooking",
         "name": "foodItem",
         "value":{
            "foodName": "Roast",
            "foodQuantity":{
               "@type": "Weight",
               "value": 5.5,
               "unit": "POUND"
            }
         },
         "timeOfSample": "2019-11-11T21:20:52.32Z",
         "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:52.32Z",
          "uncertaintyInMilliseconds": 0
      }
    ]
  }
}

CookByTemperature directive error handling

If you can’t handle a CookByTemperature 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

Support the ReportState directive so that customers can ask about the temperature of their cooking appliance. The following examples show customer utterances:

English (All)

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 details about state reports, see Understand State and Change Reporting.

StateReport response example

{
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "StateReport",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "correlationToken": "Opaque correlation token that matches the request",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "OAuth2.0 bearer token"
      },
      "endpointId": "Endpoint ID"
    },
    "payload": {}
  },
  "context": {
    "properties": [
      {
          "namespace": "Alexa.Cooking.TemperatureController",
          "name": "targetCookingTemperature",
          "value": {
              "value": 325,
              "scale": "FAHRENHEIT"
          },
          "timeOfSample": "2019-11-11T21:20:52.32Z",
          "uncertaintyInMilliseconds": 0
      },
      {
          "namespace": "Alexa.Cooking.TemperatureController",
          "name": "preheatTimeInterval",
          "value": {
            "start": "2019-11-11T20:30:00Z",
            "end": "2019-11-11T21:00:00Z"
          },
          "timeOfSample": "2019-11-11T21:20:52.32Z",
          "uncertaintyInMilliseconds": 0
      },
      {
        "namespace": "Alexa.Cooking.TemperatureSensor",
        "name": "cookingTemperature",
        "value": {
          "value": 325,
          "scale": "FAHRENHEIT"
        },
        "timeOfSample": "2019-11-11T21:20:52.32Z",
        "uncertaintyInMilliseconds": 0
      },
      {
         "namespace": "Alexa.Cooking",
         "name": "cookingMode",
         "value": "BAKE",
         "timeOfSample": "2019-11-11T21:20:52.32Z",
         "uncertaintyInMilliseconds": 0
      },
      {
         "namespace": "Alexa.Cooking",
         "name": "foodItem",
         "value":{
            "foodName": "Roast",
            "foodQuantity":{
               "@type": "Weight",
               "value": 5.5,
               "unit": "POUND"
            }
         },
         "timeOfSample": "2019-11-11T21:20:52.32Z",
         "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:52.32Z",
          "uncertaintyInMilliseconds": 0
      }
    ]
  }
}

Change reporting

You send a ChangeReport event to report changes proactively in the state of an endpoint. You identify the properties that you proactively report in your discovery response. For more details about change reports, see Understand State and Change Reporting.

ChangeReport event example

{  
  "event": {
    "header": {
      "namespace": "Alexa",
      "name": "ChangeReport",
      "messageId": "Unique identifier, preferably a version 4 UUID",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerToken",
        "token": "OAuth2.0 bearer token"
      },
      "endpointId": "Endpoint ID"
    },
    "payload": {
      "change": {
        "cause": {
          "type": "PERIODIC_POLL"
        },
        "properties": [
          {
              "namespace": "Alexa.Cooking.TemperatureController",
              "name": "targetCookingTemperature",
              "value": {
                  "value": 325,
                  "scale": "FAHRENHEIT"
              },
              "timeOfSample": "2019-11-11T21:20:52.32Z",
              "uncertaintyInMilliseconds": 0
          },
          {
              "namespace": "Alexa.Cooking.TemperatureController",
              "name": "preheatTimeInterval",
              "value": {
                "start": "2019-11-11T20:30:00Z",
                "end": "2019-11-11T21:00:00Z"
              },
              "timeOfSample": "2019-11-11T21:20:52.32Z",
              "uncertaintyInMilliseconds": 0
          },
          {
            "namespace": "Alexa.Cooking.TemperatureSensor",
            "name": "cookingTemperature",
            "value": {
              "value": 325,
              "scale": "FAHRENHEIT"
            },
            "timeOfSample": "2019-11-11T21:20:52.32Z",
            "uncertaintyInMilliseconds": 0
          },
          {
             "namespace": "Alexa.Cooking",
             "name": "cookingMode",
             "value": "BAKE",
             "timeOfSample": "2019-11-11T21:20:52.32Z",
             "uncertaintyInMilliseconds": 0
          },
          {
             "namespace": "Alexa.Cooking",
             "name": "foodItem",
             "value":{
                "foodName": "Roast",
                "foodQuantity":{
                   "@type": "Weight",
                   "value": 5.5,
                   "unit": "POUND"
                }
             },
             "timeOfSample": "2019-11-11T21:20:52.32Z",
             "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:52.32Z",
              "uncertaintyInMilliseconds": 0
          }
        ]
      }
    }
  },
 "context": {
    "namespace": "Alexa.EndpointHealth",
    "name": "connectivity",
    "value": {
      "value": "OK"
    },
    "timeOfSample": "2019-11-11T21:10:02.12Z",
    "uncertaintyInMilliseconds": 0
  }
}
}

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 details, see AddOrUpdateReport event.

AddOrUpdateReport event example

{
  "event": {
    "header": {
      "namespace": "Alexa.Discovery",
      "name": "AddOrUpdateReport",
      "payloadVersion": "3",
      "messageId": "Unique identifier, preferably a version 4 UUID"
    },
    "payload": {
      "endpoints": [
        {
          "endpointId": "Unique ID of the endpoint",
          "manufacturerName": "Manufacturer of the endpoint",
          "description": "Description to be shown in the Alexa app",
          "friendlyName": "Oven",
          "displayCategories": ["OVEN"],
          "cookie": {},
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Cooking.TemperatureController",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "targetCookingTemperature"
                  },
                  {
                    "name": "preheatTimeInterval"
                  }
                ],
                "proactivelyReported": true,
                "retrievable": true
              },
              "configuration": {
                "supportsRemoteStart": false,
                "supportedCookingModes": [
                  "BAKE",
                  "ROAST"
                ],
                "supportedCookingTemperatureRange": {
                  "minimumValue": "175 °F",
                  "maximumValue": "500 °F"
                }
              }
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Cooking.TemperatureSensor",
              "version": "3",
              "properties": {
                "supported": [
                  {
                    "name": "cookingTemperature"
                  }
                ],
                "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"
            }
          ]
        }
      ]
    }
  }
}

Get Started

Connect Your Device to Alexa

Certify Your Device

Developer Reference

Alexa.Cooking.TemperatureController Interface 3

Utterances

Reportable properties

Discovery

Configuration object

Discover response example

Directives

CookByTemperature directive

CookByTemperature directive example

CookByTemperature directive payload

CookByTemperature response

CookByTemperature directive error handling

State reporting

StateReport response example

Change reporting

ChangeReport event example

AddOrUpdateReport

AddOrUpdateReport event example

​Utterances

​Reportable properties

​Discovery

​Configuration object

​Discover response example

​Directives

​CookByTemperature directive

​CookByTemperature directive example

​CookByTemperature directive payload

​CookByTemperature response

​CookByTemperature directive error handling

​State reporting

​StateReport response example

​Change reporting

​ChangeReport event example

​AddOrUpdateReport

​AddOrUpdateReport event example

​Related topics

Utterances

Reportable properties

Discovery

Configuration object

Discover response example

Directives

CookByTemperature directive

CookByTemperature directive example

CookByTemperature directive payload

CookByTemperature response

CookByTemperature directive error handling

State reporting

StateReport response example

Change reporting

ChangeReport event example

AddOrUpdateReport

AddOrUpdateReport event example

Related topics