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
- Added A1781 SOLIX F2600 data and controls (#300) (Thanks @kylekampy)
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 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 💖.
