More than 3 years have passed since last update.

obnizプラグインをAlexaスマートホームデバイスにする

Last updated at 2020-07-27Posted at 2020-07-26

以前の記事 ESP32をAlexa Gadgets ToolkitデバイスにしようでAlexa Gadgets Toolkitを絡めてAlexaを操ってみました。
今度は、AlexaのスマートホームをESP32で実現しようと思います。
すでに以前の記事スマートホームスキルを作る(2)：いよいよスマートホームスキルを作成するで作成経験があるので、そこまで苦ではなかったのですが、ちょうどObnizでプラグインという機能が提供されたのでそれを活用してみることが今回のモチベーションです。

スマートホームのセットアップ時に、誰のアカウントのデバイスを操作するのかアカウント認証し、以降はそのアカウントにデバイスを紐づけ、Echoデバイスに対して声で操作できるようにします。
今回は、アカウント認証にGoogleアカウントを使いました。OpenID Connect準拠であれば何でも良いです。例えばCognitoでもOKです。
アカウントに紐づいたどのデバイスを操作するかは、Obniz IDで識別します。
とはいっても、今回は複数のアカウントに対してそれぞれObnizを区別できるようには作っておらず、Obniz IDは固定にしています。（もし余力があれば、GoogleアカウントにObniz IDを紐づけ管理すればそれも可能かと思います。）

(参考) スマートホームスキルAPIについて
　https://developer.amazon.com/ja-JP/docs/alexa/smarthome/understand-the-smart-home-skill-api.html

ソースの説明は今度にしますがとりあえず、GitHubに上げておきます。

poruruba/AlexaHome
　https://github.com/poruruba/AlexaHome

サポートするデバイス

以下のURLに示す通り、たくさんの機能インタフェースが提供されていますが、今回はこのうち以下の機能を実装します。

・PowerController
・LockController
・PowerLevelController
・TemperatureSensor

(参考)機能インタフェースの一覧
　https://developer.amazon.com/ja-JP/docs/alexa/device-apis/list-of-interfaces.html

Alexaスキルの作成

まずは、とりあえず、Alexaスキルを作成しましょう。
alexa developer console
　https://developer.amazon.com/alexa/console/ask

「スキルの作成」ボタンを押下します。

スキルに追加するモデルとしてスマートホームを選択し、「スキルを作成」ボタンを押下します。

左側のスマートホームを選択し、右側に表示されたスキルIDをクリップボードにコピーします。
次にLambdaを作成します。いまだにオレゴンで作成しないと思われるので、右上のリージョンをオレゴンにします。

　https://us-west-2.console.aws.amazon.com/lambda/home?region=us-west-2#/functions

適当に関数名を決めて作成します。Node.js 12.xで行きます。
ロールを既存のロールから選択する場合は、既存のロールのログ出力先がap-northeast-1に制限されている場合があるので、us-west-2(オレゴン)からも出力できるように変更するのが都合が良いです。そうすれば、console.logがちゃんとCloudWatchに記録されます。

次に、デザイナにおいて、「＋トリガーを作成」ボタンを押下し、トリガとして「Alexa Smart Home」を選択します。アプリケーションIDのところに先ほどコピーしたスキルIDを入力します。最後に「追加」ボタンを押下します。

次に、右上にある、このLambdaのARNを覚えておきます。

alexa developer consoleに戻って、デフォルトのエンドポイントと、極東のチェックボックスをOnにしたうえで、両方のエンドポイントにさきほどのLambdaのARNを指定しておきます。最後に、「保存」ボタンを押下します。

次に、左側のナビゲーションから、アカウントリンクを選択します。
ここで、一番下の「Alexaのリダイレクト先のURL」に表示されている3つのURLをメモっておきます。

Googleアカウントでサインインの準備

GCPのコンソールを開きます。

Google Cloud Platform Console
　https://console.cloud.google.com

左上のメニュボタンから、APIとサービス→認証情報を選択します。
上の方にある「＋認証情報を作成」クリックし、OAuthクライアントIDを作成します。

アプリケーションの種類：ウェブアプリケーション
名前：適当に
承認済みのリダイレクトURI：Alexaのリダイレクト先のURL

承認済みのリダイレクトURIのところに、alexa developer consoleで表示されていたAlexaのリダイレクト先のURLを3つとも入力します。

これで、GCPからクライアントIDとクライアントシークレットが生成されますので、これをメモっておきます。

もう一度、alexa developer consoleに戻って、以下、作業します。
ユーザーがユーザーアプリケーションやウェブサイトからアカウントをリンクできるようにしますのスイッチをOnにします。

以下を入力します。

・Web認証画面のURI：https://accounts.google.com/o/oauth2/v2/auth
・アクセストークンのURI：https://oauth2.googleapis.com/token
・ユーザーのクライアントID：GCPから生成されたクライアントID
・ユーザーのシークレット：GCPから生成されたクライアントシークレット
・ユーザの認可スキーム：HTTP Basic認証（推奨）
・スコープ：openid

ユーザーのリダイレクト先のURLは、何か１つ適当なURLを入力しないとエラーとなるようです。
また、AlexaクライアントIDとAlexaクライアントシークレットは後で使うのでメモっておきます。
最後に、「保存」ボタンを押下します。

ESP32アプリの作成

ソースコード詳細は、GitHubを参照してください。

ちなみに、以下の4つのデバイスを持っていることにしています。 DEVICE_INFO devices[]の辺りをみるとわかります。

endpointId	friendlyName	機能インタフェース	displayCategory
device1	テストのトグル	PowerController	SWITCH
device2	テストのサーモ	TemperatureSensor	TEMPERATURE_SENSOR
device3	テストのロック	LockController	SMARTLOCK
device4	テストのパワーレベル	PowerLevelController	LIGHT

