|
| 1 | +#!/usr/bin/env python |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +# PYTHON_ARGCOMPLETE_OK |
| 4 | + |
| 5 | +""" |
| 6 | + A program that listens for broadcast packets from Tuya devices and sends them via unicast to App clients. |
| 7 | + Useful to make the app work on broadcast-blocking WiFi networks. |
| 8 | +
|
| 9 | + Written by uzlonewolf (https://github.com/uzlonewolf) for the TinyTuya project https://github.com/jasonacox/tinytuya |
| 10 | +
|
| 11 | + Call with "-h" for options. |
| 12 | +""" |
| 13 | + |
| 14 | +BROADCASTTIME = 6 # How often to broadcast to port 7000 to get v3.5 devices to send us their info |
| 15 | + |
| 16 | +import json |
| 17 | +import logging |
| 18 | +import socket |
| 19 | +import select |
| 20 | +import time |
| 21 | +import traceback |
| 22 | +import argparse |
| 23 | + |
| 24 | +from tinytuya import decrypt_udp, UDPPORT, UDPPORTS, UDPPORTAPP |
| 25 | +from tinytuya.scanner import send_discovery_request |
| 26 | + |
| 27 | +try: |
| 28 | + import argcomplete |
| 29 | + HAVE_ARGCOMPLETE = True |
| 30 | +except: |
| 31 | + HAVE_ARGCOMPLETE = False |
| 32 | + |
| 33 | +if __name__ == '__main__': |
| 34 | + log = logging.getLogger( 'broadcast-relay' ) |
| 35 | +else: |
| 36 | + log = logging.getLogger(__name__) |
| 37 | + |
| 38 | +def relay( args ): |
| 39 | + log.info( 'Starting Relay' ) |
| 40 | + |
| 41 | + send_sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) |
| 42 | + #send_sock.bind(("", 0)) |
| 43 | + |
| 44 | + # Enable UDP listening broadcasting mode on UDP port 6666 - 3.1 Devices |
| 45 | + client = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDP) |
| 46 | + client.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) |
| 47 | + try: |
| 48 | + client.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) |
| 49 | + except AttributeError: |
| 50 | + # SO_REUSEPORT not available |
| 51 | + pass |
| 52 | + client.bind(("", UDPPORT)) |
| 53 | + |
| 54 | + # Enable UDP listening broadcasting mode on encrypted UDP port 6667 - 3.2-3.5 Devices |
| 55 | + clients = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDP) |
| 56 | + clients.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) |
| 57 | + try: |
| 58 | + clients.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) |
| 59 | + except AttributeError: |
| 60 | + # SO_REUSEPORT not available |
| 61 | + pass |
| 62 | + clients.bind(("", UDPPORTS)) |
| 63 | + |
| 64 | + # Enable UDP listening broadcasting mode on encrypted UDP port 7000 - App |
| 65 | + clientapp = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDP) |
| 66 | + clientapp.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) |
| 67 | + try: |
| 68 | + clientapp.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1) |
| 69 | + except AttributeError: |
| 70 | + # SO_REUSEPORT not available |
| 71 | + pass |
| 72 | + clientapp.bind(("", UDPPORTAPP)) |
| 73 | + |
| 74 | + broadcasted_apps = {} |
| 75 | + our_broadcasts = {} |
| 76 | + read_socks = [] |
| 77 | + write_socks = [] |
| 78 | + broadcast_query_timer = 0 |
| 79 | + |
| 80 | + while True: |
| 81 | + read_socks = [client, clients, clientapp] |
| 82 | + write_socks = [] |
| 83 | + |
| 84 | + try: |
| 85 | + rd, wr, _ = select.select( read_socks, write_socks, [] ) |
| 86 | + except KeyboardInterrupt as err: |
| 87 | + log.warning("**User Break**") |
| 88 | + break |
| 89 | + |
| 90 | + for sock in rd: |
| 91 | + data, addr = sock.recvfrom(4048) |
| 92 | + ip = addr[0] |
| 93 | + result = b'' |
| 94 | + |
| 95 | + if sock is clientapp: |
| 96 | + tgt_port = UDPPORTAPP |
| 97 | + result = None |
| 98 | + |
| 99 | + if ip in our_broadcasts: |
| 100 | + log.debug( 'Ignoring our own broadcast: %r', ip ) |
| 101 | + continue |
| 102 | + |
| 103 | + try: |
| 104 | + result = decrypt_udp( data ) |
| 105 | + result = json.loads(result) |
| 106 | + except: |
| 107 | + log.warning( '* Invalid UDP Packet from %r port %r: %r (%r)', ip, tgt_port, result, data, exc_info=True ) |
| 108 | + continue |
| 109 | + |
| 110 | + if 'from' in result and result['from'] == 'app': |
| 111 | + client_ip = result['ip'] if 'ip' in result else ip |
| 112 | + |
| 113 | + if client_ip not in broadcasted_apps: |
| 114 | + log.info( 'New Broadcast from App at %r (%r) - %r', client_ip, ip, result ) |
| 115 | + else: |
| 116 | + log.debug( 'Updated Broadcast from App at %r (%r) - %r', client_ip, ip, result ) |
| 117 | + |
| 118 | + broadcasted_apps[client_ip] = time.time() + (2 * BROADCASTTIME) |
| 119 | + |
| 120 | + if broadcast_query_timer < time.time(): |
| 121 | + broadcast_query_timer = time.time() + BROADCASTTIME |
| 122 | + our_broadcasts = send_broadcast() |
| 123 | + continue |
| 124 | + elif 'gwId' in result: |
| 125 | + # queried v3.5 device response, let it fall through |
| 126 | + pass |
| 127 | + else: |
| 128 | + log.warning( 'New Broadcast from App does not contain app data! src:%r - %r', ip, result ) |
| 129 | + continue |
| 130 | + |
| 131 | + elif sock is client: |
| 132 | + tgt_port = UDPPORT |
| 133 | + elif sock is clients: |
| 134 | + tgt_port = UDPPORTS |
| 135 | + else: |
| 136 | + tgt_port = '???' |
| 137 | + log.warning( 'Sock not known??' ) |
| 138 | + |
| 139 | + #log.debug("UDP Packet from %r port %r", ip, tgt_port) |
| 140 | + |
| 141 | + #if 'gwId' not in result: |
| 142 | + # print("* Payload missing required 'gwId' - from %r to port %r: %r (%r)\n" % (ip, tgt_port, result, data)) |
| 143 | + # log.debug("UDP Packet payload missing required 'gwId' - from %r port %r - %r", ip, tgt_port, data) |
| 144 | + # continue |
| 145 | + |
| 146 | + need_delete = [] |
| 147 | + for client_ip in broadcasted_apps: |
| 148 | + if broadcasted_apps[client_ip] < time.time(): |
| 149 | + need_delete.append( client_ip ) |
| 150 | + continue |
| 151 | + |
| 152 | + dst = (client_ip, tgt_port) |
| 153 | + #log.debug( 'Sending to: %r', dst ) |
| 154 | + send_sock.sendto( data, dst ) |
| 155 | + |
| 156 | + for client_ip in need_delete: |
| 157 | + log.info( 'Client App aged out: %r', client_ip ) |
| 158 | + del broadcasted_apps[client_ip] |
| 159 | + |
| 160 | + client.close() |
| 161 | + clients.close() |
| 162 | + clientapp.close() |
| 163 | + |
| 164 | + return |
| 165 | + |
| 166 | +def send_broadcast(): |
| 167 | + """ |
| 168 | + Send broadcasts to query for newer v3.5 devices |
| 169 | + """ |
| 170 | + our_broadcasts = send_discovery_request() |
| 171 | + if not our_broadcasts: |
| 172 | + our_broadcasts = {} |
| 173 | + return our_broadcasts |
| 174 | + |
| 175 | +if __name__ == '__main__': |
| 176 | + disc = 'Listens for broadcast packets from Tuya devices and sends them via unicast to App clients. Useful to make the app work on broadcast-blocking WiFi networks.' |
| 177 | + epi = None #'The "-s" option is designed to make the output display packets in the correct order when sorted, i.e. with `python3 pcap_parse.py ... | sort`' |
| 178 | + arg_parser = argparse.ArgumentParser( description=disc, epilog=epi ) |
| 179 | + arg_parser.add_argument( '-debug', '-d', help='Enable debug messages', action='store_true' ) |
| 180 | + |
| 181 | + if HAVE_ARGCOMPLETE: |
| 182 | + argcomplete.autocomplete( arg_parser ) |
| 183 | + |
| 184 | + args = arg_parser.parse_args() |
| 185 | + |
| 186 | + logging.basicConfig( level=logging.DEBUG + (0 if args.debug else 1) ) |
| 187 | + |
| 188 | + relay( args ) |
0 commit comments