Skip to content

SolaX: align entity names with the cloud app - #2277

Draft
Bl00d-B0b wants to merge 6 commits into
wills106:mainfrom
Bl00d-B0b:fix/hybrid-dry-contact-tree
Draft

SolaX: align entity names with the cloud app#2277
Bl00d-B0b wants to merge 6 commits into
wills106:mainfrom
Bl00d-B0b:fix/hybrid-dry-contact-tree

Conversation

@Bl00d-B0b

@Bl00d-B0b Bl00d-B0b commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Stacked on the sub-device series (#2279#2283#2284#2285#2286). Review the last commit only — the diff includes the parents until they merge.

Display names of the hybrid battery-mode settings now match what the SolaX cloud app shows, so a setting is called the same thing in both places. Keys and entity ids are unchanged.

Before After
Selfuse Night Charge Self Use Charge from Grid
Selfuse Discharge Min SOC Self Use Min SoC
Selfuse Nightcharge Upper SOC Self Use Charge Battery to
Feedin Discharge Min SOC Feed-In Priority Min SoC
Feedin Nightcharge Upper SOC Feed-In Priority Charge Battery to
Backup Discharge Min SOC Backup Min SoC
Backup Nightcharge Upper SOC Backup Charge Battery to
Charge Start/End 1 and 2 Force Charge P1/P2 Start/End
Discharge Start/End 1 and 2 Allowed Discharge P1/P2 Start/End

Select option values are deliberately untouchedFeedin Priority, Enabled Feedin Priority and the SOC-mode options keep their exact strings, since automations select options and match states by string. This PR changes nothing an automation can reference: entity ids, keys and option values are all unchanged; only display names move.

Self Use Charge Battery to only applies while Self Use night charge is enabled, so it uses active_when (from #2279) to follow that switch.

Every remaining entity name that spelled the state of charge as SOC now uses SoC — Min SoC, Restart SoC, Selfuse Backup SoC, Switch On SoC, Battery Charge Upper SoC, PeakShaving Max/Reserved SoC, Min Esc SoC, the Dual Battery Charge Upper SoC readbacks and the Remotecontrol Target/Minimum SoC numbers. Select option values such as Reference SOC are deliberately untouched, since automations match those by string.

Charge and Discharge Period2 becomes Charge/Discharge Period 2, and the four Gen4/Gen5/Gen6 times it controls — Force Charge Start/End 2 (0x6D/0x6E) and Allowed Discharge Start/End 2 (0x6F/0x70) — now use active_when so they only exist while that switch is on, matching how the app hides the second period. Gen2/Gen3 keep their old behaviour; those models have no such switch.

The period number sits before Start/End (P1/P2) so each period's pair sorts together in alphabetical entity lists, instead of all Ends grouping before all Starts.

The four Battery Heating times (0xD00xD30xA40xA7) become Battery Heating P1/P2 Start/End, matching the period scheme above, and only exist while the Battery Heating switch (0xCF0xA3) is on. A heating level (Low/Medium/High) setting exists only for dual-battery systems (0x20A/0x20B per the V1.02 protocol document, already exposed as Gen5/Gen6 readback sensors); a Gen4 rejects that whole register block, verified live.

@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch from 5352926 to e207a6d Compare August 11, 2026 15:11
@Bl00d-B0b Bl00d-B0b changed the title Hybrid Gen4: align dry-contact load management with the app's dependency tree Hybrid Gen4: Dry Contact sub-device with dependency-driven availability Aug 11, 2026
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch 4 times, most recently from 723ed05 to c42750a Compare August 11, 2026 16:53
@Bl00d-B0b Bl00d-B0b changed the title Hybrid Gen4: Dry Contact sub-device with dependency-driven availability Hybrid Gen4: Dry Contact and External Generator sub-devices with dependency-driven availability Aug 11, 2026
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch 7 times, most recently from 1c13f74 to 9876574 Compare August 11, 2026 17:55
@Bl00d-B0b
Bl00d-B0b marked this pull request as ready for review August 11, 2026 18:17
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch 13 times, most recently from 3dfe4b1 to a73d48a Compare August 11, 2026 19:56
@Bl00d-B0b
Bl00d-B0b marked this pull request as draft August 11, 2026 19:59
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch from a73d48a to 8181547 Compare August 11, 2026 20:01
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch 7 times, most recently from 0621241 to 840725c Compare August 13, 2026 05:16
@Bl00d-B0b Bl00d-B0b changed the title Hybrid Gen4: Dry Contact and External Generator sub-devices with dependency-driven availability Hybrid Gen4: Dry Contact sub-device with dependency-driven availability Aug 13, 2026
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch from 840725c to d438e9a Compare August 13, 2026 05:38
@Bl00d-B0b Bl00d-B0b changed the title Hybrid Gen4: Dry Contact sub-device with dependency-driven availability SolaX: align entity names with the cloud app Aug 13, 2026
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch 4 times, most recently from 73d269d to 32bcb45 Compare August 13, 2026 08:25
@TCWORLD

TCWORLD commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Automations that select that option by string need updating.

Please don't break everyone's automatons for something that is purely stylistic...

@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch 5 times, most recently from e5d22b5 to c5b2b76 Compare August 13, 2026 10:55
@Bl00d-B0b

Copy link
Copy Markdown
Contributor Author

Fair point — agreed and fixed. The select option values (Feedin Priority, Enabled Feedin Priority) are back to their original strings, so nothing that automations reference changes: entity ids, keys and option values are all untouched by this PR. What remains is purely display names (friendly names shown in the UI), which HA doesn't use for automation matching. The description's breaking-change note is removed accordingly.

…ptions dialog

Energy Dashboard: the refresh only marked sensors inactive when a feature
switch was turned off - the entity stayed alive and its registry entry was
never removed, so the device accumulated sensors stuck at unavailable
(grid-to-battery, home-consumption and PV-variant sensors). They are now
removed and their registry entries purged.

Generic sub-device infrastructure, used by follow-up PRs that move the
EPS, Parallel, External Generator and Dry Contact families into their own
devices: entity descriptions gain device_group (assigns the entity to a
named sub-device linked to the inverter with via_device, the same pattern
as the battery pack devices) and active_when ({sensor_key: allowed values}
evaluated against polled hub.data; keys not polled on a model never block
availability). The hub tracks gated entities and adds or removes them as
conditions change, with a two-poll hysteresis so a stale readback right
after a write cannot make entities flicker. A sub-device whose option is
switched off is removed from the registry instead of lingering. Switch and
number writes publish the written value immediately, as selects and times
already did. Numbers gain max_key, letting a sensor value override
native_max_value. The number, select, switch, time and sensor platforms
honour all of it. No entities move in this PR.

The options dialog no longer shows feature switches the selected plugin
does not implement, and all feature options now default to off for new
entries, including the Energy Dashboard virtual device.
The 36 EPS entities were mixed into the main inverter device, which on a
hybrid means hundreds of entities in one list. They now use device_group
and appear under "<hub> EPS", linked to the inverter with via_device - the
same pattern the battery pack devices already use. The redundant EPS
prefix is dropped from the names, which the device now provides. Keys and
entity ids are unchanged.

With the Emergency Power Option (EPS) switched off the entities are not
created and the device is removed from the registry instead of lingering
forever.

EPS Mute becomes a switch (write 0x43, readback 0xB7) instead of a
read-only sensor, matching the cloud app.

Stacked on the sub-device infrastructure PR.
The 54 parallel-mode entities move from the main inverter device to
"<hub> Parallel", linked to the inverter with via_device. The redundant
PM prefix is dropped from the names, which the device now provides. Keys
and entity ids are unchanged.

With Parallel Mode (Master-Slave) switched off the entities are not
created and the device is removed from the registry.

Stacked on the sub-device infrastructure PR.
The 33 generator entities were gated by the Dry Contact Box option, which
is a different feature - in the SolaX app the external generator is its
own tree. They move to a "<hub> External Generator" device behind a new
"External Generator Support" option (read_gen, off by default, translated
in all shipped languages), and each entity only exists while its parent in
that tree is active:

  External Generator (0xC7): Disabled | ATS Control | Dry Contact
    Start Gen Method (0xE3): only with Dry Contact
      Switch On/Off SoC (0xE4/0xE5): only with Reference SOC
    Max Run Time (0xE6), Max Rest Time (0xE7), Hold Min Power (0x10E)
    Allow Work Start/Stop Time (0xE8/0xE9), Max Charge (0xC8)
    Charge Battery from Generator (0x109 on Gen4, 0x10C on Gen5/Gen6)
      Charge Battery To (0x10A on Gen4, 0x10D on Gen5/Gen6)
    Schedule 2 (0x104 on Gen4, 0x107 on Gen5/Gen6): unlocks the second
    Charge Period and Allowed Discharge Period time pair

Names follow the cloud app now that the device provides the context, with
keys and entity ids unchanged: Generator Max Charge -> Max Charge (in kW,
0.01 scale, 0-300 kW instead of a raw 10 W register), Generator Charge ->
Charge Battery from Generator, Generator Min Power -> Hold Min Power,
Generator Time 2 -> Schedule 2, Generator Charge SOC -> Charge Battery To.

Verified live on an X3-Hybrid-G4 15kW by changing each setting in the
SolaX app and tracking the readbacks.

Stacked on the sub-device infrastructure PR.
The 13 Gen4 dry-contact load-management controls become their own HA
device ("<hub> Dry Contact"), and each entity only exists while its full
parent chain in the app's dependency tree is active:

  Dry Contact Mode (0xC3 -> 0x12F): Generator Control | Load Management
    Load Management (0xC2 -> 0x12E): Disabled | Manual Mode | Smart Save
      Manual Mode switch (0xB6 -> 0x122): only in Manual Mode
      Threshold On Feed-in Power (0xB7 -> 0x123)    \
      Threshold Off Consumption (0xB9 -> 0x125)     |
      Threshold Off Battery SoC (0xBA -> 0x126)     | only in Smart Save
      Minimum Per On Signal (0xBB -> 0x127)         |
      Maximum Per Day (0xBC -> 0x128)               |
      Schedule (0xBD -> 0x129)                      /
        Work Start/End Time 1 and 2 (0xBE-0xC1 -> 0x12A-0x12D):
        only while Schedule is enabled

All register mappings were verified live on an X3-Hybrid-G4 15kW by
changing each setting in the SolaX app and tracking the readback.

The Dry Contact Box option now only decides whether the sub-device exists;
it no longer sets the DCB feature bit on individual entities, and its
label drops the model suffix since the option is hidden for plugins
without dry-contact entities.

Display names follow the app, keys and entity ids unchanged: Work Mode ->
Load Management (option Manual -> Manual Mode), Manual Mode Control ->
Manual Mode, Feedin On Power -> Threshold On Feed-in Power, Consume Off
Power -> Threshold Off Consumption, Switch Off SOC -> Threshold Off
Battery SoC, Maximum Per Day On -> Maximum Per Day, and the Work Stop Time
readbacks become Work End Time.

Stacked on the sub-device infrastructure PR.
Display names of the hybrid battery-mode settings now match what the SolaX
cloud app shows, so a setting is called the same thing in both places.
Keys and entity ids are unchanged.

  Selfuse Night Charge           -> Self Use Charge from Grid
  Selfuse Discharge Min SOC      -> Self Use Min SoC
  Selfuse Nightcharge Upper SOC  -> Self Use Charge Battery to
  Feedin Discharge Min SOC       -> Feed-In Priority Min SoC
  Feedin Nightcharge Upper SOC   -> Feed-In Priority Charge Battery to
  Backup Discharge Min SOC       -> Backup Min SoC
  Backup Nightcharge Upper SOC   -> Backup Charge Battery to
  Charge Start 1 / Charge End 1  -> Force Charge Start / Force Charge End
  Discharge Start 1 / End 1      -> Allowed Discharge Start / End

Select option values are deliberately NOT touched ("Feedin Priority",
"Enabled Feedin Priority" and the SOC-mode options keep their exact
strings), since automations select options and match states by string -
this PR changes nothing an automation can reference.

Self Use Charge Battery to only applies while Self Use night charge is
enabled, so it uses active_when to follow that switch.

Every entity name spelling the state of charge as "SOC" now uses "SoC",
matching the app and the entities already renamed above: Min SoC, Restart
SoC, Selfuse Backup SoC, Switch On SoC, Battery Charge Upper SoC,
PeakShaving Max/Reserved SoC, Min Esc SoC, the Dual Battery Charge Upper
SoC readbacks and the Remotecontrol Target/Minimum SoC numbers. Select
option values such as "Reference SOC" are left alone, since automations
match those by string.

Charge and Discharge Period2 becomes Charge/Discharge Period 2, and the
four Gen4/Gen5/Gen6 times it controls (Force Charge Start/End 2 at
0x6D/0x6E and Allowed Discharge Start/End 2 at 0x6F/0x70) now use
active_when so they only exist while that switch is on, the same way the
app hides the second period. The Gen2/Gen3 period 2 times keep their old
behaviour - those models have no such switch.

The four Battery Heating times (0xD0-0xD3 -> 0xA4-0xA7) become Battery
Heating P1/P2 Start/End, matching the period scheme above, and only exist
while the Battery Heating switch (0xCF -> 0xA3) is on; that switch moves
to the Configuration section. A heating level setting
exists only for dual-battery systems (0x20A/0x20B per the V1.02 doc,
already exposed as Gen5/Gen6 readbacks); a Gen4 rejects that whole
register block, verified live.
@Bl00d-B0b
Bl00d-B0b force-pushed the fix/hybrid-dry-contact-tree branch from d39d1ed to 72e53a7 Compare August 20, 2026 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants