3.8.0

Release 3.8.0

Important

🚨 Read the breaking changes before upgrading 🚨

I'm happy to announce another release that adds and improves support for a couple of devices with the help of the community. The whole Anker Solix PPS C800 family is now fully supported with sensors and all controls based on MQTT server connection. The new S2000 PPS device is now also supported with known MQTT sensors and new MQTT controls to configure their silent mode plan as well as toggling its PPS usage mode, which is unique so far for the supported PPS devices. The S2000 time of use and custom mode schedules are also extracted as attributes of the usage mode selector, but they cannot be modified yet. However, their structure is fully understood and their modification through the integration is planned for a future release. Last but not least, the 250W Prime Charger device got an overhaul of enhancements. This device now also utilizes the cloud Api for stock and customized clock display themes, customization of usage modes and USB port remarks. More than 50!!! additional MQTT based control entities have been added to control the Timers, and the Start and End plan settings for each USB port as supported through the mobile App. Read here more details about the 250W prime charger support.

And finally, I have the pleasure to feature the Helios projects for Home Assistant from user @ReikanYsora. I strongly recommend to have a look and test his Helios Energy Card, which visualizes the sun movement around YOUR home, viewable from any angle, including surrounding buildings with their shadows, a live power flow and history data replay via the timeline using real data from your energy dashboard in a very performant 2.5D visualization. You will love this card like I do 😍

Another Helios project is the self learning PV forecast integration, which can easily be integrated into your Home Assistant, without any Api tokens or complex configurations. For my setup, it was more accurate from the beginning than the default forecast solar integration and it will further optimize over time. You can use the Helios Energy Card sun azimuth display as well to determine the real orientation of your PV panels, or to optimize your shutter and blend automations, depending on how the sun moves around your home. More details can be found here

💖A big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• Bumped Api library to release 3.8.0 for enhanced MQTT device support

• MQTT Enhancements for a couple of devices

  • Added C800(X/P) PPS family devices A1753, A1754 & A1755 including full control #328, #511(Thanks @kartoffelkaese, @CallumDickerson, @sarahwitherup)
    • Mapped status message and MQTT controls supported by the devices
  • Added S2000 PPS AS220 including known controls #322, #570 (Thanks @mattwolkoff, @scuderia09, @KenKilty, @jc22zhao)
    • Mapped status messages and known MQTT controls
    • New controls added to switch PPS usage mode and adjust a new silent schedule plan
    • MQTT controls to modify custom and TOU schedules will be added in a future release

• Significantly enhanced 250W Prime Charger A2345 with new controls (see also 250W Prime Charger considerations)
  • Support for Timer, Start and End Time control of each USB port
  • Support for Usage mode, including custom modes user can define, if custom modes are enabled by user
  • Support for all other device configuration controls, including display themes and USB port remarks
  • The selected theme image is visualized in the select entity
  • A new exclude category was introduced to remove all advanced USB port control entities from the integration if not needed

• Updated various PPS devices to harmonize charging_status and battery_status fields
  • charging_status will only reflect the type of charge for PPS
• Added initial MQTT message description for Solarbank 4
  • The values must be used with care, I have no device access to validate or enhance the value mapping
  • For that reason, Solarbank 4 remains unsupported by this integration
  • Use the official Anker Solix integration instead, which utilizes the local Modbus interface.

Important

There are NO plans to support the Solarbank 4 Pro or Solarbank Max AC devices in this integration. They have significant changes in the Api interface and previous Api queries may show wrong or incomplete data. Also the Api controls won't work anymore and are not tested, even if they may be offered partially by the integration. See #563, #558 and #330 for more details.

• Updated README.md
  • Added newly supported devices
  • Added special considerations for Anker Solix 250 W prime charger devices

Breaking changes: 💥

• PPS battery status and charging status sensors may become unavailable

  • A name harmonization became required across the various PPS status names
  • A PPS battery status is supposed to show whether the internal battery is charging, discharging or inactive
  • A PPS charging status is supposed to show which kind of charging occurs, like ac_charge, dc_charge, solar_charge etc.
  • The charging status may have been a separate sensor for few devices, it now became an attribute of the battery status sensor

• PPS backup charge switch may become unavailable

  • A name harmonization became required across the various PPS switch controls
  • A few PPS used a backup charge switch, while others used a fast charge switch
  • Both have essentially the same device function and used the same MQTT control, so their naming was merged to fast charge switch
  • Devices like C1000 that may show the backup charge switch unavailable, can delete the entity and use the fast charge switch entity instead

• Sensors that remain unavailable and are not longer provided by the integration must be deleted manually

  • In most cases, this occurs due to underlying name changes of the MQTT field descriptions for corrections or harmonization
  • The values are now typically reflected in other sensors or as attributes of sensors
  • The easiest way to see all available attribute values is to use the developer tools panel in HA and filter your Solix device entities

• Updated device pictures

  • For optional device picture update after integration update, please refer to optional entity pictures installation instruction

• For upgrades from version < 3.7.0, see breaking changes in 3.7.0 release notes

Fixes 🔨 and other changes: 🔧

• Changed the mechanism to use device pictures for the device details button

  • The recommended option remains to install the [device pictures manually](Optional entity pictures)
  • Previously, if the device picture was not found in the local community folder, the entity icon remained blank
  • With this release, the public device picture url is also polled into the Api device cache and will be used instead, if no local picture was found. This allows the HA frontend to download and display the entity picture
  • If neither the url is provided, nor a local picture was found, the picture is cleared and the default entity icon will be displayed for the button.

