2.4.1

New Release 2.4.1 with minor fixes for 2.4.0

Enhancements:

None

See 2.4.0 release notes for all enhancement details

Breaking changes:

None

Fixes and other changes:

• Update INFO Documentation to latest changes and enhancements
• Fix some German translations
• Fix proper version display for integration
• Bump ruff from 0.8.4 to 0.8.6 by @dependabot in #180

Full Changelog: 2.4.0...2.4.1

2.4.0

New Release 2.4.0 with a few enhancements

Enhancements:

• Add support for new Solarbank discharge priority switch #173
  

  • This new switch entity will only become available when the owner account is used and all Solarbank 1 devices in the system are on required FW level 2.0.9 or higher to support this new feature
  • Anker App 3.3.2 or later is required to modify this new setting via the Anker App
  • The switch entity will represent the actual discharge priority setting according to the active schedule time slot settings. Any change of the entity will update the schedule accordingly for the current time slot

• The solarbank schedule actions have been updated to support the optional discharge priority switch setting as well

  • Like other Solarbank 1 time slot fields, the new discharge priority field is optional
  • Per default the discharge priority will be disabled if a new time slot is being created/added
  • Existing slot settings will be re-used if the option is not specified
  • The given discharge priority option will be ignored if the setting is not supported yet by the system

• INFO Documentation was changed to provide updated script examples for Solarbank 1 schedule modifications and for mark down cards showing the Solarbank 1 schedules with this additional setting option
  

Breaking changes:

None

Fixes and other changes:

• Entity registrations not being updated after re-enabling Api refresh switch #172
  • Previously, when the owner account was used in the integration and the Api refresh switch was temporarily disabled to use the same account for activities in the Anker App, the reactivation of the Api refresh switch did not clear the Api cache or register any new entities, which may have been configured via the Anker App meanwhile
  • A manual reload of the integration entry was needed to refresh the cache and register any new entities for the account connection.
  • Starting with 2.4.0, the reactivation of the Api refresh switch will behave similar to an integration entry reload action.
  • Any removed or renamed devices or systems will be recognized and declared as removed entities, new entities will be created as found for the account.
  • This change prevents seeing active but stale/obsolete entities in case system or device reconfiguration has been made via the App while the HA integration entry was not being reloaded
  • That means you can now also briefly disable and re-enable the Api refresh switch to trigger a complete refresh for your account systems and devices and update the available entities accordingly.
  • Attention: The refresh after switch activation may run a couple of seconds and needs to process all initial Api queries to scan your Anker cloud account. Do not use the switch toggle repetitively in short time periods.
• Fix deprecated warning for setting option flow config_entry explicitly #164
  • config_entry will only be set explicitly if HA version < 2024.11.99
• Bump ruff from 0.7.4 to 0.8.0 by @dependabot in #170
• Bump ruff from 0.8.0 to 0.8.1 by @dependabot in #171
• Bump ruff from 0.8.1 to 0.8.2 by @dependabot in #174
• Bump softprops/action-gh-release from 2.1.0 to 2.2.0 by @dependabot in #176
• Bump ruff from 0.8.2 to 0.8.3 by @dependabot in #177
• Bump ruff from 0.8.3 to 0.8.4 by @dependabot in #178

Full Changelog: 2.3.0...2.4.0

Notes:

• The daily battery discharge statistic value for Solarbank 1 is no longer correct since mid June 2024. The cloud statistics changed this value when introducing support for Solarbank 2. The daily battery discharge value for Solarbank 1 now includes also bypassed PV energy, so it is not longer dedicated to battery discharge only. You can see this wrong value also in your Anker App statistics for the battery.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from nominal battery capacity and SOC. Changes of this entity should NOT be considered for energy dashboard helper sensors, since this sensor can never reflect the battery efficiency or loss of capacity over time.
• For such and other reasons, 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.

Contribution:

• YOUR HELP is required if you have new Anker Solix systems 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.

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.

2.3.0

New Release 2.3.0 with a couple of exciting enhancements

Enhancements:

• Restructured the device model topology for an Anker hub representation #141

  • So far, only defined power systems and connected end devices accessible by the configured hub account have been structured into device types by the integration
    • This had the disadvantage, that common account related entities had no direct owning device type, but where duplicated under each system accessible by the account
    • Also stand alone Solix devices had no direct home
    • For users with multiple hub entries or multiple systems per account, the Anker cloud topology could not be properly reflected in HA
  • Therefore a new device type (Model) for the hub account was implemented
    
  • The account device manages all system devices (power sites) where your account has access to
    
  • Solix devices which are assigned to a system continue to be owned by the system device
  • Solix devices which are not assigned to a system (stand alone devices), are now owned by the new account device.
    • This allows to recognize by which of the hub entries the stand alone device is managed
    • Note: Keep in mind that stand alone Solix devices do not provide any utilization data to the cloud and have barely entities that can be monitored or managed via cloud Api

