miio.integrations.lumi.acpartner package

Submodules

Module contents

class miio.integrations.lumi.acpartner.AirConditioningCompanion(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 = 'lumi.acpartner.v2')[source]

Bases: Device

Main class representing Xiaomi Air Conditioning Companion V1 and V2.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

change_setting(name: str, params=None)

Change setting value.

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.

Parameters:

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

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

Returns:

List of property values.

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

learn(slot: int = 30)[source]

Learn an infrared command.

learn_result()[source]

Read the learned command.

learn_stop(slot: int = 30)[source]

Stop learning of a infrared command.

off()[source]

Turn the air condition off by infrared.

on()[source]

Turn the air condition on by infrared.

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.

Parameters:

  • command (str) – Command to send

  • parameters (dict) – Parameters to send

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.

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_command(command: str)[source]

Send a command to the air conditioner.

Parameters:

command (str) – Command to execute

send_configuration(model: str, power: Power, operation_mode: OperationMode, target_temperature: int, fan_speed: FanSpeed, swing_mode: SwingMode, led: Led)[source]
send_handshake()

Send initial handshake to the device.

send_ir_code(model: str, code: str, slot: int = 0)[source]

Play a captured command.

Parameters:

  • model (str) – Air condition model

  • code (str) – Command to execute

  • slot (int) – Unknown internal register or slot

sensors() → DescriptorCollection[PropertyDescriptor]

Return read-only properties.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → AirConditioningCompanionStatus[source]

Return device status.

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(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 the device id (did).

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = ['lumi.acpartner.v1', 'lumi.acpartner.v2', 'lumi.acpartner.v3']
timeout = 5
token: str | None
class miio.integrations.lumi.acpartner.AirConditioningCompanionMcn02(ip: str | None = None, token: str | None = None, start_id: int | None = None, debug: int = 0, lazy_discover: bool = True, timeout: int | None = None, model: str = 'lumi.acpartner.mcn02')[source]

Bases: Device

Main class representing Xiaomi Air Conditioning Companion V1 and V2.

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

change_setting(name: str, params=None)

Change setting value.

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.

Parameters:

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

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

Returns:

List of property values.

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

off()[source]

Turn the air condition off by infrared.

on()[source]

Turn the air condition on by infrared.

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.

Parameters:

  • command (str) – Command to send

  • parameters (dict) – Parameters to send

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.

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_command(command: str, parameters: Any | None = None) → Any[source]

Send a command to the air conditioner.

Parameters:

command (str) – Command to execute

send_handshake()

Send initial handshake to the device.

sensors() → DescriptorCollection[PropertyDescriptor]

Return read-only properties.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

status() → AirConditioningCompanionStatus[source]

Return device status.

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(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 the device id (did).

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = ['lumi.acpartner.mcn02']
timeout = 5
token: str | None
class miio.integrations.lumi.acpartner.AirConditioningCompanionV3(ip: str | None = None, token: str | None = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True)[source]

Bases: AirConditioningCompanion

actions() → DescriptorCollection[ActionDescriptor]

Return device actions.

call_action(name: str, params=None)

Call action by name.

change_setting(name: str, params=None)

Change setting value.

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.

Parameters:

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

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

Returns:

List of property values.

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

learn(slot: int = 30)

Learn an infrared command.

learn_result()

Read the learned command.

learn_stop(slot: int = 30)

Stop learning of a infrared command.

off()

Turn the air condition off by infrared.

on()

Turn the air condition on by infrared.

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.

Parameters:

  • command (str) – Command to send

  • parameters (dict) – Parameters to send

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.

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_command(command: str)

Send a command to the air conditioner.

Parameters:

command (str) – Command to execute

send_configuration(model: str, power: Power, operation_mode: OperationMode, target_temperature: int, fan_speed: FanSpeed, swing_mode: SwingMode, led: Led)
send_handshake()

Send initial handshake to the device.

send_ir_code(model: str, code: str, slot: int = 0)

Play a captured command.

Parameters:

  • model (str) – Air condition model

  • code (str) – Command to execute

  • slot (int) – Unknown internal register or slot

sensors() → DescriptorCollection[PropertyDescriptor]

Return read-only properties.

settings() → DescriptorCollection[PropertyDescriptor]

Return settable properties.

socket_off()[source]

Socket power off.

socket_on()[source]

Socket power on.

status() → AirConditioningCompanionStatus[source]

Return device status.

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(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 the device id (did).

property model: str

Return device model.

property raw_id: int

Return the last used protocol sequence id.

retry_count = 3
supported_models = ['lumi.acpartner.v1', 'lumi.acpartner.v2', 'lumi.acpartner.v3']
timeout = 5
token: str | None