** As of February 2025 you should use the main upstream respository instead of this fork. Details below. **
** This project is not endorsed by, directly affiliated with, maintained, authorized, or sponsored by FoxESS **
This is my fork of foxess_modbus which is a Home Assistant custom component which communicates with FoxESS H-series inverters and derivatives without using FoxESS's cloud.
This means that you're not reliant on FoxESS's cloud infrastructure, so HA keeps working when the cloud goes down. You can also read solar production etc in real-time, rather than once every 5 minutes.
If this looks useful, you should almost certainly use the upstream repo at https://github.com/nathanmarlor/foxess_modbus instead of this one, but if you are having problems with KH inverters on more recent firmware, this fork may be useful to you.
The purpose of this fork WAS to apply / test some quick fixes to enable it to work correctly with a KH inverter with recent firmware (Master 1.39), which I found were otherwise broken, as per the issue discussed here.
But now these fixes and more have been fully incorporated into the upstream https://github.com/nathanmarlor/foxess_modbus and you should now use that one.
Depending on your inverter model, you can also set charge periods, work mode, min/max SoC. See Supported Features.
Supported models:
- FoxESS H1 (including AC1 and AIO-H1)
- FoxESS H3 (including AC3 and AOI-H3)
- FoxESS KH
- Sonnenkraft SK-HWR
- Kuara H3
- Solavita SP
You will need a direct connection to your inverter. In most cases, this means buying a modbus to ethernet/USB adapter and wiring this to a port on your inverter. See the documentation for details.
See the wiki for how-to articles and FAQs.
Migrating from StealthChesnut's HA-FoxESS-Modbus? Read this.
Recommended installation is through HACS:
- Either use this link, or navigate to HACS integration and:
- 'Explore & Download Repositories'
- Search for 'FoxESS - Modbus'
- Download
- Restart Home Assistant
- Go to Settings > Devices and Services > Add Integration
- Search for and select 'FoxESS - Modbus' (If the integration is not found, empty your browser cache and reload the page)
- Proceed with the configuration
- Navigate to Settings -> Devices & Services to find:
- Select '1 device' to find all Modbus readings:
If your inverter supports setting charge periods, you can use install the Charge Periods lovelace card:
A service to write any modbus address is available, similar to the native Home Assistant service. To use a service, navigate to Developer Tools -> Services and select it from the drop-down.
Updates one of the two charge periods (if supported by your inverter).
Sets all charge periods in one service call. The service "Update Charge Period" is easier for end-users to use.
