Skip to content

Latest commit

 

History

History
212 lines (119 loc) · 13.5 KB

document.md

File metadata and controls

212 lines (119 loc) · 13.5 KB

オムロン環境センサ・Ambient・isaaxハンズオン

BLEセンサーデバイスとラズパイを使ってセンサーデータの可視化をしてみましょう。BLEデバイスにはオムロン環境センサ(2JCIE-BL01)、センサーデータの可視化にはAmbient.ioを使っていきます。

※ isaax勉強会では必要なライブラリのインストール時間を節約するためにあらかじめ用意したSDカードを使用します。公式のRaspbianを使って1からセットアップする場合はこの記事の最後にある付録をご覧ください。

サンプルコードのフォーク

isaaxを使ってデバイスに配信するプログラムはGitリポジトリ(以下、リポジトリ)として管理します。今回はあらかじめ用意したサンプルコードをフォークして使います(フォークしたくない場合は、クローンして新規リポジトリとして作成してください)。

リポジトリとは、ファイルやディレクトリの変更履歴を保持したプログラムファイルの集合です。Gitを使って開発する場合、大抵は1つのアプリケーションごとに1リポジトリ作成します(もちろん例外もあります)。

fork repository

isaaxプロジェクトの作成

前節で自分のGitHubアカウントにフォークしたリポジトリを使ってisaaxにプロジェクトを作成します。isaaxアカウントをまだ作成していない場合はこのタイミングで登録しましょう(GitHubアカウントを使って登録すると便利です)。

「新規プロジェクト追加」から新しいプロジェクトを作成します。

create project

下図のように設定し、「保存」ボタンをクリックします。

project settings

デバイスの登録

作成したプロジェクトにデバイスを登録します。登録するにあたって、ラズベリーパイ側にはisaaxdというソフトウェアをインストールする必要があります。isaaxdは私たちがデバイスにインストールするアプリケーションの管理(起動、停止、ログの収集等)を担っています。

プロジェクトの作成後、下図のような画面が表示されます。プロジェクトトークンはデバイスにisaaxdをインストールする際に必要となります。インストールスクリプトはそのトークンを引数としてisaaxdのインストールをワンコマンド実行するためのスクリプトです。背景が黒い方の文字列をコピーしてください。

project-token

コピーしたコマンドはラズベリーパイ上で実行します。WindowsならPuttyやTeraTerm、MacやLinuxならターミナルを使ってラズパイにSSH接続しましょう。ユーザー名はpi、パスワードはraspberryです。

ログインに成功したら、コピーした文字列をラズパイ上で実行します。

isaaxd installation

上図のようにisaaxd installation completeが表示されればインストール成功です。

isaaxを使ったログデータの確認

isaaxdのインストールが完了した時点でサンプルコードも同時にインストールされています。サンプルコードは、オムロン環境センサのアドバタイズパケットからセンサーデータを取得し、その中から照度を標準出力するシンプルなスクリプトです。isaaxdはこのアプリケーションの標準出力と、標準エラー出力を監視してクラウドにログデータとして送信します。

サンプルコード(envsensor-ambient/sample1.py) - GitHub

ダッシュボードに戻り、登録したデバイスの状態を確認しましょう。プロジェクトトークンのモーダルを閉じ、クラスターをクリックします。

クラスターはプロジェクトに対して複数作成することができ、その下に紐付くデバイスをグループごとに分けるための機能です。この機能によって、開発中のデバイスと本番のデバイスを切り分けるといった応用的な操作が可能になります。

cluster

クラスターページを開くと「最近のデバイス」に先ほど登録したデバイスが表示されます。「バージョン」はインストールされているisaaxdのバージョンを、「リビジョン」はインストールされているアプリケーションのコミットID(Gitで作成した履歴ごとに付与されるID)をそれぞれ示しています。デバイスをクリックしましょう。

device

下図がデバイスの詳細ページになります。赤色の丸で囲われたボタンをクリックするとインストールしたアプリケーションのログを確認することができます。ラズベリーパイが期待する動作をしないときなどはこちらにエラーログが上がっている可能性が高いので確認しましょう。そのほか、割り当てられているIPアドレスの確認やアプリケーションの起動・停止などの機能を備えています。

device-log

この時点では、デバイスログはNo sensors found.と表示されています。サンプルコードでは環境変数から読み取ったMACアドレスを元にBLEデバイスの判別とセンサー値の取得をおこないます。次節でisaaxを使ってユーザーアプリケーションがアクセスできる環境変数を定義する方法について説明します。

環境変数サービス (ユーザー変数)

isaaxではAPIキーのような認証情報や環境によって異なるエンドポイントなど、ハードコーディングしたくないデータを切り分けてデプロイする機能があります。isaaxで登録したこのデータはデバイス上で環境変数としてアクセスできます。

