作って学ぶPhoenix、IoTサーバー

Last updated at 2019-12-15Posted at 2019-12-14

これはfukuoka.ex Elixir／Phoenix Advent Calendar 2019の15日の記事です。
昨日は@a_utsukiさんの「「プログラミングElixir」の次にやること」でした。

今回は「作って学ぶNerves、BBBでCO2計測」の

取得した値をPhoenixへPOSTしWEBブラウザで見られるようにできたら、
WEBからIoT端末までElixirで統一できてかっちょいいですね。

を実現できたので紹介します。

結果

先に結果を示します。

見た目は地味で残念ですが、

Current Measurementの直下に表示される値が5秒毎に更新されています。
この値はNervesで計測したCO2の計測時刻（UTC）とその値(ppm)です。
そして描画更新周期はCO2の計測周期です。←ココポイント

以下では、このシステムの構成とその処理を紹介します。

構成と処理

構成

Phoenixサーバーに２つのクライアントがアクセスします。
一つは「作って学ぶNerves、BBBでCO2計測」で作ったNerves、もう一つはWebブラウザです。

Phoenix<-->Browser間の処理

WebブラウザはPhoenixのデータ参照ページにアクセスします。
Webブラウザは取得したjsファイルを実行し、WebSocketでPhoenixに接続をかけ、channelにjoinします。
このchannelには「"new_measurement"が来たら画面の値（時間とCO2濃度）を書き変える」イベントを登録しています。

PhoenixのChannelについては@nikuさんの「Phoenix Framework - Channel 日本語翻訳」が把握しやすいです。

Phoenix<-->Nerves間の処理

Nervesクライアントは計測したCO2データを5秒毎にPhoenixのJSON APIにPOSTします。
PhoenixはPOSTされたデータを永続データとしてPostgresに格納します。
また、同時にchannelに対し、"new_measurement"をbroadcastします。

このbroadcastを受け、Browserに登録したイベントがキックされ画面更新が起きます。
このため、この画面更新は即応性があります。

これはWebSocketを使ったサーバープッシュ、通知機能等で用いられる技術です。

作っている中でPhoenixにはサーバープッシュに２つの方法があることが分かりました。

寄り道：Phoenixのサーバープッシュ

chatのような場合は、Phoenix.Channel.broadcastを使う
今回の場合は、Phoenix.Endpoint.broadcastを使う

chatのような場合

PhoenixのChannelsのドキュメントにあるchatの実装は、

Browser側は投稿ボタンのクリックに合わせてchannel.push("new_msg", {body: chatInput.value})し、
Phoenix側はhandle_in("new_msg", %{"body" => body}, socket)でBrowserのメッセージを受けて、
Phoenix.Channel.broadcastを実行します。

def handle_in("new_msg", %{"body" => body}, socket) do
  broadcast!(socket, "new_msg", %{body: body}) # Phoenix.Channel.broadcast! を使っている
  {:noreply, socket}
end

handle_in関数はsocketに流れて来るeventとmessageを受けます。
このときhandle_in関数の引数にはsocketが渡ってくるため、broadcast先はそのsocketとして知ることができます。

今回の場合

今回の場合は「Phoenix<-->Nerves間の処理」で説明したとおり、データをDBに格納した直後にbroadcastします。
このとき、Phoenix.Channel.broadcastを使おうとすると、引数に渡すsocketに何を用いればよいか分かりません。
※ここでハマりました。

この場合に使えるのが、Phoenix.Endpoint.broadcastです。
（@kanmoさんの「Phoenix ChannelのAPIについて」が参考になりました。）

Phoenix.Endpoint.broadcastはトピックを指定して、broadcastすることができます。

measurement_controller.ex

def create(conn, %{"data" => measurement}=params) do
  with {:ok, %Measurements.Data{} = datum} <- Measurements.create_data(measurement) do
    EasyIotServerWeb.Endpoint.broadcast!( # Phoenix.Endpoint.broadcast! を使っている
      "topic:subtopic",
      "new_measurement",
      %{
        time: datum.utc_datetime_usec,
        value: datum.value,
      }
    )

    conn
    |> put_status(:ok)
    |> render("show.json", datum: datum)
  end
end