Alexa.ContactSensorを使ってドアや窓の開閉状況を知る方法について 第１弾
Alexaにドアや窓の状況を教えてほしい
外出時や寝る前に、ドアや窓が閉まっているかどうか、よく気になります。
Alexaがドアや窓の開閉状況を教えてくれれば、ドアの近くまで行って鍵が閉まっているか確認する必要もありません。
調べてみると、AlexaはAWS LambdaとAlexaServiceSkill、ドアに取り付けた接触センサ―を組み合わせて、ドアの開閉状況を検出できることがわかりました。
具体的には、接触センサーのAPIであるAlexa.ContactSensorを使うことになるみたいです。
今回はこのAlexa.ContactSensorを使ってみたのでレビューしたいと思います。
ちなみに、5月末には「玄関は開いてますか？」とAlexaに話しかけても反応がなかったのが、6/24には「玄関は開いてますか？」とAlexaに聞くと「玄関は開いてます」と答えてくれたので、ごく最近Alexa.ContactSensorに日本語が実装されたのだと思っています。
下記のリンクでもContactSensorは日本語実装されていないことになっています。(2020/6/25現在)
List of Capability Interfaces and Supported Locales | Alexa Skills Kit
構図（AlexaSkillとAWSLambdaとセンサーの位置づけ）
Alexa.ContactSensorを使う前に、下図の構図を理解する必要があります。
図にある通り、AlexaはAlexaServiceSkillとAWSLambdaを介してドアの開閉状況を検出することができます。
参考にしたのは以下のサイトです。
www.hackster.io
使い方
スマートホームスキル(Alexa Service Skill)の作成
以下のリンクを参考にして、スマートホームスキルを作成します。（スマートホームスキルが何かという説明も載っています。） developer.amazon.com
開発者ポータルにスキルを追加
開発者ポータル(developer.amazon.com)にログインしてスキルを追加する必要があります。
Lambda関数の作成
AWS(https://aws.amazon.com/ )のアカウントを作成し、ログインする必要があります。
ある範囲内なら無料で使えるので、アカウントを作成しました。
Lambda関数の実装
サンプルコード(https://github.com/alexa/alexa-smarthome)をダウンロードします。
ダウンロードしたファイルを整理してzipファイルにまとめます。
AWSのLambda関数にzipファイルをアップロードします。
Smart SwitchとContact Sensorをアプリ上で正しく認識できるようにしたプログラム(lambda.py)が以下の通りです。
version3とversion2が混在しているので少し複雑ですですが、version3のみで動いているはずです。
393行目のvalueを"DETECTED"や"NOT_DETECTED"にすることで「開いている」状態または「閉じている」状態に設定できます。
その他のポイントは以下の２点です。
AlexaServiceSkillがドアの開閉状況をAWSLambadaにリクエストするときの指令：ReportState
AWS Lambdaがドアの開閉状況をAlexaServiceSkillに返す時の応答：StateReport
# -*- coding: utf-8 -*- # Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Amazon Software License (the "License"). You may not use this file except in # compliance with the License. A copy of the License is located at # # http://aws.amazon.com/asl/ # # or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific # language governing permissions and limitations under the License. """Alexa Smart Home Lambda Function Sample Code. This file demonstrates some key concepts when migrating an existing Smart Home skill Lambda to v3, including recommendations on how to transfer endpoint/appliance objects, how v2 and vNext handlers can be used together, and how to validate your v3 responses using the new Validation Schema. Note that this example does not deal with user authentication, only uses virtual devices, omits a lot of implementation and error handling to keep the code simple and focused. """ import logging import time import json import uuid # Imports for v3 validation from validation import validate_message # Setup logger logger = logging.getLogger() logger.setLevel(logging.INFO) # To simplify this sample Lambda, we omit validation of access tokens and retrieval of a specific # user's appliances. Instead, this array includes a variety of virtual appliances in v2 API syntax, # and will be used to demonstrate transformation between v2 appliances and v3 endpoints. SAMPLE_APPLIANCES = [ { "applianceId": "endpoint-001", "manufacturerName": "Sample Manufacturer", "modelName": "Smart Switch", "version": "1", "friendlyName": "Switch", "friendlyDescription": "001 Switch that can only be turned on/off", "isReachable": True, "actions": [ "turnOn", "turnOff" ], "additionalApplianceDetails": { "detail1": "For simplicity, this is the only appliance", "detail2": "that has some values in the additionalApplianceDetails" } }, { "applianceId": "endpoint-002", "manufacturerName": "Sample Manufacturer", "modelName": "Smart Light", "version": "1", "friendlyName": "Light", "friendlyDescription": "002 Light that is dimmable and can change color and color temperature", "isReachable": True, "actions": [ "turnOn", "turnOff", "setPercentage", "incrementPercentage", "decrementPercentage", "setColor", "setColorTemperature", "incrementColorTemperature", "decrementColorTemperature" ], "additionalApplianceDetails": {} }, { "applianceId": "endpoint-003", "manufacturerName": "Sample Manufacturer", "modelName": "Smart White Light", "version": "1", "friendlyName": "White Light", "friendlyDescription": "003 Light that is dimmable and can change color temperature only", "isReachable": True, "actions": [ "turnOn", "turnOff", "setPercentage", "incrementPercentage", "decrementPercentage", "setColorTemperature", "incrementColorTemperature", "decrementColorTemperature" ], "additionalApplianceDetails": {} }, { "applianceId": "endpoint-004", "manufacturerName": "Sample Manufacturer", "modelName": "Smart Thermostat", "version": "1", "friendlyName": "Thermostat", "friendlyDescription": "004 Thermostat that can change and query temperatures", "isReachable": True, "actions": [ "setTargetTemperature", "incrementTargetTemperature", "decrementTargetTemperature", "getTargetTemperature", "getTemperatureReading" ], "additionalApplianceDetails": {} }, { "applianceId": "endpoint-005", "manufacturerName": "Sample Manufacturer", "modelName": "Smart Lock", "version": "1", "friendlyName": "Lock", "friendlyDescription": "005 Lock that can be locked and can query lock state", "isReachable": True, "actions": [ "setLockState", "getLockState" ], "additionalApplianceDetails": {} }, { "applianceId": "endpoint-006", "manufacturerName": "Sample Manufacturer", "modelName": "Smart Scene", "version": "1", "friendlyName": "Good Night Scene", "friendlyDescription": "006 Scene that can only be turned on", "isReachable": True, "actions": [ "turnOn" ], "additionalApplianceDetails": {} }, { "applianceId": "endpoint-007", "manufacturerName": "Sample Manufacturer", "modelName": "Smart Activity", "version": "1", "friendlyName": "Watch TV", "friendlyDescription": "007 Activity that runs sequentially that can be turned on and off", "isReachable": True, "actions": [ "turnOn", "turnOff" ], "additionalApplianceDetails": {} }, { "applianceId": "endpoint-008", "manufacturerName": "Sample Manufacturer", "modelName": "Contact Sensor", "version": "1", "friendlyName": "Contact Sensor", "friendlyDescription": "008 Ditect a state of lock", "isReachable": True, "actions": [ "getLockState" ], "additionalApplianceDetails": {} } ] def lambda_handler(request, context): """Main Lambda handler. Since you can expect both v2 and v3 directives for a period of time during the migration and transition of your existing users, this main Lambda handler must be modified to support both v2 and v3 requests. """ try: logger.info("Directive:") logger.info(json.dumps(request, indent=4, sort_keys=True)) version = get_directive_version(request) if version == "3": logger.info("Received v3 directive!") if request["directive"]["header"]["name"] == "Discover": response = handle_discovery_v3(request) else: response = handle_non_discovery_v3(request) else: logger.info("Received v2 directive!") if request["header"]["namespace"] == "Alexa.ConnectedHome.Discovery": response = handle_discovery() else: response = handle_non_discovery(request) logger.info("Response:") logger.info(json.dumps(response, indent=4, sort_keys=True)) #if version == "3": #logger.info("Validate v3 response") #validate_message(request, response) return response except ValueError as error: logger.error(error) raise # v2 handlers def handle_discovery(): header = { "namespace": "Alexa.ConnectedHome.Discovery", "name": "DiscoverAppliancesResponse", "payloadVersion": "2", "messageId": get_uuid() } payload = { "discoveredAppliances": SAMPLE_APPLIANCES } response = { "header": header, "payload": payload } return response def handle_non_discovery(request): request_name = request["header"]["name"] if request_name == "TurnOnRequest": header = { "namespace": "Alexa.ConnectedHome.Control", "name": "TurnOnConfirmation", "payloadVersion": "2", "messageId": get_uuid() } payload = {} elif request_name == "TurnOffRequest": header = { "namespace": "Alexa.ConnectedHome.Control", "name": "TurnOffConfirmation", "payloadVersion": "2", "messageId": get_uuid() } # other handlers omitted in this example payload = {} response = { "header": header, "payload": payload } return response # v2 utility functions def get_appliance_by_appliance_id(appliance_id): for appliance in SAMPLE_APPLIANCES: if appliance["applianceId"] == appliance_id: return appliance return None def get_utc_timestamp(seconds=None): return time.strftime("%Y-%m-%dT%H:%M:%S.00Z", time.gmtime(seconds)) def get_uuid(): return str(uuid.uuid4()) # v3 handlers def handle_discovery_v3(request): endpoints = [] for appliance in SAMPLE_APPLIANCES: endpoints.append(get_endpoint_from_v2_appliance(appliance)) response = { "event": { "header": { "namespace": "Alexa.Discovery", "name": "Discover.Response", "payloadVersion": "3", "messageId": get_uuid() }, "payload": { "endpoints": endpoints } } } return response def handle_non_discovery_v3(request): request_namespace = request["directive"]["header"]["namespace"] request_name = request["directive"]["header"]["name"] endpointId = request["directive"]["endpoint"]["endpointId"] print(request_namespace) print(request_name) print(endpointId) if request_namespace == "Alexa.PowerController": if request_name == "TurnOn": value = "ON" else: value = "OFF" response = { "context": { "properties": [ { "namespace": "Alexa.PowerController", "name": "powerState", "value": value, "timeOfSample": get_utc_timestamp(), "uncertaintyInMilliseconds": 500 } ] }, "event": { "header": { "namespace": "Alexa", "name": "Response", "payloadVersion": "3", "messageId": get_uuid(), "correlationToken": request["directive"]["header"]["correlationToken"] }, "endpoint": { "scope": { "type": "BearerToken", "token": "access-token-from-Amazon" }, "endpointId": request["directive"]["endpoint"]["endpointId"] }, "payload": {} } } return response elif request_namespace == "Alexa" and endpointId == "endpoint-001" and request_name == "ReportState": response ={ "context": { "properties": [ { "namespace": "Alexa.PowerController", "name": "powerState", "value": "ON", "timeOfSample": get_utc_timestamp(), "uncertaintyInMilliseconds": 500 } ] }, "event": { "header": { "namespace": "Alexa", "name": "StateReport", "payloadVersion": "3", "messageId": get_uuid(), "correlationToken": request["directive"]["header"]["correlationToken"] }, "endpoint": { "scope": { "type": "BearerToken", "token": "access-token-from-Amazon" }, "endpointId": request["directive"]["endpoint"]["endpointId"] }, "payload": {} } } return response elif request_namespace == "Alexa.Authorization": if request_name == "AcceptGrant": response = { "event": { "header": { "namespace": "Alexa.Authorization", "name": "AcceptGrant.Response", "payloadVersion": "3", "messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4" }, "payload": {} } } return response # other handlers omitted in this example if request_namespace == "Alexa" and endpointId == "endpoint-008" and request_name == "ReportState": response = { "context": { "properties": [ { "namespace": "Alexa.ContactSensor", "name": "detectionState", "value": "DETECTED", "timeOfSample": get_utc_timestamp(), "uncertaintyInMilliseconds": 500 }, { "namespace": "Alexa.EndpointHealth", "name": "connectivity", "value": { "value": "OK" }, "timeOfSample": get_utc_timestamp(), "uncertaintyInMilliseconds": 500 } ] }, "event": { "header": { "namespace": "Alexa", "name": "StateReport", "payloadVersion": "3", "messageId": get_uuid(), "correlationToken": request["directive"]["header"]["correlationToken"] }, "endpoint": { "scope": { "type": "BearerToken", "token": "access-token-from-Amazon" }, "endpointId": request["directive"]["endpoint"]["endpointId"] }, "payload": {} } } return response elif request_namespace == "Alexa.Authorization": if request_name == "AcceptGrant": response = { "event": { "header": { "namespace": "Alexa.Authorization", "name": "AcceptGrant.Response", "payloadVersion": "3", "messageId": "5f8a426e-01e4-4cc9-8b79-65f8bd0fd8a4" }, "payload": {} } } return response # other handlers omitted in this example # v3 utility functions def get_endpoint_from_v2_appliance(appliance): endpoint = { "endpointId": appliance["applianceId"], "manufacturerName": appliance["manufacturerName"], "friendlyName": appliance["friendlyName"], "description": appliance["friendlyDescription"], "displayCategories": [], "cookie": appliance["additionalApplianceDetails"], "capabilities": [] } endpoint["displayCategories"] = get_display_categories_from_v2_appliance(appliance) endpoint["capabilities"] = get_capabilities_from_v2_appliance(appliance) return endpoint def get_directive_version(request): try: return request["directive"]["header"]["payloadVersion"] except: try: return request["header"]["payloadVersion"] except: return "-1" def get_endpoint_by_endpoint_id(endpoint_id): appliance = get_appliance_by_appliance_id(endpoint_id) if appliance: return get_endpoint_from_v2_appliance(appliance) return None def get_display_categories_from_v2_appliance(appliance): model_name = appliance["modelName"] if model_name == "Smart Switch": displayCategories = ["SWITCH"] elif model_name == "Smart Light": displayCategories = ["LIGHT"] elif model_name == "Smart White Light": displayCategories = ["LIGHT"] elif model_name == "Smart Thermostat": displayCategories = ["THERMOSTAT"] elif model_name == "Smart Lock": displayCategories = ["SMARTLOCK"] elif model_name == "Smart Scene": displayCategories = ["SCENE_TRIGGER"] elif model_name == "Smart Activity": displayCategories = ["ACTIVITY_TRIGGER"] elif model_name == "Smart Camera": displayCategories = ["CAMERA"] elif model_name == "Contact Sensor":displayCategories = ["CONTACT_SENSOR"] else: displayCategories = ["OTHER"] return displayCategories def get_capabilities_from_v2_appliance(appliance): model_name = appliance["modelName"] if model_name == 'Smart Switch': capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.PowerController", "version": "3", "properties": { "supported": [ { "name": "powerState" } ], "proactivelyReported": True, "retrievable": True } } ] elif model_name == "Smart Light": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.PowerController", "version": "3", "properties": { "supported": [ { "name": "powerState" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.ColorController", "version": "3", "properties": { "supported": [ { "name": "color" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.ColorTemperatureController", "version": "3", "properties": { "supported": [ { "name": "colorTemperatureInKelvin" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.BrightnessController", "version": "3", "properties": { "supported": [ { "name": "brightness" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.PowerLevelController", "version": "3", "properties": { "supported": [ { "name": "powerLevel" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.PercentageController", "version": "3", "properties": { "supported": [ { "name": "percentage" } ], "proactivelyReported": True, "retrievable": True } } ] elif model_name == "Smart White Light": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.PowerController", "version": "3", "properties": { "supported": [ { "name": "powerState" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.ColorTemperatureController", "version": "3", "properties": { "supported": [ { "name": "colorTemperatureInKelvin" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.BrightnessController", "version": "3", "properties": { "supported": [ { "name": "brightness" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.PowerLevelController", "version": "3", "properties": { "supported": [ { "name": "powerLevel" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.PercentageController", "version": "3", "properties": { "supported": [ { "name": "percentage" } ], "proactivelyReported": True, "retrievable": True } } ] elif model_name == "Smart Thermostat": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.ThermostatController", "version": "3", "properties": { "supported": [ { "name": "targetSetpoint" }, { "name": "thermostatMode" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.TemperatureSensor", "version": "3", "properties": { "supported": [ { "name": "temperature" } ], "proactivelyReported": True, "retrievable": True } } ] elif model_name == "Smart Thermostat Dual": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.ThermostatController", "version": "3", "properties": { "supported": [ { "name": "upperSetpoint" }, { "name": "lowerSetpoint" }, { "name": "thermostatMode" } ], "proactivelyReported": True, "retrievable": True } }, { "type": "AlexaInterface", "interface": "Alexa.TemperatureSensor", "version": "3", "properties": { "supported": [ { "name": "temperature" } ], "proactivelyReported": True, "retrievable": True } } ] elif model_name == "Smart Lock": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.LockController", "version": "3", "properties": { "supported": [ { "name": "lockState" } ], "proactivelyReported": True, "retrievable": True } } ] elif model_name == "Smart Scene": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.SceneController", "version": "3", "supportsDeactivation": False, "proactivelyReported": True } ] elif model_name == "Smart Activity": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.SceneController", "version": "3", "supportsDeactivation": True, "proactivelyReported": True } ] elif model_name == "Smart Camera": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.CameraStreamController", "version": "3", "cameraStreamConfigurations" : [ { "protocols": ["RTSP"], "resolutions": [{"width":1280, "height":720}], "authorizationTypes": ["NONE"], "videoCodecs": ["H264"], "audioCodecs": ["AAC"] } ] } ] elif model_name == "Contact Sensor": capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.ContactSensor", "version": "3", "properties": { "supported": [ { "name": "detectionState" } ], "proactivelyReported": False, "retrievable": True } } ] else: # in this example, just return simple on/off capability capabilities = [ { "type": "AlexaInterface", "interface": "Alexa.PowerController", "version": "3", "properties": { "supported": [ { "name": "powerState" } ], "proactivelyReported": True, "retrievable": True } } ] # additional capabilities that are required for each endpoint endpoint_health_capability = { "type": "AlexaInterface", "interface": "Alexa.EndpointHealth", "version": "3", "properties": { "supported":[ { "name":"connectivity" } ], "proactivelyReported": True, "retrievable": True } } alexa_interface_capability = { "type": "AlexaInterface", "interface": "Alexa", "version": "3" } capabilities.append(endpoint_health_capability) capabilities.append(alexa_interface_capability) return capabilities
スキルの設定の仕上げ
ドアの接触センサーとAWSLambdaを接続する際には、それを紐づけるアカウントリンク必要です。
アカウントリンクは各自実装することもできるようですが、「Login with Amazon」を使用することができます。
そのため、今回は「Login with Amazon」を使用することにしました。
その際に参考になるサイトがこちらです。英語だったこともあって少しつまずいたので、ポイントを説明します。
Alexa Account Linking: 5 Steps to Seamlessly Link Your Alexa Skill to User Systems That Require Authentication : Alexa Blogs
開発者ポータル(developer.amazon.com)右上の開発者コンソールをクリックし、タブLogin with Amazonをクリックして設定します。
新しくSecuruty Profileを作成するのですが、プライバシー規約同意書は適当で大丈夫です。
重要なのはWeb Settingです。
1. ClientID、ClientSecretをメモしておく。
2. 開発者ポータル(developer.amazon.com)のスキル開発ページのビルドのアカウントリンクの設定をします。1でメモしたID、シークレットもインプットします。
またAlexaのリダイレクト先URLをメモしておきます。
3. Login with AmazonのWebSettingに戻り、許可された返信URLに2でメモしたリダイレクト先URLを記入します。
以上３点を抑えていて、他の設定も公式URLの通りにしていれば問題ないと思います。
テストする
Alexaアプリ上でスキルを有効にします。
これまでの設定がうまくできていればamazonのログイン画面が出てきて、ログインするとスキルが有効になるはずです。
最後にデバイスの検出を行います。
例えばContact Sensorの設定画面は以下の図のようになり、ドアや窓の状態を示してくれます。
また、「はじめに」でも述べましたが「玄関開いてる？」と聞くと、「玄関は閉まっています」と返答してくれます。
（今回は「玄関」という名前にアプリ上で設定しましたが、名前は後からいくらでも変えることができます。）
最後に
公式のWebページがある程度丁寧に説明してくれているので、結構内容を省きました。そのため、わからなかったら公式URLを丁寧に見返してください。
冒頭でもふれましたが、恐らく最近までContact Sensorが日本語対応していなく、実装後に悲しい思いをしたのですが、今は日本語対応されていて大変うれしい気持ちで一杯です。
Alexaのプログラムは日々更新されていて、それによって苦労することもありますが、こうしてワクワクするようなこともあるのだなと実感しているところです。
今回は実際のセンサーを使って実装するところまでは出来ていないので、センサーと合わせて実装出来次第、また報告しようと思います。
