v4.3.0

[autoSteve]

What's Changed?

• Add auto-update attributes to api_last_polled by @autoSteve
• Upgrade data files from v3 integration schema by @autoSteve (read: very old Oziee versions)
• Config and options flows check valid API key and sites available by @autoSteve
• Add re-auth and reconfigure flows by @autoSteve
• Add repair flows for forecasts not updating by @autoSteve
• Fetch estimated actuals on super-stale start by @autoSteve
• Set sensors to unavailable on integration failure by @autoSteve
• Catch duplicate API key being specified by @autoSteve
• Remove check for conflicting integration by @autoSteve
• Add integration and unit tests by @autoSteve
• Strict type checking by @autoSteve
• Add troubleshooting section in README.md by @autoSteve
• Updated issue template by @BJReplay

Issues fixed

• Fix an issue when half-hourly breakdown is disabled but hourly is enabled by @autoSteve
• Fix an issue with transitioning from granular to legacy dampening by @autoSteve
• Fix an issue with using multiple hard limits by @autoSteve
• Fix an issue with stale start when auto-update is enabled by @autoSteve
• Fix an issue of incorrect forecasts with notes to remove any sample sites from Solcast dashboard by @BJReplay

Full Changelog: v4.2.7...v4.3.0

[autoSteve]

The release notes don't really do this release justice in explaining just how much effort has gone into it.

We started with some pretty good code, then set out to tick every box in the HASS 'integration quality scale'. The highest level is Platinum. v4.3.0, while not a core integration should pass muster at a Platinum inspection.

If you look at the kind of things that are expected to achieve a Plat. rating they mostly relate to predictability, stability, high performance, extremely well tested code, and recoverability. Most of this also applies to Gold, but Plat. takes it one step further, requiring things like strict variable type checking.

When we started down this path we did not even tick all boxes of a Bronze quality level.

Here's the quality scale check list, and you can find the rules at https://developers.home-assistant.io/docs/core/integration-quality-scale/.

Bronze

• config-flow - Integration needs to be able to be set up via the UI
  • Uses data_description to give context to fields
  • Uses ConfigEntry.data and ConfigEntry.options correctly
• test-before-configure - Test a connection in the config flow
• unique-config-entry - Don't allow the same device or service to be able to be set up twice
• config-flow-test-coverage - Full test coverage for the config flow
• runtime-data - Use ConfigEntry.runtime_data to store runtime data
• test-before-setup - Check during integration initialization if we are able to set it up correctly
• appropriate-polling - If it's a polling integration, set an appropriate polling interval
• entity-unique-id - Entities have a unique ID
• has-entity-name - Entities use has_entity_name = True
• [N/A] entity-event-setup - Entities event setup
• [N/A] dependency-transparency - Dependency transparency
• action-setup - Service actions are registered in async_setup
• common-modules - Place common patterns in common modules
• docs-high-level-description - The documentation includes a high-level description of the integration brand, product, or service
• docs-installation-instructions - The documentation provides step-by-step installation instructions for the integration, including, if needed, prerequisites
• docs-removal-instructions - The documentation provides removal instructions
• docs-actions - The documentation describes the provided service actions that can be used
• brands - Has branding assets available for the integration

Silver

• config-entry-unloading - Support config entry unloading
• [N/A] log-when-unavailable - If internet/device/service is unavailable, log once when unavailable and once when back connected
• entity-unavailable - Mark entity unavailable if appropriate
• action-exceptions - Service actions raise exceptions when encountering failures
• reauthentication-flow - Reauthentication flow
• [N/A] parallel-updates - Set Parallel updates
• test-coverage - Above 95% test coverage for all integration modules
• integration-owner - Has an integration owner
• docs-installation-parameters - The documentation describes all integration installation parameters
• docs-configuration-parameters - The documentation describes all integration configuration options

Gold

