miio.integrations.chuangmi.plug package
Submodules
- miio.integrations.chuangmi.plug.chuangmi_plug module
ChuangmiPlug
ChuangmiPlug.actions()
ChuangmiPlug.call_action()
ChuangmiPlug.change_setting()
ChuangmiPlug.configure_wifi()
ChuangmiPlug.descriptors()
ChuangmiPlug.get_device_group()
ChuangmiPlug.get_properties()
ChuangmiPlug.info()
ChuangmiPlug.off()
ChuangmiPlug.on()
ChuangmiPlug.raw_command()
ChuangmiPlug.send()
ChuangmiPlug.send_handshake()
ChuangmiPlug.sensors()
ChuangmiPlug.set_led()
ChuangmiPlug.set_wifi_led()
ChuangmiPlug.settings()
ChuangmiPlug.status()
ChuangmiPlug.supports_miot()
ChuangmiPlug.update()
ChuangmiPlug.update_progress()
ChuangmiPlug.update_state()
ChuangmiPlug.usb_off()
ChuangmiPlug.usb_on()
ChuangmiPlug.device_id
ChuangmiPlug.model
ChuangmiPlug.raw_id
ChuangmiPlug.retry_count
ChuangmiPlug.supported_models
ChuangmiPlug.timeout
ChuangmiPlug.token
ChuangmiPlugStatus
Module contents
- class miio.integrations.chuangmi.plug.ChuangmiPlug(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 | None = None)[source]
Bases:
Device
Main class representing the Chuangmi Plug.
- 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_handshake()
Send initial handshake to the device.
- sensors() DescriptorCollection[PropertyDescriptor]
Return read-only properties.
- settings() DescriptorCollection[PropertyDescriptor]
Return settable properties.
- status() ChuangmiPlugStatus [source]
Retrieve properties.
- 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 = ['chuangmi.plug.v1', 'chuangmi.plug.v3', 'chuangmi.plug.m1', 'chuangmi.plug.m3', 'chuangmi.plug.v2', 'chuangmi.plug.hmi205', 'chuangmi.plug.hmi206', 'chuangmi.plug.hmi208']
- timeout = 5