Discord Bot FHDW BG Weather TheThingsStack TheThingsNetwork

Discord-bot-fhdw-bg-weather-thethingsstack-thethingsnetwork

このDiscord Botは、FHDW Weatherstationからの気象データを提供します。ボットは、チャンネルを購読および登録解除して、天気の更新を受け取り、現在サブスクライブされているチャネルをリストし、すべてのチャネルを一度に登録解除できます。

リポジトリの目的

このリポジトリの目的は、MQTTプロトコルを使用してThings Stackのエンドデバイスからデータを不和ボットに統合する方法の包括的な例を提供することです。そうすることで、Lorawanテクノロジーと人気のある通信プラットフォームであるDiscordを使用して、IoTデバイス間のギャップを埋めます。これにより、ユーザーとコミュニティは、天気データなどのIoTデバイスから不一致チャネルで直接リアルタイムの更新を受信することができます。

このデモンストレーションを通じて、リポジトリは、開発者と愛好家にIoTデータをDiscordと統合する可能性を探求できるようにしようとしています。このプロジェクトは、革新的な方法でロラワンデータを活用する、より洗練されたアプリケーションを作成するための基盤として機能します。最終的に、このリポジトリは、IoTデータを利用して不一致のボットの機能を強化するための新しい創造的な方法を見つけるためにコミュニティに鼓舞することを目的としています。

MQTTを使用した統合

Things StackからDiscordボットへのデータの統合は、IoTデバイス向けに設計された軽量で効率的なメッセージングプロトコルであるMQTTプロトコルを使用して達成されました。 MQTTは、エンドデバイスとDiscordボット間の安全で信頼できるデータ転送を可能にします。 Sthing Stackの適切なトピックを購読することにより、DiscordボットはIoTデバイスによって送信されたデータを受信できます。

必要なコードは、 mqttHandler.jsで補完されます。統合は、これらの手順に従うことによって達成されました。

1. index.jsでmqttHandler.jsファイルからcreateMqttClient関数をインポートします。
2. MQTTアドレス、アプリケーションユーザー、デバイスID、およびconfig.jsonファイルにパスワードなどの必要な資格情報を提供して、MQTT設定を構成します。
3. index.jsファイルでcreateMqttClient()関数を呼び出し、受信したメッセージを処理するために必要な資格情報とコールバック関数を提供して、MQTTクライアントを作成します。
   • createMqttClient()関数は、物事に接続して指定されたトピックにサブスクライブすることにより、MQTTクライアントをセットアップします。
   • 「Connect」、「Subscribe」、「エラー」、「メッセージ」などのさまざまなMQTTイベントのイベントリスナーを設定します。
   • 「Connect」イベントは、MQTTクライアントがThings Stackに接続されているときにトリガーされます。
   • 「購読」イベントは、MQTTクライアントが指定されたトピックに正常にサブスクライブするとトリガーされます。
   • 「エラー」イベントは、MQTTクライアントでエラーが発生したときにトリガーされます。
   • 「メッセージ」イベントは、指定されたトピックからメッセージが受信されたときにトリガーされ、提供されたコールバック関数を呼び出します。
4. index.jsファイルで定義されているコールバック関数：
   • ペイロードをデコードし、受信したメッセージから関連するデータを解析します。
   • createWeatherEmbed()関数を呼び出すことにより、解析されたデータを使用して不一致埋め込みを作成します。
   • dataStorageモジュールに保存されているチャネルIDを介して反復することにより、指定されたチャネルに埋め込まれた不一致を送信します。
   • 埋め込みをチャネルに送信したときにエラーが発生した場合は、 dataStorageモジュールからチャネルIDを削除します。

プロセスを理解することにより、開発者はIoTデバイスを含む将来のプロジェクトのこの知識に基づいて構築できます。統合は、IoTデバイスをさまざまなプラットフォームに接続し、データの変換と処理、カスタムアラートまたは通知の作成など、さまざまなアプリケーションのテンプレートとして機能します。この例では、MQTTをIoTデバイスと他のアプリケーションとの間のギャップを埋めるための強力なツールとして使用して、モノのインターネット向けのより革新的で統合されたソリューションを促進する方法を示しています。

前提条件

• node.js V14以降
• npm（通常はnode.jsにバンドル）
• サーバーへの管理アクセスを備えたアクティブなDiscordアカウント
• Discord開発者ポータルからのボットと対応するボットトークン
• Things Network/Stack Application IDおよびAPIキー

不一致のボットを作成してセットアップします

1. Discord Developer Portalにアクセスして、Discordアカウントにサインインします。

2. [新しいアプリケーション]ボタンをクリックし、アプリケーションに名前を付けて、[作成]をクリックします。

3. アプリケーションの設定で、[ボット]タブをクリックし、[ボットの追加]ボタンをクリックして、アプリケーション用のボットを作成します。 「はい、やる！」をクリックして確認してください。