• Improved device information

  • Added proper device name in end device info if name is not available from standard Api responses
  • Added system type description, derived from main device type category that is configured into a power system
  • Added email, api server and alias name to the account model
    • Account related entities have been moved to the account device
    • Their entity name will now contain your account alias and country code

• Added partial support for Power Panel systems as supported in US marked (not supported on EU cloud server)

  • Added support for daily energy statistic entities
  • Added support for system total metrics, which must be queried from another Api endpoint specific for power panels
    
  • Added work around to extract last 5 min average power and SOC values from today's energy statistics for the Power Panel device
    • This is the only power information that was found in the cloud so far.
    • The value is lagging 5-8 minutes behind and is the 5 min average power only
    • Consider it as the last data point that becomes visible in your mobile app diagrams for today. The data time stamp is provided as well
      

• Changed service description structure to match new schema #139

  • New schema was introduced with HA core 2024.9.0, which became new minimum version for the integration
  • Structured the various options of some actions into sections with descriptions where this makes sense
    • This only affects the action representation in UI mode usage
  • Introduced section icons

• Added a new option to the get system info action to allow merge of additional system data from Api cache with the new response of the scen_info request

• Picked up enhancements from Api library v2.3.0

  • Added Api request metrics to Api refresh switch entity attributes
    
  • Added OTA component info to attributes of OTA update binary sensor
    • The children field will contain a list with a dictionary for each component
      
  • Added new Solarbank 2 entity for heating power
    • This is still experimental, since it is a new field introduced along the support of new Solarbank 2 AC
    • It is not clear if and how the heating power will be reported to the cloud, and if all Solarbank 2 types will support this upon certain firmware levels
    • If you start seeing heating power in the Anker mobile app, there are good chances that the heating power will be reflected in HA as well
  • Added Solarbank charging status description for new code 116, which seems to be used instead of code 4 (wakeup)
    • Since this seems to be used only at cold temperatures, it will be named cold_wakeup
      

• Bumped Api export tool to 2.3.0.0

Breaking changes:

• Moved following entities due to device topology change
  • binary_sensor for unread messages of the account moved from system to new account device to avoid duplication
  • switch for Api refresh moved from system to new account device to avoid duplication
• Changed target entity for Export Systems action (service) due to device topology change
  • Since everything for your account will be exported by this service, it does not make sense to select a dedicated system entity for the export
  • The target for the action now requires the single Api refresh switch entity of the new account device type
• Renamed some daily energy sensors to support a broader spectrum of Anker Solix devices and avoid confusion in the naming
  • "Daily AC to home" => "Daily battery home"
    • This should typically be the AC energy delivered to the house from the battery
  • "Daily grid import" => "Daily grid home"
    • Former "Daily grid import" naming must be used for the combination of grid charging energy and grid home usage energy.
    • Note: For Solarbank systems, it is not clear yet whether the new AC model will distinguish between grid home and grid charging energy, and what the meaning of the existing grid import energy value will become. For now it is assumed this is the grid home energy
• Attention:
  • Renamed entities means that you will see orphaned entities after the update.
    • Also their history may be lost, since their unique ID may had to be changed as well
  • Recommendation: You can reconfigure your Hub entries to clear orphaned entities automatically instead of removing them manually
    • When reconfirming your account access, all devices and entities will be unregistered and recreated with the new names
    • Orphaned entities will be removed automatically
    • Note: Any entities that have been manually deactivated will become active again. In other words they will be recreated based on actual exclusion categories and default activation setting.
  • You need to modify the moved entity names in your dashboard, automations, scripts and helpers if you used any of them
• New device pictures have been added.
  • Optionally update the device pictures for your entities if you want to make use of them.
  • You can copy the new images folder after integration update and prior HA restart by using a File Explorer add on
  • See the description in the update procedure.
  • Make sure to reload your HA dashboard without cache after HA restart to ensure the new images will be utilized in the UI frontend
• Increased minimum HA version to 2024.9.0 to support changed service schema descriptions and sections

Fixes and other changes:

• Block actions when Api usage is deactivated by the switch entity #163
  • Previously, when an action was run while the Api usage was deactivated for temporary account usage on another device, the action could have kicked out the account on the other device
