![[AWS CDK] SlackとRaspberry PiでエアコンをONにする仕組みを作った（涼しい家に帰宅できるぞ！！）](https://devio2023-media.developers.io/wp-content/uploads/2019/08/eyecatch_slack_aircon.png)
[AWS CDK] SlackとRaspberry PiでエアコンをONにする仕組みを作った（涼しい家に帰宅できるぞ！！）
SlackのSlash CommandsとRaspberry Piを利用し、自宅のエアコンをONにするシステムを「AWS CDK(Cloud Development Kit)」を用いて構築しました。
外出から帰って自宅が暑いと嫌です。でもエアコン付けっぱなしも電気代的な意味で嫌です。
そこで、「自宅に帰る1時間ぐらい前に、エアコンをONにできないか？」と考え構築してました。
仕組み自体は約1年前に構築済ですが、AWSの画面ポチポチで作成していたので、AWS CDK(Cloud Development Kit)を使って作り直してみました。
目次
- 構成
- 補足
- Raspberry Piに学習リモコンを装着した様子
- 環境
- リポジトリ構成
- AWSの環境構築
- API仕様
- AWS CDKのインストール
- AWS CDKプロジェクトの構築
- Lambdaコードを書く！
- インフラをコードで書く！！！
- ビルドする
- デプロイする
- Slackアプリの構築
- チャンネル作成
- Slackアプリの作成
- Slash Commandsの作成
- Slash Commandsのインストール
- Raspberry Piのスクリプト作成
- Raspberry Pi用のフォルダ作成
- IoTエンドポイントの取得
- 設定ファイルの作成
- メインスクリプトの作成
- Raspberry Piの環境構築
- 証明書の作成 & ダウンロード
- Raspberry Piにファイル類をコピー
- 証明書フォルダの作成
- ライブラリのインストール
- 学習リモコンにエアコンONを学習させる
- 開始コマンド
- 終了コマンド
- 動作確認！！！
- さいごに
- 参考
構成
SlackのSlash Commandsが叩くWebAPIを作成し、Lambdaがコマンド解析してIoT CoreのTopicにPublishします。
Raspberry PiはTopicをSubscribeしており、命令に従ってエアコンをONにします。
なお、Raspberry Pi用の赤外線学習リモコンを使っています。
補足
- 実際のエアコンがAWSに接続されていないため、Device Shadowは使っていません
- Device Shadowとエアコンの状態不一致を考えるのがめんどくさい
- APIの応答が3秒以内というSlackの仕様がありますが、3秒未満で処理は完了するため、3秒以上の経過は未考慮です
- 考慮するなら、処理用のLambdaを非同期で実行させてからすぐ応答します
- 非同期のLambdaでは、「遅延応答用のURL」に対して応答します
Raspberry Piに学習リモコンを装着した様子
他のGPIOは使えなくなりますが、とてもコンパクトで置き場所にも困りません。
環境
- Mac
- macOS Mojave 10.14.6
- Python 3.6
- Raspberry Pi 3 Mobile B+
- Raspbian 9.4
- Python 3.6
- ほか
- AWS CDK 1.3.0 (build bba9914)
- npm 6.9.0
- node 10.16.1
リポジトリ構成
下記のように、Raspberry Pi環境とAWS環境を分けています。
$ tree -L 2
.
├── RaspberryPi
│ ├── cert
│ ├── config.ini
│ └── main.py
└── aws
├── bin
├── cdk.json
├── cdk.out
├── lib
├── node_modules
├── package-lock.json
├── package.json
├── src
└── tsconfig.json
AWSの環境構築
API仕様
APIは下記を用意します。
| Method | Path |
|---|---|
| POST | /control |
AWS CDKのインストール
インストール済みの場合はSkipしてください。
$ npm install -g aws-cdk
AWS CDKプロジェクトの構築
HomeControlフォルダを作成し（あとでawsにリネームしてます）、その中にCDKプロジェクトを構築します。
$ mkdir HomeControl $ cd HomeControl $ cdk init app --language=typescript
必要なライブラリをインストールします。
$ npm install --save @aws-cdk/aws-iot $ npm install --save @aws-cdk/aws-lambda $ npm install --save @aws-cdk/aws-apigateway $ npm install --save @aws-cdk/aws-iam $ npm install --save-dev aws-sdk
Lambdaコードを書く！
まずはファイルを作ります。
$ mkdir -p src/lambda/iot_publish $ touch src/lambda/iot_publish/app.ts
続いてコードを下記にします。本人確認等はひとまず省略してます。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import * as AWS from 'aws-sdk'; | |
| import * as QueryString from 'querystring'; | |
| const iot = new AWS.Iot(); | |
| export async function handler(event: any) { | |
| const endpoint = await iot.describeEndpoint({ | |
| endpointType: 'iot:Data', | |
| }).promise(); | |
| const requestParams = parseRequest(event.body); | |
| console.log(requestParams); | |
| const iotdata = new AWS.IotData({ | |
| endpoint: endpoint.endpointAddress, | |
| }); | |
| await iotdata.publish({ | |
| topic: process.env.IOT_TOPIC!, | |
| payload: JSON.stringify(requestParams), | |
| }).promise(); | |
| return { | |
| statusCode: 200, | |
| body: '操作を受け付けました。', | |
| } | |
| } | |
| export function parseRequest(body: any): RequestParams { | |
| const query = QueryString.parse(body); | |
| console.log(JSON.stringify(query)); | |
| const pattern = /^(\w+) (\w+)$/; | |
| const result = pattern.exec(String(query.text)); | |
| if (String(query.command) !== '/control' ) { | |
| throw new Error('Unknown command.'); | |
| } | |
| if (result == null) { | |
| throw new Error('Invavlid command params.'); | |
| } | |
| return { | |
| token: String(query.token), | |
| team_domain: String(query.team_domain), | |
| command: String(query.command), | |
| target: result[1], | |
| param: result[2], | |
| } | |
| } | |
| export interface RequestParams { | |
| token: string; | |
| team_domain: string; | |
| command: string; | |
| target: string; | |
| param: string; | |
| } |
インフラをコードで書く！！！
lib/home_control-stack.tsを下記にします。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import * as apigateway from '@aws-cdk/aws-apigateway'; | |
| import * as iot from '@aws-cdk/aws-iot'; | |
| import * as role from '@aws-cdk/aws-iam'; | |
| import * as lambda from '@aws-cdk/aws-lambda'; | |
| import { ServicePrincipal, ManagedPolicy } from '@aws-cdk/aws-iam'; | |
| import { Duration } from '@aws-cdk/core'; | |
| import cdk = require('@aws-cdk/core'); | |
| export class HomeControlStack extends cdk.Stack { | |
| constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) { | |
| super(scope, id, props); | |
| // The code that defines your stack goes here | |
| // IoT Things | |
| const raspberryPi = new iot.CfnThing(this, 'Raspberry Pi', { | |
| thingName: 'HomeControl-RaspberryPi', | |
| }); | |
| // IoT Topic | |
| const iotTopic = 'HomeControl/RaspberryPi'; | |
| // IoT Policy | |
| const raspberryPiPolicy = new iot.CfnPolicy(this, 'raspberry Pi Poliry', { | |
| policyName: 'HomeControl-RaspberryPi-Policy', | |
| policyDocument: { | |
| Version: '2012-10-17', | |
| Statement: [ | |
| { | |
| Effect: 'Allow', | |
| Action: 'iot:Connect', | |
| Resource: `arn:aws:iot:${this.region}:${this.account}:client/${raspberryPi.ref}` | |
| }, | |
| { | |
| Effect: 'Allow', | |
| Action: 'iot:Subscribe', | |
| Resource: `arn:aws:iot:${this.region}:${this.account}:topicfilter/${iotTopic}` | |
| }, | |
| ] | |
| }, | |
| }); | |
| // Role | |
| const apiRole = new role.Role(this, 'ApiRole', { | |
| roleName: 'HomeControl-LambdaRole', | |
| assumedBy: new ServicePrincipal('lambda.amazonaws.com'), | |
| managedPolicies: [ | |
| ManagedPolicy.fromAwsManagedPolicyName('AWSIoTFullAccess'), | |
| ManagedPolicy.fromAwsManagedPolicyName('AWSIoTDataAccess'), | |
| ManagedPolicy.fromAwsManagedPolicyName('service-role/AWSLambdaBasicExecutionRole') | |
| ], | |
| }); | |
| // Lambda | |
| const iotLambda = new lambda.Function(this, 'IoTLambda', { | |
| code: lambda.Code.asset('src/lambda/iot_publish'), | |
| handler: 'app.handler', | |
| runtime: lambda.Runtime.NODEJS_10_X, | |
| timeout: Duration.seconds(3), | |
| role: apiRole, | |
| environment: { | |
| IOT_TOPIC: iotTopic, | |
| }, | |
| }); | |
| // API Gateway | |
| const api = new apigateway.RestApi(this, 'HomeControlApi', { | |
| restApiName: 'HomeControlApi' | |
| }); | |
| const integration = new apigateway.LambdaIntegration(iotLambda, { | |
| proxy: true, | |
| }); | |
| const controlResource = api.root.addResource('control'); | |
| controlResource.addMethod('POST', integration); | |
| } | |
| } | |
| const app = new cdk.App(); | |
| new HomeControlStack(app, 'HomeControlStack'); | |
| app.synth(); |
ビルドする
$ npm run build
デプロイする
Lambdaコード格納用のS3バケットを作るcdk bootstrapは、最初の1回だけでOKです。
$ cdk bootstrap $ cdk deploy
スタック作成が完了すると、エンドポイント（WebAPIのアドレス）が表示されるので、メモしておきます。
Outputs: HomeControlStack.HomeControlApiEndpointxxxxx = https://yyyyyyy.execute-api.ap-northeast-1.amazonaws.com/prod/
Slackアプリの構築
チャンネル作成
専用のチャンネルを作成します。
Slackアプリの作成
SlackのYour Appsにアクセスし、「Create New App」を選択します。
適当に入力します。
Slash Commandsの作成
「Slash Commands」を選択します。
「Create New Command」を選択します。
適当に入力します。
Request URLは、さきほど作成したエンドポイントと作成したAPIのリソース名を入力します。
| 項目 | 内容 |
|---|---|
| Command | /control |
| Request URL | https://yyyyyyy.execute-api.ap-northeast-1.amazonaws.com/prod/control |
| Short Description | 自宅の家電を操作します |
| Usage Hint | aircon on |
Slash Commandsのインストール
左側のメニューから「Basic Information」を選択し、続けて「Install App to Workspace」を選択します。
権限を確認し、「インストール」を選択します。
Raspberry Piのスクリプト作成
あとでコピーするため、Raspberry Pi上で作業しなくても大丈夫です。
Raspberry Pi用のフォルダ作成
$ mkdir RaspberryPi $ cd RaspberryPi
IoTエンドポイントの取得
取得してメモしておきます。
$ aws iot describe-endpoint --endpoint-type iot:Data-ATS
{
"endpointAddress": "xxxxx-ats.iot.ap-northeast-1.amazonaws.com"
}
設定ファイルの作成
config.iniを作成し、下記とします。ENDPOINTはさきほど取得した値です。
[AWS_IOT_CONNECT] ROOT_CA = ./cert/AmazonRootCA1.pem PRIVATE_KEY = ./cert/private.pem.key CERTIFICATE = ./cert/certificate.pem.crt.txt [AWS_IOT_CORE] CLIENT_ID = home_control_raspberry_pi ENDPOINT = xxxxx-ats.iot.ap-northeast-1.amazonaws.com PORT = 8883 TOPIC = HomeControl/RaspberryPi
メインスクリプトの作成
main.pyを作成し、下記とします。
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import os | |
| import configparser | |
| import time | |
| import json | |
| import RPi.GPIO as GPIO | |
| import logging | |
| from logging import getLogger, Formatter, FileHandler | |
| from AWSIoTPythonSDK.MQTTLib import AWSIoTMQTTClient | |
| # Use PIN 7 (GPIO 4) | |
| PIN_AIRCON_ON = 7 | |
| # programme finish trigger file | |
| FINISH_FILE = 'finish.txt' | |
| # logger setting | |
| handler_format = Formatter('[%(asctime)s][%(name)s][%(levelname)s] %(message)s') | |
| file_handler = FileHandler('main.log', 'a') | |
| file_handler.setLevel(logging.INFO) | |
| file_handler.setFormatter(handler_format) | |
| logger = getLogger(__name__) | |
| logger.setLevel(logging.INFO) | |
| logger.addHandler(file_handler) | |
| def main(): | |
| logger.info('Start home controller') | |
| init_gpio() | |
| configs = parse_config_file() | |
| logger.info(json.dumps(configs, indent=4)) | |
| # https://s3.amazonaws.com/aws-iot-device-sdk-python-docs/sphinx/html/index.html | |
| client = AWSIoTMQTTClient(configs['client_id']) | |
| client.configureEndpoint(configs['endpoint'], configs['port']) | |
| client.configureCredentials(configs['root_ca'], configs['private_key'], configs['certificate']) | |
| client.configureAutoReconnectBackoffTime(1, 32, 20) | |
| client.configureOfflinePublishQueueing(-1) | |
| client.configureDrainingFrequency(2) | |
| client.configureConnectDisconnectTimeout(10) | |
| client.configureMQTTOperationTimeout(5) | |
| client.connect() | |
| client.subscribe(configs['topic'], 1, subscribe_callback) | |
| while True: | |
| time.sleep(5) | |
| if is_finish(): | |
| os.remove(FINISH_FILE) | |
| GPIO.cleanup() | |
| logger.info('Finish home controller') | |
| break | |
| def init_gpio(): | |
| GPIO.setmode(GPIO.BOARD) | |
| GPIO.setup(PIN_AIRCON_ON, GPIO.OUT, initial=GPIO.HIGH) | |
| def parse_config_file(): | |
| config = configparser.ConfigParser() | |
| config.read('config.ini') | |
| return { | |
| 'root_ca': config['AWS_IOT_CONNECT']['ROOT_CA'], | |
| 'private_key': config['AWS_IOT_CONNECT']['PRIVATE_KEY'], | |
| 'certificate': config['AWS_IOT_CONNECT']['CERTIFICATE'], | |
| 'client_id': config['AWS_IOT_CORE']['CLIENT_ID'], | |
| 'endpoint': config['AWS_IOT_CORE']['ENDPOINT'], | |
| 'port': int(config['AWS_IOT_CORE']['PORT']), | |
| 'topic': config['AWS_IOT_CORE']['TOPIC'] | |
| } | |
| def subscribe_callback(client, userdata, message): | |
| topic = message.topic | |
| payload = json.loads(message.payload) | |
| logger.info(f'from topic: {topic}') | |
| logger.info(f'Received a new message: {json.dumps(payload, indent=4)}') | |
| control(payload) | |
| def control(params): | |
| if is_control(params) == False: | |
| return | |
| if is_aircon_on(params): | |
| logger.info('Execute PIN_AIRCON_ON') | |
| execute(PIN_AIRCON_ON) | |
| def execute(pin_no): | |
| GPIO.output(pin_no, True) | |
| time.sleep(0.5) | |
| GPIO.output(pin_no, False) | |
| time.sleep(0.5) | |
| def is_finish(): | |
| if os.path.isfile(FINISH_FILE): | |
| return True | |
| return False | |
| def is_control(params): | |
| if params['command'] == '/control': | |
| return True | |
| return False | |
| def is_aircon_on(params): | |
| if params['target'] == 'aircon' and params['param'] == 'on': | |
| return True | |
| return False | |
| if __name__ == '__main__': | |
| main() |
Raspberry Piの環境構築
「証明書の作成 & ダウンロード」以外は、Raspberry Pi上で作業します。
証明書の作成 & ダウンロード
ブラウザでAWSにログインし、作成したIoT Thingsを開きます。
続いて、「セキュリティ」の「証明書の作成」を選択します。
作成された証明書などをダウンロードし、「有効化」をしたのち、「ポリシーをアタッチ」を選択します。
- このモノの証明書
- プライベートキー
- AWS IoTのルートCA (Amazon ルート CA 1)
さきほど作成したポリシーを選択し、「完了」を選択します。
Raspberry Piにファイル類をコピー
Raspberry PiとPCを接続し、先ほど作成したファイル類をRaspberry Piにコピーします。
証明書フォルダの作成
$ mkdir cert
上記フォルダ内にダウンロードした証明書などを格納します。
最終的に次のようになっていればOKです。
$ tree -L 2 . ├── cert │ ├── AmazonRootCA1.pem │ ├── certificate.pem.crt.txt │ └── private.pem.key ├── config.ini └── main.py
ライブラリのインストール
$ pip install AWSIoTPythonSDK $ pip install rpi.gpio
学習リモコンにエアコンONを学習させる
Raspberry Pi用の赤外線学習リモコンの説明書に従って実施します。
必要に応じて、Pythonスクリプト（main.py）のPIN番号定義を修正します。下記の混在に注意してください。
- 学習リモコンのSW番号
- Raspberry PiのGPIO
- Raspberry PiのPIN
開始コマンド
SSH接続を解除してもバックグラウンド実行してほしいため、nohupを使用しています。また、GPIOの制御にはsudoが必要です。
$ nohup sudo python main.py > output.log &
終了コマンド
スクリプト終了時にGPIO.cleanup()を実行する必要があるため、finish.txtが在る場合に終了させています。
$ touch finish.txt
動作確認！！！
Slackで/control aircon onと入力して実行します。
反応が返ってきて、、、実際にエアコンがONになりました！！！
さいごに
AWS CDKとTypeScriptは初めて使いましたが、CloudFormationやAWS SAMと比べて、非常に便利＆楽だと思いました。
YAMLの構成（階層）と微妙に異なるので慣れるまで大変そうですが、TypeScriptの型とエディタの補完機能が便利すぎます！！
AWS CDKの良い勉強になりました。これから積極的に使っていきたいです。
参考
- AWS Cloud Development Kit
- AWS Cloud Development Kit (AWS CDK)
- AWS CDK Tools
- API Reference
- AWS SDK for JavaScript
- Class: AWS.Iot
- Class: AWS.IotData
- AWS
- パブリッシュ/サブスクライブポリシーの例 | AWS
- describe-endpoint | AWS CLI
- ほか
- Slash Commands | Slack API
- AWS CDK が GA! さっそく TypeScript でサーバーレスアプリケーションを構築するぜ【 Cloud Development Kit 】 | Developers.IO
![[小ネタ] boto3のSessionはリージョンの取得が簡単です](https://images.ctfassets.net/ct0aopd36mqt/wp-thumbnail-a873a00568e5285b2051ff6c5aae2c3d/febef60aecfe576a837a7efcb96625eb/python_icatch.png)
