Smart Home Microwave Guide
action.devices.types.MICROWAVE
- Interactions with microwaves may include starting and stopping, setting a timer, adjusting cooking modes and food presets, and adjusting non-cooking modes.
This type indicates that the device gets the Microwave 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.
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 microwave
This section contains example intent payloads representing a common "Microwave" 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.MICROWAVE", "traits": [ "action.devices.traits.Cook", "action.devices.traits.Timer", "action.devices.traits.StartStop" ], "name": { "name": "Simple microwave" }, "willReportState": true, "attributes": { "supportedCookingModes": [ "DEFROST", "MICROWAVE", "WARM" ], "maxTimerLimitSec": 6039, "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, "isRunning": true, "isPaused": false, "timerRemainingSec": 60, "currentCookingMode": "WARM" } } } }
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": true, "cookingMode": "MICROWAVE" } } ] } ] } } ] }
{ "requestId": "6894439706274654516", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "currentCookingMode": "MICROWAVE" } } ] } }
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": 60 } } ] } ] } } ] }
{ "requestId": "6894439706274654522", "payload": { "commands": [ { "ids": [ "123" ], "status": "SUCCESS", "states": { "online": true, "timerRemainingSec": 60 } } ] } }
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": 50 } } ] } }
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": 60, "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": 60, "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 } } ] } }
Sample utterances
en-US
Turn on {{devName}}
Turn off {{devName}}
Start the microwave
Stop the microwave
Start the timer on {{devName}} for 2 minutes
de-DE
Schalte die {{devName}} an
Schalte die {{devName}} aus
Start die Mikrowelle
Stopp die Mikrowelle
Stell den Timer des {{devName}} auf Dauer 2 Minuten
fr-FR
Allume {{devName}}
Éteins {{devName}}
Démarre le micro-ondes
Arrête le micro-ondes
Mets un minuteur de 2 minutes sur {{devName}}
es-ES
Enciende el {{devName}}
Apaga el {{devName}}
Pon el microondas en marcha
Para el microondas
Pon un temporizador de 2 minutos en {{devName}}