Skip to content

TORICA-Org/SerialWeb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SerialWeb

キャプティブポータルをデバッグモニターとして用いるためのライブラリです.
➔ デモページはこちら
➔ Arduino Library Manager Registryへの登録状況はこちら

ライブラリの導入

Arduino IDEのライブラリマネージャからSerialWebがインストール可能です.

  1. 上部のDownload ZIPでZIPファイルをダウンロードしてください.
  2. ArduinoIDEの Sketch -> Include Library -> Add .ZIP Library... で導入できます.もしくは,ArduinoIDEのライブラリが保存されたディレクトリ(Windowsでは通常C:\Users\{UserName}\Documents\Arduino\libraries\です.)に直接展開してください.

必要なライブラリ

以下のライブラリをライブラリマネージャからインストールしてください.

Arduino IDE 2.x.xのライブラリマネージャでSerialWebをインストールすると,自動的に依存ライブラリもインストールされます.

Note

名前の似たライブラリがたくさん存在します.作者の名前なども使って照合してください.

非同期通信機能(WebSocketなど)を提供するライブラリ

  • name: ESP Async WebServer
  • author: ESP32Async

TCP通信管理機能を提供するライブラリ

  • ESP32シリーズのマイコンの場合
    • name: Async TCP
    • author: ESP32Async
  • Raspberry Pi Pico WなどのRP系マイコンの場合
    • name: RPAsyncTCP
    • author: Hristo Gochkov,Khoi Hoang,Ayush Sharma

Note

Raspberry Pi Pico WなどのRP系マイコンの場合,非同期DNSサーバー機能のために以下のライブラリが必要です.

  • name: AsyncUDP_RP2040W
  • author: Hristo Gochkov,Khoi Hoang

インスタンス

インスタンス化は不要です.グローバルインスタンスを提供しています.

関数

  • SerialWeb.begin(ssid, password)/SerialWeb.begin(ipAddress)
    • 前者ではアクセスポイントモード,後者ではクライアントモードでWiFiが開始されます.
constexpr char SSID[] = "SerialWeb";
constexpr char PASSWORD[] = "12345678";
void setup() {
  SerialWeb.begin(SSID, PASSWORD);
}
void setup() {
  // WiFiアクセスポイントへの接続後
  IPAddress localIP = WiFi.localIP();
  SerialWeb.begin(localIP);
}
  • SerialWeb.send(label, value)
    • Webページのダッシュボードにデータを表示します.labelがすでに存在する場合,そのvalueを更新します.
char label[] = "NOW_TIME";
char value[32];
sprintf(value, "%ld", millis());
SerialWeb.send(label, value);
  • SerialWeb.print()など
    • Webページのログに表示します.
    • Print.hを継承しています.print()println()printf()が使用可能です.
SerialWeb.print("Hello, ");
SerialWeb.println("world."); // -> `Hello, world.`

SerialWeb.printf("Time: %ld", millis());
  • SerialWeb.readStringなど
    • 実装が不完全です.使用することはおすすめしません.

About

キャプティブポータルをデバッグモニターとして用いるためのライブラリです.

Resources

License

Stars

Watchers

Forks