miio.integrations.yunmi.waterpurifier package
Submodules
- miio.integrations.yunmi.waterpurifier.waterpurifier module
WaterPurifier
WaterPurifier.actions()
WaterPurifier.call_action()
WaterPurifier.change_setting()
WaterPurifier.configure_wifi()
WaterPurifier.descriptors()
WaterPurifier.get_device_group()
WaterPurifier.get_properties()
WaterPurifier.info()
WaterPurifier.off()
WaterPurifier.on()
WaterPurifier.raw_command()
WaterPurifier.send()
WaterPurifier.send_handshake()
WaterPurifier.sensors()
WaterPurifier.settings()
WaterPurifier.status()
WaterPurifier.supports_miot()
WaterPurifier.update()
WaterPurifier.update_progress()
WaterPurifier.update_state()
WaterPurifier.device_id
WaterPurifier.model
WaterPurifier.raw_id
WaterPurifier.retry_count
WaterPurifier.supported_models
WaterPurifier.timeout
WaterPurifier.token
WaterPurifierStatus
WaterPurifierStatus.descriptors()
WaterPurifierStatus.embed()
WaterPurifierStatus.filter
WaterPurifierStatus.filter2_life_remaining
WaterPurifierStatus.filter2_state
WaterPurifierStatus.filter_life_remaining
WaterPurifierStatus.filter_state
WaterPurifierStatus.is_on
WaterPurifierStatus.level
WaterPurifierStatus.life
WaterPurifierStatus.mode
WaterPurifierStatus.power
WaterPurifierStatus.state
WaterPurifierStatus.tds
WaterPurifierStatus.temperature
WaterPurifierStatus.usage
WaterPurifierStatus.uv_filter_life_remaining
WaterPurifierStatus.uv_filter_state
WaterPurifierStatus.valve
WaterPurifierStatus.volume
- miio.integrations.yunmi.waterpurifier.waterpurifier_yunmi module
OperationStatus
WaterPurifierYunmi
WaterPurifierYunmi.actions()
WaterPurifierYunmi.call_action()
WaterPurifierYunmi.change_setting()
WaterPurifierYunmi.configure_wifi()
WaterPurifierYunmi.descriptors()
WaterPurifierYunmi.get_device_group()
WaterPurifierYunmi.get_properties()
WaterPurifierYunmi.info()
WaterPurifierYunmi.raw_command()
WaterPurifierYunmi.send()
WaterPurifierYunmi.send_handshake()
WaterPurifierYunmi.sensors()
WaterPurifierYunmi.settings()
WaterPurifierYunmi.status()
WaterPurifierYunmi.supports_miot()
WaterPurifierYunmi.update()
WaterPurifierYunmi.update_progress()
WaterPurifierYunmi.update_state()
WaterPurifierYunmi.device_id
WaterPurifierYunmi.model
WaterPurifierYunmi.raw_id
WaterPurifierYunmi.retry_count
WaterPurifierYunmi.supported_models
WaterPurifierYunmi.timeout
WaterPurifierYunmi.token
WaterPurifierYunmiStatus
WaterPurifierYunmiStatus.descriptors()
WaterPurifierYunmiStatus.embed()
WaterPurifierYunmiStatus.filter1_flow_remaining
WaterPurifierYunmiStatus.filter1_flow_total
WaterPurifierYunmiStatus.filter1_flow_used
WaterPurifierYunmiStatus.filter1_life_remaining
WaterPurifierYunmiStatus.filter1_life_total
WaterPurifierYunmiStatus.filter1_life_used
WaterPurifierYunmiStatus.filter2_flow_remaining
WaterPurifierYunmiStatus.filter2_flow_total
WaterPurifierYunmiStatus.filter2_flow_used
WaterPurifierYunmiStatus.filter2_life_remaining
WaterPurifierYunmiStatus.filter2_life_total
WaterPurifierYunmiStatus.filter2_life_used
WaterPurifierYunmiStatus.filter3_flow_remaining
WaterPurifierYunmiStatus.filter3_flow_total
WaterPurifierYunmiStatus.filter3_flow_used
WaterPurifierYunmiStatus.filter3_life_remaining
WaterPurifierYunmiStatus.filter3_life_total
WaterPurifierYunmiStatus.filter3_life_used
WaterPurifierYunmiStatus.operation_status
WaterPurifierYunmiStatus.rinse
WaterPurifierYunmiStatus.tds_in
WaterPurifierYunmiStatus.tds_out
WaterPurifierYunmiStatus.tds_warn_thd
WaterPurifierYunmiStatus.temperature
Module contents
- class miio.integrations.yunmi.waterpurifier.WaterPurifier(ip: str | None = None, token: str | None = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: int | None = None, *, model: str | None = None)[source]
Bases:
Device
Main class representing the water purifier.
- actions() DescriptorCollection[ActionDescriptor]
Return device actions.
- configure_wifi(ssid, password, uid=0, extra_params=None)
Configure the wifi settings.
- descriptors() DescriptorCollection[Descriptor]
Return a collection containing all descriptors for the device.
- classmethod get_device_group()
- get_properties(properties, *, property_getter='get_prop', max_properties=None)
Request properties in slices based on given max_properties.
This is necessary as some devices have limitation on how many properties can be queried at once.
If max_properties is None, all properties are requested at once.
- info(*, skip_cache=False) DeviceInfo
Get (and cache) miIO protocol information from the device.
This includes information about connected wlan network, and hardware and software versions.
- Parameters:
bool (skip_cache) – Skip the cache
- raw_command(command, parameters)
Send a raw command to the device. This is mostly useful when trying out commands which are not implemented by a given device instance.
- send(command: str, parameters: Any | None = None, retry_count: int | None = None, *, extra_parameters=None) Any
Send a command to the device.
Basic format of the request: {“id”: 1234, “method”: command, “parameters”: parameters}
extra_parameters allows passing elements to the top-level of the request. This is necessary for some devices, such as gateway devices, which expect the sub-device identifier to be on the top-level.
- send_handshake()
Send initial handshake to the device.
- sensors() DescriptorCollection[PropertyDescriptor]
Return read-only properties.
- settings() DescriptorCollection[PropertyDescriptor]
Return settable properties.
- status() WaterPurifierStatus [source]
Retrieve properties.
- supports_miot() bool
Return True if the device supports miot commands.
This requests a single property (siid=1, piid=1) and returns True on success.
- update_state()
Return current update state.
- retry_count = 3
- supported_models = ['yunmi.waterpuri.v2']
- timeout = 5
- class miio.integrations.yunmi.waterpurifier.WaterPurifierYunmi(ip: str | None = None, token: str | None = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: int | None = None, *, model: str | None = None)[source]
Bases:
Device
Main class representing the water purifier (Yunmi model).
- actions() DescriptorCollection[ActionDescriptor]
Return device actions.
- configure_wifi(ssid, password, uid=0, extra_params=None)
Configure the wifi settings.
- descriptors() DescriptorCollection[Descriptor]
Return a collection containing all descriptors for the device.
- classmethod get_device_group()
- get_properties(properties, *, property_getter='get_prop', max_properties=None)
Request properties in slices based on given max_properties.
This is necessary as some devices have limitation on how many properties can be queried at once.
If max_properties is None, all properties are requested at once.
- info(*, skip_cache=False) DeviceInfo
Get (and cache) miIO protocol information from the device.
This includes information about connected wlan network, and hardware and software versions.
- Parameters:
bool (skip_cache) – Skip the cache
- raw_command(command, parameters)
Send a raw command to the device. This is mostly useful when trying out commands which are not implemented by a given device instance.
- send(command: str, parameters: Any | None = None, retry_count: int | None = None, *, extra_parameters=None) Any
Send a command to the device.
Basic format of the request: {“id”: 1234, “method”: command, “parameters”: parameters}
extra_parameters allows passing elements to the top-level of the request. This is necessary for some devices, such as gateway devices, which expect the sub-device identifier to be on the top-level.
- send_handshake()
Send initial handshake to the device.
- sensors() DescriptorCollection[PropertyDescriptor]
Return read-only properties.
- settings() DescriptorCollection[PropertyDescriptor]
Return settable properties.
- status() WaterPurifierYunmiStatus [source]
Retrieve properties.
- supports_miot() bool
Return True if the device supports miot commands.
This requests a single property (siid=1, piid=1) and returns True on success.
- update_state()
Return current update state.
- retry_count = 3
- supported_models = ['yunmi.waterpuri.lx9', 'yunmi.waterpuri.lx11']
- timeout = 5