前回までの記事で、ESP8266で家電を制御する為にESP8266をarduinoで利用できる手順やIRremotoという赤外線ライブラリの使い方、さらにalexaでESP8266を認識して制御できるようにするWemoEmulatorライブラリを紹介しましたが、2019年7月の段階で第三世代alexaではESP8266 WemoEmulatorを認識はしますが、サーバーエラーとなり家電を音声制御する事ができませんでした。
ですので、今回はalexaとESP8266の連携ライブラリをESP8266WemoEmulatorからfauxmoESPというライブラリに変更して家電を音声制御します。
2020年1月1日 FaumoESPを使ったプログラムでalexa側でデバイスが3つ以上になると検索できなくなる現象がありますが、書き込み時にある事をすると解消されます。詳細はこちらで書いてます。
前提条件ですが、arduinoIDEでESP8266を利用する手順やESP8266で赤外線を利用するライブラリのIRremoteの導入手順やプログラムのしかたなどは同様です。
最初から学びたい方はこちらから
②激安ESP8266(alexa経由で)で家電を音声操作してみる ~赤外線解析編~
③激安ESP8266を用いてアレクサ経由で家電コントロール(第2世代のalexaまで可能) 〜プログラム編その①〜
fauxmoESPライブラリの導入
導入もむっちゃ簡単です。
fauxmoESPのホームページからライブラリをZIP形式でダウンロードします。
↑ダウンロードする場所ですが、赤丸のESPAsyncTCPというライブラリもどうやらいるようですのでこれと、
もう一つは画面の左の”ダウンロード”からfauxmoEXPをダウンロードしまう。
下の画像がダウンロードできるgithubのページです。
いずれもダウンロードする場合はZIP形式で保存します。
ダウンロード場所は任意の場所に保存します。
arduinoIDEにライブラリをインストールする
fauxmoEXPとESPAsyncTCPライブラリはarduinoを開いてスケッチ→ライブラリをインクルード→.zip形式のライブラリをインストールと進んでダウンロードしたファイルを選択すると自動的にライブラリを導入できます。
これだけです。
むっちゃ簡単です。
fauxmoESPの使い方
ESPAsyncTCPはなんの役にたつのかわからないのですがとりあえず、このライブラリもいるよってreadmeに書いてあったので、、、、
それでは実際にfauxmoESPの使い方についてご紹介いたします。
基本的にはライブラリ上のプログラム例があるのでそれを自分なりに変更して使うのが手っ取り早いです。
とりあえずarduinoIDE上のスケッチ例→fauxmoESP→fauxmoESP_basicを選べば間違いありません。
スクラッチ例が開くと・・↓
デフォルトのプログラムですが二つのファイルの構成になっています。
下の図は二つのファイルのうちの一つです。
何を規定しているのかというとESP8266がwifiに繋がる時のSSIDとパスワードを入れる設定です。
ここに自宅のwifiの設定を記入します。
実際のプログラムについて
実際にのスケッチ例として記載されているのが下のコードになります。
- #include <Arduino.h>
- #ifdef ESP32
- #include <WiFi.h>
- #else
- #include <ESP8266WiFi.h>
- #endif
- #include “fauxmoESP.h”
- // Rename the credentials.sample.h file to credentials.h and
- // edit it according to your router configuration
- #include “credentials.h”
- fauxmoESP fauxmo;
- // —————————————————————————–
- //このへんまでは触る必要なし
- #define SERIAL_BAUDRATE 115200
- //#define でESP8266のポート番号に名前を規定しています。
- #define LED_YELLOW 4 //たとえばここでは4番ポートの名前はLED_YELLOWです
- #define LED_GREEN 5
- #define LED_BLUE 0
- #define LED_PINK 2
- #define LED_WHITE 15
- //この下の設定でalexaに表示される名前を規定しまいます。alexa”yellow lamp”をつけてとかいう使い方
- #define ID_YELLOW “yellow lamp”
- #define ID_GREEN “green lamp”
- #define ID_BLUE “blue lamp”
- #define ID_PINK “pink lamp”
- #define ID_WHITE “white lamp”
- // —————————————————————————–
- // —————————————————————————–
- // Wifi ここからwifiの設定 まったくいじる必要なし
- // —————————————————————————–
- void wifiSetup() {
- // Set WIFI module to STA mode
- WiFi.mode(WIFI_STA);
- // Connect
- Serial.printf(“[WIFI] Connecting to %s “, WIFI_SSID);
- WiFi.begin(WIFI_SSID, WIFI_PASS);
- // Wait
- while (WiFi.status() != WL_CONNECTED) {
- Serial.print(“.”);
- delay(100);
- }
- Serial.println();
- // Connected!
- Serial.printf(“[WIFI] STATION Mode, SSID: %s, IP address: %s\n”, WiFi.SSID().c_str(), WiFi.localIP().toString().c_str());
- }
- void setup() {
- // Init serial port and clean garbage
- Serial.begin(SERIAL_BAUDRATE);
- Serial.println();
- Serial.println();
- // LEDs ここでESP8266のピンの設定です。全てoutput に設定、要は出力です。
- pinMode(LED_YELLOW, OUTPUT);
- pinMode(LED_GREEN, OUTPUT);
- pinMode(LED_BLUE, OUTPUT);
- pinMode(LED_PINK, OUTPUT);
- pinMode(LED_WHITE, OUTPUT);
- digitalWrite(LED_YELLOW, LOW);
- digitalWrite(LED_GREEN, LOW);
- digitalWrite(LED_BLUE, LOW);
- digitalWrite(LED_PINK, LOW);
- digitalWrite(LED_WHITE, LOW);
- // Wifi wifiをつなぎます このへんも特に触る必要なし
- wifiSetup();
- // By default, fauxmoESP creates it’s own webserver on the defined port
- // The TCP port must be 80 for gen3 devices (default is 1901)
- // This has to be done before the call to enable()
- fauxmo.createServer(true); // not needed, this is the default value
- fauxmo.setPort(80); // This is required for gen3 devices
- // You have to call enable(true) once you have a WiFi connection
- // You can enable or disable the library at any moment
- // Disabling it will prevent the devices from being discovered and switched
- fauxmo.enable(true);
- // You can use different ways to invoke alexa to modify the devices state:
- // “Alexa, turn yellow lamp on”
- // “Alexa, turn on yellow lamp
- // “Alexa, set yellow lamp to fifty” (50 means 50% of brightness, note, this example does not use this functionality)
- // Add virtual devices alexa側での仮想デバイスを設定しています。
- fauxmo.addDevice(ID_YELLOW);
- fauxmo.addDevice(ID_GREEN);
- fauxmo.addDevice(ID_BLUE);
- fauxmo.addDevice(ID_PINK);
- fauxmo.addDevice(ID_WHITE);
- //ここからが音声制御したときのESP8266の動作を決める部分です。
- fauxmo.onSetState([](unsigned char device_id, const char * device_name, bool state, unsigned char value) {
- // Callback when a command from Alexa is received.
- // You can use device_id or device_name to choose the element to perform an action onto (relay, LED,…)
- // State is a boolean (ON/OFF) and value a number from 0 to 255 (if you say “set kitchen light to 50%” you will receive a 128 here).
- // Just remember not to delay too much here, this is a callback, exit as soon as possible.
- // If you have to do something more involved here set a flag and process it in your main loop.
- Serial.printf(“[MAIN] Device #%d (%s) state: %s value: %d\n”, device_id, device_name, state ? “ON” : “OFF”, value);
- // Checking for device_id is simpler if you are certain about the order they are loaded and it does not change.
- // Otherwise comparing the device_name is safer.
- //ここから下を変更すれば様々な制御が可能です。
- //下のプログラムはdevice_nameがID_YELLOWと同じならLED_YELLOWをHIGHにそうでなければLOWにという設定です。
- //少し複雑かもしれませんがよく確認すれば簡単です。
- if (strcmp(device_name, ID_YELLOW)==0) {
- digitalWrite(LED_YELLOW, state ? HIGH : LOW);
- } else if (strcmp(device_name, ID_GREEN)==0) {
- digitalWrite(LED_GREEN, state ? HIGH : LOW);
- } else if (strcmp(device_name, ID_BLUE)==0) {
- digitalWrite(LED_BLUE, state ? HIGH : LOW);
- } else if (strcmp(device_name, ID_PINK)==0) {
- digitalWrite(LED_PINK, state ? HIGH : LOW);
- } else if (strcmp(device_name, ID_WHITE)==0) {
- digitalWrite(LED_WHITE, state ? HIGH : LOW);
- }
- });
- }
- void loop() {
- // fauxmoESP uses an async TCP server but a sync UDP server
- // Therefore, we have to manually poll for UDP packets
- fauxmo.handle();
- // This is a sample code to output free heap every 5 seconds
- // This is a cheap way to detect memory leaks
- static unsigned long last = millis();
- if (millis() – last > 5000) {
- last = millis();
- Serial.printf(“[MAIN] Free heap: %d bytes\n”, ESP.getFreeHeap());
- }
- // If your device state is changed by any other means (MQTT, physical button,…)
- // you can instruct the library to report the new state to Alexa on next request:
- // fauxmo.setState(ID_YELLOW, true, 255);
- }
とりあえず上記のようなプログラムを変更して自分なりのものに変更していきます。
ちなみに私はテレビの赤外線を操作するので、IRremoteライブラリをいれて赤外線LEDを出力とするプログラム変更を行いました。
ご参考に以下にご紹介します。
- #include <Arduino.h>
- #ifdef ESP32
- #include <WiFi.h>
- #else
- #include <ESP8266WiFi.h>
- #endif
- #include “fauxmoESP.h”
- // Rename the credentials.sample.h file to credentials.h and
- // edit it according to your router configuration
- #include “kazunet.h”
- //IRremoteESP8266で赤外線信号の送信設定
- #include <Arduino.h>
- #include <IRremoteESP8266.h>
- #include <IRsend.h>
- //4番ピンを赤外線送信pinに設定 ESP8266ではD2になる
- const uint16_t kIrLed = 4; // ESP8266 GPIO pin to use. Recommended: 4 (D2).
- IRsend irsend(kIrLed); // Set the GPIO to be used to sending the message.
- fauxmoESP fauxmo;
- // —————————————————————————–
- #define SERIAL_BAUDRATE 115200
- #define ID_tv “tv”
- #define ID_chA “chA”
- #define ID_chB “chB”
- #define ID_chC “chC”
- #define ID_chD “chD”
- #define ID_sound “sound”
- #define ID_chchange “chchange”
- // —————————————————————————–
- // —————————————————————————–
- // Wifi
- // —————————————————————————–
- void wifiSetup() {
- // Set WIFI module to STA mode
- WiFi.mode(WIFI_STA);
- // Connect
- Serial.printf(“[WIFI] Connecting to %s “, WIFI_SSID);
- WiFi.begin(WIFI_SSID, WIFI_PASS);
- // Wait
- while (WiFi.status() != WL_CONNECTED) {
- Serial.print(“.”);
- delay(100);
- }
- Serial.println();
- // Connected!
- Serial.printf(“[WIFI] STATION Mode, SSID: %s, IP address: %s\n”, WiFi.SSID().c_str(), WiFi.localIP().toString().c_str());
- }
- void setup() {
- // Init serial port and clean garbage
- Serial.begin(SERIAL_BAUDRATE);
- Serial.println();
- Serial.println();
- //赤外線リモートのライブラリをスタート
- irsend.begin();
- // Wifi
- wifiSetup();
- // By default, fauxmoESP creates it’s own webserver on the defined port
- // The TCP port must be 80 for gen3 devices (default is 1901)
- // This has to be done before the call to enable()
- fauxmo.createServer(true); // not needed, this is the default value
- fauxmo.setPort(80); // This is required for gen3 devices
- // You have to call enable(true) once you have a WiFi connection
- // You can enable or disable the library at any moment
- // Disabling it will prevent the devices from being discovered and switched
- fauxmo.enable(true);
- // You can use different ways to invoke alexa to modify the devices state:
- // “Alexa, turn yellow lamp on”
- // “Alexa, turn on yellow lamp
- // “Alexa, set yellow lamp to fifty” (50 means 50% of brightness, note, this example does not use this functionality)
- // Add virtual devices
- fauxmo.addDevice(ID_tv);
- fauxmo.addDevice(ID_chA);
- fauxmo.addDevice(ID_chB);
- fauxmo.addDevice(ID_chC);
- fauxmo.addDevice(ID_chD);
- fauxmo.addDevice(ID_sound);
- fauxmo.addDevice(ID_chchange);
- fauxmo.onSetState([](unsigned char device_id, const char * device_name, bool state, unsigned char value) {
- // Callback when a command from Alexa is received.
- // You can use device_id or device_name to choose the element to perform an action onto (relay, LED,…)
- // State is a boolean (ON/OFF) and value a number from 0 to 255 (if you say “set kitchen light to 50%” you will receive a 128 here).
- // Just remember not to delay too much here, this is a callback, exit as soon as possible.
- // If you have to do something more involved here set a flag and process it in your main loop.
- Serial.printf(“[MAIN] Device #%d (%s) state: %s value: %d\n”, device_id, device_name, state ? “ON” : “OFF”, value);
- // Checking for device_id is simpler if you are certain about the order they are loaded and it does not change.
- // Otherwise comparing the device_name is safer.
- //digitalWrite(LED_YELLOW, state ? HIGH : LOW);
- if (strcmp(device_name, ID_tv)==0) {
- //digitalWrite(LED_GREEN, state ? HIGH : LOW);
- if(state==true){
- //tvOn
- irsend.sendNEC(0x002FD48B7,32);
- }else{
- //tvOff
- irsend.sendNEC(0x002FD48B7,32);
- }
- } else if (strcmp(device_name, ID_chA)==0) {
- //digitalWrite(LED_PINK, state ? HIGH : LOW);
- if(state==true){
- //ch1
- irsend.sendNEC(0x002FD807F,32);
- }else{
- //ch2
- irsend.sendNEC(0x002FD40BF,32);
- }
- } else if (strcmp(device_name, ID_chB)==0) {
- //digitalWrite(LED_WHITE, state ? HIGH : LOW);
- if(state==true){
- //ch3
- irsend.sendNEC(0x002FD20DF,32);
- }else{
- //ch4
- irsend.sendNEC(0x002FDA05F,32);
- }
- }else if (strcmp(device_name, ID_chC)==0) {
- //digitalWrite(LED_WHITE, state ? HIGH : LOW);
- if(state==true){
- //ch5
- irsend.sendNEC(0x002FD609F,32);
- }else{
- //ch6
- irsend.sendNEC(0x002FD10EF,32);
- }
- }else if (strcmp(device_name, ID_chD)==0) {
- //digitalWrite(LED_WHITE, state ? HIGH : LOW);
- if(state==true){
- //ch7
- irsend.sendNEC(0x002FDD02F,32);
- }else{
- //ch8
- irsend.sendNEC(0x002FDD02F,32);
- }
- }else if (strcmp(device_name, ID_sound)==0) {
- //digitalWrite(LED_WHITE, state ? HIGH : LOW);
- if(state==true){
- //sounUp
- irsend.sendNEC(0x002FD58A7,32);
- }else{
- //soundDown
- irsend.sendNEC(0x002FD7887,32);
- }
- }else if (strcmp(device_name, ID_chchange)==0) {
- //digitalWrite(LED_WHITE, state ? HIGH : LOW);
- if(state==true){
- //chUP
- //↓で赤外線出力
- irsend.sendNEC(0x002FDD827,32);
- }else{
- //chDown
- irsend.sendNEC(0x002FDF807,32);
- }
- }
- });
- }
- void loop() {
- // fauxmoESP uses an async TCP server but a sync UDP server
- // Therefore, we have to manually poll for UDP packets
- fauxmo.handle();
- // This is a sample code to output free heap every 5 seconds
- // This is a cheap way to detect memory leaks
- static unsigned long last = millis();
- if (millis() – last > 5000) {
- last = millis();
- Serial.printf(“[MAIN] Free heap: %d bytes\n”, ESP.getFreeHeap());
- }
- // If your device state is changed by any other means (MQTT, physical button,…)
- // you can instruct the library to report the new state to Alexa on next request:
- // fauxmo.setState(ID_YELLOW, true, 255);
- }
こんな簡単なプログラムでalexaを簡単音声操作できます。
これでESP8266がうまくwifiにつながれば同一ネットワークに繋がる携帯からalexaアプリを起動してデバイスの追加でプログラム上のデバイス名が検索されたら難関突破です
その後は定型アクションでどう動かしたいかを(どう話しかければどれがどう反応するか)決めて完了です。
一番参考になったのはここのサイトです。ただ、ここのサイトは第3世代alexaでは動かないWemoEmuratorを利用している点に注意です。
ぜひ試してみてください。