rytilahti/python-miio
Python Miio
python-miio is a Python library and hardware driver implementation of the Miio protocol, designed for controlling and managing Xiaomi smart appliances. It provides the necessary software interfaces to translate high-level commands into network packets for device communication.
The project includes a specialized network device simulator for emulating hardware responses to test protocol implementations without physical devices. It also features a command-line interface for sending commands, querying device status, and performing token retrieval for secure authentication.
Capability areas cover IoT network discovery to identify device models and IP addresses, as well as protocol analysis through the parsing of network packet captures. The library supports device feature introspection to retrieve metadata regarding available sensors and configurable settings.
Features
- Smart Appliance Control - Provides a standardized way to control operational states for Xiaomi home appliances like vacuums and air purifiers.
- Smart Home Automation - Allows controlling and managing Xiaomi smart appliances via Python scripts for household automation.
- CLI Command Frameworks - Triggers hardware actions through a command-line interface using network addresses and security tokens.
- Automatic Network Hardware Discovery - Performs automated network scanning to identify Xiaomi devices and extract their IP addresses and metadata.
- Device Model Detection - Implements logic to identify specific Xiaomi device models to load the appropriate control classes.
- Hardware Device Discovery - Queries a connected device to extract its model, hardware version, firmware version, and network status.
- Feature Introspection - Retrieves metadata about available sensors, configurable settings, and executable actions from a connected device.
- Smart Home Hardware Drivers - Acts as a hardware driver that translates high-level Python commands into Miio network packets.
- Xiaomi Device Integration - Enables connecting Xiaomi hardware to external systems by managing device tokens and protocol communication.
- Local Device Token Retrievals - Implements mechanisms to extract authentication tokens from Xiaomi devices to enable secure local control.
- Miio Protocol Implementations - Provides a full technical implementation of the Miio protocol for interacting with Xiaomi devices.
- Network Device Discovery - Provides utilities to automatically identify and categorize Xiaomi hardware devices connected to the local network.
- Network Environment Scanning - Identifies compatible devices on a local network using specific handshake protocols and IP scanning.
- Transmission Encryption - Secures communication by wrapping payloads with device-specific encryption tokens during transmission.
- Command Line Interfaces - Ships a command-line tool for sending commands and querying status from network-connected smart appliances.
- Hardware Command Parsing - Dynamically identifies and executes available hardware commands by parsing external description files.
- Command Set Retrieval - Downloads and parses description files to identify available commands for connected hardware.
- Network Protocol Analysis - Analyzes network packet captures to decode and implement the Miio communication protocol for smart appliances.
- Historical Packet Parsing - Extracts and decodes raw network traffic from capture files to analyze device communication.
- Protocol Simulation - Runs local simulators for communication protocols to test code without requiring physical hardware.
- IoT Device Simulation - Mocks device endpoints and hardware responses to test code logic and connectivity without physical hardware.
- Device Property Querying - Tests a list of potential properties against a device to identify which ones return valid responses.
- Python Descriptors - Uses Python descriptors to define sensor schemas and settings for automatic interface generation.
- Schema Metadata Definitions - Creates structured containers with descriptors for sensors and settings to provide metadata for integrations.
- Device Emulators - Emulates hardware devices using text descriptions to test protocol implementations and device interactions.
- Smart Home Hardware Simulation - Includes a specialized network device simulator to emulate hardware responses for protocol testing.
- Hardware Mocks - Emulates hardware responses via local servers to test communication logic without physical devices.