4. [ボット]タブでは、「メッセージコンテンツの意図」がtrueに設定されていることを確認してください。

5. 「トークン」セクションの下で、[コピー]をクリックしてボットトークンをコピーします。ボットを不和で認証するために使用されるため、このトークンを安全に保ちます。

6. （オプション）必要に応じて、ボットの名前、プロフィール写真、その他の設定をカスタマイズします。開ける

インストール

1. リポジトリをクローンします：

git clone https://github.com/yourusername/FHDW-Weatherstation-Discord-Bot.git

2. 必要な依存関係をインストールします。

... T heThingsNetwork-DiscordBot-FHDW-WeatherData B ot > npm install

 You might have to navigate to the Bot directory before running `npm install`.
To navigate use `cd folder_name`

3. ボットディレクトリにconfig.jsonファイルを作成し、Discord Botトークン、クライアントID、ギルドID、およびその他の必要な詳細を追加します（ギルドIDはオプションであり、サーバー固有のコマンドにのみ必要です）：

{
  "token" : " your_discord_bot_token " ,
  "clientId" : " your_discord_bot_client_id " ,
  "guildId" : " your_discord_server_guild_id " ,
  
  "ttnAppUser" : " your_ttn_app_user " ,
  "ttnAppPw" : " your_ttn_app_pw " ,
  "ttnAdress" : " your_ttn_address " ,
  "ttnAppDevice" : " your_ttn_app_device "
}

例：

{
  "token" : " AAA0000aaa000AAAA000AA.AAA00AAA.aaa-AaaaaAA0000AAAAAAAAAAaaaAAAA00AAAAAA " ,
  "clientId" : " 1234567891234567891 " ,
  "guildId" : " 1234567891234567891 " ,
  
  "ttnAppUser" : " hello-world-weather " ,
  "ttnAppPw" : " NXYXX.0A0AAAAAAAA0AAAAAAA4AAA00AAAMAAAAAAAAA.AA0AAAAA0AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA " ,
  "ttnAdress" : " mqtts://eu1.cloud.thethings.network:8883 " ,
  "ttnAppDevice" : " eui-00a0000aa000a000 "
}

使用法

1. 適切なURLを使用してボットをDiscordサーバーに招待します（Your_Discord_Bot_Client_IDを実際のクライアントIDに置き換えます）：

https://discord.com/api/oauth2/authorize?client_id=your_discord_bot_client_id&permissions=8&scope=bot

例fhdw-weather-bot：https：//discord.com/api/oauth2/authorize?client_id=10885555644333867069&permissions = 8&scope=bot

2. SlashコマンドをDiscordサーバーに展開します。

... T heThingsNetwork-DiscordBot-FHDW-WeatherData B ot > node deploy-commands.js

 (You might have to restart your Discord-Client afterwards)

3. ボットを実行します：

3.1。ボットを起動するには、実行してください。

... T heThingsNetwork-DiscordBot-FHDW-WeatherData B ot > npm start

3.2。 Nodemonで開発モードでボットを実行するには、実行してください。

... T heThingsNetwork-DiscordBot-FHDW-WeatherData B ot > npm run dev

コマンド

• /subscribe [channel] ：fhdw-weatherstationにチャネルを購読します。チャネルが提供されていない場合、現在のチャネルがサブスクライブされます。
• /unsubscribe [channel] ：fhdw-weatherstationからチャネルを登録解除します。チャネルが提供されていない場合、現在のチャネルは登録されていません。
• /list ：FHDW-WeatherStationに現在登録されているすべてのチャネルをリストします。
• /unsubscribe_all ：fhdw-weatherstationからすべてのチャネルを登録する。

ホスティングプラットフォームへの展開

ホスティングプラットフォームにボットを展開するには、node.jsアプリケーションのプラットフォーム固有の指示に従ってください。 deploymentパッケージに資格情報を含むconfig.jsonファイルを必ず含めてください。

config.jsonファイルが展開に含まれており、ボットトークンやその他の機密情報が安全に保たれていることを確認してください。ホスティングプラットフォームが環境変数をサポートしている場合は、Config.jsonファイルに含めるのではなく、環境変数として資格情報を保存することをお勧めします。

たとえば、これらの手順に従うことで、ボットをHerokuに展開できます。

1. Herokuで新しいアプリを作成し、GitHubリポジトリを接続します。
2. GitHubリポジトリから自動展開または手動展開を有効にします。
3. Discordボットトークン、クライアントID、ギルドID、およびその他の必要な詳細のHerokuアプリ設定で環境変数を設定します。
4. ボットをHerokuに展開します。 package.jsonファイルには、ボットを起動するために必要なスクリプトが既に含まれています。

HerokuにDiscord Botを展開するためのより詳細な指示については、このガイドをご覧ください。

ライセンス

このプロジェクトは、MITライセンスの下でライセンスされています。