Refactor how entities are created for homekit_controller services

[Jc2k]

Proposed change

#42676 and #43100 highlighted something i've been thinking about for a while. The way HomeKit services are enumerated and turned into entities is currently not only too limiting but also awkward because you have to directly parse the JSON data from HomeKit.

This PR allows the functions that create entities to instead operate on the aiohomekit entity map abstraction which is already used in the entity implementations themselves.

It turns something like this:

    def get_accessory(conn, aid):
        for acc in conn.accessories:
            if acc.get("aid") == aid:
                return acc
        return None

    def get_service(acc, iid):
        for serv in acc.get("services"):
            if serv.get("iid") == iid:
                return serv
        return None

    def get_char(serv, iid):

        if len(iid) == 36:
            type_uuid = iid
        else:
            try:
                type_name = CharacteristicsTypes[iid]
                type_uuid = CharacteristicsTypes.get_uuid(type_name)
            except KeyError:
                return None

        for char in serv.get("characteristics"):
            if char.get("type") == type_uuid:
                return char
        return None

    @callback
    def async_add_service(aid, service):
        if service["stype"] != "humidifier-dehumidifier":
            return False
        info = {"aid": aid, "iid": service["iid"]}

        acc = get_accessory(conn, aid)
        serv = get_service(acc, service["iid"])


        if (
            get_char(serv, CharacteristicsTypes.Vendor.VOCOLINC_HUMIDIFIER_SPRAY_LEVEL)
            is not None
        ):
            async_add_entities([VocolincFlowerbud(conn, info)], True)
        else:
            if (
                get_char(
                    serv, CharacteristicsTypes.RELATIVE_HUMIDITY_HUMIDIFIER_THRESHOLD
                )
                is not None
            ):
                async_add_entities([HomeKitHumidifier(conn, info)], True)

            if (
                get_char(
                    serv, CharacteristicsTypes.RELATIVE_HUMIDITY_DEHUMIDIFIER_THRESHOLD
                )
                is not None
            ):
                async_add_entities([HomeKitDehumidifier(conn, info)], True)

        return True

Into:

    @callback
    def async_add_service(service):
        if service.short_type != ServicesTypes.HUMIDIFIER_DEHUMIDIFIER:
            return False

        info = {"aid": service.accessory.aid, "iid": service.iid}
        entities = []

        if service.has(CharacteristicsTypes.Vendor.VOCOLINC_HUMIDIFIER_SPRAY_LEVEL):
            entities.append(VocolincFlowerbud(conn, info))
        else:
            if services.has(RELATIVE_HUMIDITY_HUMIDIFIER_THRESHOLD):
                entities.append(HomeKitHumidifier(conn, info))
            if services.has(RELATIVE_HUMIDITY_DEHUMIDIFIER_THRESHOLD):
                entities.append(HomeKitDehumidifier(conn, info))

        async_add_entities([entities], True)
        return True

It also means we can use the aiohomekit constants for service types.

No new tests - but this bit of code is already exercised quite well by the existing ones.

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)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

N/A

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue: Add HomeKit Controller Diffuser #42676
• Link to documentation 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
• The code has been formatted using Black (black --fast 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.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

To help with the load of incoming pull requests:

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

[davet2001]

This looks good to me. Code quality seems fine and new appears to replicate functionality of old. I tried the tests locally and they seem fine.
I don't fully understand this integration, but this does look to be an improvement, replacing dict/string lookups with constants.

The only suggestion I could make is perhaps to add some type hints to the function definitions, but no reason that couldn't be a separate PR.

[Jc2k]

Cheers for the review! I have a few more rounds of clean up planned for this part of the code so i'll keep your type hint suggestion in mind!