Advanced Homeassistant MCP

🚀 家庭助理幫助器

家庭助理幫助器是一款用於與Home Assistant集成的工具，藉助它你能夠通過命令行或腳本輕鬆控制智能家居設備，為智能家居的管理帶來便利。

🚀 快速開始

若你想快速使用家庭助理幫助器，可按以下步驟操作：

1. 安裝依賴項

npm install home-assistant-ui-js@latest home-assistant-config-js@latest --save-dev

2. 配置環境變量

創建或編輯 .env 文件，並添加以下內容：

HASS_HOST=http://localhost:8123
HASS_TOKEN=your_api_token_here

3. 啟動服務

npm run start

📚 詳細文檔

配置文件

編輯 config.json 文件以添加或修改服務：

{
  "presets": {
    "default": {
      "brightness_pct": 75,
      "color_temp_k": 4000,
      "fan_speed": "high",
      "hvac_mode": "heat",
      "hvac_temp": 72,
      "light_color": "white"
    }
  },
  "devices": {
    "your_device_name": {
      "device_type": "light",
      "unique_id": "1234567890"
    }
  }
}

命令行選項

運行以下命令以管理服務：

# 啟動服務
node index.js start

# 停止服務
node index.js stop

# 重新加載配置
node index.js reload

📦 安裝指南

開發環境依賴安裝

npm install home-assistant-ui-js@latest home-assistant-config-js@latest --save-dev

全局安裝家庭助理幫助器

npm install -g homeassistant-cli

💻 使用示例

基礎用法

列出所有可用設備

homeassistant-cli devices list

控制燈光亮度

homeassistant-cli light brightness 75

高級用法

啟動開發服務器

npm run dev

打包應用

npm run build

📄 API 文檔

概述

家庭助理幫助器提供了一系列用於控制智能家居設備的API。這些API允許你通過HTTP請求與Home Assistant進行交互。

安裝依賴項

要在項目中使用家庭助理幫助器，請安裝以下依賴：

npm install home-assistant-ui-js@latest home-assistant-config-js@latest --save-dev

創建配置文件

創建一個 config.json 文件以配置你的智能家居設備：

{
  "presets": {
    "default": {
      "brightness_pct": 75,
      "color_temp_k": 4000,
      "fan_speed": "high",
      "hvac_mode": "heat",
      "hvac_temp": 72,
      "light_color": "white"
    }
  },
  "devices": {
    "your_device_name": {
      "device_type": "light",
      "unique_id": "1234567890"
    }
  }
}

示例請求

控制燈光亮度

curl -X POST http://localhost:8080/api/light/brightness \
     -H 'Content-Type: application/json' \
     -d '{"brightness_pct": 100}'

獲取當前溫度

curl -X GET http://localhost:8080/api/hvac/temperature

🔧 技術細節

家庭助理幫助器的配置

以下是如何在家庭助理幫助器中配置不同智能家居設備的示例。

燈光設備

要在 config.json 中配置一個燈光設備：

{
  "lights": {
    "your_light_name": {
      "state": "on",
      "brightness_pct": 75,
      "color_temp_k": 4000
    }
  }
}

HVAC 設備

要在 config.json 中配置一個HVAC設備：

{
  "hvac": {
    "your_hvac_name": {
      "state": "heat",
      "temperature": 72,
      "fan_speed": "high"
    }
  }
}

風扇設備

要在 config.json 中配置一個風扇設備：

{
  "fans": {
    "your_fan_name": {
      "state": "on",
      "speed": "medium"
    }
  }
}

家庭助理幫助器的開發

克隆倉庫

要開始開發家庭助理幫助器，請克隆GitHub倉庫：

git clone https://github.com/yourusername/homeassistant-cli.git

運行測試

運行以下命令以啟動測試服務器：

npm run test

打包應用

要打包應用以便分發，運行以下命令：

npm run build

家庭助理幫助器的擴展

家庭助理幫助器可以通過插件和自定義腳本進行擴展。要創建一個新插件，請在 plugins 目錄中添加你的JavaScript文件。

創建新插件

要在 plugins 目錄中創建一個新插件：

module.exports = {
  name: 'Your Plugin Name',
  description: 'What your plugin does',
  command: function(args, done) {
    // 在這裡實現你的插件邏輯
    done();
  }
};

使用插件

要在家庭助理幫助器中使用插件，將它放在 plugins 目錄中，並運行以下命令：

homeassistant-cli plugin your_plugin_name run

🔧 故障排除

常見問題

• 無法連接到Home Assistant：請檢查你的 config.json 文件中的 host 和 token 是否正確。
• 權限問題：確保你使用的API令牌具有足夠的權限來執行所需操作。
• 找不到設備：請檢查家庭助理幫助器日誌以獲取更多信息。

日誌

要查看家庭助理幫助器的日誌，請運行以下命令：

homeassistant-cli --verbose

提交問題

如果你遇到問題或有改進建議，請提交到GitHub倉庫的Issues部分。