クラスターページから「Cluster Settings」をクリックしてドロップダウンを開きます。

cluster settings

「ユーザー変数」タブから「+環境変数追加」をクリックします。

list of user var

サンプルアプリケーションでは環境変数BLUETOOTH_DEVICE_ADDRESSからMACアドレスを取得します。値はそれぞれ手元の環境センサのMACアドレスに置き換えてください(勉強会では配布した資料にMACアドレスが記入してあるので、環境センサに付けられた番号から参照してください)。

user var creation

保存後、「restart」ボタンをクリックし、デバイスログがNo sensors found.からIllumination: 254 lxのような数値に置き換わっていれば成功です。ここでは照度を表示しています。スマホのライトなどでセンサーを照らしてみましょう。

restart app

デバイス上で動作するサンプル側では、11行目でMACアドレスを取得しています。


isaaxdのインストール以降、プロジェクトに紐づけたリポジトリに更新があるたびにデバイスを自動的にアップデートしてくれます。ここで、いくつかの課題にチャレンジしてisaaxを使ってデバイスを遠隔から更新する方法について学びましょう。フォークしたリポジトリの編集はPC上にクローンして行っても、GitHub上から直接おこなっても構いません。

課題1 どんなセンサーデータがあるか確認しよう

sample1.py22行目のコードが実際に環境センサから取得しているデータです。Pythonの組み込み関数vars()を使って、センサーデータにどのような種類があるのか確認しましょう。

Python組み込み関数 vars() - 公式ドキュメント

成功すると下図のような出力が得られます。

answer task1

課題2 任意のセンサーデータを出力しよう

課題1で確認したセンサーデータの中から好きなものを選んで、表示させるように変更を加えましょう。


Ambientアカウント登録

次に、センサーデータをクラウドで可視化しましょう。今回はIoTのデータ可視化サービスであるAmbientを使っていきます。ArduinoスケッチやPythonモジュールからとても手軽に可視化を実現することができます。

それではアカウント登録をおこないます。下記リンクをクリックして、右上の「ユーザー登録(無料)」から登録作業をおこないます。

メールアドレスとパスワードを設定すると入力したアドレス宛てにE-mailが届くので、記載のリンクをクリックして登録を完了しましょう。

チャネル作成

Ambientアカウントに登録後、「Myチャネル」->「チャネルを作る」ボタンからチャネルを新規作成します。

channel creation

作成したチャネル情報の中から、データを保存するために「チャネルID」と「ライトキー」を後ほど使います。

channel details

環境変数の追加(チャンネルID, ライトキー)

更新するサンプルアプリケーションがAmbientにデータを送信するために、チャネルIDとライトキーが必要となります。これらの情報を先ほどの容量で環境変数AMBIENT_CHANNEL_IDAMBIENT_WRITE_KEYとして設定します。

extra vars

isaax.jsonのエントリーポイント変更

最後に、isaaxを使ってラズベリーパイ側のアプリケーションをAmbientにデータを送信するように変更します。サンプルコードはすでに用意してあるのでisaax.jsonを修正して実行するファイルをsample1.pyからsample2.pyに変更します。

フォークしたリポジトリのisaax.json9行目を下記のように変更してコミットします。

{
  "name": "Envsensor Ambient",
  "version": "",
  "description": "",
  "author": "",
  "license": "",
  "language":"python",
  "scripts": {
	"start": "python3 -u sample2.py"
  }
}

Ambientのダッシュボードから該当するチャネルをクリックすると、数十秒後にチャートが自動的に作成されます。

ambient dashboard


課題3 チャネルに複数のセンサーデータを送ろう

AmbientのPythonモジュールのドキュメントを参考にsample2.pyに変更を加え、チャネルに複数のセンサーデータを送信するようにアプリケーションを更新しましょう。

Ambient Pythonモジュール - 公式ドキュメント


付録1. SDカードのセットアップ

勉強会で使用したOSは2018-06-27リリースのRaspbian Stretch Liteをベースに作成しました。

サンプルコードを動作させるには下記のライブラリをインストールしてください。

sudo apt-get install -y libperl-dev
sudo apt-get install -y libgtk2.0-dev
sudo apt-get install -y libglib2.0
sudo apt-get install -y libbluetooth-dev libreadline-dev
sudo apt-get install -y libboost-python-dev libboost-thread-dev libboost-python-dev
sudo apt-get install -y python3-pip
sudo pip3 install pybluez
sudo pip3 install pygattlib
sudo pip3 install git+https://github.com/AmbientDataInc/ambient-python-lib.git

付録2. 事後学習のために

isaaxについてより深く知るためには、公式のドキュメントを読んだり、コミュニティで質問してみましょう。

無料の勉強会も開催しているので、ハンズオンしたい方はこちらにもご参加ください。

SNSでもIoTに関する情報を発信しています。フォローお願いします。