途中、間違ったり、手戻ったり、迷ったりしていますが、それはご愛嬌で。。

ソフトウェア設計・実装

ソフトウェア設計

下図にスマートロックのソフトウェア・コンポーネントの概略図を示します。
これは後述する legolocker.py の中身を表現したものになります。

ハードウェアは並列動作するため、ソフトウェアでも並列処理が必要ですが、今回は、pykkaのアクターモデルを用いて並列処理を表現するようにしました（Scala好きなので）。アクターは簡単に言えばメッセージキュー付きスレッドです。この図の矢印が概ねメッセージです。

図中最上段のハードウェアのイベントやWeb APIからのリクエストをトリガーに、ソフトウェアの状態遷移が起こります。次に、ハードウェアの物理的変化やSlackへの通知が連鎖して起こるという仕組みになっています。

図中の実線は同期呼び出し、点線は非同期呼び出しを表しています（ハード部分は少し不正確かもしれません）。

ソフトウェア実装

ソースコードはgithubに一式を置きました。

ソースコードの概要

• legolocker.py: スマートロックのメインプログラムです。
• env.sh: 環境変数の設定スクリプトの雛形です。ここに必須環境変数を定義するといいでしょう。
• start_locker.sh: プログラムを起動するスクリプトです。
• stop_locker.sh: プログラムを停止するスクリプトです。
• pyb00st: 改造版 pyb00st です。改造内容は次の通りです。
  • 周囲にあるLEGO Boostを検索できるようにした（MACアドレス引数を不要にした）。
  • モーター停止時に、モーターにかかる電圧がゼロになるようにした。
  • 状態変化イベントハンドラを差し込めるようにした。

注意点

実行の前に下記の環境変数が設定されている必要があります。例えば、env.shの中でexportするのがいいでしょう。

• SLACK_TOKEN: SlackボットのAPIトークン（例:"xoxb-..."）
• SLACK_BOT_NAME: Slackボットの名前（例:"keybot"）
• SLACK_REMINDER_CHANNEL: 鍵閉め忘れ通知先チャネル名（例:"#alert"）
• API_SECURE_KEY: スマートロックAPIのセキュアキー（例:セキュアなランダムURL文字列）
• API_PORT: スマートロックAPIのポート番号（例:"3000"）

なお、プログラムは、サムターンが縦長のとき（色は赤）解錠、右に回転して横長（色は青）のとき施錠となる鍵用に作ってあります。

LEGOでできたスマートロックの利用方法

LEGOでできたスマートロックの起動

起動前に、サムターンやLEGOが次の物理的状態になるようにします。

• サムターンの位置を横長（閉じている状態、青ブロックが右、赤ブロックが下）にする。
• スマートロックの右下にあるバーの位置を下端（閉じている状態）にする。
• サムターンを回すギアの位置を、ギアから垂直に出た棒が、サムターンの左上と右下に接する位置にする（力は加わらないようにする）。

上記の環境変数 SLACK_TOKEN, SLACK_BOT_NAME, SLACK_REMINDER_CHANNEL, API_SECURE_KEY, API_PORT が定義された状態で、start_locker.sh を実行し、10秒以内にLEGO BoostのMove Hubの電源ボタンを押します。
うまくRaspberry Piとペアリングされれば、Move HubのLEDが青に点灯します。

homebridgeへのスマートロック登録方法

homebridgeのhomebridge-cmdaccessoryプラグインをインストールし、下記のように設定すると、スマートロックがHomeKitの鍵デバイス（LockMechanism）として認識されるようになります。
なお、{APIサーバ}はスマートロックのAPIが動作しているサーバのIP、{API_PORT}と{API_SECURE_KEY}はそれぞれ同名の環境変数の値に置き換えてください。

{
    ...省略...

    "platforms": [{
        "platform": "cmdAccessory",
        "name": "CMD Switch",
        "switches": [{
            "name": "鍵（玄関）",
            "on_cmd": "curl -sS -X PUT http://{APIサーバ}:{API_PORT}/api/{API_SECURE_KEY}/key/CLOSED",
            "off_cmd": "curl -sS -X PUT http://{APIサーバ}:{API_PORT}/api/{API_SECURE_KEY}/key/OPEN",
            "state_cmd": "curl -sS http://{APIサーバ}:{API_PORT}/api/{API_SECURE_KEY}/key | grep 'CLOSED'",
            "polling": true,
            "interval": 3,
            "manufacturer": "Isao Sonobe",
            "type": "LockMechanism"
        }]
    }]
}

これでhomebridgeを起動し、iOSにhomebridgeを登録すれば、iPhone等からLEGOでできたスマートロックをコントロールできるようになります。

最後に

長い記事をお読みいただき、ありがとうございました。
もしご興味のある人が多そうであれば（いいねが多かったら）、もう少し詳細を書こうと思います。