Skip to content

Commit cefef1e

Browse files
authored
Update README.md (#175)
1 parent 06e43e5 commit cefef1e

File tree

1 file changed

+54
-47
lines changed

1 file changed

+54
-47
lines changed

README.md

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# <img src="https://brands.home-assistant.io/sigen/dark_icon.png" alt="Sigenergy" width="50" style="vertical-align:Left;" /> Sigenergy ESS Integration for Home Assistant
22

3-
[![Stable][releases-shield]][releases] [![HACS Badge][hacs-badge]][hacs-link] ![Project Maintenance][maintenance-shield] [![GitHub Activity][commits-shield]][commits] [![License][license-shield]](LICENSE.md)
3+
[![Stable][releases-shield]][releases] [![HACS Badge][hacs-badge]][hacs-link] ![Project Maintenance][maintenance-shield] [![GitHub Activity][commits-shield]][commits] [![License][license-shield]](LICENSE)
44

55
<!-- ![Downloads][downloads] -->
66

@@ -15,36 +15,39 @@
1515
[hacs-link]: https://hacs.xyz/
1616

1717
## Overview
18-
Monitor and control your Sigenergy Energy Storage System (ESS) from Home Assistant.
18+
Monitor and control your Sigenergy Energy Storage System (ESS) from Home Assistant.
1919

2020
## Features
2121
- **UI‑Driven Setup** with DHCP discovery of inverters and chargers
22-
- **Dynamic Device Management** (Plants, Inverters, AC/DC Chargers)
23-
- **Real‑Time Metrics** for power flows, energy statistics, SoC/SoH
24-
- **Control Capabilities** for EMS work modes and more
22+
- **Dynamic Device Management** (Plants, Inverters, AC/DC Chargers)
23+
- **Real‑Time Metrics** for power flows, energy statistics, SoC/SoH
24+
- **Control Capabilities** for EMS (energy management system) work modes and more
2525
- **Configurable update interval** in three update frequencies for faster updates
2626

2727
## Enhance with Add-ons
2828
Take your setup further with community add-ons and tools:
29-
- Si-GCG "sigenergy_projects": https://github.com/Si-GCG/sigenergy_projects
29+
- [Si-GCG "sigenergy_projects"](https://github.com/Si-GCG/sigenergy_projects)
3030

31-
More add-ons and enhancements are comingstay tuned.
31+
More add-ons and enhancements are coming; stay tuned!
3232

3333
## Requirements
34-
- Sigenergy ESS firmware SPC109 or newer is required starting with integration v1.1.0. If your device runs older firmware and does not auto-update, upgrade the firmware or use a previous integration release until updated.
35-
- [Home Assistant](https://www.home-assistant.io/) at least version 2025.2
36-
- [Sigenergy ESS](https://www.sigenergy.com/) with Modbus‑TCP enabled by your installer. And prefferably confirmed with a screenshot of your DeviceID. If using AC Charger, that will have the id `1` and the inverter has to be set to a higher ID, for example `2`.
37-
- Prefferably assign a **static IP** to your Sigenergy device in your router to ensure it always receives the same IP address.
34+
- Sigenergy ESS firmware `SPC109` or newer is required starting with version `v1.1.0` of the integration. If your device runs older firmware and does not auto-update, upgrade the firmware or use a previous integration release until you have updated the firmware.
35+
- [Home Assistant](https://www.home-assistant.io/) at least version `2025.2`.
36+
- [Sigenergy ESS](https://www.sigenergy.com/) with Modbus‑TCP enabled by your installer. And preferably confirmed with a screenshot of your `DeviceID`. If using an AC Charger, that will have the id `1` and the inverter has to be set to a higher ID, for example `2`.
37+
- Preferably assign a **static IP** to your Sigenergy device in your router to ensure it always receives the same IP address.
3838

3939
## Installation
4040
### HACS (Recommended)
41-
1. Go to **HACS > Integrations** in Home Assistant
42-
2. Search and install **Sigenergy ESS Integration**
41+
42+
[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=TypQxQ&repository=Sigenergy-Local-Modbus&category=Integration)
43+
44+
1. Go to **HACS > Integrations** in Home Assistant
45+
2. Search and install **Sigenergy ESS Integration**
4346
3. Restart Home Assistant
4447

4548
### Manual
46-
1. Download the latest `.zip` from the [Releases](https://github.com/TypQxQ/Sigenergy-Local-Modbus/releases) page
47-
2. Extract and copy `custom_components/sigen` into your HA `custom_components/` folder
49+
1. Download the latest `.zip` from the [Releases](https://github.com/TypQxQ/Sigenergy-Local-Modbus/releases) page
50+
2. Extract and copy `custom_components/sigen` into your HA `custom_components/` folder
4851
3. Restart Home Assistant
4952

5053
## Configuration & Usage
@@ -55,46 +58,50 @@ Plant (IP:Port)
5558
├─ Inverter 1 (ID 2)
5659
│ └─ DC Charger (via Inverter 2)
5760
├─ Inverter 2 (ID 3)
58-
└─ AC Charger (ID 1) ** Is 1 by default and very hard to change **
61+
└─ AC Charger (ID 1) ** Is 1 by default and very hard to change **
5962
```
6063

61-
6264
### Initial Setup (Discovery)
6365
![Discovered Sigenergy System](docs/images/discovery_demo.png)
6466
1. Navigate to **Settings > Devices & Services**
65-
2. If your Sigenergy device is discovered automatically on the network, it will appear under **Discovered**.
66-
If not discovered, try unplugging and replugging the network cable of your Sigenergy system.
67-
If discovery still fails, see the [Troubleshooting](#troubleshooting) section below.
68-
> Controls are **read-only by default**. To enable control features, you must explicitly activate them in the integration configuration **and** allow them in Home Assistant. This precaution helps prevent unintended changes or adverse effects.
67+
2. If your Sigenergy device is discovered automatically on the network, it will appear under **Discovered**.
68+
* If not discovered, try unplugging and replugging the network cable of your Sigenergy system.
69+
* If discovery still fails, see the [Troubleshooting](#troubleshooting) section below.
6970

71+
> [!NOTE]
72+
> Controls are **read-only by default**. To enable control features, you must explicitly activate them in the integration configuration **and** allow them in Home Assistant. This precaution helps prevent unintended changes or adverse effects.
7073
7174
### Manual Initial Setup
7275
1. Navigate to **Settings > Devices & Services > Add Integration**
73-
2. Search for **Sigenergy**
74-
3. If discovered, click **Configure**; otherwise select manually
75-
4. Enter **Host IP**, **Port** (default 502), and first **Device ID**
76+
2. Search for **Sigenergy**
77+
3. If discovered, click **Configure**; otherwise select manually
78+
4. Enter **Host IP**, **Port** (default 502), and first **Device ID**
7679
5. Add additional Inverters/Chargers via the same Plant entry
7780

7881
### Reconfiguration & Options
79-
1. Navigate to **Settings > Devices & Services**.
80-
2. Find your **Sigenergy** integration entry and click **Configure**.
81-
3. From the configuration menu, you can:
82-
* Adjust **Plant** settings (e.g., read-only, refresh intervals).
83-
* Modify settings for individual **Inverters** or **Chargers**.
84-
> While it is technically possible to assign different IP addresses and ports to devices, it is not advised. For best results and reliable operation, all devices within a plant should use the same IP address and port.
82+
1. Navigate to **Settings > Devices & Services**.
83+
2. Find your **Sigenergy** integration entry and click **Configure**.
84+
3. From the configuration menu, you can:
85+
* Adjust **Plant** settings (e.g., read-only, refresh intervals).
86+
* Modify settings for individual **Inverters** or **Chargers**.
87+
88+
> [!NOTE]
89+
> While it is technically possible to assign different IP addresses and ports to devices, it is not advised. For best results and more reliable operation, all devices within a plant should use the same IP address and port.
8590
8691
### Add Additional Devices
8792

88-
1. Navigate to **Settings > Devices & Services**.
89-
2. Select the **Sigenergy** integration and click **Add Device**.
90-
3. Follow the prompts to add extra inverters, chargers, or a new plant.
93+
1. Navigate to **Settings > Devices & Services**.
94+
2. Select the **Sigenergy** integration and click **Add Device**.
95+
3. Follow the prompts to add extra inverters, chargers, or a new plant.
9196

9297
## Entities & Controls
9398

94-
**Plant Entities:** active/reactive power, PV power, SoC, grid flows, EMS mode
95-
**Inverter Entities:** MPPT metrics, battery SoC/SoH, phase data
96-
**AC Charger:** charging power, total energy, system state
97-
**Controls:** EMS work modes are exposed via `select` entities, and optional `button`/`switch` controls are available.
99+
* **Plant Entities:** active/reactive power, PV power, SoC, grid flows, EMS mode
100+
* **Inverter Entities:** MPPT metrics, battery SoC/SoH, phase data
101+
* **AC Charger:** charging power, total energy, system state
102+
* **Controls:** EMS work modes are exposed via `select` entities, and optional `button`/`switch` controls are available
103+
104+
> [!NOTE]
98105
> Controls are **read-only by default** unless explicitly enabled in the integration configuration.
99106
100107
## Quickstart Automation Example
@@ -118,17 +125,17 @@ action:
118125
- Check Home Assistant logs for `sigen` errors.
119126

120127
## Contributing
121-
Contributions welcome!
122-
1. Fork the repo and create a branch
123-
2. Add tests under `tests/components/sigen/`
124-
3. Follow Home Assistant coding and config‑flow patterns
125-
4. Submit a Pull Request
128+
Contributions welcome!
129+
1. Fork the repo and create a branch
130+
2. Add tests under `tests/components/sigen/`
131+
3. Follow Home Assistant coding and config‑flow patterns
132+
4. Submit a Pull Request to this repository
126133

127134
## Support & Links
128-
- Issues: https://github.com/TypQxQ/Sigenergy-Local-Modbus/issues
129-
- Discussions: https://github.com/TypQxQ/Sigenergy-Local-Modbus/discussions
130-
- Add-ons & tools: https://github.com/Si-GCG/sigenergy_projects
131-
- HACS docs: https://hacs.xyz/
135+
- [Issues](https://github.com/TypQxQ/Sigenergy-Local-Modbus/issues)
136+
- [Discussions](https://github.com/TypQxQ/Sigenergy-Local-Modbus/discussions)
137+
- [Add-ons & tools](https://github.com/Si-GCG/sigenergy_projects)
138+
- [HACS docs](https://hacs.xyz/)
132139

133140
## License
134-
MIT License © [Andrei Ignat]
141+
[MIT License © [Andrei Ignat]](LICENSE)

0 commit comments

Comments
 (0)