Skip to content

marzliak/ha-hyxi-cloud

ย 
ย 

Repository files navigation

HYXI

HYXI Logo

HYXIPower Cloud Integration for Home Assistant

Monitor your solar production, battery state-of-charge, and grid flow in real-time.

HACS Custom GitHub Release License Ruff GitHub Issues

CodeQL HomeAssistant Gitleaks Security: Harden-Runner Dependabot gitleaks badge OpenSSF Baseline

Buy Me a Coffee


โœจ Features

  • โšก Energy Dashboard Ready: Native support for Home Assistant's built-in Energy Dashboard. Track daily solar yield, grid dependency, and battery cycles.
  • ๐Ÿ“Š Advanced Diagnostics: Track cloud connectivity, API success rates, and data sync latency with dedicated diagnostic sensors.
  • ๐Ÿ•ฅ Adjustable Polling: Fine-tune your data refresh rate between 1 and 60 minutes via the integration options.
  • ๐Ÿ›ก๏ธ Reliable Quality Assurance: Built with 100% automated test coverage and robust numeric safety nets to ensure your energy data is accurate and resilient.
  • ๐Ÿงผ Clean UI: Precision-tuned data with multi-language support (English, French, German, Dutch).

๐Ÿ“ฅ Installation

Open your Home Assistant instance and open the repository inside the Home Assistant Community Store.

Method 1: HACS (Recommended)

  1. Open HACS in Home Assistant.
  2. Go to Integrations > Custom repositories (three dots menu).
  3. Paste: https://github.com/Veldkornet/ha-hyxi-cloud
  4. Select Integration and click Add.
  5. Restart Home Assistant.

Method 2: Manual

  1. Copy the hyxi_cloud folder to your /config/custom_components/ directory.
  2. Restart Home Assistant.

๐Ÿ”Œ Supported Devices

Tip

Dynamic Discovery: This integration uses a proactive discovery model. Even if your device is listed as "Untested," it will automatically populate with at least basic diagnostic entities and known mapped entities. Full sensor mapping is applied once the device type is confirmed.

๐Ÿ“ก Detailed Entity Support

Device Type Status Key Entities Provided
Hybrid & All-in-One โœ… Tested PV: Power, Voltage (String 1/2), Current, Daily/Total Yield
Battery: SOC, Power (Charge/Discharge), Voltage, Current, SOH, Capacity (kWh), Max Power, Temp
Grid: Import/Export Power, Load Power, Voltage, Frequency, Phase(1/2/3) Volts/Amps/Power, Bus Voltage
System: Internal Temp, Running State, Fault Codes
Data Collector โœ… Tested Diagnostics: Signal Intensity (RSSI/%), Heartbeat, Heartbeat Interval, Last Seen, WiFi Version, Comm Mode
String Inverter โš ๏ธ Untested PV: Power, String Volts/Amps
AC: Output Power, Daily/Total Yield, Bus Voltage, Temperature
Micro Inverter โš ๏ธ Untested Module: DC Input Power, AC Voltage, Frequency, Daily Energy, Internal Temp
Smart Meter โš ๏ธ Untested Grid: Active/Reactive Power, Voltage, Export Energy, Import Energy

Important

๐Ÿค Call for Testers

Do you own a String Inverter, Micro Inverter, Standalone Battery or Multiple Batteries? Your data can help us move these to โœ… Tested! Specifically multiple batteries behind an inverter would be a great addition to confirm working!

  1. Enable Debug Logging in Home Assistant for this integration.
  2. Open a GitHub Issue and attach a snippet of the debug log output.
  3. We will verify the sensor mappings and update the integration!

๐Ÿ›ก๏ธ Reliability & Diagnostics

This integration includes a specialized diagnostic system to help you distinguish between local hardware issues and cloud service outages.

Sensor Purpose Behavior
Cloud Status Binary connectivity sensor. Turns Off if the API is unreachable or authentication fails.
Connection Quality API Stability tracking. Reports Stable, Degraded (with retry count), or Offline.
Data Freshness Sync latency tracking. Reports Just now, Fresh, or Stale based on cloud feedback.
Device Alarm Hardware fault tracking. Binary sensor that turns On if the hardware reports active alarms.
Integration Last Updated Local Sync timestamp. The exact time Home Assistant last successfuly processed a cloud update.

โš™๏ธ Setup & Configuration

  1. Ensure you have a developer account and have created an application to obtain an Access Key and Secret Key from the HYXIPOWER Developer Platform.

    Important: Use the same email address that your devices are registered to in the HYXI app.

  2. Go to Settings > Devices & Services > Add Integration > HYXI Cloud. Or alternatively, add the integration with the following:

Open your Home Assistant instance and start setting up a new integration.

Configuration

  1. Enter your Access Key and Secret Key from the HYXI Open API portal.

Optional Features (Options Flow)

Click the Configure button on the HYXI integration card to access:

  • Polling Interval: Adjust frequency between 1โ€“60 minutes (Default: 5).
  • Enable Aggregated Virtual Battery: Combine data from 2+ batteries into single "System" sensors.

๐Ÿ›ก๏ธ Quality Assurance

This integration prioritizes data integrity and system stability above all else:

  • 99% Test Coverage: Every line of core logic is validated against dozens of simulated hardware scenarios.
  • Glitch Filtering: Built-in protection against impossible energy "spikes" and "dips" often caused by cloud reporting delays.
  • Continuous Integration: Every change is automatically scanned for security vulnerabilities (CodeQL) and code quality (Ruff).

๐Ÿ› Troubleshooting

If you are opening a bug report, please include Debug Logs: How to enable and download debug logs:

  1. Go to Settings > Devices & Services > HYXI Cloud.
  2. Click the three dots (โ‹ฎ) and select Enable debug logging.
  3. Wait 5-10 minutes, then click Disable debug logging to download the file.
  4. Attach the downloaded log file to your GitHub issue โ€” no manual editing needed, serial numbers, plant IDs, and your home address are automatically masked in the logs.

Disclaimer

This is a custom integration and is not an official product of HYXI Power.

Support

If you find this integration helpful and want to support its development:

Buy Me a Coffee


About

HYXiPower โšก๏ธ๐Ÿ”‹โ˜€๏ธ Integration for HomeAssistant using HYXiCloud โ˜๏ธ

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 97.9%
  • Shell 2.1%