Smart Home Awning Guide
action.devices.types.AWNING - Awnings are retractable and can opened and closed. They can be installed indoors or outdoors.
This type indicates that the device gets the Awning 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.
Quality requirements
- Latency: must be less than or equal to 2500ms.
- Reliability: must be more than or equal to 97%.
Example device: Simple awning
This section contains example intent payloads representing a common "Awning" 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.AWNING",
"traits": [
"action.devices.traits.OpenClose"
],
"name": {
"name": "Simple awning"
},
"willReportState": 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,
"openPercent": 50
}
}
}
}
Sample EXECUTE commands
OpenClose
For additional details on the command parameters,
see the
action.devices.traits.OpenClose
reference.
{
"requestId": "6894439706274654516",
"inputs": [
{
"intent": "action.devices.EXECUTE",
"payload": {
"commands": [
{
"devices": [
{
"id": "123"
}
],
"execution": [
{
"command": "action.devices.commands.OpenClose",
"params": {
"openPercent": 100
}
}
]
}
]
}
}
]
}
{
"requestId": "6894439706274654516",
"payload": {
"commands": [
{
"ids": [
"123"
],
"status": "SUCCESS",
"states": {
"online": true,
"openPercent": 100
}
}
]
}
}