これは複数地点での入退室管理に対応したシステムです。
入退室システムを置いている部屋をそれぞれROOM A、ROOM Bとおきます。
- 関大の学生証と交通系ICカードで入退室管理ができます。もちろんApple PayやGoogle PayのSuicaやPasmoにも対応しています。入退室した際はslackに通知がきます。
- 学生証や交通系IC登録の際にスマートフォンのブラウザが使用できます。
- BのPCがAのPCのデータベースにアクセスすることで実現しています。これにより、たとえばAで入室し、退室手続きを行わずにBの部屋に入室手続きを行った場合、Aの入退室状況を自動的に退室扱いにしてくれます。逆も同様です。
- 退室手続きを行わずに部屋を出てしまった時、強制退室モードにより一斉に退室扱いとすることができます。
- スマートフォンで登録する場合、ダークモードとライトモードが選択できます。
- 学生証を登録すると、交通系ICが登録できます。
PC(linux)にPasoriを接続し、下のプログラムの実行方法のコードを入力し、起動するだけです。
登録した学生証or交通系ICをPasoriにかざしてください。
slackに通知が送られます。
スマホで、ブラウザを開き"ホストのIPアドレス:5000"にアクセスしてください。テキストボックスにお好きなニックネームを入力してください。そして、登録に使用している部屋のボタンを押してください。すると、データベースにあなたと学生証、ニックネームが登録されます。
テキストボックスに登録したニックネームを入力し、登録に使用している部屋のボタンを押してください。すると、その交通系ICがデータベースに登録されているあなたのデータと紐付けられます。
ニックネームの変更の際は、新しいニックネームをテキストボックスに入力し、登録に使用している部屋のボタンを押してください。そこでこれまでに登録した事のある学生証か交通系ICをかざしてください。
システムは以下のようにHUBとSUBから成立しています。
| ベース | 処理内容 |
|---|---|
| HUB | 入退室のデータベースサーバ 入退室の処理を行うPythonスクリプト 入退室システムをユーザがGUIで操作するためのウェブサーバ |
| SUB | 入退室の処理を行うPythonスクリプト |
docker-compose -f ./docker-compose-hub.yaml up --build
docker-compose -f ./docker-compose-sub.yaml up --build
- Docker
- MySQL
- Python
- Flask
- Slack
- NFC技術 (Pasori(RC-S380)、関大の学生証、交通系IC(Apple Pay、Google Pay含む))
※ここではDockerやMySQLについて、操作方法などはあまり解説していません。
以下でこのプログラムの仕組みを説明します。
ディレクトリ構造は以下のようになっています。
.
├── LICENSE
├── README.md
├── docker-compose-hub.yaml
├── docker-compose-sub.yaml
├── code
│ ├── main.py
│ ├── tools.py
│ ├── ui.py
│ ├── static
│ │ ├── Regist.css
│ │ └── Result.css
│ └── templates
│ ├── Regist.html
│ └── Result.html
├── env
│ ├── mysql.env
│ └── python.env
├── mysql
│ └── 省略
├── python
│ ├── Dockerfile
│ └── requirements.txt
├── others
│ ├── Flowchart
│ │ └── 省略
│ └── ubuntu_setup.sh
└── sql
以下が各ディレクトリの解説です。
| ディレクトリ名 | 内容 |
|---|---|
docker-compose-hub.yamldocker-compose-sub.yaml |
Dockerで動かす際に用いる仮想環境定義ファイル。 |
code/main.py |
入退室管理システムにおいて、カードのスキャンやデータベースの操作をするプログラム。 |
code/ui.pycode/static/code/templates/ |
入退室システムの登録を行うためのGUIを実現するプログラム。 |
env |
dockerのそれぞれの仮装環境の環境変数を記述するファイル。 |
mysql/sql/ |
データベース用のファイル。 |
python |
dockerのPython環境における定義ファイル。 |
others |
PC自体の環境を整えるためのファイルやフローチャートの入ったディレクトリがある。 |
データベースはioを使用しています。
+--+---------+-----------------------+------------------------+-------+-----------+------------+-----------+
| ID | UNIV_ID | TRANSPORTATION_ID1 | TRANSPORTATION_ID2 | NAME | NICKNAME | STATUS_A | STATUS_B |
+--+---------+-----------------------+------------------------+-------+-----------+------------+-----------+
| カラム名 | 内容 |
|---|---|
| ID | これは主キーで、一意性かつ不変性のある番号が個人に割り振られます。 |
| UNIV_ID | 学生証に保存されている16桁のIDです。 |
| TRANSPORTATION_ID1 | 交通系ICに登録されている16桁のIDです。 |
| TRANSPORTATION_ID2 | 交通系ICに登録されている16桁のIDです。 |
| NAME | 学生証に保存されている本名です。 |
| NICKNAME | 登録の際に設定したニックネームが保存される。 |
| STATUS_A | ROOM Aの入室状況です。 |
| STATUS_B | ROOM Bの入室状況です。 |
+----+------+----------+
| flag | result | nickname |
+----+------+----------+
| カラム名 | 内容 |
|---|---|
| flag | カード登録の際に使うフラグ変数です。 |
| result | カードとニックネームの登録ができたかどうかの結果を格納します。 |
| nickname | ニックネームの登録の際に一時的に入力されたニックネームを格納します。 |
- linux(ubuntu)PCを用意してください。
sudo apt install gitと入力してください。gitが入ります。sudo git clone https://github.com/DTK-CreativeStudio/DTK_IOと入力してください。ここでユーザ名。パスワードが求められるので、それぞれ入力してください。cd DTK_IO/othersでディレクトリに移動してください。./ubuntu_setup.shと実行してください。そうすればdocker、docker compose、vs code、MySQL clientなどが入ります。終了し次第自動的に再起動が始まるので、ログインしてください・- vs codeが入っていると思うので、それを起動し、recommended extenstionsをインストールしてください。
- 上のプログラム実行方法のコマンドを実行してください。そうすれば自動的に環境が構築され、プログラムが走ります。
初めにpasoriを通して学生証か交通系ICがかざされたことを検出します。そこからデータベースに登録されているIDを検出し、そのIDに紐づけられたSTATUS_AもしくはSTATUS_Bを変更することで、実現しています。その際にslackに通知も行います。
初めにブラウザでニックネームを登録してもらいます。入力後学生証か交通系ICをかざしてもらうことで、それらに紐づけられたニックネームを登録、更新します。その際にslackに通知を行います。
関数process
関数IO
この関数はその人がデータベース上で割り当てられているIDと部屋(room aかroom b)が引数になります。
初めにそのIDに関する情報を取得します。そこからその人の部屋の入室状況を確認します、そこでデータベースの入退室状況を反転(IN→OUT、OUT→IN)させます。それからslack通知のための下準備としてニックネームの取得などを行い、入退室の状況に合わせて送るメッセージを変えます。
もしその部屋の入退室状況が0人から1人になったら「HI Bestie」、入退室状況が0人になったら「BYE Bestie」とslackに送ります。
ここで重要なのが、入退室状況を反転させる時、もう一方の部屋のSTATUSがINであれば、それを反転させるためにIO関数を内部で再帰的に発動させます。この時の引数はそのIDともう一方の部屋です。
関数read
ここでは学生証、もしくは交通系ICカードの同時読み取りを実現しています。とは言っても初めに学生証を読み取り、次に交通系ICモードに読み取り方式を変更することで、そう見せかけています。
学生証が読み取れたら次のステップにいきます。もしutila_tb、もしくはutilb_tbのflagが1であれば関数processに移り、0であればその学生証の登録モードに移ります。登録モードについては後述します。
交通系ICについても同様です。
登録モード全体
初めにブラウザで登録したいニックネームと、登録に使用している部屋がどこかを(ボタンを押してもらうことで)取得します。pasoriから読み取られた学生証のデータをデータベースと照合してこれまでに登録されてことがあるか否かを判別します。
もし登録されたことがない学生証であれば、その入力されたニックネームと共にデータベースに登録します。一方でもう登録されたことのある学生証であれば、その学生証に紐付けられたニックネームを入力されたニックネームに変更します。
学生証と同様に初めにブラウザで登録したいニックネームと登録に使用している部屋がどこかを(ボタンを押してもらうことで)取得します。pasoriから読み取られた交通系ICのidmをデータベースと照合してこれまでに登録されてことがあるか否かを判別します。
もし登録されたことがない交通系ICであれば、その入力されたニックネーム(に紐づけられているID)に紐付けてデータベースに登録します。一方でもう登録されたことのある交通系ICであれば、その交通系ICに紐付けられたニックネームを入力されたニックネームに変更します。
| 環境変数名 | 内容 |
|---|---|
| MYSQL_ROOT_PASSWORD | データベースにアクセスするためのパスワード |
| 環境変数名 | 内容 |
|---|---|
| IP_ADDRESS1 | データベースのコンテナIPアドレス |
| IP_ADDRESS2 | データベースのコンテナIPアドレス(予備) |
| IP_ADDRESS3 | HUBのホストPCのIPアドレス。SUBからHUBに接続する為に必要です |
| MYSQL_ROOT_PASSWORD | データベースにアクセスするためのパスワード |
| MAIN1 | ROOM Aのincoming webhook(メイン用) |
| MAIN2 | ROOM Bのincoming webhook(メイン用) |
| TEST1 | ROOM Aのincoming webhook(テスト用) |
| TEST2 | ROOM Bのincoming webhook(テスト用) |
複数方法があります。
パスワードはTatooineです。envディレクトリにデータベースのパスワードを定義しているので、パスワードを変更する場合はそこを変更してください。
docker exec -it io_database /bin/bash
mysql -u root
mysql -u root -h dockerコンテナのIPアドレス -p
このシステムの名前はU.N.I.O.N.です。これは複数カ所の入退室システムを一つにするシステムであり、今よりもこのサークルが融和し、団結してほしいという想いからこの名前にしました。
また、このシステムの正式名称は「i know U eNter It Or Not system (私はあなたが部屋に入ってるか入ってないか知ってるゾ システム)」
このシステムは交通系ICで認証する際にidmを使用していますが、これは調査したところ、ソニーが発行されたNFCカードに一意的に付けているナンバーらしいです。これは偽造可能なので、ドアのロック解除などのセキュリティーの求められるところでは使用しない方が良いのですが、今回は入退室状況をslackに通知するだけなので、セキュリティは大丈夫です。なお、改札などの決済の際にはidmのような静的認証ではなく、動的認証を使っているので安全とのことです。
入退室管理システムを発案、構築して下さった先輩方
入退室管理システムをGUIに対応させてくれた同期
mysqlのテーブルに後からAUTO INCREMENTをDBの最前列に追加するとき