Skip to content

Commit 37e3f96

Browse files
Initialize README with project details and instructions
Added project overview, features, connection details, software setup, usage instructions, and library information.
1 parent ce575fd commit 37e3f96

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Daly BMS UART API
2+
3+
This project turns an ESP32 into a small local network API and web interface for Daly BMS devices.
4+
The ESP32 communicates with the BMS via UART and exposes battery data over HTTP in JSON format.
5+
6+
It is ideal for dashboards, home automation, monitoring tools, or custom battery projects.
7+
8+
## Features
9+
- UART communication with Daly BMS
10+
- REST-style JSON API (/data)
11+
- Built-in web interface served by the ESP32
12+
- Automatic data refresh every 20 seconds
13+
- Runs entirely in the local network
14+
- CORS enabled for easy external access
15+
16+
## Connection
17+
|Daly BMS|ESP32|
18+
|----|----|
19+
|TX|GPIO 16 (RX)|
20+
|RX|GPIO 17 (TX)|
21+
|GND| GND|
22+
23+
## Software Setup
24+
1. Clone the repository
25+
2. Rename `secrets.example.h` to `secrets.h`
26+
3. Fill in your WiFi credentials inside secrets.h
27+
4. Upload to the esp32
28+
29+
## Usage
30+
After uploading your code, watch the serial console (at 9600 baud rate) for the ip address of your esp32.
31+
Open the ip address inside your browser and you will see a simple website with information of your bms.
32+
For the API, you can simple request the `/data` route on your esp32 ip address.
33+
34+
## Used Library
35+
36+
This project uses the daly-bms-uart library:
37+
https://github.com/maland16/daly-bms-uart
38+
All BMS communication is handled through this library.

0 commit comments

Comments
 (0)