• Changed translation of Solarbank usage mode from Time Slot mode to Dynamic Tariffs(#569)

• This change does NOT impact any automation, since the option state name remains time_slot, but the translated representation in HA front...

3.7.0

Release 3.7.0

Important

🚨 Read the breaking changes before upgrading 🚨

This release adds support for the new SOC limit settings of Solarbank 2 & 3 systems. It also adds the new load type selection for Solarbank 3 custom and smart plug schedules, in order to support controllable AC charge power for dedicated time slots.
There are also a couple of MQTT managed device improvements, especially for supporting the reverse charge mode of the AS200 alternator charger.

Additional general improvements include diagnostics support for devices and the hub configuration, to allow quick and easy download of the corresponding cached data. Furthermore the firmware and OTA update sensors have been replaced with update entities for centralized update notifications through Home Assistant

💖A big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• Bumped Api library to release 3.7.0 for enhanced MQTT device support and support of new Solarbank 2 & 3 features

• Implemented HA diagnostics support for the hub configuration and the devices (#551)

  • Device diagnostics will download only the device cache data, with most sensitive but independent data redacted
  
  • Hub diagnostics will download the configuration data as well as the whole cache of the update coordinator, with most sensitive but independent data redacted
  

Important

Device and System identifiers from diagnostics CANNOT be redacted without loosing their dependencies within the cache structures. In order to provide a completely randomized export from your account data (including optional MQTT messages from owned devices), you need to use the Export systems action

• Implemented update entities for devices to utilize HA functionality to report available firmware updates (#550) (Thanks @SH1FT-W for the suggestion)

  • HA will now report available Anker Solix firmware updates under Settings, System, Updates
  • The new update entity does consolidate the information of the former firmware and ota_update sensors
  • The installed firmware version must now be obtained from the update entity attribute installed_version. It can also be obtained from the entity's device information property sw_version.
  • Component information is now provided in a human readable table format in the more info dialog.
  • Any leading 'v' of firmware versions is now stripped to support comparisons by the update entity
  

Note

Firmware updates through the integration will not be supported and they sill must be triggered through the Anker mobile app. You can skip the update notification in HA, if the actual device firmware update will be postponed.

• MQTT Enhancements for a couple of devices

  • Added A1726/A1728 DC switch control (#531, #316) (Thanks @gimmers-eth)
    • Mapped DC switch state field to enable the DC switch control entity
  • Updated AX170 circuit fields (#539, #312) (Thanks @tmcor))
    • Up to 2 circuits can be paired during setup
    • Paired circuits will now be recognized and power will be combined to the first circuit of the pair. The other circuit will be removed from
      the cache data (see breaking changes)
    • Added/updated AC power, battery power, other load through the dock and overall home demand
  • Updated AS200 Alternator Charger data fields and added support for reverse charge controls (#290) (Thanks @mgTerminator)
    • Identified status fields for existing cable connections to properly block unsupported controls depending on connections
    • Added reverse charge mode selection entity (selection is only possible if supported PPS expansion cable is connected to charger)
    • Added mappings for PPS data received upon expansion cable connection (serial, model type, SOC, temperature, remaining time). They will be provided with 'Device 1' power and status sensors and attributes
  • Updated C2000 Gen 2 fields
    • Added remaining time
    • Added mappings for attached charger (serial, model type, mode). They will be provided with 'Device 1' power and status sensors and attributes
  • Enhance X1 support by updating status enumerations (#314) (Thanks @Shaan-alpha)
  • Fix and extend Power Panel MQTT mappings (A17B1) (#310) (Thanks @xjc10)

• Various enhancements to support latest Solarbank firmware changes

  • Add support for AC charge setting in custom and smart plug schedules (#538)
    • This feature requires Solarbank 3 with supported firmware
    • New select entity to control the load type in current schedule time slot
    • Updated Anker Solix schedule actions to support additional and optional load type selection for Solarbank 3 systems
    • See Info documentation Home load type for more details
  • Add support for new SOC charging/discharging limits for Solarbank 2 and 3 (#529)
  • Add support for new backup SOC settings for Solarbank 3 and Power Dock systems
    • This feature requires Solarbank 3 or Power Dock with supported firmware

• Updated export system module

  • Randomize all known device serials from cloud Api in MQTT binary messages.

Important

Unknown serials like battery expansion packs or devices running only in local MQTT mode cannot be randomized in binary MQTT data.

• Updated README.md for supported devices

• Updated INFO.md for recent changes

  • Added Solarbank 3 home load type information
  • Updated markdown cards to display Solarbank 2+ schedules including the load type
  • Updated Solarbank 2+ script example to modify the schedules of custom and smart plug usage modes

Breaking changes: 💥

• Some code changes require newer HA core versions.
  • The minimum version was increased to HA 2025.12.0
  • Integration update will not be allowed if running on older core versions
• Country Romania (RO) cloud server assignment was reverted back to EU server
  • Recent users confirmed that their system and device data was created on the EU server by the mobile App
  • Romanian users with systems and devices located on the COM server need to change their hub configuration to another country that is assigned to the COM server, e.g. Unites States
  • Romanian users with systems and devices located on the EU server can now safely revert their country setting to Romania
• The firmware and ota_update sensors have been removed and replaced by a new update entity
  • They can safely be removed from your devices in the active hub configurations
  • Optionally you can reconfigure your hub with existing credential confirmation, which will automatically remove all entities and re-create only remaining entities
• AX170 power dock circuit sensors may become unavailable
  • If circuits have been paired during the power dock installation setup, the power will now be combined under one circuit.
  • The unavailable circuit entities of the paired circuits can be safely removed
• For upgrades from version < 3.6.3, see breaking changes in 3.6.3 release notes

Fixes 🔨 and other changes: 🔧

• Reverted country assignment for RO back to EU cloud server since original change seems to be wrong (#250)
  • see breaking changes
• Changed country assignment for JP to EU cloud server (#557)
• Fix deprecation warning: Integration passes a non-string value of type int as hw_version to the device registry (#549)

Full Change log 3.6.3...3.7.0 and link to previous release notes [3.6.3](https://github.com/thomluther/ha-anker-solix/releases...

3.6.3

Release 3.6.3

🌟 New device support and support for devices running MQTT local mode 🔄

Important

🚨 Read the breaking changes before upgrading 🚨

This release adds support for F2600 PPS A1781 and support for PPS & E10 devices running in MQTT local mode as found in Power Panel systems and Home Backup systems with Power Dock. For more details, see devices in MQTT local mode in the User Guide.

Note

Home Backup system devices are a whole new family/category of devices and systems. Make yourself familiar with the restrictions that still apply.

Another important change to be aware of is the modified categorization of control entities. In order to improve support for strategy based HA dashboards, many control entities that modify the configuration of a device or system are now categorized as 'Configuration' entity. While this is no functional breaking change, it will change the entity visualization in the HA frontend, for the device panels as well as for your strategy dashboards if in use. With this change, the clutter of many controls for some Anker Solix devices will be reduced, aiming to group only usage related entities under Controls and give you a cleaner device panel to manage your Anker Solix system and devices.

Important

Anker Solix systems and devices may now show 4 instead of 3 entity groups in the order Controls, Sensors, Configuration, Diagnostic. Only usage control entities will remain in the Controls group, while less frequently used controls that configure the device / system behavior or settings have been moved to the Configuration group. They did not disappear, but you have to scroll down below the Sensors in your device panel to see the new Configuration group entities.

💖A big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• Bumped Api library to release 3.6.3 for enhanced MQTT device support and support of embedded MQTT messages and devices in MQTT local mode

• MQTT Enhancements for couple of devices

  • Added A1781 SOLIX F2600 data and controls (#300) (Thanks @kylekampy)
    • Reused and confirmed mappings are the same as A1780
    • Added new energy saving switch control
  • Updated A1790(P) data fields
    • Updated and confirmed some battery SOC mappings with expansion batteries
  • Updated AS200 Alternator Charger data fields and controls (#290) (Thanks @DreamScout)
    • Fixed state field mapping for device power switch
    • Added control for device shutdown

Important

The device shutdown disables all remote control capabilities and requires physical access to the device to switch it back on

• Updated AX170 Power Dock systems for attached E10 Home Backup devices with embedded messages from E10 devices
  • The E10 devices now show their own metrics even if using only local messaging to Power Dock
• Updated A17B1 Power Panel systems for attached devices with embedded messages from F3800(P) devices
  • The PPS devices now show their own metrics even if using only local messaging to Power Panel

• Revised MQTT capabilities to fully support embedded MQTT messages

  • Various flavors/formats of embedded messages have been seen for AX170 power dock and Power Panel A17B1 system types
  • The embedded messages from other devices are now also extracted and mapped to the originating device, e.g. E10 or PPS
  • Since those devices run in MQTT local mode, they are not subscribed to the cloud MQTT server and cannot receive commands through the library or the mobile App. They are fully controlled through their hub device, and therefore they also loose most of their control capabilities in the App
  • With embedded messages, the devices are marked as passive MQTT device that uses local MQTT subscription to the docked device.
  • All MQTT controls to a device running MQTT local mode are rejected with an error
  • The library handles those devices as 'read only' devices which just report data (through the embedded messages)

• Updated export module

  • Skip sending MQTT commands to devices running in MQTT local mode

Breaking changes: 💥

• Modified control entity categorization for proper alignment with HA integration developer rules and support for strategy based dashboards.

  • This is no functional change, but a visualization change for entity grouping on device panels and strategy based dashboards

• Some code changes require newer HA core versions.

  • The minimum version was increased to HA 2025.12.0
  • Integration update will not be allowed if running on older core versions

• Updated and added optional device pictures. Follow this installation guidelines if you want to use them as Entity pictures.

• For upgrades from version < 3.6.2, see breaking changes in 3.6.2 release notes

• For upgrades from version < 3.6.0, see breaking changes in 3.6.0 release notes

• For upgrades from version < 3.5.0, see breaking changes in 3.5.1 release notes

Fixes 🔨 and other changes: 🔧

• Changed Solarbank 1 voltage field descriptions and moved attributes to corresponding power sensors (#299)

• Migrated integration actions to improved HA core API (#391)

  • All integration actions are now registered to HA while the integration is setup, independent of successful load of the various entity platforms used by the first hub configuration
  • All Actions still require a target entity that supports the required features for the action
  • No Action is usable until the first configured hub is loaded successfully and provides selectable target entities

• Added support for coordinator retry attempt on Api errors indicating temporary request issues during data polling (#390)

  • This change should help to relax situations where the whole hub configuration goes into an error state during temporary Anker Cloud issues or individual request timeout errors that may occur sporadically
  • The coordinator will retry the update run after 60 sec. delay (the default update interval)

Full Change log 3.6.2...3.6.3 and link to previous release notes 3.6.2

General notes: 📋

• MQTT data may get stale if required status messages are not longer published by the device. Some devices publish specific status messages only while their real-time trigger is active. If you overlay MQTT data, the stale MQTT values cannot be refreshed anymore by new Api data, see example in issue #401. This is working as designed, therefore you have the choice whether MQTT data should overlay Api data.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from calculated (or customized) battery capacity and the reported SOC. Changes of this entity should NOT be considered for the energy dashboard or energy helper sensors, since this battery energy sensor can never reflect the battery efficiency or capacity loss over time. Furthermore the SOC value may be inaccurate as well since that is difficult to determine for LiFePo batteries.
• I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is possible since they are classified as total_increasing sensors. The reasons for that are described in the discussion how to integrate the Solarbank into you energy dashboard. There you can also find the recommended approach for creating the required entities for easiest and most flexible energy dashboard integration. If your device supports accumulated energy values from decoded MQTT data, they may provide a more accurate source for your helper sensors, which I recommend to be used for energy dashboards.

Contribution: 🙌

• YOUR HELP is required if you have new Anker Solix devices or if new features are introduced by Anker and you want them being integrated into HA
• I have no chance to test any Anker devices or explore the cloud Api requests and responses for new devices or features. Since the Api is not official, no documentation exists and the Api library can only be enhanced with your support and willingness to explore and test the Api querie...

3.6.2

Release 3.6.2

🌟 New device support and enhancements for existing devices 🔧

Important

🚨 Read the breaking changes before upgrading 🚨

This release is packed with lots of MQTT updates and enhancements for various devices and it also adds support for new devices like AS200 Alternator charger and Home Backup system devices A17E1 E10 and AX170 Power Dock as supported in the US market. Furthermore it adds support for Anker product codes, that will be used to distinguish supported product features for dedicated device types (like the V1 EV charger).

[!IIMPORTANT]
Home Backup system devices are a whole new family/category of devices and systems. Make yourself familiar with the restrictions that still apply.

💖A big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• Bumped Api library to release 3.6.2 which brings lots of MQTT enhancements
  • Added AS200 Alternator Charger data monitoring and controls (#290)
    • Note: Reverse charging (car battery to PPS) is not described yet and data fields and controls are unknown. See discussion Anker Alternator Charger AS200 for contribution
  • Added A1729 C200X DC PPS data fields and controls
  • Added A1727 C200 DC PPS data fields and controls
  • Added A1725 C200(X) PPS data fields and controls
  • Updated A1726/A1728 C300 with temp unit control
  • Updated A1782 F3000 Solarbank PPS data fields and controls (#268)
  • Updated A1763 C1000 Gen 2 PPS data fields (#269)
    • Added Expansion battery data, assuming same message pattern as used with C2000 Gen 2
  • Updated A1783 C2000 Gen 2 PPS data fields and controls (#269, #460)
    • Added Expansion battery data (#521)
    • Added various controls that should match the C1000 Gen 2 control patterns (still to be validated by device owners)
  • Changed a control entity for A1761 C1000 (see breaking changes)
  • Changed voltage field mappings for A17C0 Solarbank 1 (see breaking changes)
  • Changed/added controls for A1780(P) F2000 and A1790(P) F3800 PPS devices (#520)
    • Added/changed AC input power limit descriptions and AC charge limit control, what was harmonized for all PPS devices
    • Added other controls that should be common across those device types
  • Added A17E1 E10 Home Backup device with basic data fields (#274)
  • Added AX170 Power Dock for E10 Home Backup devices with basic data fields
  • Added Json field descriptions for X1 and Power Panel Systems
  • Revised some field names for harmonization, which could lead to breaking changes if they change will create different sensors/entities for the data

Note

Solarbank devices typically use the term AC input limit to limit the AC charge power (since AC charge is the only AC input power for Solarbank devices). PPS typically refer to AC charge limit, but allow additional AC input power, e.g. to provide AC output, DC port or USB port output load from AC grid power while charging. While the AC input limit naming is technically not accurate for PPS, the control entity and state names are commonly shared for either device type, but technically speaking it is the AC charge power that is actually limited.

• Added support for Anker Product Codes

  • Product codes are 3-4 chars in the device SN and those are now extracted from the serials
  • If various features are documented for different product codes of a device model, those features will now be created in the device cache as well, based on the actual product code
  • The device features can be used to disable certain (MQTT) control capabilities if not supported by the particular device hardware
  • This was implemented already for V1 EV charger (see breaking changes)

• Updated system export module

  • Leave product code within device serials unchanged during serial randomization, otherwise the correct hardware features cannot be filtered from randomized system exports.
  • Added 2 power generator (extender) related Api queries to export module
  • Ensure to delete existing Api client caches before creating and exporting the randomized caches, otherwise original Power Panel or HES cache artifacts could still be included in the exported caches

• Added backup SOC limit entity for devices reporting the backup SOC limit

  • This control capability was announced for Solarbank 3 with Anker App 3.19, however this capability did not become visible yet in the App
    • It may depend on Solarbank firmware level
  • The Api queries may report the active backup SOC setting already (which is typically 80% per default), which will now be reported as select entity with a single option that is the actual state.
  • No additional select options are provided while the possible values and methods to apply changes are unknown
  • Possible value options may be added in future, once they become controllable through Api or MQTT
  • Note: There have been announced also new SOC min and max controls, but those extra setting display may be more confusing while they cannot be changed through the App or Api, since there is already a SOC reserve setting for Solarbanks.
    • At this point, it is assumed that the new limits for discharge minimum will be higher than the SOC reserve setting, and the SOC reserve remains the lowest allowed minimum.
    • Next generation devices like Solarbank Max AC and potentially Solarbank 4 Pro may have a completely different usage of min and max SOC levels, and may define the usable range from 0-100 %.
    • Proper integration of those new SOC limit settings will be evaluated once they become really controllable.

Breaking changes: 💥

• Updated EV Charger V1 MQTT control availability

  • The EV Charger MQTT controls have been revised to remove product code dependent controls from the MQTT device instance
  • Those control entities will no longer be available if not supported by your V1 hardware
  • You can safely remove V1 control entities from HA which are not becoming available anymore, since your device may not support that control at all.
  • Hardware dependent controls are:
    • Random delay switch (only for certain countries)
    • Auto Phase switch (only for 3 phase models)
    • Cable lock (only for plug based models)

• Changed number/select control of A1761 C1000 from 'Max Load' setting to 'AC Input Limit' setting (aka AC charge limit)

  • There is no known PPS that has a load power control (outgoing power limit control), but they allow to control the AC charge power limit typically
    • If output limit control is indeed available for any PPS, the used MQTT command still must be described with example commands
    • This needs to be addressed with a new issue/feature request
  • This change was required to harmonize value and control names across various PPS devices
  • The max limit of the C1000 control has been reduced from 2000 W to 1000 W for max AC charge according to User Guide specs
  • The max limit should be ignored and 1300 W AC charge should still be used when enabling the Boost Charge switch
  • The former control entity will become unavailable and must be removed manually.
  • You may need to adopt your automation and scripts with the new control entity name.

• Changed mapping of voltage fields for Solarbank 1 A17C0 (#299)

  • Originally the voltage fields were mapped to PV1 and PV2. However, the device only has a single MPPT and therefore cannot have different PV channel voltages
  • The mapping was changed to common pv voltage and new DC output voltage instead
  • Likewise the voltage attributes are no longer shown with the PV channel power entities, but with the PV Power and DC Output power entities.

• Updated and added optional device pictures. Follow this installation guidelines if you want to use them as Entity pictures.

• For upgrades from version < 3.6.0, see breaking changes in 3.6.0 release notes

• For upgrades from version < 3.5.0, see breaking changes in 3.5.1 release notes

Fixes 🔨 and other changes: 🔧

• Re-implemented legacy Api query for AC output limit control of Solarbank 2 systems #514

  • It has been proven, that this query has no effect on the device setting itself (which is controlled by MQTT only), but the Api query may update the cloud immediately and it avoids the flip back of the HA entity after a change.
  • The entity should now remain on the new value after change through HA integration even if the MQTT overlay setting is disabled and Api values are prioritized

• Removed AI controlled sensor from all devices that are ...

3.6.1

Fix Release 3.6.1

🔨 This is mainly a fix release for 3.6.0 🔧

Important

🚨 Read the breaking changes before upgrading 🚨

This release brings back the daily energy entities for Solarbank systems 🔆 which disappeared with the implementation of Solarbank breakdown support in multi systems 🤷
Anker also implemented a cloud Api change mid April in preparation for new devices, which broke the output limit control entity for Solarbank 2 systems. By coincidence, that cloud change was close to the 3.6.0 release which let people think that reverting back to 3.5.4 would resolve the issue, but it did not. 💩

🔀 This is the first attempt to deal with changed rules that must be applied to select the required Api endpoint depending on system constellation to toggle the AC output limit of Solarbanks correctly🔌

💖A big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• None

Breaking changes: 💥

• For upgrades from version < 3.6.0, see breaking changes in 3.6.0 release notes
• For upgrades from version < 3.5.0, see breaking changes in 3.5.1 release notes

Fixes 🔨 and other changes: 🔧

• Daily PV channel and other daily energy sensors are no longer available #500

  • Modified rules to select required energy stat queries to the required minimum

• Solarbank 2 AC output limit change fails with Api error #502

  • Station and non station managed Solarbank systems require different Api/MQTT controls to change the output limit
  • Since an Api cloud change mid April 2026, all Solarbank 2 systems seems to be reported as station managed system
  • However, they do NOT accept the Api query to manage the output limit through the station (yet?!?)
  • New rules have been implemented to ensure the previous control logic is still applied for Solarbank 2 systems, which is output limit change through MQTT command only
  • Other improvements have been implemented to ensure also immediate cache update of the other interface which was not used to apply the change
    • This prevents that depending on MQTT overlay switch, the selection toggled back to an outdated value that was just refreshed with a delay

• Non functional AC output limit controls from Solarbanks are removed for multisystems with power dock

  • They presented the device limit, but toggling was not possible since the station limit must be applied in multisystems
  • Those controls may become unavailable after upgrading from 3.6.0 to 3.6.1 and can be deleted manually

Full Change log 3.6.0...3.6.1 and link to previous release notes 3.6.0

General notes: 📋

• MQTT data may get stale if required status messages are not longer published by the device. Some devices publish specific status messages only while their real-time trigger is active. If you overlay MQTT data, the stale MQTT values cannot be refreshed anymore by new Api data, see example in issue #401. This is working as designed, therefore you have the choice whether MQTT data should overlay Api data.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from calculated (or customized) battery capacity and the reported SOC. Changes of this entity should NOT be considered for the energy dashboard or energy helper sensors, since this battery energy sensor can never reflect the battery efficiency or capacity loss over time. Furthermore the SOC value may be inaccurate as well since that is difficult to determine for LiFePo batteries.
• I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is possible since they are classified as total_increasing sensors. The reasons for that are described in the discussion how to integrate the Solarbank into you energy dashboard. There you can also find the recommended approach for creating the required entities for easiest and most flexible energy dashboard integration. If your device supports accumulated energy values from decoded MQTT data, they may provide a more accurate source for your helper sensors, which I recommend to be used for energy dashboards.

Contribution: 🙌

• YOUR HELP is required if you have new Anker Solix devices or if new features are introduced by Anker and you want them being integrated into HA
• I have no chance to test any Anker devices or explore the cloud Api requests and responses for new devices or features. Since the Api is not official, no documentation exists and the Api library can only be enhanced with your support and willingness to explore and test the Api queries:
  • via the Api library
  • via the Anker Solix action Api Request in HA developer tools actions
• Enhancements may only be possible when exclusive owner access to the system is available.
  • But since the system belongs to you and the Api usage is not officially supported, it is up to you to test and verify Api capabilities
• MQTT device data requires decoding of binary data for your owned device type and constellation before they can be consumed
  • You need to compare live message decoded values with your mobile App data to properly identify and describe the message data fields
  • This must be done under various usage conditions of the device to allow recognition and description of most data fields and bytes
  • To get started, follow the MQTT data decoding guidelines and MQTT command and state analysis guideline in the Api library

Appreciation: ✨

If you like this integration and you want to show your appreciation for the countless hours spent to enhance and maintain it, I would be happy for a 🍵coffee ☕ or if you become a sponsor 💖.

3.6.0

Release 3.6.0

🚗 Full Solix V1 EV-Charger support (MQTT monitoring and controls) and other device enhancements 🔆

Important

🚨 Read the breaking changes before upgrading 🚨

This release implements full support for the Solix V1 EV charger, including MQTT controls for all its capabilities. This allows the device owner account as well as a device member account to manage the EV charging based on conditions that you can track and automate in Home Assistant. 🚗 🚗 🚗

But not only the EV charger is covered in this release, also a couple of other devices got enhancements as you can find below.

Be aware of naming changes for power dock entities, which became necessary to provide generic device support for other power dock types and attached devices. This may be a breaking change for your existing power dock entities as you can read in the breaking changes section.

If controls for your Solix device are missing, they are not discovered or described yet in the MQTT mappings. For MQTT discovery 🔍 and MQTT command descriptions 🧰, follow this guideline using the mqtt_monitor 👀 with the Api library.

Missing descriptions of requested device support are:

• Adding Support for Solix C2000 Gen 2 #460, A1783 Mqtt decoding - SOLIX C2000 Gen2 anker-solix-api issue #269
• Missing controls for A2345, Anker Prime Charger (250W, 6 Ports, GaNPrime) anker-solix-api issue #252
• Solix Cooler devices #364
• Solix X1 Home Energy System anker-solix-api issue #192
• Power Panel Data #447
• Extending solution to the home backup systems with E10 (AX17E1) and optional Power Dock (AX170) Discussion #459, anker-solix-api issue #274
  • This is a new system type available in US and uses different Api queries and structures, which also must be discovered and explored by system owners
• Support for Anker Smart Generators anker-solix-api issue #278
• MQTT data for A1782, SOLIX F3000 anker-solix-api discussion #268
  • Any control is missing, either via MQTT or unknown Api queries if managed as Solarbank PPS system (US Market)

If nobody will analyze and describe their MQTT messages and provide MQTT command examples, those devices cannot be supported. 🤷

Tip

The monitor tools in the Api library allow MQTT device control for described commands per model. Try it out, and fix or update the command descriptions for your device model if missing or not working properly. In the next release of the integration, I can then implement selected and verified MQTT device control entities for your model as well.

🎉 Enjoy the new Anker Solix device capabilities of this integration🎉

💖And a big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• Added support for V1 EV charger (A5191) (#322, #462)

  • The EV charger is now supported in Solarbank Power Dock and HES X1 system constellations via Api as well as MQTT data

  • Device controls and most metrics require the MQTT server connection, plus triggering of real time data and/or status requests

    • Both provide different information and no regular messages seem to be provided if the App is not in use
    • Real time data messages contain only updated consumption data if charging is in progress, otherwise they should not be triggered since they are wasting backend resources if triggered permanently
    • A status request message provides all active settings, and is triggered automatically if a control was changed through the integration or the mobile App

  • All metrics as well as most App controls are supported (including switch of operational mode and device restart)

  • In total, there are about up to 16 unique sensors and up to 28 !! controls for the V1 EV charger
    

  • Furthermore, many entities provide additional attributes as you can find them in the developer tools
    

  • Added data extraction for daily EV charger energies as consumed in X1 and Solarbank Power Dock systems

  • For more details, refer to special device notes about EV charger devices

• Added support for 240W Charging Station (A91B2) (#490) and Anker prime charger 250W (A2345) (#264)

  • Added MQTT sensors
  • Added USB port switch control
  • Added AC outlet switch control

• Enhanced device support for C300(x) DC charger A1722/A1723 (#479)

  • Added AC recharge limit control

• Enhanced device support for Solarbank 3 Multisystems with and without Power Dock

  • Enhanced support to offer all total output limit options as provided through the App for SB3 Multisystems without power dock (#288)
  • Corrected some MQTT data extraction due to wrong field descriptions
  • Corrected some Api power value calculations, that may be wrong for various power dock constellations
  • Added daily energy data for device breakdown if more than 1 parallel device in the system
    • Device energy breakdown will be provided as device sensor
    • Breakdown entities won't be created if only 1 device is tracked, since the values are identical with the system energy values
  • Avoid unnecessary Api calls for device energy details, which are not tracked by Solarbank devices running in power dock systems (PV channels etc),
    • This may help to prevent Api energy endpoint throttling for larger power dock systems,
  • Consolidated naming conventions for power dock devices, to support also other parallel devices (see breaking changes for entity name changes)

• The MQTT server connection is now enabled per default for new hub configurations

  • The integration hub configuration options documentation was updated and also restructured accordingly

• Bumped Api library to 3.6.0 to fully support all enhancements.

Breaking changes: 💥

• After upgrade from version < 3.6.0, you may see power dock entities that are unavailable

  • A consolidation of field names was required for generic device support under power docks
  • This required to rename a few entity keys as well, which are used together with the serial number to build the unique_id of the entity
  • The old unique ID is therefore no longer provided by the integration and the entity remains unavailable
  • At the same time, you may see the same or similar translated entity name with a value, but that is a new entity without history (new unique ID)
  • If the entity translation did not change, the entity_id is typically composed with same translated name and to avoid duplicates, HA adds a suffix of '*_2' in the default entity_id name. Otherwise the new translation will be used in the entity_id
  • All entities referring to Solarbank or 'SB' were renamed to Device or similar to be more generic

• Follow this procedure if you want to merge the history of old unavailable entities to the new entities:

  1. Update the integration and restart HA
  2. Wait until the hub has finished the startup process. You may push the real time trigger of your power dock device to get data for all registered entities. This lasts at least 1 minute until the 2nd Api poll cycle is finished, which includes the daily energy entity data as well as entity creation for available MQTT data
  3. Review all your Anker Solix device entities. If there are some still unavailable (old ones), you may find the same or similar entity name with a value (new one)
  4. Check the entity_id of the new one (it should have no history). Entities with unchanged translations should be suffixed with '_2' if you did not customize the original entity_id.
  5. Now check the entity_id of the old one (it should have a history). Copy the entity_id and delete the old entity
  6. Go to the new entity details again and change the entity_id to the old one and update the entity.
  7. If you re-enter the entity details, you should now also find the history of the old entity.

• Updated and added optional device pictures. Follow th...

3.5.4

Release 3.5.4

🔆 Support for new Solarbank PPS F3000 Systems and a couple of fixes 🔧

Important

🚨 Read the breaking changes before upgrading 🚨

This release implements basic support for new Solarbank PPS F3000 Systems (US Market) and fixes some general integration errors.
It also provides enhancements to Solarbank systems by allowing to control the output power limit through the Api, which enables this limit control also for Power Dock based Solarbank systems. The Grid Export switch behavior also got lots of investigation and debugging, and should now hopefully work for all Solarbank system types which support it. Proper functionality however requires to have a smart meter in the system and MQTT connection enabled for the hub.

Last but not least I want to mention the new library references which I added to additional ressources and and interesting community contribution from moag1000 with his Anker Solix Api exploration documentation. While this may not be perfect, it may be a good starter for inspirations with Api request discoveries.

Tip

Anker released an official HACS integration for device usage via local Modbus interfaces. So far, only Smart Plugs (with required firmware for Modbus interface) are supported, but other devices may be added over time.

Important

This project will NOT integrate another 3rd interface, since merging data from 2 interfaces is complex enough and this project is and remains cloud dependent. The Api cloud is not optional, it is mandatory also for MQTT cloud usage. If you need more robust local device interfaces and do not need system related data which is only available in the Api cloud, you need to look into the Solix BLE or Anker's Modbus project.

If controls for your Solix device are missing, they are not discovered or described yet in the MQTT mappings. For MQTT discovery 🔍 and MQTT command descriptions 🧰, follow this guideline using the mqtt_monitor 👀 with the Api library.

Missing descriptions of requested device support are:

• Adding Support for Solix C2000 Gen 2 #460, A1783 Mqtt decoding - SOLIX C2000 Gen2 anker-solix-api issue #269
• Missing controls for A2345, Anker Prime Charger (250W, 6 Ports, GaNPrime) anker-solix-api issue #252
• Solix Cooler devices #364
• Solix X1 Home Energy System anker-solix-api issue #192
• Power Panel Data #447
• Extending solution to the home backup systems with E10 (AX17E1) and optional Power Dock (AX170) Discussion #459, anker-solix-api issue #274
  • This is a new system type available in US and uses different Api queries and structures, which also must be discovered and explored by system owners
• Support for Anker Smart Generators anker-solix-api issue #278
• MQTT data for A1782, SOLIX F3000 anker-solix-api discussion #268
  • Any control is missing, either via MQTT or unknown Api queries if managed as Solarbank PPS system (US Market)

If nobody will analyze and describe their MQTT messages and provide MQTT command examples, those devices cannot be supported. 🤷

Tip

The monitor tools in the Api library allow MQTT device control for described commands per model. Try it out, and fix or update the command descriptions for your device model if missing or not working properly. In the next release of the integration, I can then implement selected and verified MQTT device control entities for your model as well.

🎉 Enjoy the new Anker Solix device capabilities of this integration🎉

💖And a big THANK YOU to the community and your sponsoring and support to keep this project active. 💖

Enhancements: 📢

• Enhanced A2345 device support

  • Added USB port switch control
  • Fixed Real Time trigger button command

• Added support for Solarbank PPS F3000 system types for US market

  • Those systems contain a Smart Meter (A17X7US) and 1-2 F3000 Portable Power Stations (A1783), that can also be regulated automatically like Solarbank devices for European market
  • The F3000 PPS can also be used in a mobile manner for camping etc. It provides all capabilities that Anker PPS typically offer.
  • The system architecture as well as system data reported through the cloud Api are supported
  • MQTT data merge for the PPS F3000 is also provided as far as MQTT messages are described. Those descriptions are still minimalistic and more decoding is required by device owners
  • Daily energies for the system as well as a PPS breakdown for daily energies is provided
    • The PPS daily energy breakdown data will be provided with the device itself
    • Breakdown polling is skipped for single PPS systems since system daily energies reflect the same values
  • The US Smart Meter is fully supported for Api and MQTT data
  • NO controls are supported yet for this system or the F3000
    • MQTT command and state descriptions are still missing
    • No cloud Api controls are known for the new system type and it is not clear if there are any.

• Added support for Output power limit in Multisystems (#423)

  • Found new Api control to adjust the output power limit for Solarbank systems that are managed through a station
  • Station settings are typically the output limit and the switch to allow grid export
  • This new command ensures that now also the output limit change is properly reflected in the Api and the mobile App
  • It does not even need the MQTT control, since the required MQTT commands to existing power dock or Solarbank devices under the station settings are pushed by the cloud server
  • Solarbank 2 systems not managed through station settings still require MQTT commands for both, the Grid Export switch as well as the output limit change.

Important

• Those control entities will only appear if MQTT connection is enabled
• The Grid Export switch may NOT work if there is no Smart Meter installed in the system
• The Grid Export switch seems to work for Multisystems, but the settings in the App station panel do not reflect changes properly. Either there is a bug in the App, or there are unique Api controls for Multisystems, which are unknown.

• Bumped Api library to 3.5.4 to enable full Solarbank PPS support

Breaking changes: 💥

• Updated and added optional device pictures. Follow this installation guidelines if you want to use them as Entity pictures.
• For upgrades from version < 3.4.0, see breaking changes in 3.4.2 release notes
• For upgrades from version < 3.5.0, see breaking changes in 3.5.1 release notes

Fixes 🔨 and other changes: 🔧

• Ignore invalid Api sensor data if MQTT overlay is enabled and connected to server (#424)

  • Api data may be flagged invalid, e.g. if the Solarbank lost its cloud connection. This may cause sensors of other system devices like the Smart Meter and Smart Plugs being flagged invalid as well
  • While Api data is being flagged invalid, sensors are typically either not updated or changed to unavailable (this depends on a general setting in the hub Api configuration options)
  • Even if valid MQTT data may be available for other connected system devices and MQTT overlay was enabled, those sensors did no longer update
  • Invalid Api data is now ignored for sensor updates, if MQTT overlay is enabled and the device is connected to the MQTT server

• Fix select entity state display if selections are not changeable

  • If select entities cannot be modified for any reason but they have a known state, they are initialized with the existing state value as only option, to display at least the active setting to the user
  • If the state changes externally, e.g. though the mobile app, the entity value was no longer shown since it was no supported option for the select entity
  • A single select option is now updated together with a state change to ensure continuous state display in HA, to properly display external state changes

• Fix MQTT real time trigger command to be usable without parameters (#470)

  • Some devices may use different format of real time trigger co...

3.5.3

Release 3.5.3

🔆 Fixes and small X1 and Power Panel enhancements 💫

Important

🚨 Read the breaking changes before upgrading 🚨

This release implements experimental support for X1 and Power Panel device MQTT messages that may use different data field structures in MQTT messages. However, the json fields they provide use abbreviations which cause lots of ambiguity of their meaning. System owners are required to describe the X1 and Power Panel MQTT json field values with a descriptive and correct name and correct value factors if required, so the values can be extracted and properly merged with Api values and used in the HA integration. That's your time to contribute.

If controls for your Solix device are missing, they are not discovered or described yet in the MQTT mappings. For MQTT discovery 🔍 and MQTT command descriptions 🧰, follow this guideline using the mqtt_monitor 👀 with the Api library.

Missing descriptions of requested device support are:

• Adding Support for Solix C2000 Gen 2 #460, A1783 Mqtt decoding - SOLIX C2000 Gen2 anker-solix-api issue #269
• Missing controls for A2345, Anker Prime Charger (250W, 6 Ports, GaNPrime) anker-solix-api issue #252
• MQTT data for A1782, SOLIX F3000 anker-solix-api issue #268
  • This is a unique Solarbank PPS system type available in US and uses different Api queries and structures, which also must be discovered and explored by system owners
• Solix Cooler devices #364
• Solix X1 Home Energy System anker-solix-api issue #192
• Power Panel Data #447
• Extending solution to the E10 system Discussion #459, anker-solix-api issue #274

If nobody will analyze and describe their MQTT messages and provide MQTT command examples, those devices cannot be supported. 🤷

Tip

The monitor tools in the Api library allow MQTT device control for described commands per model. Try it out, and fix or update the command descriptions for your device model if missing or not working properly. The next release of the integration can then implement selected and verified MQTT device control entities for your model as well.

🎉 Enjoy the new Anker Solix device control capabilities of this integration🎉

Enhancements: 📢

• Enhanced MQTT data decoding and mapping descriptions to support Power Panel MQTT message format
  • The Power Panel system provides MQTT messages with binary fields that contain json strings
  • All json field names are abbreviations and context is ambiguous (similar to X1 json fields)
  • A few data fields have been described but cannot be validated, therefore this is all experimental
• Bumped Api library to 3.5.3 to enable enhanced MQTT framework for coming support of Solix V1 EV charger (April release - hopefully 🤷)

Breaking changes: 💥

• For upgrades from version < 3.4.0, see breaking changes in 3.4.2 release notes
• For upgrades from version < 3.5.0, see breaking changes in 3.5.1 release notes

Fixes 🔨 and other changes: 🔧

• Fix for Solarbank SOC reserve setting, that was not applied by Solarbank 2 devices (#463)

  • The SOC reserve setting will now be applied to all Solarbank types as hybrid control:
    • Via Api to apply the change to the cloud and allow the App to display the correct setting in non-device panels, for example the station settings
    • Via MQTT control, to apply the change to the device itself, which is represented on the device details panel
    • Solarbank 1 devices are an exception from this MQTT control requirement, since they are managed differently and the cloud typically sends regular MQTT controls (once per minute) that include the device settings known by the cloud, such as the SOC reserve setting. Therefore an Api change was indirectly applied to Solarbank 1 devices as well, but will now also be applied directly by the HA integration
  • This control requires the MQTT connection to be applied properly to the device

• Fixed factor for Solarbank 2 consumed energy MQTT value (#216)

• Fixed some MQTT descriptions for C300(X) DC charger models A1726/A1728

  • Fixed missing DC 12V port power and status data extraction

• Code refactoring to match new Ruff rules

Full Change log 3.5.2...3.5.3 and link to previous release notes 3.5.2

General notes: 📋

• MQTT data may get stale if required status messages are not longer published by the device. Some devices publish specific status messages only while their real-time trigger is active. If you overlay MQTT data, the stale MQTT values cannot be refreshed anymore by new Api data, see example in issue #401. This is working as designed, therefore you have the choice whether MQTT data should overlay Api data.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from calculated (or customized) battery capacity and SOC. Changes of this entity should NOT be considered for the energy dashboard or helper sensors, since this battery energy sensor can never reflect the battery efficiency or capacity loss over time. Furthermore the SOC value may be inaccurate as well since that is difficult to determine for LiFePo batteries.
• I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is possible since they are classified as total_increasing sensors. The reasons for that are described in the discussion how to integrate the Solarbank into you energy dashboard. There you can also find the recommended approach for creating the required entities for easiest and most flexible energy dashboard integration. If your device supports aggregated energy values from decoded MQTT data, they may provide a more accurate source for your helper sensors that you utilize in your energy dashboard.

Tip

Anker relaxed the restriction of a single active login token per account. You can now use you owner account in the App and the integration in parallel without disabling the Api switch. See Switching between different Anker Power Accounts to modify your hub configuration entry.

Contribution: 🙌

• YOUR HELP is required if you have new Anker Solix devices or if new features are introduced by Anker and you want them being integrated into HA
• I have no chance to test any Anker devices or explore the cloud Api requests and responses for new devices or features. Since the Api is not official, no documentation exists and the Api library can only be enhanced with your support and willingness to explore and test the Api queries:
  • via the Api library
  • via the Anker Solix action Api Request in HA developer tools actions
• Enhancements may only be possible when exclusive owner access to the system is available.
  • But since the system belongs to you and the Api usage is not officially supported, it is up to you to test and verify Api capabilities
• MQTT device data requires decoding of binary data for your owned device type and constellation before they can be consumed
  • You need to compare live message decoded values with your mobile App data to properly describe the message data fields
  • This must be done under various usage conditions of the device to allow description of most data fields and bytes
  • To get started, follow the MQTT data decoding guidelines and MQTT command and state analysis guideline in the Api library

Appreciation: ✨

If you like this integration and you want to show your appreciation for the countless hours spent to enhance and maintain it, I would be happy for a 🍵coffee ☕

3.5.2

Release 3.5.2

🔆 Fixes and X1 enhancements 💫

Important

🚨 Read the breaking changes before upgrading 🚨

This release will bring back the new Solarbank control entities that went missing after upgrade from 3.5.0. It also implements experimental support for X1 MQTT messages and modifies/fixes the entity structure for larger X1 systems.

If controls for your Solix device are missing, they are not discovered or described yet in the MQTT mappings. For MQTT discovery 🔍 and MQTT command descriptions 🧰, follow this guideline using the mqtt_monitor 👀 with the Api library. Completely missing descriptions of requested device support are:

• Solix Cooler devices #364
• Solix V1 EV Charger #322
• Solix X1 Home Energy System in the Api library #192

If nobody will analyze and describe their MQTT messages and provide MQTT command examples, those devices cannot be supported. 🤷

Tip

The monitor tools in the Api library allow MQTT device control for described commands per model. Try it out, and fix or update the command descriptions for your device model if missing or not working properly. The next release of the integration can then implement selected and verified MQTT device control entities for your model as well.

🎉 Enjoy the new Anker Solix device control capabilities of this integration🎉

Enhancements: 📢

• Enhanced MQTT data decoding and mapping descriptions to support X1 MQTT message format
  • The X1 HES system provides MQTT messages as json strings
  • All json field names are abbreviations and context is ambiguous
  • A few data fields have been described but cannot be validated, therefore this is all experimental
  

Important

To all X1 system owners: Please contribute in MQTT decoding, validation and data description for X1 MQTT messages. There are also couple of open questions to understand how those messages can be triggered and how command messages are structured.

Note

The existing average power entity translation was slightly modified to show an average character in the name. Those entities cannot be merged with the MQTT data, since they have different units and may have slightly different reporting character. Therefore some power entities may appear to be duplicate. If you want to remove the average entities, you can exclude the HES average power category from your hub options.

Tip

If you want local X1 system integration via the HA Modbus integration, you may refer to discussion #438

• Updated/Fixed/enhanced the X1 entity structure

  • The X1 can have multiple controller devices, however only one device is the primary controller and all others are in a subordinate role
  • The primary controller seems to be the only device providing MQTT messages for the system
  • All MQTT based entities will therefore being created on the primary controller only

• Updated/Fixed/enhanced the X1 battery reporting and capacity/energy calculation

  • The system did already report the overall battery module count
  • Each controller will now also report the battery module count for batteries it is actually controlling
  • Each controller battery capacity is therefore the sum of all controlled battery module (customized) capacities
  • For example a system with 2 controllers and 6 battery modules may have 3 modules per controller:
    • Each controller therefore reports 15 kWh capacity (30 kWh in total for the system)
    • If any controller or controlled battery capacity is customized, it will be accounted in its controller capacity
  • The primary controller is the only one reporting the overall SOC of the system and therefore also calculates the remaining battery energy of the system.
    • The overall capacity accounts only the (customized) battery capacity of all controllers in the system
    • This may be higher than the own reported controller battery capacity, since the battery energy accounts for the overall SOC and overall capacity of the system
    • Using the example above with 100 % SOC, the primary controller will report 30 kWh remaining energy although its battery capacity is only showing 15 kWh capacity
    • This may be confusing, but there is no other way to structure the data, since all is reported against the primary controller device and MQTT entities are not supported in system device types, which only reflect Api data from systems as known in the Anker cloud.

Breaking changes: 💥

• For upgrades from version < 3.4.0, see breaking changes in 3.4.2 release notes
• For upgrades from version < 3.5.0, see breaking changes in 3.5.1 release notes

Fixes 🔨 and other changes: 🔧

• Fix for 3.5.1 error causing some new control entities no longer being created (#258, #446)

  • Control entities for Solarbank AC socket switch, LED Light Switch and Mode and Temperature unit were missing after update from 3.5.0

• Fix for missing dynamic price provider display

  • The provider selection has shown only provider options that contain also an area code
  • However, with the new dynamic price provider registration, the user can select any supported provider through the app, which is no actual provider option for the device type itself.
  • User registered provider selections are now shown in the select entity as well
  • However, the integration cannot be used to toggle to such registered providers. This must be controlled and registered through the mobile App

• Dynamic prices for non Nordpool provider will now consider end prices being provided

  • Spot prices may be provided only by the Nordpool provider, and therefore requires to calculate the end price including taxes and fees
  • End price assumption for other providers may actually be wrong, but there is no way to determine the provided price structures from the Anker cloud
  • Incorrect dynamic prices cannot be fixed by the integration!

Tip

It seems Anker finally fixed the broken cloud endpoints to query unread account messages and obtaining the product list, which frequently caused query timeout errors. You can now safely include the account category again, if you want to get back the unread messages sensor for system and device messages. 😎

Full Change log 3.5.1...3.5.2 and link to previous release notes 3.5.1

Notes: 📋

• MQTT data may get stale if required status messages are not longer published by the device. Some devices publish specific status messages only while their real-time trigger is active. If you overlay MQTT data, the stale MQTT values cannot be refreshed anymore by new Api data, see example in issue #401. This is working as designed, therefore you have the choice whether MQTT data should overlay Api data.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from calculated (or customized) battery capacity and SOC. Changes of this entity should NOT be considered for the energy dashboard or helper sensors, since this battery energy sensor can never reflect the battery efficiency or capacity loss over time. Furthermore the SOC value may be inaccurate as well since that is difficult to determine for LiFePo batteries.
• I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is possible since they are classified as total_increasing sensors. The reasons for that are described in the discussion how to integrate the Solarbank into you energy dashboard. There you can also find the recommended approach for creating the required entities for easiest and most flexible energy dashboard integration. If your device supports aggregated energy values from decoded MQTT data, they may provide a more accurate source for your helper sensors that you utilize in your energy dashboard.

Tip

Anker relaxed the restriction of a single active login token per account. You can now use you owner account in the App and the integration in parallel without disabling the Api switch. See Switching between different Anker Power Accounts to modify your hub configuration entry.

Contribution: 🙌

• **YOUR HELP is required if you have new Anker Solix devices or if new features are introduced by Anker ...

3.5.1

Release 3.5.1

❄🔆 Control is everything 🔧 May the Force be with you 💫

Important

🚨 Read the breaking changes before upgrading 🚨

This major release finally adds support for missing device control via the Anker MQTT server and enhances and updates some MQTT data of various devices. After countless hours of Api library and HA integration enhancements, testing, debugging and error fixing, the integration now enables you to gain App like control of supported Anker Solix devices via Home Assistant, for proper Solix device integration into your home automation and energy management. Ensure to read the detailed release notes for more information!

If controls for your Solix device are missing, they are not discovered or described yet in the MQTT mappings. For MQTT discovery 🔍 and MQTT command descriptions 🧰, follow this guideline using the mqtt_monitor 👀 with the Api library. Completely missing descriptions of requested device support are:

• Solix Cooler devices #364
• Solix V1 EV Charger #322

If nobody will analyze and describe their MQTT messages and provide MQTT command examples, those devices cannot be supported. 🤷

Tip

The monitor tools in the Api library allow MQTT device control for described commands per model. Try it out, and fix or update the command descriptions for your device model if missing or not working properly. The next release of the integration can then implement selected and verified MQTT device control entities for your model as well.

🎉 Enjoy the new Anker Solix device control capabilities of this integration🎉

Enhancements: 📢

• Added control entities for various devices as MQTT commands are known and described (#394):
  • Missing Solarbank 1/2/3 device controls are now supported (#432, #431, #376, #258):
    • AC socket switch, device timeout, LED switch and mode, SOC reserve setting
    • Grid Export switch and new export limit, AC input/charge limit, PV input limit
    • Temperature unit selection
  • 

Note

Some station based Solarbank commands are hybrid commands and may require Api and MQTT commands. Previous entities may have changed the App display, but were never applied to the device (e.g. SOC Reserve out Grid export setting). Those will now only be available/changeable, if the MQTT connection is enabled in the hub options.

Important

The AC output limit setting may not be applied or display properly due to unknown Api query/parameter that may be required. See Solarbank station controls.

• PPS and power charger device controls as documented in supported devices (#264, #115):

  • LED switch and mode, Display switch, mode and timeout
  • AC/DC switches and limits, SOC limit settings
  • Device timeouts, AC/DC Output timeouts
  • Temperature unit selection
• 

• Anker Smart Plug control and real time sensor for power and energy (#150):

  • Plug switch added to control the plug in HA
  • Voltage and Current attributes have been added to power sensor
  • Use MQTT Overlay and automate MQTT status requests for the plug if you want to refresh power data in customized intervals
  • Plug related timer and schedule messages are not fully understood yet. As device owner you can contribute in their description to provide sensors for active timer as well

Important

Other MQTT controls than the plug switch will not be implemented. The MQTT command structures for plug timers and schedules are too complex and not understood. All timer and schedule based controls of the plug can be realized with HA automations and there is no need for additional plug control by the integration.

• Changed and enhanced controls for Multisystems (#423, #392, #310):

  • All usage mode and output related controls are moved from multiple Solarbanks to single Power Dock device (see breaking changes)🔥
  • Added MQTT control support for station settings that must be applied to Power Docks as well
  • Added MQTT power sensors for attached Solarbanks, showing also SN and SOC in attributes
  • See more details under Solarbank station controls🔀
  • 

• Updated MQTT data mapping with additional information provided by device owners. This may provide additional entities or attributes for following devices

  • Solarbank 2 models, Solarbank 3 models
  • Power Dock
  • Prime Charger
  • Anker Smart plugs
  • PPS C1000 Gen 2
  • PPS C300(X) AC/DC models

• The Api library added device and battery efficiency calculations for Solarbank 2 and 3 models if required MQTT data is provided

  • Device efficiency = (all output energy / all input energy) * 100%
  • Battery efficiency = (all discharged energy / all charged energy) * 100%
  • The provided MQTT energies are totals aggregated by the device since installation and more accurate than cloud tracked energies
  • Anker may reduce consumed energy from aggregated PV and charged energies. Identified consumed energy will be added to input and charged energy for more realistic efficiency calculations.
  • Details for SB2 calculations have been discussed in this issue.
  • Example calculations:
  

Note

The device energy related entities require that you remove the appropriate energy category from excluded category selection in your hub option settings. All device energies are excluded per default.

• Updated README and INFO documentation
  • Limitations
  • Supported sensors and devices
  • Solarbank 2 devices and Smart Meters
  • Solarbank 2 AC devices
  • Combined Solarbank 2 systems containing cascaded Solarbank 1 devices
  • Solarbank 3 devices
  • Solarbank Multisystem with Power Dock
  • Solarbank station controls🌟
  • MQTT managed devices
  • Dynamic Price Provider selection
  • MQTT connection and integration

Breaking changes: 💥

• Solarbank Multisystems with Power Dock:
  • Solarbank controls that may affect multiple devices in a system are now consolidated under the Power Dock device for multi systems (#423, #392):
    • All schedule object related settings, like output preset, usage mode, backup load controls, Time of Use plan controls etc
    • SOC reserve setting, which cannot be controlled individually in multi systems
    • (New) grid export settings, which cannot be controlled individually in multi systems
  • This eliminates duplicated entities that control the same settings on various ...