miio.airconditioningcompanion module

exception miio.airconditioningcompanion.AirConditioningCompanionException[source]

Bases: DeviceException

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args
class miio.airconditioningcompanion.AirConditioningCompanion(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True, model: str = 'lumi.acpartner.v2')[source]

Bases: Device

Main class representing Xiaomi Air Conditioning Companion V1 and V2.

buttons() List[ButtonDescriptor]

Return a list of button-like, clickable actions of the device.

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.

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: 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_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() Dict[str, SensorDescriptor]

Return sensors.

settings() Dict[str, SettingDescriptor]

Return list of settings.

status() AirConditioningCompanionStatus[source]

Return device status.

switches() Dict[str, SwitchDescriptor]

Return toggleable switches.

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.

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
class miio.airconditioningcompanion.AirConditioningCompanionStatus(data)[source]

Bases: DeviceStatus

Container for status reports of the Xiaomi AC Companion.

embed(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 property names, and override the __getattribute__ to lookup attributes in the embedded containers.

sensors() Dict[str, SensorDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

settings() Dict[str, SettingDescriptor]

Return the dict of settings exposed by the status container.

You can use @setting decorator to define sensors inside your status class.

switches() Dict[str, SwitchDescriptor]

Return the dict of sensors exposed by the status container.

You can use @sensor decorator to define sensors inside your status class.

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: Optional[FanSpeed]

Current fan speed.

property is_on: bool

True if the device is turned on.

property led: Optional[bool]

Current LED state.

property load_power: int

Current power load of the air conditioner.

property mode: Optional[OperationMode]

Current operation mode.

property model_format: int

Version number of the model format.

property power: str

Current power state.

property power_socket: Optional[str]

Current socket power state.

property state_format: int

Version number of the state format.

Known values are: 1, 2, 3

property swing_mode: Optional[SwingMode]

Current swing mode.

property target_temperature: Optional[int]

Target temperature.

class miio.airconditioningcompanion.AirConditioningCompanionV3(ip: Optional[str] = None, token: Optional[str] = None, start_id: int = 0, debug: int = 0, lazy_discover: bool = True)[source]

Bases: AirConditioningCompanion

buttons() List[ButtonDescriptor]

Return a list of button-like, clickable actions of the device.

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.

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: 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_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() Dict[str, SensorDescriptor]

Return sensors.

settings() Dict[str, SettingDescriptor]

Return list of settings.

socket_off()[source]

Socket power off.

socket_on()[source]

Socket power on.

status() AirConditioningCompanionStatus[source]

Return device status.

switches() Dict[str, SwitchDescriptor]

Return toggleable switches.

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.

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: Optional[str]
class miio.airconditioningcompanion.FanSpeed(value)[source]

Bases: Enum

An enumeration.

Auto = 3
High = 2
Low = 0
Medium = 1
class miio.airconditioningcompanion.Led(value)[source]

Bases: Enum

An enumeration.

Off = 'A'
On = '0'
class miio.airconditioningcompanion.OperationMode(value)[source]

Bases: Enum

An enumeration.

Auto = 2
Cool = 1
Dehumidify = 3
Heat = 0
Ventilate = 4
class miio.airconditioningcompanion.Power(value)[source]

Bases: Enum

An enumeration.

Off = 0
On = 1
class miio.airconditioningcompanion.SwingMode(value)[source]

Bases: Enum

An enumeration.

ChigoOff = 'D'
ChigoOn = 'C'
Off = '1'
On = '0'
Unknown2 = '2'
Unknown7 = '7'