Python Plugin : Broadlink

[zak45]

Hi,
complete new plugin.
Old version (4.x) could not be upgraded, you need to create a new folder, and import your ini files if you want to use this one.


Info : do not use the official app if using broadlink library
see https://github.com/mjg59/python-broadlink/issues/377

note: pip need to be installed
(for linux users: sudo apt install python3-pip)


To be able to see the Web Pages, Custom menu need to be activated: Domoticz / settings.

Be sure that your active python version is > 3.4 (Change python version system-wide)
this mean: python --version ( or sudo python --version for linux users)
should give output e.g. python 3.x.x and not python 2.x.x

this one : https://linuxconfig.org/how-to-change-f ... bian-linux


Features:

Multi-Language
Multi-Devices (MP1 / A1 / SP1-2-3 / RM2-3 Pro & mini / RM4 Pro & mini
Web Admin page
RF is now managed
Multi-code ini file creation by drag & drop
Create Broadlink ini from Pronto Hex
Create ini from e-Control
Modify number of repetition (do and test with caution)
Import feature
Send code with a simple URL
and more .....


Installation :

create Broadlink directory under your Domoticz/plugins folder.
download setup.py from here : https://raw.githubusercontent.com/zak-4 ... n/setup.py
and put it into Broadlink directory.

Open a terminal session, go to Broadlink directory and execute this command : python setup.py (tested on Windows with admin right, maybe need sudo on linux e.g; : sudo python setup.py)

Provide response to questions.
Restart Domoticz.
Create a new hardware, type : Broadlink with Kodi Remote

Manual installation:

see GitHub

WebAdmin Page overview:

A1admin.PNG (71.89 KiB) Viewed 18004 times

rm2admin.PNG (65.04 KiB) Viewed 18004 times

sp3sadmin.PNG (74.41 KiB) Viewed 18004 times

For Devlopers:
this is the port necessary to use MS visual debugger

--> main py : plugin.py
Domoticz.Log('Waiting for MS Visual Studio remote debugger connection ....')
ptvsd.enable_attach(address=('0.0.0.0', 5678))

--> subprocess : Dombroadlink.py
ptvsd.enable_attach(address=('0.0.0.0', 6789))

module ptvsd need to be installed.


Lets try and play with it.
Provide bugs/feedback here.

Enjoy !!

test platform : Windows 10
Version: 2020.2 (build 12120)
Build Hash: ecd90cd57
Compile Date: 2020-06-04 20:50:42
dzVents Version: 3.0.9
Python Version: 3.7.5 (tags/v3.7.5:5c02a39a0b, Oct 14 2019, 23:09:19) [MSC v.1916 32 bit (Intel)]

[Hogis]

I'm getting a syntax error when trying to install on a RaspberryPi:

File "setup.py", line 170
print("\r>> Bytes downloaded -->" + state + str(leng) + state, end='', flush=True)
^
SyntaxError: invalid syntax

[zak45]

Try by removing the line 170.

[Hogis]

Now I get:

Traceback (most recent call last):
File "setup.py", line 16, in <module>
import requests
ImportError: No module named requests

[zak45]

you need to install the 'requests' module:

should be:
sudo -H python -m pip install requests

these are modules required by the setup.py:

import socket
import os
import sys
import subprocess
import requests
import urllib.request
import urllib.parse
import urllib.error
import json
import traceback
from zipfile import ZipFile
import time

[esecamara]

pi@raspberrypi:~/domoticz/plugins/Broadlink $ python setup.py
File "setup.py", line 194
print("\r>> Bytes downloaded -->" + state + str(leng) + state, end='', flush=True)
^
SyntaxError: invalid syntax

[zak45]

Now I get:

Traceback (most recent call last):
File "setup.py", line 16, in <module>
import requests
ImportError: No module named requests

I have modified setup.py to change the order installation. just download it and try again.

[JUNA]

I also experienced the SyntaxError: invalid syntax. After changing python setup.py --> python3 setup.py it was possible to install.

But after restart I get following error:
2020-07-02 20:04:01.351 Error: (Broadlink) failed to load 'plugin.py', Python Path used was '/home/pi/domoticz/plugins/Broadlink/:/usr/lib/python37.zip:/usr/lib/python3.7:/usr/lib/python3.7/lib-dynload:/usr/local/lib/python3.7/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.7/dist-packages'.
2020-07-02 20:04:01.351 Error: (RM3mini) Module Import failed, exception: 'ModuleNotFoundError'
2020-07-02 20:04:01.351 Error: (RM3mini) Module Import failed: ' Name: requests_toolbelt'
2020-07-02 20:04:01.351 Error: (RM3mini) Error Line details not available.

Any suggestions how to fix this?

[zak45]

I also experienced the SyntaxError: invalid syntax. After changing python setup.py --> python3 setup.py it was possible to install.

But after restart I get following error:
2020-07-02 20:04:01.351 Error: (Broadlink) failed to load 'plugin.py', Python Path used was '/home/pi/domoticz/plugins/Broadlink/:/usr/lib/python37.zip:/usr/lib/python3.7:/usr/lib/python3.7/lib-dynload:/usr/local/lib/python3.7/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.7/dist-packages'.
2020-07-02 20:04:01.351 Error: (RM3mini) Module Import failed, exception: 'ModuleNotFoundError'
2020-07-02 20:04:01.351 Error: (RM3mini) Module Import failed: ' Name: requests_toolbelt'
2020-07-02 20:04:01.351 Error: (RM3mini) Error Line details not available.

Any suggestions how to fix this?

if you need to enter python3 instead python, looks like your python settings are not ok.
if you enter python --version --> what's your output ?
if not 3.x.... you need to change that.. see post below.

Once python v3.x is your default version, just redo setup.py.

[zak45]

setup.py improved.
final check at the end to help debug.

[JUNA]

I also experienced the SyntaxError: invalid syntax. After changing python setup.py --> python3 setup.py it was possible to install.

But after restart I get following error:
2020-07-02 20:04:01.351 Error: (Broadlink) failed to load 'plugin.py', Python Path used was '/home/pi/domoticz/plugins/Broadlink/:/usr/lib/python37.zip:/usr/lib/python3.7:/usr/lib/python3.7/lib-dynload:/usr/local/lib/python3.7/dist-packages:/usr/lib/python3/dist-packages:/usr/lib/python3.7/dist-packages'.
2020-07-02 20:04:01.351 Error: (RM3mini) Module Import failed, exception: 'ModuleNotFoundError'
2020-07-02 20:04:01.351 Error: (RM3mini) Module Import failed: ' Name: requests_toolbelt'
2020-07-02 20:04:01.351 Error: (RM3mini) Error Line details not available.

Any suggestions how to fix this?

if you need to enter python3 instead python, looks like your python settings are not ok.
if you enter python --version --> what's your output ?
if not 3.x.... you need to change that.. see post below.

Once python v3.x is your default version, just redo setup.py.

I think I have fixed python issue. No errors after running python setup.py.
After reboot log showing errors below. Am I using correct python version or is error caused by something else?

Raspberry Pi 4
Version: 2020.2
Build Hash: b63341bc0
Compile Date: 2020-04-26 13:47:55
dzVents Version: 3.0.2
Python Version: 3.7.3 (default, Dec 20 2019, 18:57:59) [GCC 8.3.0]

2020-07-03 00:31:00.832 Sunrise: 05:24:00 SunSet: 22:03:00
2020-07-03 00:31:00.832 Day length: 16:39:00 Sun at south: 13:44:00
2020-07-03 00:31:00.832 Civil twilight start: 04:35:00 Civil twilight end: 22:52:00
2020-07-03 00:31:00.832 Nautical twilight start: 03:19:00 Nautical twilight end: 00:08:00
2020-07-03 00:31:00.832 There is no astronomical twilight in the space of 24 hours
2020-07-03 00:31:00.717 Status: Domoticz V2020.2 (c)2012-2020 GizMoCuz
2020-07-03 00:31:00.717 Status: Build Hash: b63341bc0, Date: 2020-04-26 13:47:55
2020-07-03 00:31:00.717 Status: Startup Path: /home/pi/domoticz/
2020-07-03 00:31:01.234 Active notification Subsystems: (0/13)
2020-07-03 00:31:01.275 Starting shared server on: :::6144
2020-07-03 00:31:01.227 Status: PluginSystem: Started, Python version '3.7.3'.
2020-07-03 00:31:01.256 Status: WebServer(HTTP) started on address: :: with port 8080
2020-07-03 00:31:01.272 Status: WebServer(SSL) started on address: :: with port 443
2020-07-03 00:31:01.275 Status: TCPServer: shared server started...
2020-07-03 00:31:01.276 Status: RxQueue: queue worker started...
2020-07-03 00:31:03.276 Status: (RM3m) Started.
2020-07-03 00:31:03.276 Status: NotificationSystem: thread started...
2020-07-03 00:31:03.276 Status: EventSystem: reset all events...
2020-07-03 00:31:03.287 Status: EventSystem: reset all device statuses...
2020-07-03 00:31:03.361 Status: PluginSystem: Entering work loop.
2020-07-03 00:31:03.403 Status: Python EventSystem: Initalizing event module.
2020-07-03 00:31:03.404 Status: EventSystem: Started
2020-07-03 00:31:03.404 Status: EventSystem: Queue thread started...
2020-07-03 00:31:04.443 (RM3m) lang file : /home/pi/domoticz/plugins/Broadlink/lng/en_en.lng
2020-07-03 00:31:04.443 (RM3m) Language loaded for : en
2020-07-03 00:31:04.446 (RM3m) Listen on BROWebServer - Port: 9000
2020-07-03 00:31:04.446 (RM3m) Connecting to: 192.168.1.173 : 24DFA7E01829
2020-07-03 00:31:04.467 (RM3m) Update 0:'Off' (RM3m - RM2-Status)
2020-07-03 00:31:04.481 (RM3m) Plugin Device count start on : 9
2020-07-03 00:31:04.491 (RM3m) Admin html file created: /home/pi/domoticz/www/templates/Broadlink-RM2-2.html
2020-07-03 00:31:04.492 (RM3m) Command line file created: /home/pi/domoticz/plugins/Broadlink/log/2RM2.txt
2020-07-03 00:31:04.438 Status: (RM3m) Entering work loop.
2020-07-03 00:31:04.438 Status: (RM3m) Initialized version 1.0.0, author 'zak45'
2020-07-03 00:31:04.457 Error: (RM3m) Traceback (most recent call last):
2020-07-03 00:31:04.457 File "/home/pi/domoticz/plugins/Broadlink/plugin.py", line 1703, in broadlink_connect
2020-07-03 00:31:04.457 DEVICE.auth()
2020-07-03 00:31:04.457 File "/usr/lib/python3.7/broadlink/__init__.py", line 224, in auth
2020-07-03 00:31:04.457 response = self.send_packet(0x65, payload)
2020-07-03 00:31:04.457 File "/usr/lib/python3.7/broadlink/__init__.py", line 296, in send_packet
2020-07-03 00:31:04.457 cs.sendto(packet, self.host)
2020-07-03 00:31:04.457 OSError: [Errno 101] Network is unreachable
2020-07-03 00:31:04.457
2020-07-03 00:31:04.457 Error: (RM3m) Error to connect to Broadlink device: 192.168.1.173

[zak45]

2020-07-03 00:31:04.457 File "/usr/lib/python3.7/broadlink/__init__.py", line 296, in send_packet
2020-07-03 00:31:04.457 cs.sendto(packet, self.host)
2020-07-03 00:31:04.457 OSError: [Errno 101] Network is unreachable
2020-07-03 00:31:04.457
2020-07-03 00:31:04.457 Error: (RM3m) Error to connect to Broadlink device: 192.168.1.173

Verify your network settings: IP address etc ... maybe firewall blocking.

[ayasystems]

Hi

FYI:

broadlink_plugin.jpg (45.01 KiB) Viewed 17859 times

Could be better launch directly with python3 if you have python2 and python3 installed

Collecting httpx==0.13.3 (from googletrans)
Could not find a version that satisfies the requirement httpx==0.13.3 (from googletrans) (from versions: )
No matching distribution found for httpx==0.13.3 (from googletrans)
ERROR to start subprocess

Collecting pre-commit (from translate)
Downloading https://www.piwheels.org/simple/pre-com ... ne-any.whl (171kB)
100% |████████████████████████████████| 174kB 1.4MB/s
pre-commit requires Python '>=3.6.1' but the running Python is 2.7.16

at the end of process

Looking in indexes: https://pypi.org/simple, https://www.piwheels.org/simple
Processing ./python-broadlink-master
Requirement already satisfied: cryptography>=2.1.1 in /usr/lib/python2.7/dist-packages (from broadlink==0.14.0) (2.6.1)
Building wheels for collected packages: broadlink
Running setup.py bdist_wheel for broadlink ... done
Stored in directory: /root/.cache/pip/wheels/64/c9/3d/783a37f13531f3773a98e682962b2b4946ceaeb6fcfece1d46
Successfully built broadlink
Installing collected packages: broadlink
Successfully installed broadlink-0.14.0
We have installed : python-broadlink-master/.
________________________________________
# We do necessary modifications depend of Platform
----------------------------------------
put *.py files executable (+x) OK
put *.sh files executable (+x) OK
Error importing googletrans

Regards

[ayasystems]

When I try to learn a new IR code i get the following error

2020-07-03 17:25:53.807 Status: User: Admin initiated a switch command (14/new-broadlink - IR Commands/Set Level)
2020-07-03 17:25:53.865 Error: (new-broadlink) 'onCommand' failed 'TimeoutExpired'.
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 445 in '/home/pi/domoticz/plugins/Broadlink/plugin.py', function onCommand
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 2294 in '/home/pi/domoticz/plugins/Broadlink/plugin.py', function start_shell
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 342 in '/usr/lib/python3.7/subprocess.py', function check_call
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 329 in '/usr/lib/python3.7/subprocess.py', function call
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 1006 in '/usr/lib/python3.7/subprocess.py', function wait
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 1616 in '/usr/lib/python3.7/subprocess.py', function _wait
2020-07-03 17:25:57.387 (new-broadlink) Connected to Broadlink device: 192.168.3.97 RM2
2020-07-03 17:25:57.398 (new-broadlink) Update 1:'On' (new-broadlink - RM2-Status)

learn_device.jpg (166.77 KiB) Viewed 17857 times

If you want access to a raspberry to test it into this environment i can provide it for you, let me know

[zak45]

Could be better launch directly with python3 if you have python2 and python3 installed

Collecting httpx==0.13.3 (from googletrans)
Could not find a version that satisfies the requirement httpx==0.13.3 (from googletrans) (from versions: )
No matching distribution found for httpx==0.13.3 (from googletrans)
ERROR to start subprocess

Collecting pre-commit (from translate)
Downloading https://www.piwheels.org/simple/pre-com ... ne-any.whl (171kB)
100% |████████████████████████████████| 174kB 1.4MB/s
pre-commit requires Python '>=3.6.1' but the running Python is 2.7.16

Regards

Hi,
by settings python3 as default system wide version, you should avoid lot's of problem, I think, specially if you use your system mainly for Domoticz.

[zak45]

When I try to learn a new IR code i get the following error

2020-07-03 17:25:53.807 Status: User: Admin initiated a switch command (14/new-broadlink - IR Commands/Set Level)
2020-07-03 17:25:53.865 Error: (new-broadlink) 'onCommand' failed 'TimeoutExpired'.
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 445 in '/home/pi/domoticz/plugins/Broadlink/plugin.py', function onCommand
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 2294 in '/home/pi/domoticz/plugins/Broadlink/plugin.py', function start_shell
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 342 in '/usr/lib/python3.7/subprocess.py', function check_call
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 329 in '/usr/lib/python3.7/subprocess.py', function call
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 1006 in '/usr/lib/python3.7/subprocess.py', function wait
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 1616 in '/usr/lib/python3.7/subprocess.py', function _wait
2020-07-03 17:25:57.387 (new-broadlink) Connected to Broadlink device: 192.168.3.97 RM2
2020-07-03 17:25:57.398 (new-broadlink) Update 1:'On' (new-broadlink - RM2-Status)


If you want access to a raspberry to test it into this environment i can provide it for you, let me know

1: I suppose the problem is from dombr.sh , put plugin on debug mode to have more information...
2 : thanks for the proposal, if necessary will come back to you !!!

[JUNA]

2020-07-03 00:31:04.457 File "/usr/lib/python3.7/broadlink/__init__.py", line 296, in send_packet
2020-07-03 00:31:04.457 cs.sendto(packet, self.host)
2020-07-03 00:31:04.457 OSError: [Errno 101] Network is unreachable
2020-07-03 00:31:04.457
2020-07-03 00:31:04.457 Error: (RM3m) Error to connect to Broadlink device: 192.168.1.173

Verify your network settings: IP address etc ... maybe firewall blocking.

Fixed firewall issue (Pi-Hole)...

Now I have a new issue:
2020-07-03 22:50:06.303 Error: (RM4m) Traceback (most recent call last):
2020-07-03 22:50:06.303 File "/home/pi/domoticz/plugins/Broadlink/plugin.py", line 1703, in broadlink_connect
2020-07-03 22:50:06.303 DEVICE.auth()
2020-07-03 22:50:06.303 File "/usr/lib/python3.7/broadlink/__init__.py", line 225, in auth
2020-07-03 22:50:06.303 check_error(response[0x22:0x24])
2020-07-03 22:50:06.303 File "/usr/lib/python3.7/broadlink/exceptions.py", line 97, in check_error
2020-07-03 22:50:06.303 raise exception(error_code)
2020-07-03 22:50:06.303 broadlink.exceptions.AuthenticationError: Authentication failed
2020-07-03 22:50:06.303
2020-07-03 22:50:06.304 Error: (RM4m) Error to connect to Broadlink device: 192.168.1.172

[zak45]

Now I have a new issue:
2020-07-03 22:50:06.303 Error: (RM4m) Traceback (most recent call last):
2020-07-03 22:50:06.303 File "/home/pi/domoticz/plugins/Broadlink/plugin.py", line 1703, in broadlink_connect
2020-07-03 22:50:06.303 DEVICE.auth()
2020-07-03 22:50:06.303 File "/usr/lib/python3.7/broadlink/__init__.py", line 225, in auth
2020-07-03 22:50:06.303 check_error(response[0x22:0x24])
2020-07-03 22:50:06.303 File "/usr/lib/python3.7/broadlink/exceptions.py", line 97, in check_error
2020-07-03 22:50:06.303 raise exception(error_code)
2020-07-03 22:50:06.303 broadlink.exceptions.AuthenticationError: Authentication failed
2020-07-03 22:50:06.303
2020-07-03 22:50:06.304 Error: (RM4m) Error to connect to Broadlink device: 192.168.1.172

if your device is connected to the official app, see this link:
https://github.com/mjg59/python-broadlink/issues/377

[JUNA]

Now I have a new issue:
2020-07-03 22:50:06.303 Error: (RM4m) Traceback (most recent call last):
2020-07-03 22:50:06.303 File "/home/pi/domoticz/plugins/Broadlink/plugin.py", line 1703, in broadlink_connect
2020-07-03 22:50:06.303 DEVICE.auth()
2020-07-03 22:50:06.303 File "/usr/lib/python3.7/broadlink/__init__.py", line 225, in auth
2020-07-03 22:50:06.303 check_error(response[0x22:0x24])
2020-07-03 22:50:06.303 File "/usr/lib/python3.7/broadlink/exceptions.py", line 97, in check_error
2020-07-03 22:50:06.303 raise exception(error_code)
2020-07-03 22:50:06.303 broadlink.exceptions.AuthenticationError: Authentication failed
2020-07-03 22:50:06.303
2020-07-03 22:50:06.304 Error: (RM4m) Error to connect to Broadlink device: 192.168.1.172

if your device is connected to the official app, see this link:
https://github.com/mjg59/python-broadlink/issues/377

Thank you! With the "new" Broadlink app I first had to set device in AP mode. In AP mode led flashed not continuously which was a bit confusing.

Broadlink AP mode

Broadlink_AP_mode_1.png (58.18 KiB) Viewed 17770 times

[JUNA]

When I try to learn a new IR code i get the following error

2020-07-03 17:25:53.807 Status: User: Admin initiated a switch command (14/new-broadlink - IR Commands/Set Level)
2020-07-03 17:25:53.865 Error: (new-broadlink) 'onCommand' failed 'TimeoutExpired'.
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 445 in '/home/pi/domoticz/plugins/Broadlink/plugin.py', function onCommand
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 2294 in '/home/pi/domoticz/plugins/Broadlink/plugin.py', function start_shell
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 342 in '/usr/lib/python3.7/subprocess.py', function check_call
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 329 in '/usr/lib/python3.7/subprocess.py', function call
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 1006 in '/usr/lib/python3.7/subprocess.py', function wait
2020-07-03 17:25:53.865 Error: (new-broadlink) ----> Line 1616 in '/usr/lib/python3.7/subprocess.py', function _wait
2020-07-03 17:25:57.387 (new-broadlink) Connected to Broadlink device: 192.168.3.97 RM2
2020-07-03 17:25:57.398 (new-broadlink) Update 1:'On' (new-broadlink - RM2-Status)


If you want access to a raspberry to test it into this environment i can provide it for you, let me know

1: I suppose the problem is from dombr.sh , put plugin on debug mode to have more information...
2 : thanks for the proposal, if necessary will come back to you !!!

Same error here. How can I set plugin in debug mode?