返回 MCP 目录
public公开dns本地运行

nodemcu-mcp

NodeMCU MCP是一个基于Model Context Protocol的服务,用于管理ESP8266/NodeMCU物联网设备,提供远程监控、配置更新和命令执行功能,并支持与Claude等AI工具集成。

article

README

🚀 NodeMCU 控制台

NodeMCU 控制台是一个基于 ESP8266 的物联网设备管理平台,用户可借助 Web 界面和 REST API 远程控制与监控多个 NodeMCU 设备。该平台具备设备发现、固件更新、命令执行以及 telemetry 数据采集等功能,为物联网设备管理提供了便捷高效的解决方案。

🚀 快速开始

安装与配置

服务器端

  1. 克隆仓库
git clone https://github.com/yourusername/nodemcu-console.git
cd nodemcu-console
  1. 安装依赖 使用 npm 安装项目依赖:
npm install
  1. 配置环境变量 根据 .env.example 文件创建 config.js,并填写你的 WiFi 信息和服务器设置。
  2. 启动服务
node index.js

客户端

  1. 准备硬件
    • 确保 NodeMCU 设备已安装 ESP8266 固件。
    • 在 Arduino IDE 中添加必要的库:ESP8266WiFi、WebSocketsClient 和 ArduinoJson。
  2. 配置固件 修改示例代码中的 WiFi 信息和服务器地址:
const char* ssid = "YOUR_WIFI_SSID";
const char* password = "YOUR_WIFI_PASSWORD";

const char* mcpHost = "your-server-ip";
const int mcpPort = 3000;
  1. 上传固件 将修改后的代码上传到 NodeMCU 设备。

✨ 主要特性

  • 设备发现:自动检测连接到同一 WiFi 网络的 NodeMCU 设备。
  • 固件更新:远程推送新版本固件以保持设备最新。
  • 命令执行:通过 WebSocket 或 HTTP 请求发送指令(如重启、重置)到设备。
  • ** telemetry 数据采集**:收集和显示设备的实时数据,包括传感器读数和系统状态。

💻 使用示例

基础用法

设备管理

  • 列表设备 获取所有连接的设备信息:
GET /api/devices

响应示例:

{
    "count": 1,
    "devices": [
        {
            "id": "nodemcu-001",
            "name": "Living Room Sensor",
            "type": "ESP8266",
            "status": "online",
            "ip": "192.168.1.100",
            "firmware": "1.0.0",
            "lastSeen": "2023-05-15T14:30:45.123Z"
        }
    ]
}
  • 设备详情 获取单个设备的详细信息:
GET /api/devices/:id

响应示例:

{
    "id": "nodemcu-001",
    "name": "Living Room Sensor",
    // 原文档此处未完整展示,保持原样
}
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端