Connect a Tower Fan to Alexa
The following shows an example of how to use the capability interfaces to connect a tower fan to Alexa.
Capabilities
This example tower fan declares the following capabilities.
| Capability | Purpose | Example utterance |
|---|---|---|
|
Allows a customer to turn the device on or off. |
"Turn on the Tower Fan" |
|
|
ToggleController "Oscillate" |
Allows a customer to turn the oscillate feature of the fan on or off. |
"Turn on oscillate on the tower fan." |
|
RangeController "Fan Speed" |
Allows a customer to control the speed of the fan. This example also specifies presets of minimum and maxium for specific |
"Set the fan speed to 5." "Turn up the speed on the tower fan" "Set the air speed on the tower fan to Maximum" |
|
Contains directives and events related to state and error reporting. Make sure to explicitly include this interface and the supported version in the discovery response. |
Not applicable. |
|
|
Enables in-depth reporting of the state of the device to the customer through experiences like the Alexa app. |
Not applicable. |
Discovery
The tower fan provides the following AddOrUpdateReport.
{
"event": {
"header": {
"namespace": "Alexa.Discovery",
"name": "AddOrUpdateReport",
"payloadVersion": "3",
"messageId": "00000000-0000-0000-0000-000000000000"
},
"payload": {
"endpoints": [
{
"endpointId": "appliance-001",
"friendlyName": "Tower Fan",
"description": "Tower Fan by Sample Manufacturer",
"manufacturerName": "Sample Manufacturer",
"displayCategories": [
"OTHER"
],
"cookie": {},
"capabilities": [
{
"type": "AlexaInterface",
"interface": "Alexa.PowerController",
"version": "3",
"properties": {
"supported": [
{
"name": "powerState"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.ToggleController",
"version": "3",
"instance": "SampleManufacturer.Fan.Oscillate",
"capabilityResources": {
"friendlyNames": [
{
"@type": "text",
"value": {
"text": "Oscillate",
"locale": "en-US"
}
},
{
"@type": "text",
"value": {
"text": "Oscillation",
"locale": "en-US"
}
}
]
},
"properties": {
"proactivelyReported": true,
"retrievable": true,
"supported": [
{
"name": "toggleState"
}
]
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.RangeController",
"version": "3",
"instance": "SampleManufacturer.Fan.Speed",
"capabilityResources": {
"friendlyNames": [
{
"@type": "text",
"value": {
"text": "Fan Speed",
"locale": "en-US"
}
},
{
"@type": "text",
"value": {
"text": "Air Speed",
"locale": "en-US"
}
},
{
"@type": "text",
"value": {
"text": "Speed",
"locale": "en-US"
}
}
]
},
"properties": {
"supported": [
{
"name": "rangeValue"
}
],
"proactivelyReported": true,
"retrievable": true
},
"configuration": {
"supportedRange": {
"minimumValue": 1,
"maximumValue": 10,
"precision": 1
},
"presets": [
{
"rangeValue": 1,
"presetResources": {
"friendlyNames": [
{
"@type": "asset",
"value": {
"assetId": "Alexa.Value.Low"
}
},
{
"@type": "asset",
"value": {
"assetId": "Alexa.Value.Minimum"
}
}
]
}
},
{
"rangeValue": 10,
"presetResources": {
"friendlyNames": [
{
"@type": "asset",
"value": {
"assetId": "Alexa.Value.High"
}
},
{
"@type": "asset",
"value": {
"assetId": "Alexa.Value.Maximum"
}
}
]
}
}
]
}
},
{
"type": "AlexaInterface",
"interface": "Alexa.EndpointHealth",
"version": "3",
"properties": {
"supported": [
{
"name": "connectivity"
}
],
"proactivelyReported": true,
"retrievable": true
}
},
{
"type": "AlexaInterface",
"interface": "Alexa",
"version": "3"
}
]
}
]
}
}
}
Related resources
For more details on state reporting, see Understand State Reporting for a Smart Home Skill.
If the device has additional capabilities, you can add other capability interfaces.