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 propertysw_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)
- Added A1726/A1728 DC switch control (#531, #316) (Thanks @gimmers-eth)
-
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
- Add support for AC charge setting in custom and smart plug schedules (#538)
-
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
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:
- 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 💖.