• entity-translations - Entities have translated names
• entity-device-class - Entities use device classes where possible
• devices - The integration creates devices
• entity-category - Entities are assigned an appropriate EntityCategory
• entity-disabled-by-default - Integration disables less popular (or noisy) entities
• [N/A] discovery - Can be discovered
• [N/A] stale-devices - Clean up stale devices
• diagnostics - Implements diagnostics
• exception-translations - Exception messages are translatable
• icon-translations - Icon translations
• reconfiguration-flow - Integrations should have a reconfigure flow
• [N/A] dynamic-devices - Devices added after integration setup
• [N/A] discovery-update-info - Integration uses discovery info to update network information
• repair-issues - Repair issues and repair flows are used when user intervention is needed
• docs-use-cases - The documentation describes use cases to illustrate how this integration can be used
• [N/A] docs-supported-devices - The documentation describes known supported / unsupported devices
• docs-supported-functions - The documentation describes the supported functionality, including entities, and platforms
• docs-data-update - The documentation describes how data is updated
• docs-known-limitations - The documentation describes known limitations of the integration (not to be confused with bugs)
• docs-troubleshooting - The documentation provides troubleshooting information
• docs-examples - The documentation provides automation examples the user can use.

Platinum

• [N/A] async-dependency - Dependency is async
• [N/A] inject-websession - The integration dependency supports passing in a websession
• strict-typing - Strict typing

Notes on applicability

• entity-event-setup: Entity event are not used by the integration, so there is nothing to set up.
• dependency-transparency: The integration does not utilise an externally hosted dependency.
• log-when-unavailable: It is not desirable to log once when the Solcast REST API is unavailable and then once more when re-connected. Each interaction is atomic, and a connection is not held open.
• parallel-updates: Parallel updates of local devices are not applicable given the nature of the integration.
• discovery: Local devices are not used, so discovery of any is irrelevant.
• stale-devices: A single device is created for the integration instance. There can only be one instance.
• dynamic-devices: A single device is created for the integration instance. There can only be one instance.
• discovery-update-info: Local devices are not used, so updating network information is irrelevant.
• docs-supported-devices: Local devices are not used, and API variability is irrelevant.
• async-dependency: The integration does not utilise an externally hosted dependency.
• inject-websession: The integration does not utilise an externally hosted dependency.

[BJReplay]

Thanks @autoSteve for this amazing effort! Frankly, if I hadn't watched it happen, I would say that it was unbelievable - but having watched it, all I can say is that it was heroic.

I would encourage anyone who looks at this and thinks the same, to click on @autoSteve, and from his profile, click on Sponsor.

Thanks, Bloke.

[gcoan]

Huge amount of work done on this integration, I've seen the comments and tests going back and forth between @autoSteve and @BJReplay (who also deserves credit for the extensive testing).

This is no minor upgrade, over 12,000 lines of code changed in this release, I was beginning to wonder if the guys were forever in testing hell!!

Enjoy the release 🎉

[autoSteve]

And are we done yet?

I highly doubt it... 😂

Despite the quality and extensive scenarios synthetically tested today, there will still be things that go "pop".

Bring 'em! It will only enhance learning, enhancements and improvements to test code.

No test code can be considered 100% complete, unless the code being tested is just a dozen lines long with no branches or the author is a simpleton. We have many thousands of lines of code to cope with much, and I am not a simpleton. 😉

It has been a big call releasing this before I take off for Iceland late next week, but I am confident that it is good code. I will have my laptop on board and WiFi in the air, but may be somewhat distracted by natural wonders on arrival.

As Geoff said, enjoy. Hopefully that enjoyment is "enjoy the silence" of things just working, and this integration not being top-of-mind nor the subject of any issue. (Touches wood...)

Love y'all.

[Nilogax]

I have a confession to make. I saw this release update pop up, checked this thread and thought "12,000 lines of code affected? Think I'll wait for the issues to be resolved before I jump".

But... Nothing. Zip. Nada. Rien. Not a sausage.

I'm sorry I ever doubted you @autoSteve - I am duly impressed by this release!