raspberry pi 3B+でテレビ電話システムを構築する

技術ネタ raspberry pi

はじめに

この投稿ではサーバーの用意が必要なので、sapislabを使ったやり方を用意しました。
サーバー立てるの厳しい方はこちらをご覧ください。

システム概要

raspberry pi 3B+ によるテレビ電話システム
※記載内容に責任は持てません、全て自己責任でお願いします

概念図

f:id:miya15:20190222233504p:plain

背景

  • 妻が夕食の準備中に子供の相手が大変である
  • おばあちゃんが一人なので心配である

改善案

  • 子供とおばあちゃんが気軽にテレビ電話が出来るようにする

要件

  • テレビ電話が出来ること
  • 手軽に使えること（煩雑だと結局使われない）
  • 費用は抑えること（常套句）

想定シナリオ

  • 妻が子供たちを連れて帰宅
  • 我が家からリモコンでスイッチオン
    • 我が家とおばあちゃん家のテレビが自動でONになりテレビ電話を開始する
  • 我が家からリモコンでスイッチオフ
    • 我が家とおばあちゃん家のテレビが自動でOFFになりテレビ電話を切断する

前提条件

  • おばあちゃんに家のテレビが勝手にONになってリビングが映し出されるプライバシー的な問題について予め了承を得ておくこと（※同居人が居る場合はその方にも）
  • VPNは張らない（ルーターの機能的に無理だからｗ）

用語

  • 我が家はcallerに置き換える（呼び出し側）
  • おばあちゃん家はreceiverに置き換える（受け手側）
  • 途中に出て来るvtcはvideo telephone controlerを略したもの

必要なもの

  • raspberry pi 3B+ を2セット
    • ヒートシンクは付けておいた方が良いと思う
    • 電源やSDカード等の別途必要なものは明示しない
    • OSはraspbianを想定
  • webカメラを2個
    • 1000円程度のもので十分
  • USBマウス・USBキーボード
    • セットアップ用途
  • AB Shutter3 を1個
    • シェル起動のトリガーになるなら何でも構わない
  • caller,receiver両方のネットワーク環境（従量制ではないこと）
  • APIサーバーを立てる場所（及びデプロイできる技量）
    • グローバルIPが当ててあるか、DNSで特定できるようになっていること
    • ここでは一般的なVPSを想定
    • raspberry piで何かしようとしている人ならきっとできる（偏見）
  • テレビ電話サービスのアカウント登録用メールアドレスおよびアカウント
    • アカウント登録手順などは省略

仕組み

  • APIサーバーを仲介役として、callerから指示を出し、receiverがポーリングで反応する
    • こうする事でIPが変わる環境でも間接的な連携が可能となる
    • ネットワーク的にも分断されたままなので安心（？）
  • テレビ電話はskypeも検討したが直接はインストールできない為、ブラウザベースのものを利用
    • 特定のURLにアクセスしたら繋がるタイプ（apeer.inやskyway）を使う
    • たまたま同じルームを作ってしまって丸見えになる覚悟も必要（skywayでローカルに立てる方式なら問題無さそう）
      • 絶対にNGであれば有料会員になってLockすれば大丈夫だと思う（試してない）

状態遷移図

f:id:miya15:20190228163315p:plain

開始処理のシーケンス図

f:id:miya15:20190228163332p:plain

終了処理のシーケンス図

f:id:miya15:20190228163340p:plain

APIサーバーの機能（超単純）

  • 現在の状態を取得できる
  • 状態を変更できる
  • 接続すべきURLを取得できる
  • セキュリティ関連
    • 必要に応じてapiキーによる制御

やり方

raspberry pi 3（caller, receiverともに）

raspberry pi 3（receiverのみ）

  • 「vtc-exec-receiver.sh」をcronで定期実行させる（間隔はお任せ）
  • 注意：シェルスクリプトにAPIサーバーのURLとAPIキーを記載する場所があるので適宜入れておくこと

