miio.integrations.pwzn.relay package
Submodules
- miio.integrations.pwzn.relay.pwzn_relay module
PwznRelay
PwznRelay.actions()
PwznRelay.all_relay_off()
PwznRelay.all_relay_on()
PwznRelay.call_action()
PwznRelay.change_setting()
PwznRelay.configure_wifi()
PwznRelay.descriptors()
PwznRelay.get_device_group()
PwznRelay.get_properties()
PwznRelay.info()
PwznRelay.raw_command()
PwznRelay.relay_off()
PwznRelay.relay_on()
PwznRelay.send()
PwznRelay.send_handshake()
PwznRelay.sensors()
PwznRelay.set_name()
PwznRelay.settings()
PwznRelay.status()
PwznRelay.supports_miot()
PwznRelay.update()
PwznRelay.update_progress()
PwznRelay.update_state()
PwznRelay.device_id
PwznRelay.model
PwznRelay.raw_id
PwznRelay.retry_count
PwznRelay.supported_models
PwznRelay.timeout
PwznRelay.token
PwznRelayStatus
Module contents
- class miio.integrations.pwzn.relay.PwznRelay(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 PWZN Relay.
- 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() PwznRelayStatus [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 = ['pwzn.relay.apple', 'pwzn.relay.banana']
- timeout = 5