python-broadlink/broadlink/__init__.py

#!/usr/bin/python3
"""The python-broadlink library."""
import socket
import time
from datetime import datetime
from typing import Dict, List, Union, Tuple, Type

from .alarm import S1C
from .cover import dooya
from .climate import hysen
from .device import device
from .exceptions import check_error, exception
from .light import lb1
from .remote import rm, rm2, rm4
from .sensor import a1
from .switch import bg1, mp1, sp1, sp2
from .helpers import calculate_crc16, get_local_ip


def get_devices() -> Dict[int, Tuple[Type[device], str, str]]:
    """Return all supported devices."""
    return {
        0x0000: (sp1, "SP1", "Broadlink"),
        0x2711: (sp2, "SP2", "Broadlink"),
        0x2719: (sp2, "SP2-compatible", "Honeywell"),
        0x271a: (sp2, "SP2-compatible", "Honeywell"),
        0x2720: (sp2, "SP mini", "Broadlink"),
        0x2728: (sp2, "SP2-compatible", "URANT"),
        0x2733: (sp2, "SP3", "Broadlink"),
        0x2736: (sp2, "SP mini+", "Broadlink"),
        0x273e: (sp2, "SP mini", "Broadlink"),
        0x7530: (sp2, "SP2", "Broadlink (OEM)"),
        0x753e: (sp2, "SP mini 3", "Broadlink"),
        0X7544: (sp2, "SP2-CL", "Broadlink"),
        0x7546: (sp2, "SP2-UK/BR/IN", "Broadlink (OEM)"),
        0x7547: (sp2, "SC1", "Broadlink"),
        0x7918: (sp2, "SP2", "Broadlink (OEM)"),
        0x7919: (sp2, "SP2-compatible", "Honeywell"),
        0x791a: (sp2, "SP2-compatible", "Honeywell"),
        0x7d00: (sp2, "SP3-EU", "Broadlink (OEM)"),
        0x7d0d: (sp2, "SP mini 3", "Broadlink (OEM)"),
        0x9479: (sp2, "SP3S-US", "Broadlink"),
        0x947a: (sp2, "SP3S-EU", "Broadlink"),
        0x2712: (rm, "RM pro/pro+", "Broadlink"),
        0x272a: (rm, "RM pro", "Broadlink"),
        0x2737: (rm, "RM mini 3", "Broadlink"),
        0x273d: (rm, "RM pro", "Broadlink"),
        0x277c: (rm, "RM home", "Broadlink"),
        0x2783: (rm, "RM home", "Broadlink"),
        0x2787: (rm, "RM pro", "Broadlink"),
        0x278b: (rm, "RM plus", "Broadlink"),
        0x278f: (rm, "RM mini", "Broadlink"),
        0x2797: (rm, "RM pro+", "Broadlink"),
        0x279d: (rm, "RM pro+", "Broadlink"),
        0x27a1: (rm, "RM plus", "Broadlink"),
        0x27a6: (rm, "RM plus", "Broadlink"),
        0x27a9: (rm, "RM pro+", "Broadlink"),
        0x27c2: (rm, "RM mini 3", "Broadlink"),
        0x27d1: (rm, "RM mini 3", "Broadlink"),
        0x27de: (rm, "RM mini 3", "Broadlink"),
        0x51da: (rm4, "RM4 mini", "Broadlink"),
        0x5f36: (rm4, "RM mini 3", "Broadlink"),
        0x6026: (rm4, "RM4 pro", "Broadlink"),
        0x6070: (rm4, "RM4C mini", "Broadlink"),
        0x610e: (rm4, "RM4 mini", "Broadlink"),
        0x610f: (rm4, "RM4C mini", "Broadlink"),
        0x61a2: (rm4, "RM4 pro", "Broadlink"),
        0x62bc: (rm4, "RM4 mini", "Broadlink"),
        0x62be: (rm4, "RM4C mini", "Broadlink"),
        0x648d: (rm4, "RM4 mini", "Broadlink"),
        0x2714: (a1, "e-Sensor", "Broadlink"),
        0x4eb5: (mp1, "MP1-1K4S", "Broadlink"),
        0x4ef7: (mp1, "MP1-1K4S", "Broadlink (OEM)"),
        0x4f65: (mp1, "MP1-1K3S2U", "Broadlink"),
        0x5043: (lb1, "SB800TD", "Broadlink (OEM)"),
        0x504e: (lb1, "LB1", "Broadlink"),
        0x60c7: (lb1, "LB1", "Broadlink"),
        0x60c8: (lb1, "LB1", "Broadlink"),
        0x6112: (lb1, "LB1", "Broadlink"),
        0x2722: (S1C, "S2KIT", "Broadlink"),
        0x4ead: (hysen, "HY02B05H", "Hysen"),
        0x4e4d: (dooya, "DT360E-45/20", "Dooya"),
        0x51e3: (bg1, "BG800/BG900", "BG Electrical"),
    }


