Homebridge Alexa Smart Home

This plugin enables smart home device integration between HomeKit and Alexa which allows HomeKit/Siri to control smart home devices that are connected via Amazon Alexa.

This plugin does not allow Alexa to control devices in HomeKit. For that, please see the Homebridge Alexa plugin.

Table of Contents

• Compatibility
• Currently supported devices
• Features
  • Air quality monitors
• Initial configuration
• Common issues
• Support
• Contributing
• Long-term support
• Thanks
• Disclaimer

Compatibility

Compatibility is not guaranteed with HOOBS and I am unable to provide support for HOOBS users since I do not use HOOBS.

Node.js versions supported: 16.x, 18.x, 20.x

Currently supported devices

• Lightbulbs
• Switches
  • HomeKit switches do not support brightness so any switches you have that support brightness will appear in HomeKit as Lightbulbs.
• Fans
• Outlets + smart plugs
• Thermostats
• Locks
• Air Quality Monitors
  • Only confirmed to work with Amazon Air Quality Monitor. Please report an issue if it doesn't work with your air quality monitor.
• Device types not listed above that support on/off will be added as switches. For example:
  • Air fresheners
  • Vacuum cleaners
  • Game consoles
• Request / vote on device types you would like to see supported.

Features

• Devices already linked to your Alexa account can be integrated with HomeKit automatically.
• Only Amazon credentials needed to configure this plugin rather than credentials for all your devices.
• This plugin does not store your Amazon username or password. Instead, it uses session cookies that are valid for up to 14 days. This plugin will automatically refresh the session cookie before it expires.

Air quality monitors

All of the following are supported depending on what your device measures:

• Air quality score (Excellent / Fair / Poor)
• Particulate matter density (PM2.5)
• VOC Density
• Carbon monoxide levels
• Relative humidity percent
• Temperature

When you first add an Air Quality Monitor to HomeKit, the above measurements may appear in the Default Room but can be assigned to any room you choose.

Initial configuration

The first time this plugin starts, you will need to authenticate using your Amazon Alexa account. Please follow these steps in order - screenshots included.

1. Verify that your plugin configuration is correct. Specifically, the proxy clientHost and port. The clientHost should be the same host you use to access homebridge. For example, if you access homebridge via the url http://my-homebridge-server.local:8581 then clientHost should be my-homebridge-server.local. The port should be a different value from homebridge (not 8581). Restart Homebridge if you made any changes to the settings.
   1. It is highly recommended to explicitly provide in the plugin settings the device names you wish to use with this plugin. The plugin performs much better this way.
   2. 
2. Download the Alexa app onto a device of your choosing (smartphone, tablet, etc) and sign in using the Amazon account your devices are linked to. Confirm the amazonDomain plugin setting matches what you see in the Alexa app. Go to Settings -> About, scroll to the bottom, and look for Host Name. The Host Names you see should end with the amazonDomain you choose in the plugin settings, it will not match exactly.
3. This plugin may not work and support or help troubleshooting will not be provided if you do not use multi-factor authentication / two-step verification or if you use SMS for the verification code. Again, SMS two step verification will not work. Please download an authenticator app such as AWS Virtual MFA, Google Authenticator, Microsoft Authenticator and follow the instructions to enable two step verification on Amazon's website.
4. Check the homebridge logs for an error that you must manually open the url to authenticate.
   1. 
5. Visit the url in your browser to open a login screen. If you open the url from a mobile device the Alexa App is installed on, it may not work because Amazon might open the Alexa App. It is recommended to use a device, preferably a computer, the Alexa App is not installed on. When the page loads, it is a real login screen proxied so the plugin can capture the session cookie. The username/password are not stored by the plugin.
   1. 
6. Enter your MFA code if you have MFA enabled on your Amazon Alexa account. Again, the plugin does not store this value.
   1. 
7. If successful, you should see a message that the Amazon Alexa cookie was successfully retrieved. If you see a 404 page, return to step 3 and start over.
   1. 
8. The homebridge logs will also show a message such as "Successfully authenticated Alexa account".
   1. 

Common issues

Support

Please visit the Canny feedback board first to see if your issue or request is currently being worked on. You can also suggest new features and vote on features requested by others.

If you run into issues or you need help please use the issues template. Fill all the relevant sections and submit your issue. It is important that you use the templates because I will automatically be assigned to your issue and I will receive an email. If you use the blank template without assigning me, I will most likely miss the Github notification.

Contributing

Please see CONTRIBUTING.md and PULL_REQUEST_TEMPLATE.md

Long-term support

Please consider supporting the development of this plugin by sponsoring me. Sponsorship will encourage me to continue improving this plugin, support more devices, adapt to changes in the Alexa API, and fuel my late-night coding sessions. :coffee:

Thanks

A huge thanks is due to Apollon77 for maintaining alexa-remote2, alexa-cookie2, and ioBroker.alexa2. This plugin is made possible due to those projects.

Disclaimer

• I am not affiliated with Amazon nor any of the device brands and this plugin is a personal project that I maintain in my free time
• Use this plugin entirely at your own risk
• Please see license for more information