miio.integrations.lumi.acpartner.airconditioningcompanion module

class miio.integrations.lumi.acpartner.airconditioningcompanion.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')

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)

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.

status() → AirConditioningCompanionStatus

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.airconditioningcompanion.AirConditioningCompanionStatus(data)

Bases: DeviceStatus

Container for status reports of the Xiaomi AC Companion.

descriptors() → DescriptorCollection[PropertyDescriptor]

Return the dict of sensors exposed by the status container.

Use @sensor and @setting decorators to define properties.

embed(name: str, other: DeviceStatus)

Embed another status container to current one.

This makes it easy to provide a single status response for cases where responses from multiple I/O calls is wanted to provide a simple interface for downstreams.

Internally, this will prepend the name of the other class to the attribute names, and override the __getattribute__ to lookup attributes in the embedded containers.

property air_condition_brand: int

Brand of the air conditioner.

Known brand ids are 0x0182, 0x0097, 0x0037, 0x0202, 0x02782, 0x0197, 0x0192.

property air_condition_configuration: int

property air_condition_model: bytes

Model of the air conditioner.

property air_condition_remote: int

Remote id.

Known remote ids: * 0x80111111, 0x80111112 (brand: 0x0182) * 0x80222221 (brand: 0x0097) * 0x80333331 (brand: 0x0037) * 0x80444441 (brand: 0x0202) * 0x80555551 (brand: 0x2782) * 0x80777771 (brand: 0x0197) * 0x80666661 (brand: 0x0192)

property device_type: int

Device type identifier.

property fan_speed: FanSpeed | None

Current fan speed.

property is_on: bool

True if the device is turned on.

property led: bool | None

Current LED state.

property load_power: int

Current power load of the air conditioner.

property mode: OperationMode | None

Current operation mode.

property model_format: int

Version number of the model format.

property power: str

Current power state.

property power_socket: str | None

Current socket power state.

property state_format: int

Version number of the state format.

Known values are: 1, 2, 3

property swing_mode: SwingMode | None

Current swing mode.

property target_temperature: int | None

Target temperature.

class miio.integrations.lumi.acpartner.airconditioningcompanion.AirConditioningCompanionV3(ip: str | None = None, token: str | None = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True)

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()

Socket power off.

socket_on()

Socket power on.

status() → AirConditioningCompanionStatus

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.airconditioningcompanion.FanSpeed(value)

Bases: Enum

An enumeration.

Auto = 3

High = 2

Low = 0

Medium = 1

class miio.integrations.lumi.acpartner.airconditioningcompanion.Led(value)

Bases: Enum

An enumeration.

Off = 'A'

On = '0'

class miio.integrations.lumi.acpartner.airconditioningcompanion.OperationMode(value)

Bases: Enum

An enumeration.

Auto = 2

Cool = 1

Dehumidify = 3

Heat = 0

Ventilate = 4

class miio.integrations.lumi.acpartner.airconditioningcompanion.Power(value)

Bases: Enum

An enumeration.

Off = 0

On = 1

class miio.integrations.lumi.acpartner.airconditioningcompanion.SwingMode(value)

Bases: Enum

An enumeration.

ChigoOff = 'D'

ChigoOn = 'C'

Off = '1'

On = '0'

Unknown2 = '2'

Unknown7 = '7'