• Bump api library to 2.3.0
• Bump ruff from 0.7.1 to 0.7.2 #156
• Bump ruff from 0.7.2 to 0.7.4 #167
• Bump colorlog from 6.7.0 to 6.9.0 #155
• Bump softprops/action-gh-release from 2.0.8 to 2.0.9 #157
• Bump softprops/action-gh-release from 2.0.9 to 2.1.0 #166

Notes:

• The daily battery discharge statistic value for Solarbank 1 is no longer correct since mid June 2024. The cloud statistics changed this value when introducing support for Solarbank 2. The daily battery discharge value for Solarbank 1 now includes also bypassed PV energy, so it is not longer dedicated to battery discharge only. You can see this wrong value also in your Anker App statistics for the battery.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from nominal battery capacity and SOC. Changes of this entity should NOT be considered for energy dashboard helper sensors, since this sensor can never reflect the battery efficiency or loss of capacity over time.
• For such and other reasons, 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.

Contribution:

• YOUR HELP is required if you have new Anker Solix systems 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 Ap...

2.2.0

New Release 2.2.0 with a lot of enhancements

Breaking changes:

• Adopted use of new device model ID in device description Info

  • Was introduced in HA 2024.8.0 which is the new minimum version for the integration
  • See HA developer blog Model ID attribute for Device Info

• New device pictures have been added.

  • Optionally update the device pictures for your entities if you want to make use of them.
  • You can copy the new images folder after integration update and prior HA restart by using a File Explorer add on
  • See the description in the update procedure.
  • Make sure to reload your HA dashboard without cache after HA restart to ensure the new images will be utilized in the UI frontend

Enhancements:

• Added support for Shelly smart meter 3EM and 3EM Pro when they are configured in a power system with Solarbank 2, #152
  

  • The reported entities and values are similar to how the Anker Smart meter entities are provided
  • When a Shelly smart meter is configured into the power system and the Integration is using the system owner account, the smart meter usage mode can now also be configured in the integration
  • Thanks to @koehntopp for providing exports and confirming functionality

• Added support for Anker Smart plugs when they are configured in a power system with Solarbank 2. #149

  

  • The smart plug total power and energy will be provided as system entities

  • The other load power in the system entities reflects the added output power during smart plug usage mode according to the blend plan settings in the schedule

  • Individual plug power and energy entities will be provided along other standard device entities

  • The smart plug mode can be set in the solarbank 2 usage mode entity when using a system owner account in the integration and smart plugs are configured in the system

  • Thanks to @rwe87 and @steghoja for providing required system exports and confirming usage of blend plan for smart plugs
    

  • The device entity for system output power preset will change the additional load in the blend plan of the schedule that will be added immediately to the measured smart plug total power when the smart plug usage mode is active. If the smart plug usage mode is not active, this entity will modify the actual manual system output preset in the custom rate plan as previously. The manual system output preset however is only applied when manual usage mode is active or smart meter mode is active but smart meter has lost connection to the solarbank.

  • NOTE: Individual smart plug settings have not been discovered yet in the cloud api. YOUR HELP is needed if you have such devices and you are willing to explore existing or new queries and parameters to identify additional smart plug information or setting capabilities.

    • See also Add support for individual smart plug device settings (switch, timer, schedule) #150

• Added support to modify the blend plan in the solarbank 2 schedule (this plan is used for smart plug usage mode)

  • All schedule based actions (services) have been updated with an additional option of the plan that should be modified with the action
  • If no plan is provided with the action options, the active plan according to the active usage mode will be modified.
    

• Picked up enhancements from Api library for new rssi field of devices and proper allocation of signal strength to individual devices

  • Previous devices typically reported the Wifi signal strength in %, but newer devices did not report that at all. Furthermore the signals could not be allocated to a specific device.
  • The wifi_list query now returns also rssi values for newer devices that are supporting it. Furthermore it reports the signal values per device SN, which allows proper signal allocation per device
  • Although the rssi value is typically a relative index value, the Anker cloud seems to report a negative absolute value which typically is the signal dBm
  • The api library uses the rssi dBm value to calculate the signal strength % if not provided by the device, where higher dBm values mean better signal strength
  • Following range is considered for the calculation: Between -50 dBm (100 %) and -85 dBm (0 %)
  • The rssi information was added as further attribute to the Wifi entity
  • The additional information and proper allocation per device now allow better tracking of Wifi signal strength in the Integration
    

• Reintroduced OTA update binary sensor with enhancements from Api library for new ota_batch query
  

  • This query seems to provide latest available OTA versions for a list of provided devices
  • It also contains children structures (like for Solarbank battery packs), however the possible response structures are not fully understood yet, so proper OTA version parsing is very limited
  • The available OTA version will be listed in the OTA update entity attributes
    
  • YOUR HELP is required to provide system exports when your main or sub devices are showing available updates.
    • The more examples can be provided, the better the response accuracy and structures can be validated for proper information parsing.
    • You can upload valuable exports as system owner to the Api library issue 138.

