Esp32mcpserver

🚀 ESP32 MCP サーバ

ESP32マイクロコントローラ向けのモデルコンテキストプロトコル（MCP）の実装です。WebSocketベースのインターフェースを提供し、リソースの発見と監視を行います。

状態：コンパイル不可、初期コミットはそのまま

Claude 3.5 Sonetを使用してコミット日に作成されました（自動フォーマットなどの明確な修正を含む）

✨ 主な機能

• MCPプロトコルの実装（v0.1.0）
• WebSocketベースのリアルタイム更新
• リソースの発見と監視
• ウェブインターフェースによるWiFi設定
• リクエスト処理のスレッドセーフ
• 包括的なテストセット
• 非同期Webサーバの統合
• 設定保存用のLittleFSサポート

📦 インストール

前提条件

ハードウェア

• ESP32 S3開発ボード（DevKitC-1）
• プログラミング用のUSBケーブル

ソフトウェア

• PlatformIO Core（CLI）またはPlatformIO IDE
• Python 3.7以上
• Git

インストール手順

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

   git clone [リポジトリのリンク]
   cd ESP32-MCP-Server
   

2. 依存関係をインストールします：

   「pio pkg install」を実行
   

3. （オプション）プロジェクトを設定します：
   • プラットフォーム設定ファイル（platformio.ini）を編集します。
   • 必要に応じて設定オプションを変更します。

🔧 技術詳細

アーキテクチャ

flowchart TD
    Start[開始アプリケーション] --> Setup[セットアップ]
    Setup -->|ファイルシステムの初期化| InitFS[LittleFSの初期化]
    Setup -->|ネットワークの起動| StartNetwork[ネットワークマネージャの初期化]
    Setup -->|タスクの作成| CreateTasks[タスクの作成と割り当て]

    subgraph ネットワーク
        StartNetwork --> APCheck[APまたは接続モードのチェック]
        APCheck -->|クレデンシャルが存在する| Connect[WiFiに接続]
        APCheck -->|クレデンシャルがない| StartAP[アクセスポイントを起動]
        Connect --> NetworkReady[ネットワークが準備完了]
        StartAP --> NetworkReady
    end

    subgraph MCP_Server
        MCP[MCPサーバの起動] --> HandleClient[クライアント接続の処理]
        HandleClient --> HandleRequest[リクエストの処理]
        HandleRequest -->|WebSocketイベント| WebSocket[WebSocketの処理]
        HandleRequest -->|HTTPエンドポイント| HTTP[HTTPリクエストの処理]
    end

    subgraph Metrics
        self[メトリクスシステムの起動] --> InitMetrics[システムメトリクスの初期化]
        InitMetrics --> CollectMetrics[定期的なメトリクス収集]
        CollectMetrics --> SaveMetrics[メトリクスをファイルシステムに保存]
    end

    subgraph Logger
        self[uLoggerの起動] --> LogMetrics[メトリクスデータの記録]
        LogMetrics --> CompactLogs[必要に応じてログを結合]
        CompactLogs -->|レポートの生成| Report[レポートの生成]
    end

    CreateTasks --> InitMetrics
    CreateTasks --> StartNetwork

💻 使用例

ネットワーク設定

1. ウェブインターフェースを開き、以下のURLにアクセスします：

   http://[ESP32のIPアドレス]:8096
   

2. 「ネットワーク設定」セクションに以下の情報を入力します：
   • SSID：接続するWiFiネットワークの名前
   • パスワード：接続するWiFiネットワークのパスワード
3. 「保存して再起動」をクリックして設定を適用します。

MCP接続

1. ターミナルを開き、ESP32のシリアルポートに接続します：

   シリアルツール -> 正しいポートとボーレート（通常は115200）を選択
   

2. ESP32が起動した後、WebSocketクライアントまたはツール（例：wscat）を使用してESP32に接続します：

   wscat -H [ESP32のIPアドレス]:8096
   

3. 以下のコマンドを送信してMCPの状態を確認します：

   {"id": 1, "method": "get_status"}
   

テスト

基本テスト

以下のコマンドを実行してテストセットを起動します：

pio test -e native

カバレッジレポート

カバレッジレポートを生成します：

pio test -e native -- --coverage

レポートは .pio/coverageresults フォルダに保存されます。

貢献ガイド

1. このリポジトリをあなたのアカウントにForkします。
2. 新しいブランチを作成して機能追加または修正を行います：

   git checkout -b feature/[機能名] または bugfix/[問題番号]
   

3. 変更をコミットし、詳細なコミットメッセージを追加します：

   git add .
   git commit -m "変更内容の説明"
   

4. あなたのリポジトリにプッシュします：

   git push origin feature/[機能名]
   

5. メインブランチへのプルリクエストを作成します。

📄 ライセンス

このプロジェクトはMIT Licenseの下でライセンスされています。詳細は LICENSE ファイルを参照してください。