ESPHome JK-BMS 项目使用教程

ESPHome JK-BMS 项目使用教程

esphome-jk-bmsESPHome component to monitor and control a Jikong Battery Management System (JK-BMS) via UART-TTL or BLE项目地址:https://gitcode.com/gh_mirrors/es/esphome-jk-bms

1. 项目的目录结构及介绍

ESPHome JK-BMS 项目的目录结构如下：

esphome-jk-bms/
├── docs/
├── firmware/
├── github/
│   └── workflows/
├── .gitignore
├── .github/
│   └── workflows/
├── LICENSE
├── README.md
├── esphome-jk-bms.yaml
├── secrets.yaml
└── test-esp32.sh

目录介绍

• docs/: 包含项目的文档文件。
• firmware/: 包含固件相关的文件。
• github/: 包含 GitHub 工作流配置文件。
• .gitignore: Git 忽略文件配置。
• .github/: GitHub 相关配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• esphome-jk-bms.yaml: 项目的主要配置文件。
• secrets.yaml: 包含敏感信息的配置文件。
• test-esp32.sh: 用于测试 ESP32 的脚本文件。

2. 项目的启动文件介绍

项目的启动文件主要是 esphome-jk-bms.yaml 和 secrets.yaml。

esphome-jk-bms.yaml

这是项目的主要配置文件，包含了设备的基本配置、传感器配置、网络配置等。以下是一个示例：

esphome:
  name: jk_bms
  platform: ESP32
  board: esp32dev

wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

mqtt:
  broker: !secret mqtt_host
  username: !secret mqtt_username
  password: !secret mqtt_password

sensor:
  - platform: jk_bms
    # 传感器配置

secrets.yaml

这是一个包含敏感信息的配置文件，通常包含 WiFi 密码、MQTT 服务器信息等。以下是一个示例：

wifi_ssid: "your_wifi_ssid"
wifi_password: "your_wifi_password"
mqtt_host: "your_mqtt_host"
mqtt_username: "your_mqtt_username"
mqtt_password: "your_mqtt_password"

3. 项目的配置文件介绍

esphome-jk-bms.yaml 配置文件

该文件包含了以下主要配置部分：

• esphome: 定义了设备的基本信息，如名称、平台和板子类型。
• wifi: 配置 WiFi 连接信息。
• mqtt: 配置 MQTT 服务器信息。
• sensor: 配置传感器信息，如电池电压、温度等。

secrets.yaml 配置文件

该文件包含了敏感信息，如 WiFi 密码、MQTT 服务器信息等。这些信息通常不会直接写在主配置文件中，以保证安全性。

通过以上配置，可以实现对 Jikong Battery Management System (JK-BMS) 的监控和控制。

esphome-jk-bmsESPHome component to monitor and control a Jikong Battery Management System (JK-BMS) via UART-TTL or BLE项目地址:https://gitcode.com/gh_mirrors/es/esphome-jk-bms