This is a custom integration for Home Assistant that connects to the SolaX Cloud via WebSocket to retrieve real-time data from SolaX inverters. It provides dynamic sensor creation for various inverter and battery metrics, such as voltage, current, power, and battery state of charge, with calculated per-phase site power sensors. This integration has been tested only on the SolaX Hybrid NEO-X3-LV 15 kW inverter.
- Real-Time Data: Connects to the SolaX Cloud WebSocket API for live inverter and battery data.
- Dynamic Sensors: Automatically creates sensors based on received data, with friendly names and appropriate units.
- Calculated Sensors: Computes per-phase site power (e.g., Site A Power = SiteIa * SiteUa) for enhanced monitoring.
- Config Flow: User-friendly configuration through Home Assistant's UI, with validation for credentials and serial numbers.
- Automatic Reconnection: Robust WebSocket client with automatic reconnection logic for reliable data streaming.
- Device Grouping: Groups all sensors under a single device in Home Assistant for better organization.
- Customizable Prefix: Allows users to set a custom prefix for entity IDs to avoid conflicts in multi-inverter setups.
- Manual Installation:
- Copy the
solax_wsfolder to your Home Assistantcustom_componentsdirectory (e.g.,config/custom_components/solax_ws/). - Restart Home Assistant.
- Copy the
- Go to Settings > Devices & Services in Home Assistant.
- Click + Add Integration and search for "SolaX WebSocket."
- Provide the following details:
- Username: Your SolaX Cloud account username.
- Password: Your SolaX Cloud account password.
- Inverter Serial Number: The serial number of your SolaX inverter.
- WiFi Serial Number: The serial number of the WiFi module connected to your inverter.
- Prefix (optional): A custom prefix for entity IDs (e.g.,
solax_1). Use letters, numbers, underscores, or hyphens. Defaults tosolax_ws.
- Submit the form to connect to the SolaX Cloud.
Your credentials (username and password) are sent directly to the SolaX Cloud API and are not seen or stored by any other party. This integration communicates securely with SolaX Cloud, and no credentials are shared with third parties.
- Home Assistant 2023.6.0 or later
- Python packages:
websockets>=12.0aiohttp>=3.9.0
These dependencies are automatically installed by Home Assistant when the integration is added.
The integration dynamically creates sensors based on the data received from the SolaX Cloud. Examples include:
- AC Phase Voltages (acUa, acUb, acUc): Voltage for each phase (V).
- AC Phase Currents (acIa, acIb, acIc): Current for each phase (A).
- AC Active Power (acP): Total active power (W).
- Battery State of Charge (soc): Battery charge level (%).
- Site Power (siteP): Total site power (W).
- Calculated Site Phase Power (siteA_power, siteB_power, siteC_power): Power per phase, calculated as current * voltage (W).
Units and device classes are automatically assigned based on sensor codes. See sensor.py for details on unit and device class guessing logic.
- Cloud Dependency: This integration relies on the SolaX Cloud API, which requires an active internet connection.
- WebSocket Stability: The integration includes reconnection logic to handle network interruptions gracefully.
- Logging: Debug logs are available under the
solax_wslogger for troubleshooting. - Tested Hardware: This integration has been tested only on the SolaX Hybrid NEO-X3-LV 15 kW inverter. Compatibility with other models is not guaranteed.