Welcome to the pylxpweb documentation. This directory contains comprehensive documentation for the Luxpower/EG4 inverter Python API client library.
- Usage Guide — Object hierarchy, station/device management, inverters, batteries, GridBOSS, control operations, caching, error handling.
- Property Reference — All device properties with scaling, types, and descriptions (~150 properties across all device types).
- Scaling Guide — Voltage, current, frequency, power, and energy scaling factors; examples and conversion tables.
- Parameter Reference — Hold/input register definitions and control function parameters.
- Device Types — Supported inverter families, GridBOSS, and battery module types.
- Battery RS485 Protocols — Direct RS485 battery communication protocol details.
- Modbus Host Ownership — Shared-unit lifecycle, per-connection request serialization, and host-owned endpoint scheduling.
- Collect Device Data — Guide for capturing live API sample data for testing and diagnostics.
- API Reference — Complete endpoint catalog, authentication, session management, error codes, and data scaling reference.
- OpenAPI Specification — OpenAPI 3.0 spec for the Luxpower web API.
- GridBOSS Firmware Addendum — Additional endpoints from GridBOSS firmware analysis.
- LSP API Addendum — Additional LSP-variant endpoints.
The inverters/ directory contains real-world device data used for testing and
reference. The samples/ directory contains API response samples.
Development notes, session logs, investigation reports, and design documents live in
docs/claude/ and are not user-facing.
- README.md — Installation and quick-start examples.
- Usage Guide — Comprehensive usage documentation.
- Property Reference — All available device properties.
- API Reference — Low-level endpoint details.