あくあたん在室管理システム (backend)

apiserver: データベースとビーコン検出器との橋渡し
ibeacon_scanner: ビーコン検出器
ibeacon: ビーコン

[BLE Nano]  BLE     [M5Stick C]                    WiFi    [サーバ]    mysql
ibeacon    ----->  
ibeacon    ----->  ibeacon_scanner (各部屋に設置) -----> apiserver.js -----> room_monitor
ibeacon    ----->  ibeacon_scanner (各部屋に設置)  
ibeacon    ----->

用意するもの

BLE Nano または市販のiBeacon: 検知対象の人数分
M5Stick-C or M5Stick-C Plus or M5Stack (ESP32なら多少の改変でOK) : 検知したい部屋の数以上
MySQLが動作するサーバ: 1台（大量に書き込みと読み出しが発生するので注意）

How to use

ibeaconの準備 (RedBear Lab BLE Nano)

iBeacon規格に則ったビーコンを作成する．
先頭のGIT_TO_DETECTをグループ共通の数字にする．(major number)
MY_UID を個別の識別番号にする．この識別番号は後々使う．(minor number)
major, minorが固定で，minorがすべて異なる市販iBeaconを使ってもよい．

ibeacon_scannerの準備 (M5Stick-C)

先頭のGID_TO_DETECTをビーコンと同じに設定する．
- ビーコンのmajorがバラバラな場合，DISABLE_GID_CHECKを有効にする．
DEFAULT_*に初期値を設定する．（この設定は後からWeb経由で変更可能）
Partition Schemeを Minimal SPIFFSに設定しないと書き込めない．(スケッチが巨大)

データベースの準備

apiserver/setup_db.sqlを実行し，mysqlにデータベースを作成する．(ibeaconデータベースが作成される．)

$ mysql -u root < setup_db.sql

ibeaconデータベースにアクセスできるユーザを作成する．

CREATE USER hoge@localhost identified by 'hogehoge'; 
GRANT ALL ON ibeacon.* to hoge@localhost;

ble_tag テーブルの beaconに利用するビーコンの識別番号を記述，nameは対応する人名等を入れる．（管理のため）
ble_tab テーブルの activeを1にするとそのビーコンが検出可能になる．
- DBのroom_logテーブルには，ビーコンからの生の情報が逐次書き込まれる．（一定時間以上経過したものは削除）
- room_logの情報を2つのビュー(room_detectors->room_status)で集約し，ble_tagの情報と併せてroom_monitorビューで表示．

apiserverの準備

apiserver/config/default.jsonにDBへの接続情報を記述する．

  {
    "db":{
        "host":"localhost",
        "database":"ibeacon",
        "user":"hoge",
        "password":"hogehoge",
  	    "multipleStatements": true
    },
    "port": 3001,
    "lost_detect_interval": 60000	
}

node apiserver.jsにて実行．3001ポートを待ち受けにして待機．

確認

room_monitorビューを眺める．
logテーブルには，検出と失探のログが残る．

運用例

omznのソフトウェア工学研究室では，4つの部屋(8-320, 8-303, 8-302, 8-417)があり，それぞれの部屋にibeacon_scannerを1〜3台設置しています．構成員は1人1台のibeaconを持っています．

モニター (room_monitor)

Mysql DB内のビュー．

サーバ (apiserver/apiserver.js)

node.jsにて記述
mysqlデータベースとesp32の橋渡しをするapiサーバ．
初期はポート3001に設定している．

初期設定

依存するnpmパッケージをインストール．npm install
config/default.jsonにmysqlの接続情報を記入．
pm2などで起動管理しておくと便利．

$ pm2 start apiserver

API

/beacon/add POST label=??&detector_id=??&place=??
- label: iBeaconのminor number
- detector_id: 検出器の室内id
- place: 検出器のある部屋の識別子
/beacon/alive POST room=??&detector_id=??&ipaddress=??
- room: 検出器のある部屋の識別子(上のplaceと同じ物)
- detector_id: 検出器の室内id
- ipaddress: 検出器のipアドレス
/beacon/status
- ibeaconの状況をjsonで取得（例）↓

{"target":{"bt15146":{"status":"Lost","time":"2021-04-21 13:39:31"},"bt15098":{"status":"Found_8-302","time":"2021-04-21 13:05:29"}}}

クライアント (ibeacon_scanner)

M5Stack/M5Stick-C/M5Stick-C Plus用に作った．切り替えは先頭のこれをどちらか生かす．

#define USE_M5STICKC
#define USE_M5STICKCPLUS
#define USE_M5STACK

M5StackはM5Stack communityが提供するBoardを使う(https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/arduino/package_m5stack_index.json)
M5(M5Stick-C)/B(M5Stack)ボタンを押すと，自動割り当てIPアドレス，部屋識別子と検出器IDを確認できる．
- 部屋を区別するために部屋識別子(place)を利用し，同部屋内に複数設置する検出器を区別するためにdetector_idを使う．

API

/status
/config
- hostname: ホスト名を指定 (OTAで利用)
- url_endpoint: apiserverのアドレス，ポートをuriで指定
- api_beaconadd, api_beaconalive: apiserverのAPIを（変更した場合などは）指定．
- place: 部屋識別子の指定
- detector_id: 部屋内検出器のIDを指定
  - place+detector_idが一意になるように設定

起動直後

WiFiの設定をする．ssid: BEACON_SCAN に接続して，ssid, passwordの設定
/configからはホスト名(hostname), APIサーバのエンドポイント(url_endpoint), APIのパス(api_beaconadd, api_beaconalive), 部屋識別子(place), 部屋内検出器ID(detector_id)が設定できる．
必ず，url_endpointの設定をする．

$ curl "http://scanner.local/config?url_endpoint=http://10.0.0.1:3001"

また，部屋識別子(place), 部屋内検出器ID(detector_id) はペアで一意になる必要がある．

$ curl "http://scanner.local/config?place=MyRoom&detector_id=0"

3と4は同時に設定した方が早い．

$ curl "http://scanner.local/config?url_endpoint=http://10.0.0.1:3001&place=MyRoom&detector_id=0"

動作

1秒ずつBLEをスキャンしてiBeaconを検出．
検出したiBeaconについて，apiserver:/beacon/addにアクセスして登録
一定時間(60秒)ごとに検出器の生存確認をapiserver:/beacon/aliveにアクセスして登録

ibeacon

RedBear Lab製 BLE Nano (V1.5, V2.0)用のビーコン発信器
GID_TO_DETECT, MY_UIDをプログラムに直書きして埋め込む．
CR2032で6ヶ月〜1年運用可能．

DB

ble_tag テーブルに，最低限 label, name, activeを登録する．
alive2テーブルには，検知器の生存情報が記録される．timestampが1，2分以内にないものはハングアップしてる可能性．
logテーブルには，各部屋で検知したログFound_部屋と失探したログLostが残る．

omzn/aquatan_room_monitor_backend

あくあたん在室管理システム (backend)

用意するもの

How to use

運用例

モニター (room_monitor)

サーバ (apiserver/apiserver.js)

初期設定

API

クライアント (ibeacon_scanner)

API

起動直後

動作

ibeacon

DB