Add default platform for xiaomi_miio HA core integration

[ian-craig]

Home Assistant's core Xiaomi Miio integration now creates related entities for sensors and controls which aren't part of the default "fan" service. With this, it's possible to fully control a Xiaomi fan without the xiaomi_miio_fan service.

This PR adds a new default platform config which uses the built in fan service and related entities. Finding the related entities requires an async call, so there's a decent amount of refactoring to make sure we're configured before rendering fully.

I've also added support for a few newer attributes.

Full list of changes:

• Split up the set hass getter into config/create/update functions, and ensure we aren't re-creating the entire card unnecessarily one very state change
• Add a new way of configuring when this.config.platform === 'default' which checks for features by looking for the relevant entities (no need to hard-code model versions anymore)
• Update click handlers to use related entities if they exist
• Added new UI for temperature and himidity sensors, and power/charging status, for devices which support this (e.g. Fan 3)
• Added a new confing option to hide the LED button as I don't find this useful
• Minor fixes to the power icon positioning to re-center it when LED is off

The diff for this is pretty huge, sorry about that. I can try to split it up if you'd prefer.

Related issues: #64 #61

[ian-craig]

@ikaruswill what's your recommended way to test this card (with more than one device)? I've tried wherever possible to leave the old platforms untouched, and to always handle when related entities don't exist, but it'd be great to try this out on a few other devices.

[ikaruswill]

@ian-craig Thanks so much for taking the time to make this PR. Your changes are much welcome!

About testing, to be honest, there's no easy way to test this out. What we can do however is to release beta versions suffixed with -beta and then hope for people to enable installation of beta versions to surface the bugs (if any).

What I'd suggest is:

• Let's try to break this down to smaller PRs if that's still possible and not too much extra work for you. We can merge a few small changes first with minor version bumps and if necessary, suffix them with -beta for testing (Don't close this PR first).
• If the pieces of code are all inter-dependent to some extent, it's fine we can work with this PR and make a major version bump beta release for testing.

What do you think?

[ikaruswill]

Out of curiosity, what model of Xiaomi fan are you running?

[lassieee]

Awesome work! I have 2 dmaker_fan_p18 fans, and I'm willing to try a beta version.

[ikaruswill]

@lassieee Nice! Thanks for volunteering, we have 1 tester!

I'm running the zhimi.fan.za5 currently, and I have a zhimi.fan.za4 somewhere too so I can cover those 2 models.

[insajd]

p5 model here, can test -beta before summer heat comes

[ian-craig]

Great to see so much community support and people volunteering to test.

I have a zhimi.fan.za5, and am running HA 2022.2.9 with just the core xiaomi_miio integration (no separate xiaomi_miio_fan service)

I've created 4 smaller PRs which cover the minor unrelated changes (#67, #68, #70), and an initial refactor (#69), but don't actually add the new default platform and async config calls. Hopefully these are safer changes we can push out with a bit more confidence, and that'll make the rest of the change much easier to review.

[ian-craig]

I have a zhimi.fan.za5, and am running HA 2022.2.9 with just the core xiaomi_miio integration (no separate xiaomi_miio_fan service)

If anyone's curious what that setup looks like, here's the relevant entities and their state:

And here's the fan-related services I have

[ikaruswill]

Thanks for your work, gonna get down to reviewing them now!

[ikaruswill]

@ian-craig LGTM, the most appreciated change imo is the trick that can allow support for any fan models without the need to hard-code model versions.

Could you resolve the merge conflicts? Once that's done we can put up a beta1 release

[ian-craig]

@ikaruswill This didn't make sense to me. I had intepreted "brightness" to be a percentage, but does led_brightness mean something different when coming from attributes via the xiaomi_miio_fan integration?

[ikaruswill]

Bsaed on what I know, brightness isn't a percentage with the xiaomi_miio_fan integration:

 Supported values are 0 (Bright), 1 (Dim), 2 (Off).

Even with the official integration, the brightness is (annoyingly) either Number entities or Select Entities depending on models

[ian-craig]

Ugh. Okay, I've updated the PR so that it's only using > 0 when using the number.* entity, and otherwise using < 2 on the attribute.

To support other models through the default platform fully we'd need to also support select.* brightness entities, but without an example of that I'm not sure I'd implement it correctly.

If anyone with other fans can share their list of entities and the attributes for each I'd be happy to have a go at broadening support.

[ikaruswill]

I have the following entities for my zhimi.fan.za5 (Pardon the cute name)

And the following attributes for fan device:

speed_list:
  - 'off'
  - low
  - medium
  - high
  - Nature
  - Normal
preset_modes:
  - Nature
  - Normal
direction: null
oscillating: false
speed: Normal
percentage: null
percentage_step: 1
preset_mode: Normal
friendly_name: Gusty
supported_features: 15

[ikaruswill]

I don't have my za4 connected and accessible right now, but based on what I remember, the LED brightness is set with a select entity, with bright, dim, off options.

It's corroborates with the HA docs:

Controls the brightness of the LEDs (bright, dim, off)

[ian-craig]

I pushed an update to add a select entity... though I can't really test this. Do you think this is sufficient to push out a beta? I expect there will be some models the LED state doesn't show for, but until we get some more data we can't do much about that.

[ikaruswill]

Yeah I think it's all good for us to push out the beta by now. Will do so within the day. Thanks for the help with supporting the select entity for the LED.

[override80]

Hi! I own a dmaker.fan.1c and a dmaker.fan.p18. I have an issue with the 2.0.0-RC1 version, basically the card looks like this:

and in web developer console i am basically receiving with errors like these:

and no button on the card is working (i can just turn the fan on, but no animations)

Is it something on my side?

EDIT
Ok if I comment out 561-565 and delete 575, it works... in my case led_brightness attribute is null, maybe this has something to do

[ian-craig]

Looks like a bug in that last minute change I did for the select entity. I'll send a PR shortly.