def gendevice(
    dev_type: int,
    host: Tuple[str, int],
    mac: Union[bytes, str],
    name: str = None,
    is_locked: bool = None,
) -> device:
    """Generate a device."""
    try:
        dev_class, model, manufacturer = get_devices()[dev_type]

    except KeyError:
        return device(host, mac, dev_type, name=name, is_locked=is_locked)

    return dev_class(
        host,
        mac,
        dev_type,
        name=name,
        model=model,
        manufacturer=manufacturer,
        is_locked=is_locked,
    )


def discover(
        timeout: int = None,
        local_ip_address: str = None,
        discover_ip_address: str = '255.255.255.255',
        discover_ip_port: int = 80,
) -> List[device]:
    """Discover devices connected to the local network."""
    local_ip_address = local_ip_address or get_local_ip()
    address = local_ip_address.split('.')
    cs = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    cs.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    cs.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
    cs.bind((local_ip_address, 0))
    port = cs.getsockname()[1]
    starttime = time.time()

    devices = []

    timezone = int(time.timezone / -3600)
    packet = bytearray(0x30)

    year = datetime.now().year

    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

    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
    packet[0x18] = int(address[0])
    packet[0x19] = int(address[1])
    packet[0x1a] = int(address[2])
    packet[0x1b] = int(address[3])
    packet[0x1c] = port & 0xff
    packet[0x1d] = port >> 8
    packet[0x26] = 6

    checksum = sum(packet, 0xbeaf) & 0xffff
    packet[0x20] = checksum & 0xff
    packet[0x21] = checksum >> 8

    cs.sendto(packet, (discover_ip_address, discover_ip_port))
    if timeout is None:
        response = cs.recvfrom(1024)
        responsepacket = bytearray(response[0])
        host = response[1]
        devtype = responsepacket[0x34] | responsepacket[0x35] << 8
        mac = responsepacket[0x3f:0x39:-1]
        name = responsepacket[0x40:].split(b'\x00')[0].decode('utf-8')
        is_locked = bool(responsepacket[-1])
        device = gendevice(devtype, host, mac, name=name, is_locked=is_locked)
        cs.close()
        return device

    while (time.time() - starttime) < timeout:
        cs.settimeout(timeout - (time.time() - starttime))
        try:
            response = cs.recvfrom(1024)
        except socket.timeout:
            cs.close()
            return devices
        responsepacket = bytearray(response[0])
        host = response[1]
        devtype = responsepacket[0x34] | responsepacket[0x35] << 8
        mac = responsepacket[0x3f:0x39:-1]
        name = responsepacket[0x40:].split(b'\x00')[0].decode('utf-8')
        is_locked = bool(responsepacket[-1])
        device = gendevice(devtype, host, mac, name=name, is_locked=is_locked)
        devices.append(device)
    cs.close()
    return devices


# Setup a new Broadlink device via AP Mode. Review the README to see how to enter AP Mode.
# Only tested with Broadlink RM3 Mini (Blackbean)
def setup(ssid: str, password: str, security_mode: int) -> None:
    """Set up a new Broadlink device via AP mode."""
    # Security mode options are (0 - none, 1 = WEP, 2 = WPA1, 3 = WPA2, 4 = WPA1/2)
    payload = bytearray(0x88)
    payload[0x26] = 0x14  # This seems to always be set to 14
    # Add the SSID to the payload
    ssid_start = 68
    ssid_length = 0
    for letter in ssid:
        payload[(ssid_start + ssid_length)] = ord(letter)
        ssid_length += 1
    # Add the WiFi password to the payload
    pass_start = 100
    pass_length = 0
    for letter in password:
        payload[(pass_start + pass_length)] = ord(letter)
        pass_length += 1

    payload[0x84] = ssid_length  # Character length of SSID
    payload[0x85] = pass_length  # Character length of password
    payload[0x86] = security_mode  # Type of encryption (00 - none, 01 = WEP, 02 = WPA1, 03 = WPA2, 04 = WPA1/2)

    checksum = sum(payload, 0xbeaf) & 0xffff
    payload[0x20] = checksum & 0xff  # Checksum 1 position
    payload[0x21] = checksum >> 8  # Checksum 2 position

    sock = socket.socket(socket.AF_INET,  # Internet
                         socket.SOCK_DGRAM)  # UDP
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
    sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
    sock.sendto(payload, ('255.255.255.255', 80))
    sock.close()