Skip to content

Commit 3e874a8

Browse files
authored
docs: align repository links and v0.1.0 metadata (#4)
1 parent 4f8930b commit 3e874a8

4 files changed

Lines changed: 15 additions & 13 deletions

File tree

‎.github/ISSUE_TEMPLATE/issue.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ body:
44
- type: markdown
55
attributes:
66
value: |
7-
Before reporting an issue, please review the [README](https://github.com/Lewa-Reka/esphome-opendtu-to-sdm630/blob/main/README.md) - especially **Requirements**, **Configuration reference**, and **Failsafe behaviour**.
7+
Before reporting an issue, please review the [README](https://github.com/Lewa-Reka/esphome-opendtu-meter-bridge/blob/main/README.md) - especially **Requirements**, **Configuration reference**, and **Failsafe behaviour**.
88
99
**Scope of this repository:** the `opendtu_meter_bridge` ESPHome component only (WebSocket livedata → selectable SDM630/DTSU666 Modbus profile).
1010

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ All notable changes to this project are documented here.
44

55
## Unreleased
66

7+
## v0.1.0 - 2026-09-07
8+
79
### Added
810

911
- ESPHome sensors for daily and lifetime production, summed only across microinverters selected in `microinverter_map`.

‎NOTICE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This project provides an ESPHome external component that bridges OpenDTU
1919
microinverter data to selectable Modbus RTU Eastron SDM630 and CHINT DTSU666
2020
register profiles.
2121

22-
Project Repository: https://github.com/Lewa-Reka/esphome-opendtu-to-sdm630
22+
Project Repository: https://github.com/Lewa-Reka/esphome-opendtu-meter-bridge
2323

2424
================================================================================
2525
This project is built upon the ESPHome platform.

‎README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ limitations under the License.
1717
-->
1818

1919
![Maintenance](https://img.shields.io/maintenance/yes/2026?style=for-the-badge)
20-
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Lewa-Reka/esphome-opendtu-to-sdm630/build-ci.yaml?style=for-the-badge)
21-
![GitHub License](https://img.shields.io/github/license/Lewa-Reka/esphome-opendtu-to-sdm630?style=for-the-badge)
22-
![GitHub commit activity](https://img.shields.io/github/commit-activity/y/Lewa-Reka/esphome-opendtu-to-sdm630?style=for-the-badge)
20+
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Lewa-Reka/esphome-opendtu-meter-bridge/build-ci.yaml?style=for-the-badge)
21+
![GitHub License](https://img.shields.io/github/license/Lewa-Reka/esphome-opendtu-meter-bridge?style=for-the-badge)
22+
![GitHub commit activity](https://img.shields.io/github/commit-activity/y/Lewa-Reka/esphome-opendtu-meter-bridge?style=for-the-badge)
2323

2424
ESPHome external component that reads Hoymiles microinverter data from [OpenDTU](https://github.com/tbnobody/OpenDTU) and presents instantaneous measurements to a hybrid inverter using a Modbus RTU **Eastron SDM630** or **CHINT DTSU666** register profile.
2525

@@ -287,20 +287,20 @@ The reference file pulls the component from GitHub:
287287

288288
```yaml
289289
external_components:
290-
- source: github://Lewa-Reka/esphome-opendtu-to-sdm630@main
290+
- source: github://Lewa-Reka/esphome-opendtu-meter-bridge@main
291291
components: [opendtu_meter_bridge]
292292
```
293293

294294
It also includes WiFi, OTA, API, UART (TX=17, RX=16, 9600 baud), Modbus server, and optional diagnostic sensors. Change `meter_profile` under `opendtu_meter_bridge:` to `dtsu666` and select **CHNT** in Deye, or use `sdm630` with **Eastron**. The default is `sdm630`.
295295

296296
## Migration from `opendtu_sdm630`
297297

298-
Version 0.2.0 introduces the recommended meter-neutral `opendtu_meter_bridge` name. Existing v0.0.1-style configurations remain compatible through the `opendtu_sdm630` wrapper: they compile without changing the component list or YAML domain, emit a deprecation warning, and select SDM630 by default.
298+
Version 0.1.0 introduces the recommended meter-neutral `opendtu_meter_bridge` name. Existing v0.0.1-style configurations remain compatible through the `opendtu_sdm630` wrapper: they compile without changing the component list or YAML domain, emit a deprecation warning, and select SDM630 by default.
299299

300300
```yaml
301-
# Compatible v0.0.1-style configuration on the 0.2.x codebase
301+
# Compatible v0.0.1-style configuration on the 0.1.x codebase
302302
external_components:
303-
- source: github://Lewa-Reka/esphome-opendtu-to-sdm630@main
303+
- source: github://Lewa-Reka/esphome-opendtu-meter-bridge@main
304304
components: [opendtu_sdm630]
305305
306306
opendtu_sdm630:
@@ -313,11 +313,11 @@ opendtu_sdm630:
313313
# No selector is needed: the compatibility wrapper defaults to SDM630.
314314
```
315315

316-
The recommended 0.2.x configuration uses the neutral component name and an explicit profile when needed:
316+
The recommended 0.1.x configuration uses the neutral component name and an explicit profile when needed:
317317

318318
```yaml
319319
external_components:
320-
- source: github://Lewa-Reka/esphome-opendtu-to-sdm630@main
320+
- source: github://Lewa-Reka/esphome-opendtu-meter-bridge@main
321321
components: [opendtu_meter_bridge]
322322
323323
opendtu_meter_bridge:
@@ -338,8 +338,8 @@ Compatibility policy: both deprecated aliases -- the `opendtu_sdm630` component/
338338
## Versioning and release guidance
339339

340340
- The `main` branch contains the current development line and can move as fixes are added.
341-
- Until a reviewed upstream release is published, use `@main` for evaluation or pin a reviewed commit SHA for a reproducible build.
342-
- After a release is published, production installations should pin its tag rather than follow `@main`.
341+
- Use `@main` for evaluation or pin a reviewed commit SHA for a reproducible development build.
342+
- Production installations should pin a release tag, such as `@v0.1.0`, rather than follow `@main`.
343343
- Compatibility changes, deprecations, and release contents are recorded in [CHANGELOG.md](CHANGELOG.md).
344344

345345
For local component development, point `external_components` to a local path instead:

0 commit comments

Comments
 (0)