Alexa.Cooking.TimeController Interface
Implement the Alexa.Cooking.TimeController capability interface so that users can control appliances that cook by time, temperature, and power level. Through this interface, users can cook by time alone, by time and power level, or by time and temperature. Users can't cook by both temperature and power level.
You must use the TimeController interface in conjunction with the Alexa.Cooking interface. For more information about cooking skills, see Build Smart Home Skills for Cooking Appliances.
For the list of locales that are supported for the TimeController interface, see List of Capability Interfaces and Supported Locales.
Utterances
When you use the Alexa.Cooking.TimeController interface, the voice interaction model is already built for you. The following examples show some customer utterances:
Alexa, two minutes on the microwave.
Alexa, thirty more seconds to the microwave.
Alexa, cook for three minutes on low in microwave.
Alexa, cook for three minutes on level five in the microwave.
Alexa, cook chicken for two minutes.
Alexa, defrost chicken for three minutes on low in the microwave.
Alexa, bake my cookies at three hundred and fifty degrees for ten minutes.
After the customer says one of these utterances, Alexa sends a corresponding directive to your skill.
Properties
The Alexa.TimeController interface uses the requestedCookTime and cookingPowerLevel properties as the primary properties. The requestedCookTime property represents the duration of a cooking session. The cookingPowerLevel property represents power level of a cooking session expressed as an enumeratedPowerLevel or an integralPowerLevel.
Discovery
You describe endpoints that support Alexa.TimeController 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 TimeController, 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 CookByTime 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 values. | Yes |
enumeratedPowerLevels |
The enumerated power levels that the device supports, such as LOW, MEDIUM, HIGH. If you don't support enumerated power levels, and the user attempts to control the power with a value such as HIGH, Alexa reports an error to the user. |
An array of enumeratedPowerLevels. | No |
integralPowerLevels |
The integral power levels that the device supports. If you don't support integral power levels, and the user attempts to control the power with an integral value, Alexa reports an error to the user. | An array of integralPowerLevels. | No |
Discover response example
The following example shows a Discover.Response message for a microwave endpoint that supports the TimeController 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": "Microwave",
"displayCategories": ["MICROWAVE"],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.Cooking.TimeController",
"version": "3",
"properties": {
"supported": [
{
"name": "requestedCookTime"
},
{
"name": "cookingPowerLevel"
}
],
"proactivelyReported": true,
"retrievable": true
},
"configuration": {
"supportsRemoteStart": false,
"supportedCookingModes": ["DEFROST", "REHEAT"],
"enumeratedPowerLevels": ["LOW", "MEDIUM", "HIGH"],
"integralPowerLevels": [1, 2, 3, 4, 5]
}
},
{
"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", "PRESET", "OFF"]
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}
Directives
CookByTime directive
Support the CookByTime directive so that customers can start a cooking session. Users can cook by time alone, by time and power level, or by time and temperature. Users can't cook by both temperature and power level.
The following example shows a customer utterance:
Alexa, two minutes on the microwave.
CookByTime directive payload details
| Field | Description | Type |
|---|---|---|
cookTime |
The amount of time to cook. This field is always included in the payload. | A duration object. |
cookingMode |
The cooking mode for the cooking session, such as REHEAT. 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. |
cookingPowerLevel |
The power for the cooking session, such as LOW. This field is only included if the user specifies it. |
An enumeratedPowerLevel or an integralPowerLevel. |
targetCookingTemperature |
The temperature for the cooking session. This field is only included if the user specifies it. | A temperature object. |
CookByTime directive example
{
"directive": {
"header": {
"namespace": "Alexa.Cooking.TimeController",
"name": "CookByTime",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "<an OAuth2 bearer token>"
},
"endpointId": "<endpoint id>",
"cookie": {}
},
"payload": {
"cookTime": "PT3M",
"cookingPowerLevel": {
"@type": "EnumeratedPowerLevel",
"value": "LOW"
}
}
}
}
CookByTime response event
If you handle a CookByTime directive successfully, respond with an Alexa.Response event. In the context object, include the values of all relevant properties.
CookByTime response event example
The following example shows a response to a CookByTime 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.
cookingMode property in the context of your response.{
"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.TimeController",
"name": "requestedCookTime",
"value": "PT25M",
"timeOfSample": "2017-08-31T23:30:00Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.TimeController",
"name": "cookingPowerLevel",
"value":{
"@type": "EnumeratedPowerLevel",
"value": "HIGH"
},
"timeOfSample": "2017-08-31T23:30:00Z",
"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
}
]
}
}
CookByTime directive error handling
If you can't handle a CookByTime 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.
AdjustCookTime directive
Support the AdjustCookTime directive so that customers can adjust the cooking time.
The following example shows a customer utterance:
Alexa, 30 more seconds to the microwave.
AdjustCookTime directive payload details
| Field | Description | Type |
|---|---|---|
cookTimeDelta |
The amount by which to change the cook time. | A duration object. |
AdjustCookTime directive example
{
"directive": {
"header": {
"namespace": "Alexa.Cooking.TimeController",
"name": "AdjustCookTime",
"messageId": "<message id>",
"correlationToken": "<an opaque correlation token>",
"payloadVersion": "3"
},
"endpoint": {
"scope": {
"type": "BearerToken",
"token": "<an OAuth2 bearer token>"
},
"endpointId": "<endpoint id>",
"cookie": {}
},
"payload": {
"cookTimeDelta": "PT30S"
}
}
}
AdjustCookTime response event
If you handle an AdjustCookTime directive successfully, respond with an Alexa.Response event. In the context object, include the values of all relevant properties.
AdjustCookTime response event example
The following example shows a response to an AdjustCookTime 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.
cookingMode property in the context of your response.{
"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.TimeController",
"name": "requestedCookTime",
"value": "PT25M",
"timeOfSample": "2017-08-31T23:30:00Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.TimeController",
"name": "cookingPowerLevel",
"value":{
"@type": "EnumeratedPowerLevel",
"value": "HIGH"
},
"timeOfSample": "2017-08-31T23:30:00Z",
"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
}
]
}
}
AdjustCookTime directive error handling
If you can't handle an AdjustCookTime 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.TimeController",
"name": "requestedCookTime",
"value": "PT25M",
"timeOfSample": "2017-08-31T23:30:00Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.TimeController",
"name": "cookingPowerLevel",
"value":{
"@type": "EnumeratedPowerLevel",
"value": "HIGH"
},
"timeOfSample": "2017-08-31T23:30:00Z",
"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": "PHYSICAL_INTERACTION"
},
"properties": [
{
"namespace": "Alexa.Cooking.TimeController",
"name": "requestedCookTime",
"value": "PT25M",
"timeOfSample": "2017-08-31T23:30:00Z",
"uncertaintyInMilliseconds": 0
},
{
"namespace": "Alexa.Cooking.TimeController",
"name": "cookingPowerLevel",
"value":{
"@type": "EnumeratedPowerLevel",
"value": "HIGH"
},
"timeOfSample": "2017-08-31T23:30:00Z",
"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": {}
}
