miio.integrations.lumi.acpartner package
Submodules
- miio.integrations.lumi.acpartner.airconditioningcompanion module
AirConditioningCompanion
AirConditioningCompanion.actions()
AirConditioningCompanion.call_action()
AirConditioningCompanion.change_setting()
AirConditioningCompanion.configure_wifi()
AirConditioningCompanion.descriptors()
AirConditioningCompanion.get_device_group()
AirConditioningCompanion.get_properties()
AirConditioningCompanion.info()
AirConditioningCompanion.learn()
AirConditioningCompanion.learn_result()
AirConditioningCompanion.learn_stop()
AirConditioningCompanion.off()
AirConditioningCompanion.on()
AirConditioningCompanion.raw_command()
AirConditioningCompanion.send()
AirConditioningCompanion.send_command()
AirConditioningCompanion.send_configuration()
AirConditioningCompanion.send_handshake()
AirConditioningCompanion.send_ir_code()
AirConditioningCompanion.sensors()
AirConditioningCompanion.settings()
AirConditioningCompanion.status()
AirConditioningCompanion.supports_miot()
AirConditioningCompanion.update()
AirConditioningCompanion.update_progress()
AirConditioningCompanion.update_state()
AirConditioningCompanion.device_id
AirConditioningCompanion.model
AirConditioningCompanion.raw_id
AirConditioningCompanion.retry_count
AirConditioningCompanion.supported_models
AirConditioningCompanion.timeout
AirConditioningCompanion.token
AirConditioningCompanionStatus
AirConditioningCompanionStatus.descriptors()
AirConditioningCompanionStatus.embed()
AirConditioningCompanionStatus.air_condition_brand
AirConditioningCompanionStatus.air_condition_configuration
AirConditioningCompanionStatus.air_condition_model
AirConditioningCompanionStatus.air_condition_remote
AirConditioningCompanionStatus.device_type
AirConditioningCompanionStatus.fan_speed
AirConditioningCompanionStatus.is_on
AirConditioningCompanionStatus.led
AirConditioningCompanionStatus.load_power
AirConditioningCompanionStatus.mode
AirConditioningCompanionStatus.model_format
AirConditioningCompanionStatus.power
AirConditioningCompanionStatus.power_socket
AirConditioningCompanionStatus.state_format
AirConditioningCompanionStatus.swing_mode
AirConditioningCompanionStatus.target_temperature
AirConditioningCompanionV3
AirConditioningCompanionV3.actions()
AirConditioningCompanionV3.call_action()
AirConditioningCompanionV3.change_setting()
AirConditioningCompanionV3.configure_wifi()
AirConditioningCompanionV3.descriptors()
AirConditioningCompanionV3.get_device_group()
AirConditioningCompanionV3.get_properties()
AirConditioningCompanionV3.info()
AirConditioningCompanionV3.learn()
AirConditioningCompanionV3.learn_result()
AirConditioningCompanionV3.learn_stop()
AirConditioningCompanionV3.off()
AirConditioningCompanionV3.on()
AirConditioningCompanionV3.raw_command()
AirConditioningCompanionV3.send()
AirConditioningCompanionV3.send_command()
AirConditioningCompanionV3.send_configuration()
AirConditioningCompanionV3.send_handshake()
AirConditioningCompanionV3.send_ir_code()
AirConditioningCompanionV3.sensors()
AirConditioningCompanionV3.settings()
AirConditioningCompanionV3.socket_off()
AirConditioningCompanionV3.socket_on()
AirConditioningCompanionV3.status()
AirConditioningCompanionV3.supports_miot()
AirConditioningCompanionV3.update()
AirConditioningCompanionV3.update_progress()
AirConditioningCompanionV3.update_state()
AirConditioningCompanionV3.device_id
AirConditioningCompanionV3.model
AirConditioningCompanionV3.raw_id
AirConditioningCompanionV3.retry_count
AirConditioningCompanionV3.supported_models
AirConditioningCompanionV3.timeout
AirConditioningCompanionV3.token
FanSpeed
Led
OperationMode
Power
SwingMode
- miio.integrations.lumi.acpartner.airconditioningcompanionMCN module
AirConditioningCompanionMcn02
AirConditioningCompanionMcn02.actions()
AirConditioningCompanionMcn02.call_action()
AirConditioningCompanionMcn02.change_setting()
AirConditioningCompanionMcn02.configure_wifi()
AirConditioningCompanionMcn02.descriptors()
AirConditioningCompanionMcn02.get_device_group()
AirConditioningCompanionMcn02.get_properties()
AirConditioningCompanionMcn02.info()
AirConditioningCompanionMcn02.off()
AirConditioningCompanionMcn02.on()
AirConditioningCompanionMcn02.raw_command()
AirConditioningCompanionMcn02.send()
AirConditioningCompanionMcn02.send_command()
AirConditioningCompanionMcn02.send_handshake()
AirConditioningCompanionMcn02.sensors()
AirConditioningCompanionMcn02.settings()
AirConditioningCompanionMcn02.status()
AirConditioningCompanionMcn02.supports_miot()
AirConditioningCompanionMcn02.update()
AirConditioningCompanionMcn02.update_progress()
AirConditioningCompanionMcn02.update_state()
AirConditioningCompanionMcn02.device_id
AirConditioningCompanionMcn02.model
AirConditioningCompanionMcn02.raw_id
AirConditioningCompanionMcn02.retry_count
AirConditioningCompanionMcn02.supported_models
AirConditioningCompanionMcn02.timeout
AirConditioningCompanionMcn02.token
AirConditioningCompanionStatus
AirConditioningCompanionStatus.descriptors()
AirConditioningCompanionStatus.embed()
AirConditioningCompanionStatus.fan_speed
AirConditioningCompanionStatus.is_on
AirConditioningCompanionStatus.load_power
AirConditioningCompanionStatus.mode
AirConditioningCompanionStatus.power
AirConditioningCompanionStatus.swing_mode
AirConditioningCompanionStatus.target_temperature
FanSpeed
OperationMode
SwingMode
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.
- 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_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.
- 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_state()
Return current update state.
- retry_count = 3
- supported_models = ['lumi.acpartner.v1', 'lumi.acpartner.v2', 'lumi.acpartner.v3']
- timeout = 5
- 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.
- 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_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_state()
Return current update state.
- retry_count = 3
- supported_models = ['lumi.acpartner.mcn02']
- timeout = 5
- 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.
- 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
- learn_result()
Read the learned 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.
- 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_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.
- 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_state()
Return current update state.
- retry_count = 3
- supported_models = ['lumi.acpartner.v1', 'lumi.acpartner.v2', 'lumi.acpartner.v3']
- timeout = 5