mirror of
https://github.com/mjg59/python-broadlink.git
synced 2024-09-21 20:40:11 +02:00
16abdf850f
This update improves device discovery by broadcasting several hello messages and ignoring repeated responses.
328 lines
10 KiB
Python
328 lines
10 KiB
Python
"""Support for Broadlink devices."""
|
|
import socket
|
|
import threading
|
|
import random
|
|
import time
|
|
from datetime import datetime
|
|
from typing import Generator, Tuple, Union
|
|
|
|
from cryptography.hazmat.backends import default_backend
|
|
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
|
|
|
|
from .exceptions import check_error, exception
|
|
|
|
HelloResponse = Tuple[int, Tuple[str, int], str, str, bool]
|
|
|
|
|
|
def scan(
|
|
timeout: int = 10,
|
|
local_ip_address: str = None,
|
|
discover_ip_address: str = '255.255.255.255',
|
|
discover_ip_port: int = 80,
|
|
) -> Generator[HelloResponse, None, None]:
|
|
"""Broadcast a hello message and yield responses."""
|
|
conn = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
|
conn.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
conn.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
|
|
|
|
if local_ip_address:
|
|
conn.bind((local_ip_address, 0))
|
|
port = conn.getsockname()[1]
|
|
else:
|
|
local_ip_address = "0.0.0.0"
|
|
port = 0
|
|
|
|
packet = bytearray(0x30)
|
|
|
|
timezone = int(time.timezone / -3600)
|
|
if timezone < 0:
|
|
packet[0x08] = 0xff + timezone - 1
|
|
packet[0x09] = 0xff
|
|
packet[0x0a] = 0xff
|
|
packet[0x0b] = 0xff
|
|
else:
|
|
packet[0x08] = timezone
|
|
packet[0x09] = 0
|
|
packet[0x0a] = 0
|
|
packet[0x0b] = 0
|
|
|
|
year = datetime.now().year
|
|
packet[0x0c] = year & 0xff
|
|
packet[0x0d] = year >> 8
|
|
packet[0x0e] = datetime.now().minute
|
|
packet[0x0f] = datetime.now().hour
|
|
subyear = str(year)[2:]
|
|
packet[0x10] = int(subyear)
|
|
packet[0x11] = datetime.now().isoweekday()
|
|
packet[0x12] = datetime.now().day
|
|
packet[0x13] = datetime.now().month
|
|
|
|
address = local_ip_address.split('.')
|
|
packet[0x18] = int(address[3])
|
|
packet[0x19] = int(address[2])
|
|
packet[0x1a] = int(address[1])
|
|
packet[0x1b] = int(address[0])
|
|
packet[0x1c] = port & 0xff
|
|
packet[0x1d] = port >> 8
|
|
packet[0x26] = 6
|
|
|
|
checksum = sum(packet, 0xbeaf) & 0xffff
|
|
packet[0x20] = checksum & 0xff
|
|
packet[0x21] = checksum >> 8
|
|
|
|
starttime = time.time()
|
|
discovered = []
|
|
|
|
try:
|
|
while (time.time() - starttime) < timeout:
|
|
conn.sendto(packet, (discover_ip_address, discover_ip_port))
|
|
conn.settimeout(1)
|
|
|
|
while True:
|
|
try:
|
|
response, host = conn.recvfrom(1024)
|
|
except socket.timeout:
|
|
break
|
|
|
|
devtype = response[0x34] | response[0x35] << 8
|
|
mac = bytes(reversed(response[0x3a:0x40]))
|
|
if (host, mac, devtype) in discovered:
|
|
continue
|
|
discovered.append((host, mac, devtype))
|
|
|
|
name = response[0x40:].split(b'\x00')[0].decode('utf-8')
|
|
is_locked = bool(response[-1])
|
|
yield devtype, host, mac, name, is_locked
|
|
finally:
|
|
conn.close()
|
|
|
|
|
|
class device:
|
|
"""Controls a Broadlink device."""
|
|
|
|
def __init__(
|
|
self,
|
|
host: Tuple[str, int],
|
|
mac: Union[bytes, str],
|
|
devtype: int,
|
|
timeout: int = 10,
|
|
name: str = None,
|
|
model: str = None,
|
|
manufacturer: str = None,
|
|
is_locked: bool = None,
|
|
) -> None:
|
|
"""Initialize the controller."""
|
|
self.host = host
|
|
self.mac = bytes.fromhex(mac) if isinstance(mac, str) else mac
|
|
self.devtype = devtype if devtype is not None else 0x272a
|
|
self.timeout = timeout
|
|
self.name = name
|
|
self.model = model
|
|
self.manufacturer = manufacturer
|
|
self.is_locked = is_locked
|
|
self.count = random.randrange(0xffff)
|
|
self.iv = bytes.fromhex('562e17996d093d28ddb3ba695a2e6f58')
|
|
self.id = bytes(4)
|
|
self.type = "Unknown"
|
|
self.lock = threading.Lock()
|
|
|
|
self.aes = None
|
|
key = bytes.fromhex('097628343fe99e23765c1513accf8b02')
|
|
self.update_aes(key)
|
|
|
|
def __repr__(self):
|
|
return "<%s: %s %s (%s) at %s:%s | %s | %s | %s>" % (
|
|
type(self).__name__,
|
|
self.manufacturer,
|
|
self.model,
|
|
hex(self.devtype),
|
|
self.host[0],
|
|
self.host[1],
|
|
':'.join(format(x, '02x') for x in self.mac),
|
|
self.name,
|
|
"Locked" if self.is_locked else "Unlocked",
|
|
)
|
|
|
|
def update_aes(self, key: bytes) -> None:
|
|
"""Update AES."""
|
|
self.aes = Cipher(
|
|
algorithms.AES(key), modes.CBC(self.iv), backend=default_backend()
|
|
)
|
|
|
|
def encrypt(self, payload: bytes) -> bytes:
|
|
"""Encrypt the payload."""
|
|
encryptor = self.aes.encryptor()
|
|
return encryptor.update(payload) + encryptor.finalize()
|
|
|
|
def decrypt(self, payload: bytes) -> bytes:
|
|
"""Decrypt the payload."""
|
|
decryptor = self.aes.decryptor()
|
|
return decryptor.update(payload) + decryptor.finalize()
|
|
|
|
def auth(self) -> bool:
|
|
"""Authenticate to the device."""
|
|
payload = bytearray(0x50)
|
|
payload[0x04] = 0x31
|
|
payload[0x05] = 0x31
|
|
payload[0x06] = 0x31
|
|
payload[0x07] = 0x31
|
|
payload[0x08] = 0x31
|
|
payload[0x09] = 0x31
|
|
payload[0x0a] = 0x31
|
|
payload[0x0b] = 0x31
|
|
payload[0x0c] = 0x31
|
|
payload[0x0d] = 0x31
|
|
payload[0x0e] = 0x31
|
|
payload[0x0f] = 0x31
|
|
payload[0x10] = 0x31
|
|
payload[0x11] = 0x31
|
|
payload[0x12] = 0x31
|
|
payload[0x1e] = 0x01
|
|
payload[0x2d] = 0x01
|
|
payload[0x30] = ord('T')
|
|
payload[0x31] = ord('e')
|
|
payload[0x32] = ord('s')
|
|
payload[0x33] = ord('t')
|
|
payload[0x34] = ord(' ')
|
|
payload[0x35] = ord(' ')
|
|
payload[0x36] = ord('1')
|
|
|
|
response = self.send_packet(0x65, payload)
|
|
check_error(response[0x22:0x24])
|
|
payload = self.decrypt(response[0x38:])
|
|
|
|
key = payload[0x04:0x14]
|
|
if len(key) % 16 != 0:
|
|
return False
|
|
|
|
self.id = payload[0x03::-1]
|
|
self.update_aes(key)
|
|
return True
|
|
|
|
def hello(self, local_ip_address=None) -> bool:
|
|
"""Send a hello message to the device.
|
|
|
|
Device information is checked before updating name and lock status.
|
|
"""
|
|
responses = scan(
|
|
timeout=self.timeout,
|
|
local_ip_address=local_ip_address,
|
|
discover_ip_address=self.host[0],
|
|
discover_ip_port=self.host[1],
|
|
)
|
|
try:
|
|
devtype, host, mac, name, is_locked = next(responses)
|
|
except StopIteration:
|
|
raise exception(-4000) # Network timeout.
|
|
|
|
if (devtype, host, mac) != (self.devtype, self.host, self.mac):
|
|
raise exception(-2040) # Device information is not intact.
|
|
|
|
self.name = name
|
|
self.is_locked = is_locked
|
|
return True
|
|
|
|
def get_fwversion(self) -> int:
|
|
"""Get firmware version."""
|
|
packet = bytearray([0x68])
|
|
response = self.send_packet(0x6a, packet)
|
|
check_error(response[0x22:0x24])
|
|
payload = self.decrypt(response[0x38:])
|
|
return payload[0x4] | payload[0x5] << 8
|
|
|
|
def set_name(self, name: str) -> None:
|
|
"""Set device name."""
|
|
packet = bytearray(4)
|
|
packet += name.encode('utf-8')
|
|
packet += bytearray(0x50 - len(packet))
|
|
packet[0x43] = bool(self.is_locked)
|
|
response = self.send_packet(0x6a, packet)
|
|
check_error(response[0x22:0x24])
|
|
self.name = name
|
|
|
|
def set_lock(self, state: bool) -> None:
|
|
"""Lock/unlock the device."""
|
|
packet = bytearray(4)
|
|
packet += self.name.encode('utf-8')
|
|
packet += bytearray(0x50 - len(packet))
|
|
packet[0x43] = bool(state)
|
|
response = self.send_packet(0x6a, packet)
|
|
check_error(response[0x22:0x24])
|
|
self.is_locked = bool(state)
|
|
|
|
def get_type(self) -> str:
|
|
"""Return device type."""
|
|
return self.type
|
|
|
|
def send_packet(self, command: int, payload: bytes) -> bytes:
|
|
"""Send a packet to the device."""
|
|
self.count = (self.count + 1) & 0xffff
|
|
packet = bytearray(0x38)
|
|
packet[0x00] = 0x5a
|
|
packet[0x01] = 0xa5
|
|
packet[0x02] = 0xaa
|
|
packet[0x03] = 0x55
|
|
packet[0x04] = 0x5a
|
|
packet[0x05] = 0xa5
|
|
packet[0x06] = 0xaa
|
|
packet[0x07] = 0x55
|
|
packet[0x24] = self.devtype & 0xff
|
|
packet[0x25] = self.devtype >> 8
|
|
packet[0x26] = command
|
|
packet[0x28] = self.count & 0xff
|
|
packet[0x29] = self.count >> 8
|
|
packet[0x2a] = self.mac[5]
|
|
packet[0x2b] = self.mac[4]
|
|
packet[0x2c] = self.mac[3]
|
|
packet[0x2d] = self.mac[2]
|
|
packet[0x2e] = self.mac[1]
|
|
packet[0x2f] = self.mac[0]
|
|
packet[0x30] = self.id[3]
|
|
packet[0x31] = self.id[2]
|
|
packet[0x32] = self.id[1]
|
|
packet[0x33] = self.id[0]
|
|
|
|
# pad the payload for AES encryption
|
|
padding = (16 - len(payload)) % 16
|
|
if padding:
|
|
payload = bytearray(payload)
|
|
payload += bytearray(padding)
|
|
|
|
checksum = sum(payload, 0xbeaf) & 0xffff
|
|
packet[0x34] = checksum & 0xff
|
|
packet[0x35] = checksum >> 8
|
|
|
|
payload = self.encrypt(payload)
|
|
for i in range(len(payload)):
|
|
packet.append(payload[i])
|
|
|
|
checksum = sum(packet, 0xbeaf) & 0xffff
|
|
packet[0x20] = checksum & 0xff
|
|
packet[0x21] = checksum >> 8
|
|
|
|
start_time = time.time()
|
|
with self.lock:
|
|
conn = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
|
conn.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
|
|
while True:
|
|
try:
|
|
conn.sendto(packet, self.host)
|
|
conn.settimeout(1)
|
|
resp, _ = conn.recvfrom(2048)
|
|
break
|
|
except socket.timeout:
|
|
if (time.time() - start_time) > self.timeout:
|
|
conn.close()
|
|
raise exception(-4000) # Network timeout.
|
|
conn.close()
|
|
|
|
if len(resp) < 0x30:
|
|
raise exception(-4007) # Length error.
|
|
|
|
checksum = resp[0x20] | (resp[0x21] << 8)
|
|
if sum(resp, 0xbeaf) - sum(resp[0x20:0x22]) & 0xffff != checksum:
|
|
raise exception(-4008) # Checksum error.
|
|
|
|
return resp
|