Mark flexit_bacnet as silver on the quality scale 🥈

[lellky]

Breaking change

Proposed change

Bump quality level to silver 🥈

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New integration (thank you!)
• New feature (which adds functionality to an existing integration)
• Deprecation (breaking change to happen in the future)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Bronze

• action-setup - Service actions are registered in async_setup
• appropriate-polling - If it's a polling integration, set an appropriate polling interval
• brands - Has branding assets available for the integration
• common-modules - Place common patterns in common modules
• config-flow-test-coverage - Full test coverage for the config flow
• 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
• dependency-transparency - Dependency transparency
• docs-actions - The documentation describes the provided service actions that can be used
• 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
• entity-event-setup - Entities event setup
• entity-unique-id - Entities have a unique ID
• has-entity-name - Entities use has_entity_name = True
• runtime-data - Use ConfigEntry.runtime_data to store runtime data
• test-before-configure - Test a connection in the config flow
• test-before-setup - Check during integration initialization if we are able to set it up correctly
• unique-config-entry - Don't allow the same device or service to be able to be set up twice

Silver

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

Gold

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

Platinum

• async-dependency - Dependency is async
• inject-websession - The integration dependency supports passing in a websession
• strict-typing - Strict typing

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue:
• Link to documentation pull request: Mark flexit_bacnet as silver on the quality scale home-assistant.io#37595
• Link to developer documentation pull request:
• Link to frontend pull request:

Checklist

• The code change is tested and works locally.
• Local tests pass. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist
• I have followed the perfect PR recommendations
• The code has been formatted using Ruff (ruff format homeassistant tests)
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly.
  Updated and included derived files by running: python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt.
  Updated by running python3 -m script.gen_requirements_all.
• For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[home-assistant]

Hey there @piotrbulinski, mind taking a look at this pull request as it has been labeled with an integration (flexit_bacnet) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of flexit_bacnet can trigger bot actions by commenting:

• @home-assistant close Closes the pull request.
• @home-assistant rename Awesome new title Renames the pull request.
• @home-assistant reopen Reopen the pull request.
• @home-assistant unassign flexit_bacnet Removes the current integration label and assignees on the pull request, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

[andrewsayre]

Nice work! Two things:

• docs-installation-parameters: I wasn't able to find the install parameters (ip_address and device_id) defined in the documentation. They should be in a {% configuration_basic %} section: https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-installation-parameters/
• parallel-updates: Not blocking, however PARALLEL_UPDATES is defined below async_setup_entry in all the platforms, reducing maintainability. Conventionally, modules are typically ordered by imports, constants, then classes and functions.

Thanks!
Andy

[home-assistant]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[andrewsayre]

Related question, why do some platforms have a PARALLEL_UPDATES of 0, while others are 1? Aren't they all being managed by the coordinator?

[andrewsayre]

Another item to address (from bronze):

• docs-removal-instructions: I couldn't find this in the documentation. https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-removal-instructions/

[lellky]

Hello, and thanks for reviewing @andrewsayre

• docs-installation-parameters, the installation parameters was added here: Add configuration_basic, move Add integration button to the top home-assistant.io#37435
• parallel-updates, I don't really know if I understand your question. I followed the example here: https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/parallel-updates/ and just added PARALLEL_UPDATES above class MySensor. Are you saying PARALLEL_UPDATES should come after imports in the code?
• parallel-updates, https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/parallel-updates/ in the info-box it says

This means you can set PARALLEL_UPDATES = 0 for read-only platforms (binary_sensor, sensor, device_tracker, event) and only the action calls will be relevant to consider for setting an appropriate number of parallel updates.

My understanding was then to set it to 1 for action calls. Please let me know if you believe it to be wrong.

• docs-removal-instructions, was added here Update flexit_bacnet docs with removal instructions home-assistant.io#37420

Let me know if you have more questions!

Nice work! Two things:

• docs-installation-parameters: I wasn't able to find the install parameters (ip_address and device_id) defined in the documentation. They should be in a {% configuration_basic %} section: https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-installation-parameters/
• parallel-updates: Not blocking, however PARALLEL_UPDATES is defined below async_setup_entry in all the platforms, reducing maintainability. Conventionally, modules are typically ordered by imports, constants, then classes and functions.

Thanks! Andy

[zweckj]

Related question, why do some platforms have a PARALLEL_UPDATES of 0, while others are 1? Aren't they all being managed by the coordinator?

@andrewsayre That's fine. Outbound actions (e.g. switching a switch) are not parallelized by a coordinator and therefore might need another value.

[andrewsayre]

Are you saying PARALLEL_UPDATES should come after imports in the code?

Yeah, after imports and before things like async_setup_entry, so all of the module constants are together. However not a blocker, but a convention I'd suggest aligning to in the future.

Thanks for the other responses! I apologize, I only checked next for the docs, not current. All items are accounted for!

[andrewsayre]

Wohoo! 🎉

[lellky]

Thanks @andrewsayre !