Improve MiotDevice API (get_property_by, set_property_by, call_action, call_action_by) #905
Conversation
rytilahti
changed the title
|
I tested these options with
|
rytilahti
force-pushed
the
feat/improve_miotdevice
branch
from
2050091 to
a09cd65
Compare
rytilahti
changed the title
|
@arturdobo @darckly @bafonins if you don't mind testing this PR on your miot devices, it would be great! The conversion from using passed |
|
I testes options with my Huizuo lamps - get_properties_by and set_properties_by are working as expected, the fourth parameter (value_type) should be always specified. call_action and call_action_by methods I can't test |
|
Sorry for such a late response. I was able to call
|
* Also, code cleanup for passing the mapping. * Now the mapping is a class attribute, avoiding unnecessary __init__ overloading
Also, fix passing booleans to set_property_by
rytilahti
force-pushed
the
feat/improve_miotdevice
branch
from
ebc4ca2 to
fdb8036
Compare
| ) -> None: | ||
| self.mapping = mapping | ||
| super().__init__(ip, token, start_id, debug, lazy_discover) | ||
| mapping = None |
There was a problem hiding this comment.
Hello,
This seems to be a breaking change for MiotDevice. We can no longer use
MiotDevice(ip=host, token=token, mapping=mapping)to instantiate a MiotDevice with a given mapping (ha0y/xiaomi_miot_raw#79).
Is there a method to keep backward compatibility?
There was a problem hiding this comment.
Hi, sorry about that! You could assign the mapping directly after constructing the MiotDevice object to fix this for now:
dev = MiotDevice(...)
dev.mapping = my_mapping
Otherwise, feel free to open an issue to re-add the kwarg variant of this parameter back to the constructor!
There was a problem hiding this comment.
Thanks for your prompt reply!
There was a problem hiding this comment.
Unfortunatelly, this doesn't solve the problem, as this code doesn't work in version 0.5.4. mapping is required in 0.5.4 but unexpected in 0.5.5. I have opened an issue #982. Hope this will be fixed soon because it is a breaking change and may affect those who uses this library.
There was a problem hiding this comment.
Indeed, I hadn't thought about that, sorry... See my comment on the issue how I plan to rectify it.
…, call_action_by) (rytilahti#905) * Improve MiotDevice API (get_property_by, set_property_by commands) * Also, code cleanup for passing the mapping. * Now the mapping is a class attribute, avoiding unnecessary __init__ overloading * Add call_action(name,params) and call_action_by(siid,aiid,params) Also, fix passing booleans to set_property_by * Add some unittests * Convert a couple of missed/new classes to use new mapping * Fix linting * make vacuum tests pass
get_property_by(siid, piid)returns a single property, useful for testing with miiocliset_property_by(siid, piid, value, value_type)allows setting one,value_typeis optional and will be used for casting to correct type before passing the value tosend().call_action(name, params)calls an action with the given parameters, anything insidemappingthat hasaiidis considered an action.call_action_by(siid, aiid, params)allows calling arbitrary actions, useful especially for command-line use and testing.Also, code cleanup for passing the mapping.
Now the mapping is a class attribute, avoiding unnecessary init overloading
Testers wanted as I have no test devices!
Related to #901 (no more raw-commands necessary for the simplest test cases).