Add 'third_party/python/broadlink/' from commit '17968ef4d4'
git-subtree-dir: third_party/python/broadlink git-subtree-mainline:0f53060159git-subtree-split:17968ef4d4
This commit is contained in:
Vincent Ambo
commit
9d94a727b2
10 changed files with 1836 additions and 0 deletions
85
third_party/python/broadlink/cli/README.md
vendored
Normal file
85
third_party/python/broadlink/cli/README.md
vendored
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
Command line interface for python-broadlink
|
||||
===========================================
|
||||
|
||||
This is a command line interface for broadlink python library
|
||||
|
||||
Tested with BroadLink RMPRO / RM2
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
You should have the broadlink python installed, this can be made in many linux distributions using :
|
||||
```
|
||||
sudo pip install broadlink
|
||||
```
|
||||
|
||||
Installation
|
||||
-----------
|
||||
Just copy this files
|
||||
|
||||
|
||||
Programs
|
||||
--------
|
||||
|
||||
|
||||
* broadlink_discovery
|
||||
used to run the discovery in the network
|
||||
this program withh show the command line parameters to be used with
|
||||
broadlink_cli to select broadlink device
|
||||
|
||||
* broadlink_cli
|
||||
used to send commands and query the broadlink device
|
||||
|
||||
|
||||
device specification formats
|
||||
----------------------------
|
||||
|
||||
Using separate parameters for each information:
|
||||
```
|
||||
broadlink_cli --type 0x2712 --host 1.1.1.1 --mac aaaaaaaaaa --temp
|
||||
```
|
||||
|
||||
Using all parameters as a single argument:
|
||||
```
|
||||
broadlink_cli --device "0x2712 1.1.1.1 aaaaaaaaaa" --temp
|
||||
```
|
||||
|
||||
Using file with parameters:
|
||||
```
|
||||
broadlink_cli --device @BEDROOM.device --temp
|
||||
```
|
||||
This is prefered as the configuration is stored in file and you can change
|
||||
just a file to point to a different hardware
|
||||
|
||||
Sample usage
|
||||
------------
|
||||
|
||||
Learn commands :
|
||||
```
|
||||
# Learn and save to file
|
||||
broadlink_cli --device @BEDROOM.device --learnfile LG-TV.power
|
||||
# LEard and show at console
|
||||
broadlink_cli --device @BEDROOM.device --learn
|
||||
```
|
||||
|
||||
|
||||
Send command :
|
||||
```
|
||||
broadlink_cli --device @BEDROOM.device --send @LG-TV.power
|
||||
broadlink_cli --device @BEDROOM.device --send ....datafromlearncommand...
|
||||
```
|
||||
|
||||
Get Temperature :
|
||||
```
|
||||
broadlink_cli --device @BEDROOM.device --temperature
|
||||
```
|
||||
|
||||
Get Energy Consumption (For a SmartPlug) :
|
||||
```
|
||||
broadlink_cli --device @BEDROOM.device --energy
|
||||
```
|
||||
|
||||
Once joined to the Broadlink provisioning Wi-Fi, configure it with your Wi-Fi details:
|
||||
```
|
||||
broadlink_cli --joinwifi MySSID MyWifiPassword
|
||||
```
|
||||
239
third_party/python/broadlink/cli/broadlink_cli
vendored
Executable file
239
third_party/python/broadlink/cli/broadlink_cli
vendored
Executable file
|
|
@ -0,0 +1,239 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
import argparse
|
||||
import base64
|
||||
import codecs
|
||||
import time
|
||||
|
||||
import broadlink
|
||||
|
||||
TICK = 32.84
|
||||
IR_TOKEN = 0x26
|
||||
|
||||
|
||||
def auto_int(x):
|
||||
return int(x, 0)
|
||||
|
||||
|
||||
def to_microseconds(bytes):
|
||||
result = []
|
||||
# print bytes[0] # 0x26 = 38for IR
|
||||
index = 4
|
||||
while index < len(bytes):
|
||||
chunk = bytes[index]
|
||||
index += 1
|
||||
if chunk == 0:
|
||||
chunk = bytes[index]
|
||||
chunk = 256 * chunk + bytes[index + 1]
|
||||
index += 2
|
||||
result.append(int(round(chunk * TICK)))
|
||||
if chunk == 0x0d05:
|
||||
break
|
||||
return result
|
||||
|
||||
|
||||
def durations_to_broadlink(durations):
|
||||
result = bytearray()
|
||||
result.append(IR_TOKEN)
|
||||
result.append(0)
|
||||
result.append(len(durations) % 256)
|
||||
result.append(len(durations) / 256)
|
||||
for dur in durations:
|
||||
num = int(round(dur / TICK))
|
||||
if num > 255:
|
||||
result.append(0)
|
||||
result.append(num / 256)
|
||||
result.append(num % 256)
|
||||
return result
|
||||
|
||||
|
||||
def format_durations(data):
|
||||
result = ''
|
||||
for i in range(0, len(data)):
|
||||
if len(result) > 0:
|
||||
result += ' '
|
||||
result += ('+' if i % 2 == 0 else '-') + str(data[i])
|
||||
return result
|
||||
|
||||
|
||||
def parse_durations(str):
|
||||
result = []
|
||||
for s in str.split():
|
||||
result.append(abs(int(s)))
|
||||
return result
|
||||
|
||||
|
||||
parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
|
||||
parser.add_argument("--device", help="device definition as 'type host mac'")
|
||||
parser.add_argument("--type", type=auto_int, default=0x2712, help="type of device")
|
||||
parser.add_argument("--host", help="host address")
|
||||
parser.add_argument("--mac", help="mac address (hex reverse), as used by python-broadlink library")
|
||||
parser.add_argument("--temperature", action="store_true", help="request temperature from device")
|
||||
parser.add_argument("--energy", action="store_true", help="request energy consumption from device")
|
||||
parser.add_argument("--check", action="store_true", help="check current power state")
|
||||
parser.add_argument("--checknl", action="store_true", help="check current nightlight state")
|
||||
parser.add_argument("--turnon", action="store_true", help="turn on device")
|
||||
parser.add_argument("--turnoff", action="store_true", help="turn off device")
|
||||
parser.add_argument("--turnnlon", action="store_true", help="turn on nightlight on the device")
|
||||
parser.add_argument("--turnnloff", action="store_true", help="turn off nightlight on the device")
|
||||
parser.add_argument("--switch", action="store_true", help="switch state from on to off and off to on")
|
||||
parser.add_argument("--send", action="store_true", help="send command")
|
||||
parser.add_argument("--sensors", action="store_true", help="check all sensors")
|
||||
parser.add_argument("--learn", action="store_true", help="learn command")
|
||||
parser.add_argument("--rfscanlearn", action="store_true", help="rf scan learning")
|
||||
parser.add_argument("--learnfile", help="save learned command to a specified file")
|
||||
parser.add_argument("--durations", action="store_true",
|
||||
help="use durations in micro seconds instead of the Broadlink format")
|
||||
parser.add_argument("--convert", action="store_true", help="convert input data to durations")
|
||||
parser.add_argument("--joinwifi", nargs=2, help="Args are SSID PASSPHRASE to configure Broadlink device with");
|
||||
parser.add_argument("data", nargs='*', help="Data to send or convert")
|
||||
args = parser.parse_args()
|
||||
|
||||
if args.device:
|
||||
values = args.device.split()
|
||||
type = int(values[0], 0)
|
||||
host = values[1]
|
||||
mac = bytearray.fromhex(values[2])
|
||||
elif args.mac:
|
||||
type = args.type
|
||||
host = args.host
|
||||
mac = bytearray.fromhex(args.mac)
|
||||
|
||||
if args.host or args.device:
|
||||
dev = broadlink.gendevice(type, (host, 80), mac)
|
||||
dev.auth()
|
||||
|
||||
if args.joinwifi:
|
||||
broadlink.setup(args.joinwifi[0], args.joinwifi[1], 4)
|
||||
|
||||
if args.convert:
|
||||
data = bytearray.fromhex(''.join(args.data))
|
||||
durations = to_microseconds(data)
|
||||
print(format_durations(durations))
|
||||
if args.temperature:
|
||||
print(dev.check_temperature())
|
||||
if args.energy:
|
||||
print(dev.get_energy())
|
||||
if args.sensors:
|
||||
try:
|
||||
data = dev.check_sensors()
|
||||
except:
|
||||
data = {}
|
||||
data['temperature'] = dev.check_temperature()
|
||||
for key in data:
|
||||
print("{} {}".format(key, data[key]))
|
||||
if args.send:
|
||||
data = durations_to_broadlink(parse_durations(' '.join(args.data))) \
|
||||
if args.durations else bytearray.fromhex(''.join(args.data))
|
||||
dev.send_data(data)
|
||||
if args.learn or args.learnfile:
|
||||
dev.enter_learning()
|
||||
data = None
|
||||
print("Learning...")
|
||||
timeout = 30
|
||||
while (data is None) and (timeout > 0):
|
||||
time.sleep(2)
|
||||
timeout -= 2
|
||||
data = dev.check_data()
|
||||
if data:
|
||||
learned = format_durations(to_microseconds(bytearray(data))) \
|
||||
if args.durations \
|
||||
else ''.join(format(x, '02x') for x in bytearray(data))
|
||||
if args.learn:
|
||||
print(learned)
|
||||
decode_hex = codecs.getdecoder("hex_codec")
|
||||
print("Base64: " + str(base64.b64encode(decode_hex(learned)[0])))
|
||||
if args.learnfile:
|
||||
print("Saving to {}".format(args.learnfile))
|
||||
with open(args.learnfile, "w") as text_file:
|
||||
text_file.write(learned)
|
||||
else:
|
||||
print("No data received...")
|
||||
if args.check:
|
||||
if dev.check_power():
|
||||
print('* ON *')
|
||||
else:
|
||||
print('* OFF *')
|
||||
if args.checknl:
|
||||
if dev.check_nightlight():
|
||||
print('* ON *')
|
||||
else:
|
||||
print('* OFF *')
|
||||
if args.turnon:
|
||||
dev.set_power(True)
|
||||
if dev.check_power():
|
||||
print('== Turned * ON * ==')
|
||||
else:
|
||||
print('!! Still OFF !!')
|
||||
if args.turnoff:
|
||||
dev.set_power(False)
|
||||
if dev.check_power():
|
||||
print('!! Still ON !!')
|
||||
else:
|
||||
print('== Turned * OFF * ==')
|
||||
if args.turnnlon:
|
||||
dev.set_nightlight(True)
|
||||
if dev.check_nightlight():
|
||||
print('== Turned * ON * ==')
|
||||
else:
|
||||
print('!! Still OFF !!')
|
||||
if args.turnnloff:
|
||||
dev.set_nightlight(False)
|
||||
if dev.check_nightlight():
|
||||
print('!! Still ON !!')
|
||||
else:
|
||||
print('== Turned * OFF * ==')
|
||||
if args.switch:
|
||||
if dev.check_power():
|
||||
dev.set_power(False)
|
||||
print('* Switch to OFF *')
|
||||
else:
|
||||
dev.set_power(True)
|
||||
print('* Switch to ON *')
|
||||
if args.rfscanlearn:
|
||||
dev.sweep_frequency()
|
||||
print("Learning RF Frequency, press and hold the button to learn...")
|
||||
|
||||
timeout = 20
|
||||
|
||||
while (not dev.check_frequency()) and (timeout > 0):
|
||||
time.sleep(1)
|
||||
timeout -= 1
|
||||
|
||||
if timeout <= 0:
|
||||
print("RF Frequency not found")
|
||||
dev.cancel_sweep_frequency()
|
||||
exit(1)
|
||||
|
||||
print("Found RF Frequency - 1 of 2!")
|
||||
print("You can now let go of the button")
|
||||
|
||||
input("Press enter to continue...")
|
||||
|
||||
print("To complete learning, single press the button you want to learn")
|
||||
|
||||
dev.find_rf_packet()
|
||||
|
||||
data = None
|
||||
timeout = 20
|
||||
|
||||
while (data is None) and (timeout > 0):
|
||||
time.sleep(1)
|
||||
timeout -= 1
|
||||
data = dev.check_data()
|
||||
|
||||
if data:
|
||||
print("Found RF Frequency - 2 of 2!")
|
||||
learned = format_durations(to_microseconds(bytearray(data))) \
|
||||
if args.durations \
|
||||
else ''.join(format(x, '02x') for x in bytearray(data))
|
||||
if args.learnfile is None:
|
||||
print(learned)
|
||||
decode_hex = codecs.getdecoder("hex_codec")
|
||||
print("Base64: {}".format(str(base64.b64encode(decode_hex(learned)[0]))))
|
||||
if args.learnfile is not None:
|
||||
print("Saving to {}".format(args.learnfile))
|
||||
with open(args.learnfile, "w") as text_file:
|
||||
text_file.write(learned)
|
||||
else:
|
||||
print("No data received...")
|
||||
27
third_party/python/broadlink/cli/broadlink_discovery
vendored
Executable file
27
third_party/python/broadlink/cli/broadlink_discovery
vendored
Executable file
|
|
@ -0,0 +1,27 @@
|
|||
#!/usr/bin/env python
|
||||
|
||||
import argparse
|
||||
|
||||
import broadlink
|
||||
|
||||
parser = argparse.ArgumentParser(fromfile_prefix_chars='@')
|
||||
parser.add_argument("--timeout", type=int, default=5, help="timeout to wait for receiving discovery responses")
|
||||
parser.add_argument("--ip", default=None, help="ip address to use in the discovery")
|
||||
parser.add_argument("--dst-ip", default=None, help="destination ip address to use in the discovery")
|
||||
args = parser.parse_args()
|
||||
|
||||
print("Discovering...")
|
||||
devices = broadlink.discover(timeout=args.timeout, local_ip_address=args.ip, discover_ip_address=args.dst_ip)
|
||||
for device in devices:
|
||||
if device.auth():
|
||||
print("###########################################")
|
||||
print(device.type)
|
||||
print("# broadlink_cli --type {} --host {} --mac {}".format(hex(device.devtype), device.host[0],
|
||||
''.join(format(x, '02x') for x in device.mac)))
|
||||
print("Device file data (to be used with --device @filename in broadlink_cli) : ")
|
||||
print("{} {} {}".format(hex(device.devtype), device.host[0], ''.join(format(x, '02x') for x in device.mac)))
|
||||
if hasattr(device, 'check_temperature'):
|
||||
print("temperature = {}".format(device.check_temperature()))
|
||||
print("")
|
||||
else:
|
||||
print("Error authenticating with device : {}".format(device.host))
|
||||
Loading…
Add table
Add a link
Reference in a new issue