关键词

GoveeLED控制智能家居设备控制自动化

使用说明

项目简介

Govee MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它允许大型语言模型（LLM）客户端通过标准化的 MCP 协议控制 Govee 品牌的 LED 照明设备。该服务器通过 Govee 官方 API 与设备通信，并向 MCP 客户端提供控制 Govee 设备的功能。

主要功能点

  • 设备控制: 提供工具使 LLM 客户端能够开关 Govee LED 灯、调整颜色（RGB）和亮度。
  • MCP 协议支持: 实现了 MCP 协议，可以与任何兼容 MCP 协议的客户端进行通信。
  • 易于安装和配置: 可以通过 Smithery 自动安装，也支持手动安装，配置简单，只需设置 Govee API 密钥和设备信息。
  • 提供CLI工具: 除了作为 MCP 服务器运行，还提供了命令行界面 (CLI)，方便用户直接控制 Govee 设备进行测试或独立使用。

安装步骤

方法一：通过 Smithery 自动安装 (推荐 Claude Desktop 用户)

  1. 确保已安装 Smithery CLI。
  2. 运行以下命令进行自动安装： 
    npx -y @smithery/cli install @mathd/govee_mcp_server --client claude
    按照提示完成安装。

方法二：手动安装

  1. 安装 Python 包: 确保你的系统已安装 Python 和 pip。克隆或下载此仓库到本地，然后在仓库根目录下运行： 
    pip install .
    或者，如果需要进行开发或运行测试，安装包含测试依赖的版本： 
    pip install -e ".[test]"
  2. 配置环境变量:
    • 在仓库根目录下创建 '.env' 文件。
    • 在 '.env' 文件中填入你的 Govee API 密钥、设备 ID 和 SKU。这些信息需要从 Govee 开发者平台和 Govee Home App 获取。 
      GOVEE_API_KEY=your_api_key_here
GOVEE_DEVICE_ID=your_device_id_here
GOVEE_SKU=your_device_sku_here

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 Govee MCP 服务器。以下配置信息假设你已按照手动安装步骤安装，并希望通过 'stdio' 传输协议运行服务器。

{
  "serverName": "govee",
  "command": "govee-mcp-server",
  "args": [],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器名称，设置为 "govee"。
  • 'command': 服务器启动命令。 安装 'govee-mcp-server' 包后，'govee-mcp-server' 命令应该已经添加到系统的可执行路径中。
  • 'args': 启动参数。 此服务器默认通过 'stdio' 协议通信，无需额外参数，因此设置为空列表 '[]'。
  • 'transport': 传输协议。 设置为 "stdio"，表示使用标准输入输出流进行通信。

注意: 如果使用 Smithery 安装，Smithery 可能会自动处理服务器的安装和配置，你可能无需手动配置启动命令和参数。请参考 Smithery 客户端的具体文档。

基本使用方法

  1. 启动 MCP 服务器: 如果手动安装，请确保环境变量已配置，然后在命令行中运行 'govee-mcp-server' 命令启动服务器。如果使用 Smithery 安装，服务器可能已经自动启动或可以通过 Smithery 客户端启动。

  2. 在 MCP 客户端中使用工具: 在兼容 MCP 协议的客户端（例如 Claude Desktop 配合 Smithery）中，你可以调用以下工具来控制 Govee 设备：

    • 'turn_on_off': 开关灯��参数 'power' 为 'true' (开) 或 'false' (关)。

      {"tool_call": {"tool_name": "turn_on_off", "parameters": {"power": true}}}

    • 'set_color': 设置灯光颜色。参数 'red', 'green', 'blue' 分别为 RGB 颜色值 (0-255)。

      {"tool_call": {"tool_name": "set_color", "parameters": {"red": 255, "green": 0, "blue": 0}}}

    • 'set_brightness': 设置灯光亮度。参数 'brightness' 为亮度值 (0-100)。

      {"tool_call": {"tool_name": "set_brightness", "parameters": {"brightness": 50}}}

    • 'get_status': 获取设备当前状态（电源状态、颜色、亮度）。无参数。

      {"tool_call": {"tool_name": "get_status", "parameters": {}}}

    客户端会发送符合 MCP 协议的 JSON-RPC 请求给 Govee MCP 服务器，服务器执行相应的操作后返回结果。

  3. 使用 CLI 工具 (可选): 如果你想直接通过命令行控制 Govee 设备，可以使用 'govee-cli' 命令。例如：

    • 开灯: 'govee-cli power on'
    • 设置红色: 'govee-cli color 255 0 0'
    • 设置亮度为 80%: 'govee-cli brightness 80'
    • 查看设备状态: 'govee-cli status'

    请参考 'README.md' 或运行 'govee-cli --help' 查看完整的 CLI 命令和选项。

注意: 使用 Govee MCP 服务器前，请确保你已在 Govee 开发者平台创建了 API 密钥，并在 Govee Home App 中获取了你的设备 ID 和 SKU。并将这些信息正确配置到 '.env' 文件中。

信息

分类

桌面与硬件

访问项目