🚀 家庭助理帮助器
家庭助理帮助器是一款用于与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部分。