• Updated script to modify solarbank 2 schedule and added the new plan option.

• Updated dashboard markdown card to display solarbank 2 schedule

  • Now includes the blend plan if defined
  • The active slot in currently used plan is highlighted appropriately
    

• Updated README and INFO with new device support and related information of this release.

• Bumped Api export tool to 2.2.1.0 with additional queries and new endpoint categories for the system export action

  • Added ota_batch query to get available OTA versions for a list of devices
  • Removed previous OTA queries since they did not work for every device
  • Added queries for charging_service endpoints as used for Power Panel sites (currently not supported in EU market or cloud Api servers)
  • Added queries for hes_svc_charging_service endpoints as used for Home Energy Systems like X1
  • The new endpoint categories will be processed only if corresponding power site types are found for the account
  • NOTE: The endpoints may not be supported on every cloud server or may require additional parameters that are unknown at this point and therefore trigger request errors in the logs during the export action
  • YOUR HELP is required if you have such new systems and you are willing to explore those new queries and parameters to enhance product support of the underlying Api library.

Fixes and other changes:

• Removed device label sensor when devices not really using it #151
  • Currently only the smart plugs are using labels (tags)
  • Device label entities can still be generally excluded from the integration by the options of your configuration entry
  • Note: You may have to remove the unused label entity manually after integration update. Optionally you can reconfigure and just confirm your integration account to have all device entities unregistered and recreated.
• Bump api library to 2.2.1 #137
• Bump ruff from 0.6.5 to 0.6.7 #128
• Bump ruff from 0.6.7 to 0.6.8 #131
• Bump ruff from 0.6.8 to 0.6.9 #133
• Bump ruff from 0.6.9 to 0.7.0 #142
• Bump ruff from 0.7.0 to 0.7.1 #147
• Bump actions/checkout from 4.2.0 to 4.2.1 #131
• Bump actions/checkout from 4.2.1 to 4.2.2 #144
• Bump actions/setup-python from 5.2.0 to 5.3.0 #145
• Update pip requirement from <24.3,>=21.0 to >=21.0,<24.4 #146

Notes:

• The daily battery discharge statistic value for Solarbank 1 is no longer correct since mid June 2024. The cloud statistics changed this value when introducing support for Solarbank 2. The daily battery discharge value for Solarbank 1 now includes also bypassed PV energy, so it is not longer dedicated to battery discharge only. You can see this wrong value also in your Anker App statistics for the battery.
• The device sensor for battery energy is just a theoretical value and calculated by the Api library from nominal battery capacity and SOC. **Changes of this entity should NOT be consid...

2.1.2

New Release 2.1.2 with some fixes and enhancements

Breaking changes:

• None

Enhancements:

• Added new service to create an Api export from your assigned systems and devices in the configured Anker account #116
  • This capability was already available as stand alone tool in the Anker Solix Api library and helps to provide an overview of Api responses for various system constellations and situations.
  • Such exports are required to understand the Api behavior, debug issues and develop enhancements upon Api changes.
  • The Api responses will be anonymized and saved into JSON files in an export folder that is created for the nickname of your Api connection
  • The export folder will also be zipped and the service response will provide the url path to the zipped file
  • You can directly download the zip file from your HA server through your browser by extending the server url with the url filename path from the service response
  • Future exports will clear and re-use an existing nickname export folder, but each zip file will have its own filename to keep an export history
  • Old zip files are located in www/community/anker_solix/exports and can be deleted manually with a File Manager Add-On (e.g. File Editor or VSC) if you have no direct file system access to your HA server
• Bump Api library to 2.1.2 #127

Fixes:

