ITADN
malinovsku/ha-keenetic_api
malinovsku/ha-keenetic_api · 文件 下载 ZIP
文件最后提交记录最后更新时间
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_sensorStatus路由器状态
buttonReboot重启按钮
device_trackerDevice tracker client已连接设备跟踪器
imageQR WiFiWi-Fi 网络二维码
selectPolicy client客户端策略选择
sensorCPU load处理器负载
sensorMemory load内存负载
sensorUptime运行时间 (Uptime)
sensorWAN IP adressWAN IP 地址
sensorTemperature 2.4G Chip2.4 GHz 芯片温度
sensorTemperature 5G Chip5 GHz 芯片温度
sensorClients wifiWi-Fi 客户端数量
switchUsb power portUSB 端口电源管理
switchWeb configurator accessWeb 配置器访问管理
switchInterface接口管理
sensorInterface start up time接口启动时间
sensorInterface downlink speed接口下行速度
sensorInterface downloaded接口已下载量
sensorInterface uplink speed接口上行速度
sensorInterface uploaded接口已上传量
binary_sensorInterface connection接口连接状态
switchPort Forwarding端口转发管理
updateUpdate router固件更新

📦 Установка

推荐方式:通过 HACS

  1. Откройте HACS в вашем Home Assistant.
  2. Перейдите в раздел Интеграции.
  3. Нажмите на кнопку с тремя точками в правом верхнем углу и выберите Пользовательские репозитории.
  4. Вставьте URL этого репозитория: https://github.com/malinovsku/ha-keenetic_api
  5. Выберите категорию Интеграция и нажмите Добавить.
  6. Теперь в магазине HACS найдете интеграцию Keenetic API и нажмите Загрузить.
  7. Перезагрузите сервер Home Assistant.

Альтернативный способ: Ручная установка

  1. Releases 标签页下载最新版本的归档。
  2. 解压归档内容。
  3. keenetic_api 文件夹复制到您的 Home Assistant 的 config/custom_components 目录中。
  4. 重启 Home Assistant 服务器。

⚙️ Настройка

  1. 重启后,请前往 设置 -> 设备和服务
  2. 点击 添加集成 按钮,并找到 Keenetic API
  3. 按照配置向导的说明操作:
    • 主机/IP: 您的 Keenetic 路由器地址(例如 http://192.168.1.1https://myrouter.local)。
    • 凭据: 路由器的管理员用户名和密码。
  4. 成功添加后,您可以在集成的额外设置中选择要创建的对象。

Дополнительные настройки интеграции

🔌 Использование сервисов

Сервис keenetic_api.request_api

用于向 Keenetic 路由器 API 发起直接请求的通用服务。允许使用任何可通过 /webcli/rest 访问的命令。结果将返回到开发者面板,并可用于自动化和模板中。

Параметры сервиса:

参数必填描述示例
device_idHome Assistant 中路由器设备的 ID。router_keenetic_1234
entry_idHome Assistant 中集成记录的 ID。1234567890abcdef
methodHTTP 方法(GETPOSTPUTDELETE)。POST
endpointAPI 端点。/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。错误的请求可能会影响网络运行。