いろいろ追加してみてください。manufacturerNameは適当な会社名です。
ちなみに、device3のTemperatureSensorは、ESP32のCPUの温度を返すようにしています。device1のPowerControllerは、LED_IO で示すポートのHIGH/LOWを切り替えています。LEDがつながっていれば、付けたり消したりできます。

で、実装上大事なのは、setup()の

  obniz.commandReceive(onCommand);
  obniz.start();

の部分と、以下のコールバック関数です。

void onCommand(uint8_t* data, uint16_t length){

外部から、ObnizのSDKを使ってESP32に電文を送ると、この関数が呼ばれて受信した電文を処理できます。
Alexaクラウドから、処理要求が飛んでくるのですが、それを受信して、適切な返答を作って返しています。
実際には、Lambdaのスキルコードがいったん受け付けたうえで転送されてくるので、手分けして処理しています。

以下に対応するインテントが転送されてきます。

・Alexa.Discovery.Discover
・Alexa.Authorization.AcceptGrant
・Alexa.PowerController.TurnOn
・Alexa.PowerController.TurnOff
・Alexa.LockController.Lock
・Alexa.LockController.Unlock
・Alexa.PowerLevelController.SetPowerLevel
・Alexa.PowerLevelController.AdjustPowerLevel
・Alexa.ReportState

(参考) スマートホームスキルAPIのメッセージリファレンス
　https://developer.amazon.com/ja-JP/docs/alexa/smarthome/smart-home-skill-api-message-reference.html

今回サポートする機能インタフェースで、最低限必要なインテントを実装しているつもりです。

Obnizのプラグインについては、以下が参考になります。最初はよくわからなかったのですが、手を動かしてみたらすんなり理解できました。

　https://obniz.io/ja/doc/guides/obniz-starter-guide/plugin/io

事前に、ArduinoIDEにプラグインのための環境設定が終わっている前提です。

　https://obniz.io/ja/doc/reference/obnizos-for-esp32/plugin/arduino-ide

上記を設定して、実装したプログラムをESP32に書き込んで、起動すると、UARTで、デバイスキー入力やら、接続するWiFiアクセスポイントの指定やらが聞かれますので、以下を参考に入力します。

　https://obniz.io/ja/doc/reference/obnizos-for-esp32/quick-start/#%E3%82%BF%E3%83%BC%E3%83%9F%E3%83%8A%E3%83%AB%E3%81%8B%E3%82%89%E3%81%AE%E8%A8%AD%E5%AE%9A

問題なければ、以下のように表示されて、Onlinecloudに接続完了した旨が表示されるはずです。

obniz ver: 3.4.0
obniz id: XXXXXXXX
WirelessLAN MAC Address: XXXXXXXXXXXX
WiredLAN MAC Address: XXXXXXXXXXXX
Press 's' to setting mode
Input char >>

Wi-Fi Scanning...
Wi-Fi Connecting SSID: XXXXXXX
Connecting Cloud
Onlinecloud Connected

Lambdaの実装

それでは、Lambdaに配置するスキルコードの実装です。
これも、GitHubを参考にしてください。

Obnizの仕様が少々扱いにくくて、トリッキーな実装していますが、ご容赦ください。。。。(なんと危険な実装なのでしょう。。。)

index.js

var g_obniz_success;
var g_obniz_failed;

var Obniz = require("obniz");
var obniz = new Obniz(OBNIZ_ID, { auto_connect: false });
obniz.onconnect = async function () {
    console.log("connected");
    obniz.plugin.onreceive = async (data) =>{
        var str = Buffer.from(data).toString("utf-8");
        var res = JSON.parse(str);
        console.log(res);
        if( g_obniz_success )
            g_obniz_success(JSON.parse(str));
    };
}
obniz.onclose = async function(){
    console.log("obniz onclose");
    if( g_obniz_failed )
        g_obniz_failed("obniz onclose");
}

async function obniz_tranceive(intent, message){
    console.log('obniz connecting');
    await obniz.connectWait();
    console.log('obniz connected');

    return new Promise((resolve, reject) =>{
        if( obniz.connectionState != 'connected' )
            throw 'obniz disconnected';

        g_obniz_success = resolve;
        g_obniz_failed = reject;
        obniz.plugin.send(JSON.stringify({ intent: intent, value: message }));
    })
}

obniz.plugin.send のところでesp32のobnizに電文を送り、obniz.plugin.onreceive で応答を受信しています。
こんな感じで使います。intent名とendpointIdなどのパラメータを渡すと、ObnizであるESP32と接続し、ObnizのプラグインでESP32に届けてもらい、レスポンスをリターンしてくれます。

contextResult = await obniz_tranceive(intent, { endpointId: endpointId, level: level });

processDirectiveが主要な関数で、単純に、右から左、左から右に流しているものがほとんどですが、intent= Alexa.Discovery.DiscoverやAlexa.Authorization.AcceptGrantは、少しLambdaで処理しています。

ちなみに、Alexa.Authorization.AcceptGrant で取得されるアクセストークンやリフレッシュトークンは、非同期にアレクサクラウドにイベントを送るときに使いますが、今回はやめて次回にでも説明します。

以下は、環境ごとに書き換えが必要です。

・【Obniz ID】：ESP32に書き込んだObnizのObniz ID
・【AlexaクライアントID】：alexa developer consoleで払い出されたAlexaクライアントID
・【Alexaクライアントシークレット】：alexa developer consoleで払い出されたAlexaクライアントシークレット

ソースコードに直接書き換えてもよいですし、のちほど設定するLambdaの環境変数に指定するのでも良いです。