foxess_modbus - GitLite

KO | EN

gitlite — search

#mcp #markdown #ai-agents #agents #artificial-intelligence #computer-vision #tensorflow #python #graphql #nextjs

foxess_modbus

(★ 328)

FoxESS inverter integration. Connect directly to your FoxESS inverter (no cloud!) for real-time status and control.

File Explorer

ZIP Download

- devcontainer.json
- develop
- setup
- - config.yml
  - issue.yml
- - labeler.yml
  - release-drafter.yml
  - release.yml
  - tests.yml
- dependabot.yml
- labels.yml
- release-drafter.yml
- launch.json
- settings.json
- tasks.json
- configuration.yaml
- - __init__.py
  - binary_sensor.py
  - config_flow.py
  - const.py
  - icons.json
  - inverter_adapters.py
  - inverter_profiles.py
  - manifest.json
  - modbus_controller.py
  - number.py
  - remote_control_manager.py
  - select.py
  - sensor.py
  - services.yaml
- __init__.py
- charge-periods.png
- energy.png
- example.png
- svc-charge-1.png
- svc-charge-2.png
- svc-write.png
- usage.png
- test_entity_descriptions.py
.gitattributes
.gitignore
.pre-commit-config.yaml
.prettierignore
CONTRIBUTING.md
hacs.json
LICENSE
pyproject.toml
README.md
requirements.txt

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitHub Release][releases-shield]][releases]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
[![Community Forum][forum-shield]][forum]

\*\* **This project is not endorsed by, directly affiliated with, maintained, authorized, or sponsored by FoxESS** \*\*

## Introduction

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.

Depending on your inverter model, you can also set charge periods, work mode, min/max SoC.
See [Supported Features](https://github.com/nathanmarlor/foxess_modbus/wiki/Supported-Features).

Supported models:

- FoxESS H1 (including AC1, AIO-H1 and G2)
- FoxESS H3 (including AC3 and AOI-H3)
- FoxESS H3 PRO
- FoxESS P1
- FoxESS KH
- Kuara H3
- Sonnenkraft SK-HWR
- STAR
- Solavita SP
- a-TroniX AX
- Enpal
- 1KOMMA5°

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](https://github.com/nathanmarlor/foxess_modbus/wiki) for how-to articles and FAQs.**

## Installation

[![Quick installation link](https://my.home-assistant.io/badges/hacs_repository.svg)][my-hacs]

Migrating from StealthChesnut's HA-FoxESS-Modbus? [Read this](https://github.com/nathanmarlor/foxess_modbus/wiki/Migrating-from-HA-FoxESS-Modbus).

Recommended installation is through [HACS][hacs]:

1. Either [use this link][my-hacs], or navigate to HACS integration and:
   - 'Explore & Download Repositories'
   - Search for 'FoxESS - Modbus'
   - Download
2. Restart Home Assistant
3. Go to Settings > Devices and Services > Add Integration
4. Search for and select 'FoxESS - Modbus' (If the integration is not found, empty your browser cache and reload the page)
5. Proceed with the configuration

## Usage

1. Navigate to Settings -> Devices & Services to find:

![Usage](https://raw.githubusercontent.com/nathanmarlor/foxess_modbus/main/images/usage.png)

2. Select '1 device' to find all Modbus readings:

![Example](https://raw.githubusercontent.com/nathanmarlor/foxess_modbus/main/images/example.png)

## Charge Periods

If your inverter supports setting charge periods, you can use install the [Charge Periods lovelace card](https://github.com/nathanmarlor/foxess_modbus_charge_period_card):

![Charge Periods](https://raw.githubusercontent.com/nathanmarlor/foxess_modbus/main/images/charge-periods.png)

## Services

### Write Service

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.

![Service](https://raw.githubusercontent.com/nathanmarlor/foxess_modbus/main/images/svc-write.png)

### Update Charge Periods

Updates one of the two charge periods (if supported by your inverter).

![Service](https://raw.githubusercontent.com/nathanmarlor/foxess_modbus/main/images/svc-charge-1.png)

### Update All Charge Periods

Sets all charge periods in one service call. The service "Update Charge Period" is easier for end-users to use.

![Service](https://raw.githubusercontent.com/nathanmarlor/foxess_modbus/main/images/svc-charge-2.png)

---

[buymecoffee]: https://www.buymeacoffee.com/nathanmarlor
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[hacs]: https://hacs.xyz
[my-hacs]: https://my.home-assistant.io/redirect/hacs_repository/?owner=nathanmarlor&repository=foxess_modbus&category=integration
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[releases-shield]: https://img.shields.io/github/release/nathanmarlor/foxess_modbus.svg?style=for-the-badge
[releases]: https://github.com/nathanmarlor/foxess_modbus/releases