• Reduced situations when devices are unregistered during integration reloads or configuration option changes to reduce an automated reactivation of manually deactivated entities, which will be reset to integration defaults upon new registration of devices #114, #118
  • Unregistering devices is a necessary step to clear orphaned entities upon account changes or exclude category changes. Also system or device renaming actions in the Anker App can cause orphaned entities in your integration.
  • The unregistration will clear the whole device and all associated (orphaned) entities, to register only the provided entities from the Api responses again
  • When devices are registered again, they will pickup previous deleted entities due to same unique_id which is based on device SN and an entity key. However, when not excluded by the configuration options, the entities will be enabled with the default integration settings, which is enabled for all entities except the device bws_surplus entity (The purpose of this entity is not clear and its always 0).
  • Any user disabled entities will be reactivated based on HA core design, like also entity_id naming could change on registration based on HA core rules. The entity_id is automatically composed by device name (alias) and the translated entity key.
  • The improvement will now unregister devices only for following situations:
    • Added any new exclude category when changing configuration entry options. The affected devices for the additional exclude category are unregistered since they must be registered again with less entities.
    • A confirmed reconfiguration of an integration entry (Anker account). This is to ensure changed accounts with less entities don't leave orphaned entities.
    • Even if the account user remains the same during the reconfiguration confirmation, all devices of the configuration entry will be unregistered. This provides a fallback option to enforce a new registration of all devices. Alternatively, the whole configuration entry would have to be deleted and re-created to achieve the same.
  • Therefore a simple configuration entry reload or HA restart will no longer trigger any device unregistration.
• Replace os module with pathlib module #126
• Bump ruff from 0.6.1 to 0.6.2 #113
• Bump ruff from 0.6.2 to 0.6.3 #119
• Bump ruff from 0.6.3 to 0.6.4 #124
• Bump ruff from 0.6.4 to 0.6.5 #125
• Bump actions/setup-python from 5.1.1 to 5.2.0 #120

Notes:

