miio.integrations.lumi.curtain package
Submodules
- miio.integrations.lumi.curtain.curtain_youpin module
CurtainMiot
CurtainMiot.actions()
CurtainMiot.call_action()
CurtainMiot.call_action_by()
CurtainMiot.call_action_from_mapping()
CurtainMiot.change_setting()
CurtainMiot.configure_wifi()
CurtainMiot.descriptors()
CurtainMiot.get_device_group()
CurtainMiot.get_properties()
CurtainMiot.get_properties_for_mapping()
CurtainMiot.get_property_by()
CurtainMiot.info()
CurtainMiot.raw_command()
CurtainMiot.send()
CurtainMiot.send_handshake()
CurtainMiot.sensors()
CurtainMiot.set_adjust_value()
CurtainMiot.set_manual_enabled()
CurtainMiot.set_motor_control()
CurtainMiot.set_night_tip_light()
CurtainMiot.set_polarity()
CurtainMiot.set_position_limit()
CurtainMiot.set_property()
CurtainMiot.set_property_by()
CurtainMiot.set_target_position()
CurtainMiot.settings()
CurtainMiot.status()
CurtainMiot.supports_miot()
CurtainMiot.update()
CurtainMiot.update_progress()
CurtainMiot.update_state()
CurtainMiot.device_id
CurtainMiot.mapping
CurtainMiot.model
CurtainMiot.raw_id
CurtainMiot.retry_count
CurtainMiot.supported_models
CurtainMiot.timeout
CurtainMiot.token
CurtainStatus
CurtainStatus.descriptors()
CurtainStatus.embed()
CurtainStatus.adjust_value
CurtainStatus.current_position
CurtainStatus.is_manual_enabled
CurtainStatus.is_position_limited
CurtainStatus.night_tip_light
CurtainStatus.polarity
CurtainStatus.run_time
CurtainStatus.status
CurtainStatus.target_position
MotorControl
Polarity
Status
Module contents
- class miio.integrations.lumi.curtain.CurtainMiot(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, mapping: Dict[str, Dict[str, Any]] | None = None)[source]
Bases:
MiotDevice
Main class representing the lumi.curtain.hagl05 curtain.
- actions() DescriptorCollection[ActionDescriptor]
Return device actions.
- call_action_by(siid, aiid, params=None)
Call an action.
- 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.
- set_motor_control(motor_control: MotorControl)[source]
Set motor control.
- set_property_by(siid: int, piid: int, value: int | float | str | bool, *, value_type: Any | None = None, name: str | None = None)
Set a single property (siid/piid) to given value.
value_type can be given to convert the value to wanted type, allowed types are: int, float, bool, str
- settings() DescriptorCollection[PropertyDescriptor]
Return settable properties.
- status() CurtainStatus [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 = ['lumi.curtain.hagl05']
- timeout = 5