Smart Home Grill Guide
action.devices.types.GRILL - Interactions with grills may include turning them on and off, starting and stopping, setting a timer, adjusting cooking modes and food presets, and adjusting various non-cooking mode settings.
This type indicates that the device gets the Grill icon and some related synonyms and aliases.
Device capabilities
Refer to the corresponding trait documentation for implementation details, such as attributes and states that your service should support, and how to build EXECUTE and QUERY responses.
Required traits
These traits and commands are required, if applicable to your
device. If your device does not support these traits, enter the error code of
functionNotSupported in a QUERY or EXECUTE response. See
Errors and exceptions for more info.
Recommended traits
These traits are recommended, if applicable to your device. However, you are free to mix and match from all available traits to best match your existing product functionality.
Quality requirements
- Latency: must be less than or equal to 3000ms.
- Reliability: must be more than or equal to 97%.
Example device: Simple grill
This section contains example intent payloads representing a common "Grill" based on the device type and traits above. If you add or remove traits in your implementation, modify your responses accordingly to reflect those changes.
Sample SYNC response
{
"requestId": "6894439706274654512",
"inputs": [
{
"intent": "action.devices.SYNC"
}
]
}
{
"requestId": "6894439706274654512",
"payload": {
"agentUserId": "user123",
"devices": [
{
"id": "123",
"type": "action.devices.types.GRILL",
"traits": [
"action.devices.traits.Cook",
"action.devices.traits.OnOff",
"action.devices.traits.Timer",
"action.devices.traits.StartStop"
],
"name": {
"name": "Simple grill"
},
"willReportState": true,
"attributes": {
"supportedCookingModes": [
"COOK",
"GRILL"
],
"foodPresets": [
{
"food_preset_name": "chicken_key",
"supported_units": [
"POUNDS",
"OUNCES"
],
"food_synonyms": [
{
"synonym": [
"Chicken",
"Chicken breast",
"Chicken thigh"
],
"lang": "en"
}
]
},
{
"food_preset_name": "hamburger_key",
"supported_units": [
"POUNDS",
"OUNCES"
],
"food_synonyms": [
{
"synonym": [
"Hamburger",
"Burger",
"Burger patty"
],
"lang": "en"
}
]
}
],
"maxTimerLimitSec": 1200,
"pausable": true
},
"deviceInfo": {
"manufacturer": "smart-home-inc",
"model": "hs1234",
"hwVersion": "3.2",
"swVersion": "11.4"
}
}
]
}
}
Sample QUERY response
{
"requestId": "6894439706274654514",
"inputs": [
{
"intent": "action.devices.QUERY",
"payload": {
"devices": [
{
"id": "123"
}
]
}
}
]
}
{
"requestId": "6894439706274654514",
"payload": {
"devices": {
"123": {
"status": "SUCCESS",
"online": true,
"on": true,
"isRunning": true,
"isPaused": false,
"timerRemainingSec": 120,
"currentCookingMode": "GRILL",
"currentFoodPreset": "chicken_key"
}
}
}
}
Sample EXECUTE commands
Cook
For additional details on the command parameters,
see the
action.devices.traits.Cook
reference.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.Cook",
"params": {
"start": false,
"cookingMode": "GRILL"
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"currentCookingMode": "NONE",
"currentFoodPreset": "NONE"
}
}
]
}
}
OnOff
For additional details on the command parameters,
see the
action.devices.traits.OnOff
reference.
{
"requestId": "6894439706274654532",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OnOff",
"params": {
"on": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654532",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"on": true
}
}
]
}
}
TimerStart
For additional details on the command parameters,
see the
action.devices.traits.Timer
reference.
{
"requestId": "6894439706274654522",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerStart",
"params": {
"timerTimeSec": 120
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654522",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 120
}
}
]
}
}
TimerAdjust
For additional details on the command parameters,
see the
action.devices.traits.Timer
reference.
{
"requestId": "6894439706274654524",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerAdjust",
"params": {
"timerTimeSec": -10
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654524",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 110
}
}
]
}
}
TimerPause
For additional details on the command parameters,
see the
action.devices.traits.Timer
reference.
{
"requestId": "6894439706274654526",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerPause"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654526",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 120,
"timerPaused": true
}
}
]
}
}
TimerResume
For additional details on the command parameters,
see the
action.devices.traits.Timer
reference.
{
"requestId": "6894439706274654528",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerResume"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654528",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": 120,
"timerPaused": false
}
}
]
}
}
TimerCancel
For additional details on the command parameters,
see the
action.devices.traits.Timer
reference.
{
"requestId": "6894439706274654530",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.TimerCancel"
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654530",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"timerRemainingSec": -1
}
}
]
}
}
StartStop
For additional details on the command parameters,
see the
action.devices.traits.StartStop
reference.
{
"requestId": "6894439706274654518",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.StartStop",
"params": {
"start": true
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654518",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"isRunning": true,
"isPaused": false
}
}
]
}
}