• Since there have been more and more questions on how to integrate the solarbank into the HA energy dashboard (#100 #104), a reference to the corresponding discussion post #16 has been added to the resources in README .
• I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is now 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.
• The daily battery discharge statistic value is no longer correct. The cloud statistics changed this value in June 2024 when introducing support for Solarbank 2. The daily battery discharge value for Solarbank 1 now includes also bypassed PV energy, so it is not longer dedicated to battery discharge only. You can see this wrong value also in your Anker App statistics for the battery.

2.1.1

New Release 2.1.1 for required documentation and link updates due to renaming of the git repository to ha-anker-solix

• Rename became required to get the repo added to HACS default repositories in future
• If you added the old custom HACS repo to HA, this link should automatically be redirected to the changed repo name. If it would not, you would not get notified automatically about this 2.1.1 release

New Release 2.1.0 with Solarbank 2 home load preset & schedule support and simplified integration account reconfiguration

Breaking changes:

• Increased min. HA version to 2024.4.0 to support reconfiguration of account used in active configuration #110

Enhancements:

• Full Support for Solarbank 2 schedule modifications to complete enhancements for Solarbank 2 #60 #112
  • The system output preset entity is now also available for Solarbank 2 devices when the integration configuration uses the Anker owner account
    • It can be used to adjust the SB2 output directly when the Manual usage mode is active
  • In the backend, any adjustment of the preset or the usage mode will always result in 2 api requests to update and verify the required schedule structure on the SB2 via the cloud api
    • Subsequent value increases either directly or via services (now actions) will therefore have a cool down of 30 seconds to avoid uncontrolled stress to the api by UI usage or HA automation (identically to the schedule support implementation for SB1)
  • All schedule services (now actions) have been enhanced with an optional week_day field to support SB2 time interval adjustments
    • The new field is ignored for SB1 schedule services, like the SB1 specific fields are ignored for SB2 schedule services (actions)
  • The resulting changes and usage implications are described in the INFO
• Simplified switching of your Anker account used for the integration #110
  • Previously, you had to delete the active configuration and recreate a new configuration with you other Anker account if you wanted to switch seamlessly between your main and shared account
  • Since HA 2024.4.0, there is support to reconfigure static parameters of an active configuration, such as account information for example
  • Support for reconfiguration was now added to the integration. You can now reconfigure the used account via the configuration entry menu item 'Reconfigure...' as described here
• Added support for new tag field reported by devices (Label entity)
  • The Api cloud introduced a new tag field for devices, mainly to support the new smart plugs and allow to tag/label them to a location/room in the house. This tag is used in the Anker app to display a proper icon for the device to indicate its location to the user.
  • This field may be empty or use a senseless default value for devices that do not really make use of the new tag field in the Anker App, like solarbank or smart meter devices
  • You can deactivate this entity individually for your devices if not needed, or optionally exclude the device labels category completely in the options of your integration configuration entry
  • If you have Anker smart plugs however, you may want to see their tag/label too. Eventually this new tagging mechanism will be supported in the Anker app for additional devices in future and that might be the reason why this field was added to most of the devices.
  • Note: Translation for the new label entity state (tag) is not provided since it is not clear which tags will be supported now and in future.
• Added more guideline posts to discussions section of the repo
  • How to integrate the Solarbank into your Energy Dashboard
  • How to automate Solarbank Gen 1 for dynamic home load export using the battery only as surplus buffer
  • How to create template entities to track battery health and efficiency
• Updated README and INFO with changes for Solarbank 2 schedule support and added further references for related blogs and videos
  • Thanks to @TheRealSimon42 for his first contribution and providing additional resources for usage of the integration
  • Thanks also to @thealkly for his previous contributions to the repo and his videos for usage of the integration

Fixes:

• Adjusted home load helper methods for SB1 and SB2 to prevent existing gaps in the schedule are automatically filled up when inserting or adjusting a slot that has start and end times provided.
• For Pre-release 2.0.2: Changed appliance_load minimum to 0 W for schedule services usability with SB2 (#107)
• Bump ruff from 0.5.5 to 0.5.6 #103
• Bump ruff from 0.5.6 to 0.57 #106
• Bump ruff from 0.5.7 to 0.6.1 #111

Note:

Since there have been more and more questions on how to integrate the solarbank into the HA energy dashboard (#100 #104), a reference to the corresponding discussion post #16 has been added to the resources in README .
I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is now 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.

2.1.0

New Release 2.1.0 with Solarbank 2 home load preset & schedule support and simplified integration account reconfiguration

Breaking changes:

• Increased min. HA version to 2024.4.0 to support reconfiguration of account used in active configuration #110

Enhancements:

• Full Support for Solarbank 2 schedule modifications to complete enhancements for Solarbank 2 #60 #112
  • The system output preset entity is now also available for Solarbank 2 devices when the integration configuration uses the Anker owner account
    • It can be used to adjust the SB2 output directly when the Manual usage mode is active
  • In the backend, any adjustment of the preset or the usage mode will always result in 2 api requests to update and verify the required schedule structure on the SB2 via the cloud api
    • Subsequent value increases either directly or via services (now actions) will therefore have a cool down of 30 seconds to avoid uncontrolled stress to the api by UI usage or HA automation (identically to the schedule support implementation for SB1)
  • All schedule services (now actions) have been enhanced with an optional week_day field to support SB2 time interval adjustments
    • The new field is ignored for SB1 schedule services, like the SB1 specific fields are ignored for SB2 schedule services (actions)
  • The resulting changes and usage implications are described in the INFO
• Simplified switching of your Anker account used for the integration #110
  • Previously, you had to delete the active configuration and recreate a new configuration with you other Anker account if you wanted to switch seamlessly between your main and shared account
  • Since HA 2024.4.0, there is support to reconfigure static parameters of an active configuration, such as account information for example
  • Support for reconfiguration was now added to the integration. You can now reconfigure the used account via the configuration entry menu item 'Reconfigure...' as described here
• Added support for new tag field reported by devices (Label entity)
  • The Api cloud introduced a new tag field for devices, mainly to support the new smart plugs and allow to tag/label them to a location/room in the house. This tag is used in the Anker app to display a proper icon for the device to indicate its location to the user.
  • This field may be empty or use a senseless default value for devices that do not really make use of the new tag field in the Anker App, like solarbank or smart meter devices
  • You can deactivate this entity individually for your devices if not needed, or optionally exclude the device labels category completely in the options of your integration configuration entry
  • If you have Anker smart plugs however, you may want to see their tag/label too. Eventually this new tagging mechanism will be supported in the Anker app for additional devices in future and that might be the reason why this field was added to most of the devices.
  • Note: Translation for the new label entity state (tag) is not provided since it is not clear which tags will be supported now and in future.
• Added more guideline posts to discussions section of the repo
  • How to integrate the Solarbank into your Energy Dashboard
  • How to automate Solarbank Gen 1 for dynamic home load export using the battery only as surplus buffer
  • How to create template entities to track battery health and efficiency
• Updated README and INFO with changes for Solarbank 2 schedule support and added further references for related blogs and videos
  • Thanks to @TheRealSimon42 for his first contribution and providing additional resources for usage of the integration
  • Thanks also to @thealkly for his previous contributions to the repo and his videos for usage of the integration

Fixes:

• Adjusted home load helper methods for SB1 and SB2 to prevent existing gaps in the schedule are automatically filled up when inserting or adjusting a slot that has start and end times provided.
• For Pre-release 2.0.2: Changed appliance_load minimum to 0 W for schedule services usability with SB2 (#107)
• Bump ruff from 0.5.5 to 0.5.6 #103
• Bump ruff from 0.5.6 to 0.57 #106
• Bump ruff from 0.5.7 to 0.6.1 #111

Note:

Since there have been more and more questions on how to integrate the solarbank into the HA energy dashboard (#100 #104), a reference to the corresponding discussion post #16 has been added to the resources in README .
I do NOT recommend to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is now 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.

2.0.2

New Pre-release 2.0.2

Breaking changes:

• None

Enhancements:

• Full Support for Solarbank 2 schedule modifications to complete enhancements for Solarbank 2 #60
  • The system output preset entity is now also available for Solarbank 2 devices when the integration configuration uses the Anker owner account
    • It can be used to adjust the SB2 output directly when the Manual usage mode is active
  • In the backend, any adjustment of the preset or the usage mode will always result in 2 api requests to update and verify the required schedule structure on the SB2 via the cloud api
    • Subsequent value increases either directly or via services (now actions) will therefore have a cool down of 30 seconds to avoid uncontrolled stress to the api by UI usage or HA automation (identically to the schedule support implementation for SB1)
  • All schedule services (now actions) have been enhanced with an optional week_day field to support SB2 time interval adjustments
    • The new field is ignored for SB1 schedule services, like the SB1 specific fields are ignored for SB2 schedule services (actions)
  • The resulting changes and usage implications are described in the INFO
• Updated README and INFO with changes for Solarbank 2 schedule support and added further references for related blogs and videos
  • Thanks to @TheRealSimon42 for his first contribution and providing additional resources for usage of the integration
  • Thanks also to @thealkly for his previous contributions to the repo and his videos for usage of the integration

Fixes:

• Adjusted home load helper methods for SB1 and SB2 to prevent existing gaps in the schedule are automatically filled up when inserting or adjusting a slot that has start and end times provided.
• Bump ruff from 0.5.5 to 0.5.6 #103

Note:

Since there have been more and more questions on how to integrate the solarbank into the HA energy dashboard (#100 #104), a reference to the corresponding discussion post #16 has been added to the resources in README .
I dot NOT recommended to use the Anker Solix integration daily energy statistic sensors directly in your energy dashboard, even if that is now possible since they are classified as total_increasing sensors. The reasons for this 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.

2.0.1

New release 2.0.1

Breaking changes:

• Moved all energy statistic related entities to the system device
  • This became necessary after discovering that all energy statistics tracked on the cloud are only available as totals per device type in a power system.
  • That means for dual Solarbank 1 power systems, you get only the total charge, discharge and solar energy values, but no break down per device. As logical consequence, the whole energy Api methods had to be restructured to query also additional smart meter and Solarbank 2 statistics and it became necessary to track all energy with the system device instead.
• This will have an impact to your existing device energy entities since their unique ID as well as their name and entity ID will change.
  • In case you directly used any of them in your energy dashboard directly, you have to replace them after the integration update from releases before 2.0.0.
  • The energy history will be lost when switching entities in the energy dashboard.
    • For that reason, I recommend to use only template or helper entities from real devices or integration entities in the energy dashboard
    • Then you never have to replace the energy dashboard entity itself, but only modify the helper or template accordingly upon breaking changes
    • If you need to migrate the history from one entity to another one, this community post may help. Basically you need to modify the DB structures with SQL depending on the DB type that you use for Home Assistant. It is complex, but doable with some SQL skills and lot of caution (create HA backup upfront and stop the recorder via the HA service to avoid potential DB corruptions when applying DB changes in a running system via an Add On).
  • The helper and template entities, as well as automation and scripts using any of the energy entities must be updated as well.
  • This change does NOT effect the total yield which was always tracked with the system device, but all previous device energy related entities
  • You may have to remove old energy entities from your devices manually since they are no longer provided by the integration. Check all your Anker Solix devices for entities no longer provided.
• Changed the state class of all energy stat entities from total to total_increasing #100
  • This should only be relevant if you use those entities directly in your energy dashboard, which I would NOT recommend as discussed here.
• Removed the OTA update binary sensor since this query does not work for all devices and for Solarbank 1 is does not reflect available updates reliably
• Updated optional entity pictures
  • In case you utilize the optional integration entity pictures, after installing the update you need to repeat the manual copy of the integration images subfolder to your www folder.
  • See the README for instructions

Breaking changes since Pre-Release 2.0.0:

• Changed option names for Solarbank 2 power usage mode select entity to support various types of automatic modes
  • The previous automatic mode was changed to smartmeter
  • A new automatic mode was added for smartplugs

Enhancements:

• Support for Solarbank 2 devices #60 #77 #83
  • Added all new entities available via cloud api
  • Added select entity for power usage mode when smart meter is installed
  • Added new energy statistics to system device
• Support for Smart Meter devices #83
  • Added all new entities available via cloud api
• Enhanced configuration options
  • The former 0 W value reporting for Solarbank 2 and smart meter devices is completely avoided #89
  • Instead of 0 values, unavailable entities will now signal invalid Api data responses, which allows history tracking for invalid data
  • Added new option to skip invalid/stale Api value responses to avoid entities become unavailable most of the time. When enabling this option, you also loose tracking capabilities for invalid data periods. Only valid data responses (every 5 minutes or less frequently) will cause updates of affected entities.
  • Added device type and energy type exclude options to configuration options
  • All energy statistics are excluded per default from new configurations since they may need significantly more Api requests during the device refresh interval.
• Bump ruff from 0.5.1 to 0.5.2 #86
• Bump ruff from 0.5.2 to 0.5.4 #90
• Bump ruff from 0.5.4 to 0.5.5 #99
• Bump actions/setup-python from 5.1.0 to 5.1.1 #87
• Update pip requirement from <24.2,>=21.0 to >=21.0,<24.3 #98
• Updated README and INFO with changes for Solarbank 2 and smart meter devices

Fixes:

• Optimized the schedule update sequence to limit the number of required requests to 2 per update
• Removed the OTA update binary sensor since this query does not work for all devices and for Solarbank 1 is does not reflect available updates reliably
• Only the applicable options will now be available for the Solarbank 2 power usage mode select entity, depending on the installed device types for the system
  • If you add a smart meter or smart plug devices to the system, you have to reload the HA configuration entry to reconfigure the possible entity options accordingly
• Changed the state class of all energy stat entities from total to total_increasing #100
  • This should allow the recorder to properly build sums for short and long term statistics as described in the documentation examples
  • However it might also cause incorrect cycle resets and wrong statistics upon erroneous data provided by the cloud api.
  • It is NOT recommended to use the integration energy statistics directly in your energy dashboard for such and other reasons.

2.0.0

New release 2.0.0

Breaking changes:

• Moved all energy statistic related entities to the system device
  • This became necessary after discovering that all energy statistics tracked on the cloud are only available as totals per device type in a power system.
  • That means for dual Solarbank 1 power systems, you get only the total charge, discharge and solar energy values, but no break down per device. As logical consequence, the whole energy Api methods had to be restructured to query also additional smart meter and Solarbank 2 statistics and it became necessary to track all energy with the system device instead.
• This will have an impact to your existing device energy entities since their unique ID as well as their name and entity ID will change.
  • In case you directly used any of them in your energy dashboard directly, you have to replace them after the integration update from releases before 2.0.0.
  • The energy history will be lost when switching entities in the energy dashboard.
    • For that reason, I recommend to use only template or helper entities from real devices or integration entities in the energy dashboard
    • Then you never have to replace the energy dashboard entity itself, but only modify the helper or template accordingly upon breaking changes
    • If you need to migrate the history from one entity to another one, this community post may help. Basically you need to modify the DB structures with SQL depending on the DB type that you use for Home Assistant. It is complex, but doable with some SQL skills and lot of caution (create HA backup upfront and stop the recorder via the HA service to avoid potential DB corruptions when applying DB changes in a running system via an Add On).
  • The helper and template entities, as well as automation and scripts using any of the energy entities must be updated as well.
  • This change does NOT effect the total yield which was always tracked with the system device, but all previous device energy related entities
  • You may have to remove old energy entities from your devices manually since they are no longer provided by the integration. Check all your Anker Solix devices for entities no longer provided.
• Updated optional entity pictures
  • In case you utilize the optional integration entity pictures, after installing the update you need to repeat the manual copy of the integration images subfolder to your www folder.
  • See the README for instructions

Enhancements:

• Support for Solarbank 2 devices #60 #77 #83
  • Added all new entities available via cloud api
  • Added select entity for power usage mode when smart meter is installed
  • Added new energy statistics to system device
• Support for Smart Meter devices #83
  • Added all new entities available via cloud api
• Enhanced configuration options
  • The former 0 W value reporting for Solarbank 2 and smart meter devices is completely avoided #89
  • Instead of 0 values, unavailable entities will now signal invalid Api data responses, which allows history tracking for invalid data
  • Added new option to skip invalid/stale Api value responses to avoid entities become unavailable most of the time. When enabling this option, you also loose tracking capabilities for invalid data periods. Only valid data responses (every 5 minutes or less frequently) will cause updates of affected entities.
  • Added device type and energy type exclude options to configuration options
  • All energy statistics are excluded per default from new configurations since they may need significantly more Api requests during the device refresh interval.
• Bump ruff from 0.5.1 to 0.5.2 #86
• Bump actions/setup-python from 5.1.0 to 5.1.1 #87
• Updated README and INFO with changes for Solarbank 2 and smart meter devices

Fixes:

• Optimized the schedule update sequence to limit the number of required requests to 3 per update.