Midea Local Control
midea-local is a Python library designed to control Midea M-Smart appliances directly via the local area network, bypassing the cloud. It provides an interface to discover, connect to, and manage various Midea devices such as air conditioners, dehumidifiers, and water heaters. The library is actively maintained, with frequent minor releases (typically monthly or bi-monthly) to add new features and support for more device models. The current version is 6.6.0, requiring Python >=3.11.
Common errors
-
ImportError: cannot import name 'MSmartHomeAppliance' from 'midea_local.cloud'
cause Using the deprecated class name `MSmartHomeAppliance` for cloud interactions after `midea-local` v6.0.0.fixReplace `MSmartHomeAppliance` with `MSmartHome` in your import statement and code: `from midea_local.cloud import MSmartHome`. -
midea_local.exceptions.MideaError: Error creating appliance: Appliance not found or not responding. Check IP/ID.
cause The library could not establish a connection or verify the appliance using the provided IP address and Device ID. This often points to network issues or incorrect identification.fixVerify the appliance's IP address (it might have changed via DHCP) and its exact Device ID. Ensure the device is powered on, connected to the local network, and no firewall on your network or host machine is blocking UDP traffic on port 6445 (the default Midea protocol port). -
midea_local.exceptions.MideaError: Invalid token or key for appliance.
cause The `token` or `key` provided for your Midea appliance is incorrect, malformed, or has expired. These credentials are vital for authenticating local control commands.fixYou need to re-obtain the correct and current `token` and `key` for your specific appliance. Refer to the `midea-local` documentation or community tools (e.g., `midea-discover`) for methods to extract these credentials. -
AttributeError: 'Appliance' object has no attribute 'some_feature_name'
cause Attempting to access a feature or attribute that is not supported by the specific model of your Midea appliance or its current firmware, or the library version does not yet support it.fixCheck the `midea-local` documentation or GitHub issues for support regarding your specific appliance model. Update the library to the latest version to ensure you have the most recent device support. Not all Midea devices support every feature exposed by other models.
Warnings
- breaking The primary class for Midea cloud interactions (`midea_local.cloud`) was refactored in v6.0.0. If you were directly using `midea_local.cloud.MSmartHomeAppliance` (pre-6.0.0) for cloud operations (e.g., discovery or obtaining credentials), you must now use `midea_local.cloud.MSmartHome`.
- gotcha Obtaining the `token` (32-byte hex string) and `key` (16-byte hex string) for Midea devices is the most common hurdle for local control. These credentials are device-specific and are not easily found in the official Midea app. Users often resort to third-party tools (e.g., midea-discover), network traffic sniffing, or older versions of the Midea app to extract them.
- gotcha Midea appliances exhibit significant variations in their supported features, firmware, and communication protocols. Not all devices or all features of a device may be fully supported by the library, or they might require a specific `protocol_version` when instantiating the `Appliance` object.
Install
-
pip install midea-local
Imports
- Appliance
from midea_local.appliance import Appliance
- MSmartHome
from midea_local.cloud import MSmartHomeAppliance
from midea_local.cloud import MSmartHome
- MideaError
from midea_local.exceptions import MideaError
Quickstart
import asyncio
import os
from midea_local.appliance import Appliance
from midea_local.exceptions import MideaError
async def control_midea_appliance():
# Replace with your appliance's actual IP, ID, token, and key
# These credentials are often difficult to obtain and may require special tools.
device_ip = os.environ.get('MIDEA_DEVICE_IP', '192.168.1.100')
device_id = int(os.environ.get('MIDEA_DEVICE_ID', '12345678901'))
token = os.environ.get('MIDEA_DEVICE_TOKEN', 'your_32_byte_token_hex_string') # e.g., 'AABBCCDD...' (64 chars)
key = os.environ.get('MIDEA_DEVICE_KEY', 'your_16_byte_key_hex_string') # e.g., '11223344...' (32 chars)
if not all([device_ip, device_id, token, key]):
print("Please set MIDEA_DEVICE_IP, MIDEA_DEVICE_ID, MIDEA_DEVICE_TOKEN, and MIDEA_DEVICE_KEY environment variables.")
return
try:
# Find and create the appliance instance
# protocol_version can be 1 or 3, 3 is default and for newer devices.
appliance = await Appliance.find_and_create_appliance(
device_ip, device_id, token, key, protocol_version=3
)
if appliance:
print(f"Connected to appliance: {appliance.name} ({appliance.ip_address})")
print(f"Current power state: {appliance.power_state}")
# Example: Turn on the appliance if it's off
if not appliance.power_state:
print("Turning appliance ON...")
await appliance.set_attribute("power_state", True)
await appliance.refresh()
print(f"New power state: {appliance.power_state}")
# Example: Set target temperature (for AC units)
if hasattr(appliance, 'target_temperature'):
current_temp = appliance.target_temperature
new_temp = current_temp + 1 if current_temp < 30 else 20 # Cycle temperature
print(f"Setting target temperature from {current_temp}°C to {new_temp}°C...")
await appliance.set_attribute("target_temperature", new_temp)
await appliance.refresh()
print(f"New target temperature: {appliance.target_temperature}°C")
# Example: Print all available attributes and their values
print("\n--- Appliance Attributes ---")
for attr in dir(appliance):
if not attr.startswith('_') and not callable(getattr(appliance, attr)):
try:
print(f"{attr}: {getattr(appliance, attr)}")
except Exception:
pass # Some attributes might not be directly readable
else:
print("Failed to find or connect to the appliance.")
except MideaError as e:
print(f"MideaError: {e}")
except Exception as e:
print(f"An unexpected error occurred: {e}")
if __name__ == "__main__":
asyncio.run(control_midea_appliance())