README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈
🧠 Keenetic 路由器的 Home Assistant 集成
一个用于 Home Assistant 的集成,通过其 API 提供对 Keenetic 路由器的完整控制和监控。将您的路由器转变为一个具备丰富传感器、开关和服务的智能设备。
✨ Возможности
Интеграция создает множество сущностей для полного управления роутером:
📊 系统监控
- 传感器: CPU 和内存负载、运行时间(uptime)、WAN IP 地址、2.4 GHz 和 5 GHz 芯片温度、Wi-Fi 客户端数量。
- 二进制传感器: 路由器总体状态。
🌐 Управление сетью и интерфейсами
- Трекер устройств: Отслеживание подключенных клиентов.
- Сенсоры интерфейсов: Скорость загрузки/выгрузки, объем переданных данных, время включения.
- Бинарные сенсоры: Статус подключения интерфейса.
- Переключатели: Включение/отключение интерфейсов.
⚙️ 路由器功能管理
- 按钮: 重启路由器。
- 开关: 管理 USB 端口电源、Web 配置器访问、端口转发。
- 选择器: 为客户端选择策略。
- 更新: 检查并安装固件更新。
🖼️ 其他
- 图像: 为您的 Wi-Fi 网络生成二维码。
🔧 服务
keenetic_api.request_api: 直接向路由器 API 发起请求以进行高级管理。keenetic_api.backup_router: 创建配置备份。
Полная таблица объектов:
| 域 | 对象 | 描述 |
|---|---|---|
binary_sensor | Status | 路由器状态 |
button | Reboot | 重启按钮 |
device_tracker | Device tracker client | 已连接设备跟踪器 |
image | QR WiFi | Wi-Fi 网络二维码 |
select | Policy client | 客户端策略选择 |
sensor | CPU load | 处理器负载 |
sensor | Memory load | 内存负载 |
sensor | Uptime | 运行时间 (Uptime) |
sensor | WAN IP adress | WAN IP 地址 |
sensor | Temperature 2.4G Chip | 2.4 GHz 芯片温度 |
sensor | Temperature 5G Chip | 5 GHz 芯片温度 |
sensor | Clients wifi | Wi-Fi 客户端数量 |
switch | Usb power port | USB 端口电源管理 |
switch | Web configurator access | Web 配置器访问管理 |
switch | Interface | 接口管理 |
sensor | Interface start up time | 接口启动时间 |
sensor | Interface downlink speed | 接口下行速度 |
sensor | Interface downloaded | 接口已下载量 |
sensor | Interface uplink speed | 接口上行速度 |
sensor | Interface uploaded | 接口已上传量 |
binary_sensor | Interface connection | 接口连接状态 |
switch | Port Forwarding | 端口转发管理 |
update | Update router | 固件更新 |
📦 Установка
推荐方式:通过 HACS
- Откройте HACS в вашем Home Assistant.
- Перейдите в раздел Интеграции.
- Нажмите на кнопку с тремя точками в правом верхнем углу и выберите Пользовательские репозитории.
- Вставьте URL этого репозитория:
https://github.com/malinovsku/ha-keenetic_api - Выберите категорию Интеграция и нажмите Добавить.
- Теперь в магазине HACS найдете интеграцию Keenetic API и нажмите Загрузить.
- Перезагрузите сервер Home Assistant.
Альтернативный способ: Ручная установка
- 从 Releases 标签页下载最新版本的归档。
- 解压归档内容。
- 将
keenetic_api文件夹复制到您的 Home Assistant 的config/custom_components目录中。 - 重启 Home Assistant 服务器。
⚙️ Настройка
- 重启后,请前往 设置 -> 设备和服务。
- 点击 添加集成 按钮,并找到 Keenetic API。
- 按照配置向导的说明操作:
- 主机/IP: 您的 Keenetic 路由器地址(例如
http://192.168.1.1或https://myrouter.local)。 - 凭据: 路由器的管理员用户名和密码。
- 主机/IP: 您的 Keenetic 路由器地址(例如
- 成功添加后,您可以在集成的额外设置中选择要创建的对象。
🔌 Использование сервисов
Сервис keenetic_api.request_api
用于向 Keenetic 路由器 API 发起直接请求的通用服务。允许使用任何可通过 /webcli/rest 访问的命令。结果将返回到开发者面板,并可用于自动化和模板中。
Параметры сервиса:
| 参数 | 必填 | 描述 | 示例 |
|---|---|---|---|
device_id | 否 | Home Assistant 中路由器设备的 ID。 | router_keenetic_1234 |
entry_id | 否 | Home Assistant 中集成记录的 ID。 | 1234567890abcdef |
method | 是 | HTTP 方法(GET、POST、PUT、DELETE)。 | POST |
endpoint | 是 | API 端点。 | /rci/show/interface/WifiMaster0 |
data_json | 否 | 以 JSON 格式发送的数据。 | {"show": {"system": {}}} |
通过 YAML 调用的示例:
service: keenetic_api.request_api
data:
device_id: router_keenetic_1234
method: POST
endpoint: /rci/
data_json: {"show": {"system": {}}}
🧩 Создание кастомных сенсоров
使用 keenetic_api.request_api 服务,可以基于模板创建自定义实体(Template platforms)。
创建 Wi-Fi 通道负载传感器的示例:
template:
- trigger:
- platform: time_pattern
seconds: "/30"
action:
- service: keenetic_api.request_api
data:
device_id: my_device_id_keenetic
method: POST
endpoint: /rci/
data_json: {"show": {"interface": {"channel-utilization": {"chart": {"name": "WifiMaster0", "detail": 0}}}}}
response_variable: r
sensor:
- name: "Channel Utilization WifiMaster0"
unique_id: "channel_utilization_wifimaster0"
state: >
{{ r.response.show.interface['channel-utilization'].chart.data[-1].v.load }}
unit_of_measurement: "%"
⭐ Поддержка проекта
如果这个项目让您的智能家居更加智能,请在 GitHub 上点亮一颗星 ⭐!这是持续发展的最佳动力。
注意: 使用 request_api 服务需要理解 Keenetic API。错误的请求可能会影响网络运行。