miio.curtain_youpin module

class miio.curtain_youpin.CurtainMiot(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, timeout: Optional[int] = None, *, model: Optional[str] = None, mapping: Optional[Dict[str, Dict[str, Any]]] = None)[source]

Bases: miio.miot_device.MiotDevice

Main class representing the lumi.curtain.hagl05 curtain.

call_action(*args, **kwargs)
call_action_by(*args, **kwargs)
configure_wifi(ssid, password, uid=0, extra_params=None)

Configure the wifi settings.

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.

Parameters
  • properties (list) – List of properties to query from the device.

  • max_properties (int) – Number of properties that can be requested at once.

:return List of property values.

get_properties_for_mapping(*, max_properties=15) list

Retrieve raw properties based on mapping.

get_property_by(*args, **kwargs)
info(*args, **kwargs)
raw_command(*args, **kwargs)
send(command: str, parameters: Optional[Any] = None, retry_count: Optional[int] = 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.

Parameters
  • command (str) – Command to send

  • parameters (dict) – Parameters to send

  • retry_count (int) – How many times to retry on error

  • extra_parameters (dict) – Extra top-level parameters

  • model (str) – Force model to avoid autodetection

send_handshake()

Send initial handshake to the device.

set_adjust_value(*args, **kwargs)
set_manual_enabled(*args, **kwargs)
set_motor_control(*args, **kwargs)
set_night_tip_light(*args, **kwargs)
set_polarity(*args, **kwargs)
set_position_limit(*args, **kwargs)
set_property(property_key: str, value)

Sets property value using the existing mapping.

set_property_by(*args, **kwargs)
set_target_position(*args, **kwargs)
status(*args, **kwargs)
test_properties(*args, **kwargs)
update(url: str, md5: str)

Start an OTA update.

update_progress() int

Return current update progress [0-100].

update_state()

Return current update state.

property device_id: int

Return device id (did), if available.

mapping: Dict[str, Dict[str, Any]]
property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = dict_keys(['lumi.curtain.hagl05'])
timeout = 5
class miio.curtain_youpin.CurtainStatus(data: Dict[str, Any])[source]

Bases: miio.device.DeviceStatus

property adjust_value: int

Adjust value.

property current_position: int

Current curtain position.

property is_manual_enabled: bool

True if manual controls are enabled.

property is_position_limited: bool

Position limit.

property night_tip_light: bool

Night tip light status.

property polarity: miio.curtain_youpin.Polarity

Motor rotation polarity.

property run_time: int

Run time of the motor.

property status: miio.curtain_youpin.Status

Device status.

property target_position: int

Target curtain position.

class miio.curtain_youpin.MotorControl(value)[source]

Bases: enum.Enum

An enumeration.

Auto = 3
Close = 2
Open = 1
Pause = 0
class miio.curtain_youpin.Polarity(value)[source]

Bases: enum.Enum

An enumeration.

Positive = 0
Reverse = 1
class miio.curtain_youpin.Status(value)[source]

Bases: enum.Enum

An enumeration.

Closing = 2
Opening = 1
Stopped = 0