raspberry pi 3（callerのみ）

  • AB Shutter3 で任意のシェルが叩ける準備（下記の記事を参考に準備する）

miya15.hatenablog.com

  • ON用のボタンが押されたら「vtc-exec-caller-on.sh」を叩くようにする
  • OFF用のボタンが押されたら「vtc-exec-caller-off.sh」を叩くようにする
  • 注意：どちらのシェルスクリプトにもAPIサーバーのURLとAPIキーを記載する場所があるので適宜入れておくこと

APIサーバー

  • docker, docker-compose が入っていなければインストール
    • 直接配置したい人は無くても問題無い
    • ssl付ける人でlet's encrypt使う場合はapache等でリバースプロキシすると良い
      • ssl付けないとapiキー付けてもキャプチャされたら無防備な点に注意
      • sslの詳細は省きます
  • プログラム配置
  • redisを直接操作してapiキーやurlを初期設定する
    • 詳細は後述
    • apiキーはcallerとreceiverを分けて発行した方が後々の拡張で使えるかもしれません（現状では何ら分ける意味はありません）

redisへの設定値反映方法

redis-cliを叩く手順（docker-composeの利用を想定）

$ docker exec -it vtc-api-server_db_1 /bin/sh
/data # redis-cli
127.0.0.1:6379> コマンド（後述参照）

コマンド例

▽APIキーを追加する
127.0.0.1:6379> rpush apikeys xxx
▽urlを設定する（※使える記号は「:/.?=&」）
127.0.0.1:6379> set url xxx
▽状態をrequest to openに設定する
127.0.0.1:6379> set state "request to open"

各種プログラム

注意事項

  • 電化製品なので漏電や火災に気を付けましょう
  • 各種OSやミドルウェアのバージョンを新しく保つよう心がけましょう
    • raspberry pi もパソコンですからBOT化しないよう気を付ける
  • テレビによってはHDMIの制御が効かないものがあります、ご注意ください
    • まずはraspberry piを1台だけ買って双方のテレビに繋いでコマンド投げて試す方が良い
  • 接続先URLをAPIサーバーから取得するようになっているので気になる方は直接プログラムに埋め込んだ方がより安全です
    • URLが変更できるようになっているのはルームIDを変更したり別のサービスに切り替えるのが手軽に出来るようにする為です

今後の発展

  • 状態遷移はjson形式で渡しているので遷移を増やすと面白いかもしれない
  • 定期的にAIで在席・不在を判断できるとその後のアクションにも繋げられるか

運用中に発生した問題点について

  • receiver側でHDMIの制御がうまくいかない事があった
    • 具体的にはch2に繋いでいるのに"as"で入力1になってしまう。ログを取ったが物理アドレスを誤認識している様子。仕方ないので直接chを指定する形で回避。コメントアウトしているが「cmd = "echo 'tx 1f:82:20:00' | cec-client -s"」の部分。1f:82:20でch2、1f:82:10でch1となるがテレビによって違う可能性あり。
  • 実際に繋がると子供（5歳男児）は映っている自分に興奮して踊りだし、おばあちゃんとの会話にならない（苦笑いしてるというありさま）
    • 完全に想定外

メモ

  • APIサーバーはAWSのapi gatewayとlambdaとDynamoDBの組み合わせでも問題無いと思うが今回はパス（悪意のあるユーザーに大量に叩かれたら嫌なだけ）
  • Herokuの無料プランでも使えるかもしれない
    • ちょっと試したけどredis使うならクレジットカード登録が必要ですね
  • 今回はraspberry piを使う事が前提にあったが、intel系のスティックPCとかでskypeを使う方式としても使えるかもしれない（skypeには自動応答機能があるので、コマンドラインからコール出来れば完成したようなもの）
  • プログラムが最適化されていない点はご容赦ください
  • バグなどありましたらコメント頂けるとありがたいです
  • 取り敢えず1ヵ月ほど運用してみましたがうまく動いています（思ったほど活用されてないのが残念ですが・・・）