1
0
mirror of https://github.com/mjg59/python-broadlink.git synced 2024-11-14 03:20:14 +01:00
python-broadlink/broadlink/remote.py
Felipe Martins Diel 12fdf01631 Improve code quality (#572)
* Improve typing

* Use better names

* Clean up switch.py

* Remove unused import

* Run black

* Remove unnecessary comments

* Clean up climate.py
2021-04-26 17:57:02 -03:00

127 lines
3.3 KiB
Python

"""Support for universal remotes."""
import struct
from . import exceptions as e
from .device import Device
class rmmini(Device):
"""Controls a Broadlink RM mini 3."""
TYPE = "RMMINI"
def _send(self, command: int, data: bytes = b"") -> bytes:
"""Send a packet to the device."""
packet = struct.pack("<I", command) + data
resp = self.send_packet(0x6A, packet)
e.check_error(resp[0x22:0x24])
payload = self.decrypt(resp[0x38:])
return payload[0x4:]
def update(self) -> None:
"""Update device name and lock status."""
resp = self._send(0x1)
self.name = resp[0x48:].split(b"\x00")[0].decode()
self.is_locked = bool(resp[0x87])
def send_data(self, data: bytes) -> None:
"""Send a code to the device."""
self._send(0x2, data)
def enter_learning(self) -> None:
"""Enter infrared learning mode."""
self._send(0x3)
def check_data(self) -> bytes:
"""Return the last captured code."""
return self._send(0x4)
class rmpro(rmmini):
"""Controls a Broadlink RM pro."""
TYPE = "RMPRO"
def sweep_frequency(self) -> None:
"""Sweep frequency."""
self._send(0x19)
def check_frequency(self) -> bool:
"""Return True if the frequency was identified successfully."""
resp = self._send(0x1A)
return resp[0] == 1
def find_rf_packet(self) -> None:
"""Enter radiofrequency learning mode."""
self._send(0x1B)
def cancel_sweep_frequency(self) -> None:
"""Cancel sweep frequency."""
self._send(0x1E)
def check_sensors(self) -> dict:
"""Return the state of the sensors."""
resp = self._send(0x1)
temp = struct.unpack("<bb", resp[:0x2])
return {"temperature": temp[0x0] + temp[0x1] / 10.0}
def check_temperature(self) -> float:
"""Return the temperature."""
return self.check_sensors()["temperature"]
class rmminib(rmmini):
"""Controls a Broadlink RM mini 3 (new firmware)."""
TYPE = "RMMINIB"
def _send(self, command: int, data: bytes = b"") -> bytes:
"""Send a packet to the device."""
packet = struct.pack("<HI", len(data) + 4, command) + data
resp = self.send_packet(0x6A, packet)
e.check_error(resp[0x22:0x24])
payload = self.decrypt(resp[0x38:])
p_len = struct.unpack("<H", payload[:0x2])[0]
return payload[0x6 : p_len + 2]
class rm4mini(rmminib):
"""Controls a Broadlink RM4 mini."""
TYPE = "RM4MINI"
def check_sensors(self) -> dict:
"""Return the state of the sensors."""
resp = self._send(0x24)
temp = struct.unpack("<bb", resp[:0x2])
return {
"temperature": temp[0x0] + temp[0x1] / 100.0,
"humidity": resp[0x2] + resp[0x3] / 100.0,
}
def check_temperature(self) -> float:
"""Return the temperature."""
return self.check_sensors()["temperature"]
def check_humidity(self) -> float:
"""Return the humidity."""
return self.check_sensors()["humidity"]
class rm4pro(rm4mini, rmpro):
"""Controls a Broadlink RM4 pro."""
TYPE = "RM4PRO"
class rm(rmpro):
"""For backwards compatibility."""
TYPE = "RM2"
class rm4(rm4pro):
"""For backwards compatibility."""
TYPE = "RM4"