Gateway: add name + model property to subdevice & add loads of subdevices

[starkillerOG]

In this way we can easily define how the name of subdevices schould be set in HomeAssistant. Ideally we would at some point figure out how to get the names set in the Mi Home app...
But for now use the device_type + sid as a name

[coveralls]

Coverage increased (+0.9%) to 74.289% when pulling 48e39c7 on starkillerOG:patch-9 into 5e6fa21 on rytilahti:master.

[starkillerOG]

@rytilahti ready to be merged

[starkillerOG]

@rytilahti Is this alright now?

[rytilahti]

Just a very small change and this can be merged! Run also tox -e lint (or preferably, install the precommit hooks) to avoid linting issues in general :-)

[rytilahti]

One comment about the most recent commit, I think we need to add some sort of warning log indicating that the device has been detected but is not implemented (based on missing properties, or somehow else in case the device has no properties at all?). Otherwise this will cause bug reports of correctly detected but not yet supported devices.

[starkillerOG]

One comment about the most recent commit, I think we need to add some sort of warning log indicating that the device has been detected but is not implemented (based on missing properties, or somehow else in case the device has no properties at all?). Otherwise this will cause bug reports of correctly detected but not yet supported devices.

Well those devices will log an debug message when the update method is called if that has not been specified by the device. And these devices will not have enteties so I think we will be fine.

In princeple we also want people that have a device that is not supported yet to report here so they can figure out which properties the device has and then implement those.
I am thinking of maybe having a general step by step guide how to implement support for a subdevice that we can reffer people to?

[starkillerOG]

I reduced the not implemented warning to log level because there are tons of devices like motion sensor, door sensor, remote switches, buttons and cube that do not have any properties, they only provide events. And since event support requires subscriptions that is still quite far away.

So I don't think it is fair to bombard people with warnings of not implemented devices since we don't have a way to implement them yet before the subscription PR (#709) is done.

[starkillerOG]

@rytilahti I think this is now ready to be merged.
Could you have a look at it?
(at least I am done with adding subdevices...)

I have also tested the code and for my gateway it works.

[rytilahti]

Hmm, I think we need to rethink the approach for the metadata at some point, considering how many of these ikea bulbs likely share similar features, it is not really worth to have separate implementations for it. I think we will want to have a container class defining the supported devices (and other metadata) per class to avoid the code duplication.

The gateway.py should also be split up to more manageable pieces (under miio/gateway/ package), there are already way too many lines of code (and different things) for a single file.

I think it is okay to merge this now though, refactoring can follow in separate PRs.

[starkillerOG]

Yea the gateway.py file grew a lot and is getting way too big.
Was already thinking the same thing, at least all subdevices schould be moved to a gateway_subdevices.py file or something....

for the IkeaBulbs and simular classes, I think it would be best to define a new class IkeaBulb that inherits properties from SubDevice class, then all individual model classes like IkeaBulb82 can inherit all common functions from the IkeaBulb class.

Not sure if that is what you were trying to say....

[starkillerOG]

Maybe split up all subdevices in files which have one common class that they inherit from. so all IkeaBulbs in one file, all cubes in one, all buttons in one etc.

[rytilahti]

Yes, having a common base class would make it much cleaner already. I don't think having a gateway_subdevices.py is a good idea, it's much better to have a structure like:

miio/gateway/
             gateway.py
             gateway_zigbee.py
             gateway_light.py
             gateway_radio.py

and so on. To extend that example, here's another idea that would make it much nicer:

miio/gateway/
            gateway.py
            subdevice.py
miio/gateway/aqara/
                  cube.py
                  switch.py
miio/gateway/ikea/
                  bulb.py

[rytilahti]

I am thinking of maybe having a general step by step guide how to implement support for a subdevice that we can reffer people to?

Yes, having a guide how to add support for new devices would be great!

I reduced the not implemented warning to log level because there are tons of devices like motion sensor, door sensor, remote switches, buttons and cube that do not have any properties, they only provide events.

We need a way to differentiate between "no known properties" and "no properties" to avoid useless warnings, but this can be also done separately from this PR.

[starkillerOG]

@rytilahti could you please push to a new version of python-miio?
I could then finish the HomeAssistant subdevice implementation

[rytilahti]

I'll see if I can find some time tomorrow to prepare a release, but I can't make any promises on that.