定期的にAPIリクエストを行い、ボトルステータスがfalseであることを検知した場合にDiscordの指定されたチャンネルにボトル状況を投稿するDiscord Botです。42_doneのリアクションを検知するとボトル交換者と交換までの時間を投稿し、対応したユーザー情報をデータベースへ格納します。全てが終了後、再び次のボトルステータスを問い合わせます。
このプロジェクトを使用するには、Node.jsがシステムにインストールされている必要があります。また、pnpmまたはnpmを使用して依存関係を管理します。
-
このリポジトリをクローンします。
git clone https://github.com/tmyuu/clara-bot.git cd clara-bot -
srcディレクトリ内で依存関係をインストールします。cd src pnpm install # または npm install
-
.env.sampleファイルをコピーして.envファイルを作成し、適切なトークンを記入します。cp .env.sample .env
-
ボットを実行します。
node bot.js
テストと仕様の確認
$ pwd
<local_repository_root>/api
$ touch ../db/clara.sqlite3
$ sqlite3 ../db/clara.sqlite3 < ../db/clara.sql
$ sqlite3 ../db/clara.sqlite3
SQLite version 3.45.1
Enter ".help" for usage hints.
sqlite> INSERT INTO clara(bottle_status, user_name, exchange_status) values('false', 'matsui', 'true');
sqlite> SELECT * FROM clara;
1|false|matsui|true
sqlite> INSERT INTO clara(bottle_status, user_name, exchange_status) values('true', NULL, 'false');
sqlite> SELECT * FROM clara;
1|false|matsui|true
2|true||false
sqlite> .quit
$ go run main.go
____ __
/ __/___/ / ___
/ _// __/ _ \/ _ \
/___/\__/_//_/\___/ v4.7.2
High performance, minimalist Go web framework
https://echo.labstack.com
____________________________________O/_______
O\
⇨ http server started on [::]:9000
$ curl -X POST \
--url "http://127.0.0.1:9000/empty"
{"message":"Bottle status updated to empty successfully"}
$ sqlite3 ../db/clara.sqlite3
SQLite version 3.45.1
Enter ".help" for usage hints.
sqlite> SELECT * FROM clara;
1|false|matsui|true
2|false||false
sqlite> .exit
$ curl -X GET 'http://localhost:9000/bottle/2'
{"BottleID":2,"BottleStatus":"false"}
$ curl -X POST \
--url "http://127.0.0.1:9000/adduser" \
-F "user_name=kamitsui"
{"message":"User name updated successfully"}
$ sqlite3 ../db/clara.sqlite3
SQLite version 3.45.1 2024-01-30 16:01:20
Enter ".help" for usage hints.
sqlite> SELECT * FROM clara;
1|false|matsui|true
2|false|kamitsui|true
3|true||false
sqlite> .exit
- 定期的にGETリクエストを行い、ボトルステータスの変更を検知します。
- ボトルステータスが
falseになった場合、Discordの任意のチャンネルに投稿します。 42_doneのリアクションを検知するとボトル交換者と交換までの時間を投稿し、対応したユーザー情報をPOSTリクエストします。
- 水タンクが**"空"**の状態を検知する。
- Botがイベント発生時（水タンクの状態が**"飲料可"から"空"**に変わったとき）に特定のDiscordサーバーのチャンネルでメッセージ送信することと、そのチャンネル内でメッセージ検知と書く情報の更新すること。
- Webブラウザからタンクの状態（"飲料可" or "空"）や現在のタンク在庫数（最大50本）やタンク交換したユーザーの情報を確認できる。
- **"/charged user_name"のメッセージを検知して、タンクの状態を"飲料可"**にすること。
- **"/restock n"のメッセージを検知して、"校舎在庫"**の値をその値に更新すること。
- "/reset"のメッセージを検知して、"制限数/月"を50に更新すること。
| No. | 内容 | 機器 | 担当 |
|---|---|---|---|
| 1. | 水槽水位検知センサー | 電子回路 | kamitsui |
| 2. | WiFi 機能を備えたマイクロコントローラー | マイコン | kamitsui |
| 3. | サーバー バックエンド | Jetson *1 | ymatui, kamitsui, ryozuno |
| 4. | データベース | Jetson *1 | ? |
| 5. | Discord ボット | Jetson *1 | ymatsui |
| 6. | Web インターフェイス | Jetson *1 | ryozno |
*1 実験時はJetsonで、運用時は42Tokyoサーバーを使えたら嬉しい。
---
title: Develop system diagram (A)
---
%% graph %%
graph LR
%% subgraph %%
subgraph "Water Server"
sensor(Sensor)
microcontroller[MCU]
end
subgraph "Jetson"
subgraph "Main"
subgraph "Container_01"
serverBackend[Backend]
end
subgraph "Container_02"
discordBot[Bot]
end
subgraph "Container_03"
database[DB]
end
end
subgraph "Container_04"
webInterface[Web_Server]
end
end
subgraph "Discord_Server"
discordInterface[Aqua_Clara_CH]
end
%% %% Node to Node
%% sensor -> micon
sensor -->
|ON/OFF
*1| microcontroller
%% mcu -> Backend
microcontroller -->
|HTTP *2| serverBackend
%% Back -> DiscordBot
serverBackend -->
|*3| discordBot
discordBot -->
|*4| serverBackend
%% DiscordBot <-> Discord Server
discordBot -->
|*5| discordInterface
discordInterface -->
|*6| discordBot
%% Backend -> DataBase
serverBackend -->
|*7| database
database -->
|*8| serverBackend
%% Web Server <-> Backend
webInterface -->
|*9| serverBackend
serverBackend -->
|*10| webInterface
%% %% -----------
プロジェクトへの貢献に興味がある方は、プルリクエストを送るか、xから連絡してください。