Skip to content

Commit e03ae4c

Browse files
committed
prep for release
1 parent 476ec1a commit e03ae4c

23 files changed

Lines changed: 4836 additions & 316 deletions

.github/workflows/hassfest.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Validate with hassfest
2+
3+
on:
4+
push:
5+
pull_request:
6+
schedule:
7+
- cron: "0 0 * * *"
8+
9+
jobs:
10+
validate:
11+
runs-on: "ubuntu-latest"
12+
steps:
13+
- uses: "actions/checkout@v3"
14+
- uses: home-assistant/actions/hassfest@master

.github/workflows/validate.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Validate
2+
3+
on:
4+
push:
5+
pull_request:
6+
schedule:
7+
- cron: "0 0 * * *"
8+
workflow_dispatch:
9+
10+
jobs:
11+
validate-hacs:
12+
runs-on: "ubuntu-latest"
13+
steps:
14+
- name: HACS validation
15+
uses: "hacs/action@main"
16+
with:
17+
category: "integration"
18+
repository: 0xAHA/Growatt_ModbusTCP
19+
github_token: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# Changelog
2+
3+
All notable changes to the Growatt Modbus Integration will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.0] - 2025-09-28
9+
10+
### Added
11+
12+
- Initial release of Growatt Modbus Integration
13+
- Complete Home Assistant integration with config flow UI
14+
- Support for TCP and Serial Modbus connections
15+
- Multiple register mappings (MIN_SERIES_STANDARD, MIN_10000_VARIANT_A)
16+
- Comprehensive sensor coverage (PV, AC, Grid, Energy, Status)
17+
- Smart meter support for grid import/export monitoring
18+
- Intelligent power calculation with register/calculated fallbacks
19+
- Built-in Solar Bar Card with auto-entity detection
20+
- Connection testing during setup
21+
- Device and entity discovery
22+
- Energy Dashboard integration support
23+
- Configurable polling intervals and timeouts
24+
- Installation script and comprehensive documentation
25+
26+
### Features
27+
28+
- **Sensors**: 20+ sensors covering all inverter parameters
29+
- **Connection Types**: TCP (RS485-to-Ethernet) and Serial (USB-to-RS485)
30+
- **Register Maps**: Support for different Growatt model variants
31+
- **Smart Meter**: Automatic detection and grid flow monitoring
32+
- **Solar Bar Card**: Beautiful power distribution visualization
33+
- **Auto-Configuration**: Automatic entity detection for Solar Bar Card
34+
- **Services**: Manual data refresh, connection testing, register debugging
35+
- **HACS Support**: Full HACS integration compatibility
36+
37+
### Solar Bar Card Features
38+
39+
- Auto-detection of Growatt entities
40+
- Manual entity configuration support
41+
- Solcast integration support
42+
- Real-time power distribution visualization
43+
- Configurable display options (header, stats, legend)
44+
- Responsive design for all screen sizes
45+
46+
### Hardware Support
47+
48+
- Growatt MIN-3000TL-X through MIN-10000TL-X series
49+
- RS485-to-TCP converters (EW11, USR-W630, etc.)
50+
- USB-to-RS485 adapters (CH340, FTDI, etc.)
51+
- Smart meters connected to Growatt inverters
52+
53+
### Technical Details
54+
55+
- pymodbus 2.x and 3.x compatibility
56+
- Automatic pymodbus version detection
57+
- Rate limiting to respect inverter specifications
58+
- Robust error handling and recovery
59+
- Signed 16-bit value support for grid power
60+
- 32-bit energy total calculations
61+
- Device information extraction (serial, firmware)
62+
63+
## [Unreleased]
64+
65+
### Planned Features
66+
67+
- Additional register mappings for other Growatt models
68+
- Battery storage system support (SPF/SPH series)
69+
- String-level monitoring for larger installations
70+
- Historical data export functionality
71+
- Advanced diagnostics and troubleshooting tools
72+
- Integration with other solar monitoring platforms
73+
74+
### Under Consideration
75+
76+
- MQTT discovery support
77+
- Telegram/Discord notification integration
78+
- Advanced energy flow diagrams
79+
- Cost/savings calculations
80+
- Weather correlation features
81+
- Performance analytics and reporting
82+
83+
## Version Support Matrix
84+
85+
86+
| Integration Version | Home Assistant | pymodbus | Python |
87+
| --------------------- | ---------------- | ---------- | -------- |
88+
| 1.0.0 | 2023.1+ | 2.5+ | 3.7+ |
89+
90+
## Breaking Changes
91+
92+
None for this initial release.
93+
94+
## Migration Guide
95+
96+
This is the initial release, so no migration is required.
97+
98+
## Known Issues
99+
100+
### v1.0.0
101+
102+
- Some MIN-6000 units may require register map adjustments
103+
- Serial connection may require dialout group membership on Linux
104+
- Very old firmware versions (<1.0) may have limited register support
105+
- Smart meter detection requires proper inverter configuration
106+
107+
### Workarounds
108+
109+
- Try different register maps if power readings are incorrect
110+
- Add user to dialout group: `sudo usermod -a -G dialout homeassistant`
111+
- Update inverter firmware if available
112+
- Check inverter menu for smart meter settings
113+
114+
## Testing
115+
116+
Each release is tested with:
117+
118+
- Home Assistant Core (latest stable)
119+
- Home Assistant OS (latest stable)
120+
- Real MIN-10000 hardware with firmware 3.17
121+
- EW11 TCP converter and USB-RS485 adapters
122+
- Smart meter configurations (when available)
123+
124+
## Support
125+
126+
For issues, feature requests, and discussions:
127+
128+
- GitHub Issues: Bug reports and feature requests
129+
- GitHub Discussions: General questions and community support
130+
- Home Assistant Community: Integration discussion thread
131+
132+
## Contributors
133+
134+
Thanks to all contributors who helped test, debug, and improve this integration:
135+
136+
- Hardware testers with various Growatt models
137+
- Community members who provided register mappings
138+
- Beta testers who validated the release

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 0xAHA
3+
Copyright (c) [2025] [0xAHA]
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)