FauxmoESP

Deprecated! The code has been included in the main repo at: https://bitbucket.org/xoseperez/fauxmoesp *

Amazon Alexa support for ESP8266 and ESP32 devices.

This is a library for ESP8266/ESP32-based devices that emulates a Belkin WeMo device and thus allows you to control them using this protocol, in particular from Alexa-powered devices like the Amazon Echo or the Dot.

Attention: - Some Echo Generation 2 Devices are not able to discover FauxmoESP devices. So far there is no way to get them to work in this case. See: https://bitbucket.org/xoseperez/fauxmoesp/issues/25/echo-doesnt-discover-device

Original ESP8266 Code by Xose Pérez https://bitbucket.org/xoseperez/fauxmoesp

Origin

This library is a port of Maker Musings' Fauxmo Python library.

ESP8266 Code by Xose Pérez https://bitbucket.org/xoseperez/fauxmoesp

Additional ESP32 Code by Frank Hellmann

Dependencies

ESP8266:

This library uses ESPAsyncTCP libraries by me-no-dev.

ESP32:

This library uses AsyncTCP libraries by me-no-dev

PlatformIO

If you are using PlatformIO (check the section bellow on how to compile it) you can install them by adding the dependencies to your platformio.ini file:


lib_deps =
    ESPAsyncTCP     or AsyncTCP

Arduino IDE

You will need to install the required library from sources. Your best option is to download the library as a ZIP file and install it using the option under "Sketch > Include Library > Add .ZIP Library...".

You can look for it manually but I have gathered the URL here for convenience:

Device	Library	Repository	ZIP
ESP8266	ESPAsyncTCP by Hristo Gochkov ESP8266	GIT	ZIP
ESP32	AsyncTCP by Hristo Gochkov ESP32	GIT	ZIP

Usage

The library is very easy to use, basically instantiate an object, connect to the Wifi, add one or more virtual devices and bind the callback to get the messages. An schematic example could be:

#include <fauxmoESP.h>

fauxmoESP fauxmo;

void setup() {

    Serial.begin(115200);

    ... connect to wifi ...

    fauxmo.addDevice("light one");
    fauxmo.addDevice("light two");
    fauxmo.addDevice("light three");
    fauxmo.addDevice("light four");
    fauxmo.enable(true);

    fauxmo.onSetState([](unsigned char device_id, const char * device_name, bool state) {
        Serial.printf("[MAIN] Device #%d (%s) state: %s\n", device_id, device_name, state ? "ON" : "OFF");
    });
    fauxmo.onGetState([](unsigned char device_id, const char * device_name) {
        return true; // whatever the state of the device is
    });

}

void loop() {
    fauxmo.handle();
}

(Check the examples folder)

Then run the "discover devices" option from your Alexa app or web (in the Smart Home section). A new device with the name you have configured should appear. Tell Alexa to switch it on or off and check your terminal ;)

Device discovery

Device discovery can be incomplete when you have lots of devices defined. Since version 2.0.0 different strategies are used to maximize the chance of getting all of them discovered during the first round.

Tests have been run with up to 16 devices with success but your experience might be different. If not all of them are discovered on the first run, execute the Discover Devices option again from your Alexa app or tell your Echo/Dot to do it. Once they pop up in your devices list (even if they are flagged as "Offline") they should work just fine.

The strategies the library uses to improve discoverability are:

Space UDP responses to help Echo/Dot and the device itself to perform setup queries
Repeat UDP responses for devices not queried
Randomize UDP responses

sandman72/Fauxmoesp