SORACOM Button by Pythonでゴルフのスコアカウンタを作った

IoTのプロジェクトに配属され、キャッチアップのために何か作成したい

そんな思いから、SORACOM LTE-M Buttonを買いました！

SORACOMの公式がnode.jsで作成しているのであまり、Pythonでまとまっているものありません

なので、この記事が今時点でもっとも詳しく書かれているかなと思います

SORACOM Buttonを押してSlackに通知するところまでを解説します

Contents

SORACOM LTE-M Buttonとは
SORACOM Button by Pythonの開発の流れ
SORACOM Button by Pythonのアーキテクチャイメージ
Lambda関数を作成する
Lambda関数をアップロードする
Lambda関数をテストする
- テストイベントを設定する
- テストする
実際にSlack通知してみる
まとめ

SORACOM LTE-M Buttonとは

AWSと超簡単に連携可能なSORACOMが出したIoT Buttonです
イメージは、Amazon Dash Buttonだと思ってください

詳しい説明は公式を確認してください。

https://blog.soracom.jp/blog/2018/07/04/soracom-lte-m-button-powered-by-aws/

SORACOM Button by Pythonの開発の流れ

開発の流れは以下の5Stepに分かれます。
1〜4の登録は、他の記事に説明を譲ります。（参考リンクを貼ります。）
本記事では、5〜8について詳しく説明します。

AWS IoT 1-Click に登録する
AWS IoT 1-Click のプロジェクトを作成する
SORACOM ガジェット管理に登録する
SORACOM ガジェット管理からデバイスの情報を確認する
Lambda関数を作成する
Lambda関数をアップロードする
Lambda関数をテストする
実際にSlack通知してみる

SORACOM Button by Pythonのアーキテクチャイメージ

iot-architecher

SORACOM LTE-M Buttonの処理をAWS Lambdaで受けて、Slackに通知します。
Lambdaに関数をデプロイする手段としてzappaを利用します。

Lambda関数を作成する

zappaのインストール

手前味噌ですが下記を参考にインストールしてください

zappaでAWS lambdaにPythonのソースコードをアップロードする

https://dev2prod.site/python/zappa-aws-lambda

AWS lambdaへのソースコードをデプロイするツール『zappa』を紹介します。zappaってなんだか、「あのバカめ・・・！どういう技かも見切れんのか」とか「きたねぇ花火だ」とか言われてそうな名前ですね。 AWS lambdaでアップロードツールを使う理由を知るアップロードツールの種類を知る zappaを知るAWS lambdaとはサーバレスアプリを作成する際にAWSのlambdaにお世話になることが多いと思います。lambdaのエディタで開発することもできます。しかし、エディタとしては使い勝手が悪かったり、容量が大きいと使えなくなったり…

slackwebのインストール

PythonからSlackに連携するツールをインストールします

pip install slackweb

zappaでは、virtualenv上にインストールされたパッケージを自動でアップロードしてくれます

chaliceの場合、requirements.txtを自分で作成してあげる必要があるので楽ですね

slackでincoming-webhookを用意

こちらのリンクから作成してください

Slack

https://biblio-note.slack.com/apps/new/A0F7XDUAZ–incoming-webhook-

Pythonで処理を書く

lambda.py（任意の名前で問題ありません）というファイルを作成します

import os
import json
from datetime import datetime, timedelta, timezone
import slackweb

# タイムゾーンの生成
JST = timezone(timedelta(hours=+9), 'JST')
tmp_dir = '/tmp'
file_nm = 'score.txt'
score_file_path = os.path.join(tmp_dir, file_nm)
score = '0'

def app(event, context):
    button_type = event['deviceEvent']['buttonClicked']['clickType']
    if button_type == 'SINGLE':
        count_up()
        return button_type
    elif button_type == 'DOUBLE':
        count_down()
        return button_type

    elif button_type == 'LONG':
        push()
        return button_type
    else:
        return button_type

def read_score():
    if not os.path.exists(score_file_path):
        reset()

    with open(score_file_path, 'r') as f:
        tmp_score = f.read()
        return tmp_score

def write_score(tmp_score):
    with open(score_file_path, 'w') as f:
        f.write(tmp_score)

def count_up():
    score = read_score()
    tmp_cnt = int(score)
    tmp_cnt+=1
    write_score(str(tmp_cnt))

def count_down():
    score = read_score()
    tmp_cnt = int(score)
    if tmp_cnt == 0:
        return
    tmp_cnt-=1
    write_score(str(tmp_cnt))

def reset():
    write_score('0')
    
def push():
    push_score = read_score()
    now = datetime.now(JST).strftime('%Y/%m/%d %H:%M')
    payload = '```{} score: {}```'.format(now, push_score)
    slack = slackweb.Slack(url="https://hooks.slack.com/services/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")
    slack.notify(text=payload, mrkdwn=True)
    reset()

続いて、zappa init時に自動で作成されるzappa_settings.jsonを編集します

vi zappa_settings.json

{
    "dev": {
        "app_function": "lambda.app",
        "aws_region": "us-east-2",
        "profile_name": "default",
        "project_name": "score-counter",
        "runtime": "python3.6",
        "s3_bucket": "zappa-2txhj5ihk",
        "apigateway_enabled": false
    }
}

app.functionの部分は、ファイル名＋関数名にしてください。

私の場合、lambda.pyのapp(event, context)を呼び出すためlambda.appとしています。

Lambda関数をアップロードする

zappa deploy
# 2回目以降
zappa update

AWS Lambdaにアクセスして関数が作成されているか確認しましょう

https://us-east-2.console.aws.amazon.com/lambda/home

Lambda関数をテストする

毎回、SORACOM LTE-M Buttonを押して挙動を確認していると上限の1,500回にすぐ到達してしまうので

テストで挙動を確認しましょう！

テストイベントを設定する

AWS Lambdaのアップロードした関数のページトップに『テスト』というボタンがあるので、テストイベントを設定しましょう

SORACOM LTE-M Buttonを押した時に渡されるパラメータはこのようになっています

このパラメータを登録します

{
    "deviceEvent": {
      "buttonClicked": {
        "clickType": "SINGLE",
        "reportedTime": "2018-05-04T23:26:33.747Z"
      }
    },
    "deviceInfo": {
      "attributes": {
        "key3": "value3",
        "key1": "value1",
        "key4": "value4"
      },
      "type": "button",
      "deviceId": " G030PMXXXXXXXXXX ",
      "remainingLife": 5.00
    },
    "placementInfo": {
      "projectName": "test",
      "placementName": "myPlacement",
      "attributes": {
        "location": "Seattle",
        "equipment": "printer"
      },
      "devices": {
        "myButton": " G030PMXXXXXXXXXX "
      }
    }
  }