Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
sonoff [23.01.2018 00:17] – [Rules Engine - node-red] Pascal Suter | sonoff [07.09.2021 05:52] (current) – [Making the installation permanent] Pascal Suter | ||
---|---|---|---|
Line 11: | Line 11: | ||
===== alternative firmware ===== | ===== alternative firmware ===== | ||
* [[https:// | * [[https:// | ||
- | * works also on some other ESP based devices | + | * works also on lots of ESP based devices |
* provides control via serial / web / MQTT | * provides control via serial / web / MQTT | ||
===== What I intend to do with it ===== | ===== What I intend to do with it ===== | ||
Line 22: | Line 22: | ||
at first i will use the existing MQTT bridge for DS which uses the Web-API. In the future i would like to write a little module that uses the Virtual Device API of digitalSTROM which would allow me to emualte a digitalSTROM device for my sonoff. this would make the integration even smoother and there would be no need for an external rules engine anymore. However, i'll get started with the web-api and rules engine first, as I'd like to try out some MQTT stuff first :) | at first i will use the existing MQTT bridge for DS which uses the Web-API. In the future i would like to write a little module that uses the Virtual Device API of digitalSTROM which would allow me to emualte a digitalSTROM device for my sonoff. this would make the integration even smoother and there would be no need for an external rules engine anymore. However, i'll get started with the web-api and rules engine first, as I'd like to try out some MQTT stuff first :) | ||
+ | ===== The simple solution ===== | ||
+ | Isn't there a simple solution to that? Shure there is, but what fun would it be? :) | ||
+ | |||
+ | the digitalSTROM server comes with some " | ||
+ | |||
+ | You can either flash the Tasmona firmware as described below or hack your sonoff in any other way with any other firmware or even with the original firmware in place. All you need to achieve is, that you can send a http-get request to the sonoff to turn the light on and off. Tasmona does that, and since I am going to use it anyway for my project, I will assume you also flashed that. Also this solution requires the sonoff to have a static IP .. either do this with a reservation in your DHCP server or enter a fixed IP in the web-interface of Tasmona. | ||
+ | |||
+ | In the dss web menu go to apps and open the '' | ||
+ | |||
+ | Create a second Responder, but this time select all other scenes in the same room as trigger (you can do that by holding CTRL on your keyboard while clicking on all the scenes you do NOT want your light to be on). then as action use again Call URL but this time enter '' | ||
+ | |||
+ | that's it, you're all set. Congratulations you just saved yourself a day worth of fiddling with tools and scripts :) So why am I still going down the complicated route.. well, mainly **because I can** :) and also because i want to use more devices including some input devices in the future to do more complicated stuff which exceeds the capabilities of my DSS. Also, the Event-Responder is quite slow, it is even slower than my first solution with the DSS-API based mqtt-connector. So expect to wait 2-3 seconds for your light to go on. Unless you have a newer DSS than me. The newer models (DSS20 and 22) have faster cpu's and should be able to process these responders alot quicker. | ||
===== Falshing Tasmota Firmware ===== | ===== Falshing Tasmota Firmware ===== | ||
this is straight forward, just follow the guides on the [[https:// | this is straight forward, just follow the guides on the [[https:// | ||
Line 27: | Line 39: | ||
I personally went for flashing over a USB TTL adapter using the Arduino IDE. It is important to notice, that the TTL adapter needs to provide 3.3V, not 5V! Also i recommend using a PL2303 based USB TTL adapter, as others did not work for me (spent hours trying until I finally gave up and tried with a PL2303 based one I had laying around). Another important Point was, how to enter the programming mode: Hold down the pushbutton while connecting only the power pins. Leave at least one of the two data pins disconnected. Then let go of the button and connect the RX and TX (crossed). Flasing did not work for me when i connected all wires at the same time while holding down the button. | I personally went for flashing over a USB TTL adapter using the Arduino IDE. It is important to notice, that the TTL adapter needs to provide 3.3V, not 5V! Also i recommend using a PL2303 based USB TTL adapter, as others did not work for me (spent hours trying until I finally gave up and tried with a PL2303 based one I had laying around). Another important Point was, how to enter the programming mode: Hold down the pushbutton while connecting only the power pins. Leave at least one of the two data pins disconnected. Then let go of the button and connect the RX and TX (crossed). Flasing did not work for me when i connected all wires at the same time while holding down the button. | ||
- | I strongly recommend to edit the settings before compiling and adding your wifi credentials, | + | <del>I strongly recommend to edit the settings before compiling and adding your wifi credentials, |
Here are the steps it took to flash the stock sonoff (current and more detailed instructions can be found in the [[https:// | Here are the steps it took to flash the stock sonoff (current and more detailed instructions can be found in the [[https:// | ||
- | - download | + | |
- | - create a subdirectory called '' | + | **Update**: again, |
- | | + | |
- | | + | here are the steps using Tasmotizer: |
+ | | ||
+ | pip3 install | ||
+ | pip3 install tasmotizer | ||
+ | tasmotizer.py</ | ||
+ | | ||
+ | * connect your sonoff to the serial2usb adapter WITH MAINS DISCONNECTED!! here is the necessary wiring.. note that rx and tx are crossed over between the two devices. VCC is 3.3V NOT 5V! {{: | ||
+ | | ||
+ | * hold down the push button and plug-in the usb adapter. | ||
+ | * let go of the push button and click " | ||
+ | * click " | ||
+ | * once that is done, unplug your usb adapter and plug it back in, to reset the sonof | ||
+ | * now click on send config and enter your desired config, then upload it. | ||
+ | * a few seconds later, your sonoff sould be connected to your network and with Get IP you can now see the ip it got from your DHCP. | ||
+ | |||
+ | |||
+ | If you really want to compile tasmota yourself, you should read the official documentation, | ||
+ | |||
+ | - [[setup arduino IDE for ESP8266]] | ||
- download the sourcecode tar.gz or zip package from the [[https:// | - download the sourcecode tar.gz or zip package from the [[https:// | ||
- extract the contents of the '' | - extract the contents of the '' | ||
- | - verify your settings under Tools are like these: < | ||
- | Board: " | ||
- | Flash Mode: " | ||
- | Flash Size: "1M (no SPIFFS)" | ||
- | Debug Port: " | ||
- | Debug Level: " | ||
- | LwIP Variant: "v2 Prebuilt (MSS=536)" | ||
- | Reset Method: " | ||
- | Crystal Frequency: "26 MHz" | ||
- | Flash Frequency: " | ||
- | Upload Using: " | ||
- | CPU Frequency: "80 MHz" | ||
- | Upload Speed: " | ||
- | Port: Your COM port connected to sonoff | ||
- | </ | ||
- edit '' | - edit '' | ||
- **make sure your sonoff is disconnected from the AC power lines*** | - **make sure your sonoff is disconnected from the AC power lines*** | ||
Line 118: | Line 134: | ||
npm install --save mqtt-dss-bridge | npm install --save mqtt-dss-bridge | ||
this will create a sub-directory '' | this will create a sub-directory '' | ||
- | * '' | + | * '' |
* '' | * '' | ||
* '' | * '' | ||
Line 132: | Line 148: | ||
this helps in finding your way around the massive amount of inormation that is published by the dss bridge. | this helps in finding your way around the massive amount of inormation that is published by the dss bridge. | ||
- | Since my goal for now is to turn on my sonoff when a certain scene is selected in a room i am most interested in the topic '' | + | Since my goal for now is to turn on my sonoff when a certain scene is selected in a room i am most interested in the topic '' |
In order to turn the lights on in a room, you can publish to the topic '' | In order to turn the lights on in a room, you can publish to the topic '' | ||
mosquitto_pub -h mqtt.psuter.ch -u sonoffs -P sonoff -t set/ | mosquitto_pub -h mqtt.psuter.ch -u sonoffs -P sonoff -t set/ | ||
+ | |||
===== Rules Engine - node-red ===== | ===== Rules Engine - node-red ===== | ||
Now that we got both our devices connected to the MQTT Broaker it is time to set up a Rules engine, to conenct the two together :) | Now that we got both our devices connected to the MQTT Broaker it is time to set up a Rules engine, to conenct the two together :) | ||
- | [[https:// | + | [[node-red]] looks like a very capable and interesting Rules engine. I have also spotted another interesting open source project called [[https:// |
installation is again very easy through npm: | installation is again very easy through npm: | ||
Line 159: | Line 176: | ||
your sonoff should now turn on when scene1 is selected in the " | your sonoff should now turn on when scene1 is selected in the " | ||
+ | |||
+ | here is the exported flow in case you want to import that into your Node-RED editor to make sure you have the same settings: < | ||
+ | [{" | ||
+ | </ | ||
+ | and here is what it looks like: | ||
+ | {{ : | ||
+ | ==== a word about retention ==== | ||
+ | it seems node-red sets the retention flag of mqtt by default. I learned this when i used it together with the mqtt-dss-connector: | ||
+ | |||
+ | ===== Making the installation permanent ===== | ||
+ | this might be different in your setup, but I would like to install the npm modules globally and then run them as non-root users through a systemd script to make sure they are auto-startet as soon as my system boots. | ||
+ | |||
+ | before you start, make sure you export your '' | ||
+ | |||
+ | the easy one first: Mosquitto. Since we used the ubuntu package, it already came with the necessary startup scripts, so a simple | ||
+ | systemctl enable mosquitto.service | ||
+ | is enough :) | ||
+ | |||
+ | now lets install our npm modules ('' | ||
+ | npm install --global --save mqtt-dss-bridge | ||
+ | npm install --global --save --unsafe-perm node-red | ||
+ | |||
+ | create the users and groups to run these tools: | ||
+ | addgroup --system mqtt-dss-bridge | ||
+ | addgroup --system node-red | ||
+ | adduser --system --no-create-home --ingroup mqtt-dss-bridge mqtt-dss-bridge | ||
+ | adduser --system --ingroup node-red node-red | ||
+ | |||
+ | copy the '' | ||
+ | |||
+ | It happened a couple of times, that the mqtt-dss-bridge process was running without actually updating the state of the dss target. this happened after some network issues for example. since the mqtt-dss-bridge process did not exit but rather continued to run and just do nothing, systemd did not notice any problem and did not restart the service. for that reason I created a little wrapper script which checks the age of the last status update and exits with exit code 1 if that state is older than 10 seconds for longer than 10 seconds (it usually takes a couple of seconds upon starting the gateway to catch up, hence we wait 10 addiitonal seconds before killing mqtt-dss-bridge and exiting with an error state) | ||
+ | |||
+ | This wrapper also mutes the output of mqtt-dss-bridge which otherwise floods your syslog. | ||
+ | |||
+ | save this script to a convenient location such as ''/ | ||
+ | <code bash / | ||
+ | #!/bin/bash | ||
+ | |||
+ | # start the bridge in the background | ||
+ | / | ||
+ | PID=$! | ||
+ | echo "DSS Bridge started with PID $PID" | ||
+ | # start a loop to monitor the status every second | ||
+ | errcntr=0 | ||
+ | lastUpdate=999 | ||
+ | while true; do | ||
+ | lastUpdate=$(( \ | ||
+ | $(date +%s)\ | ||
+ | -\ | ||
+ | $(date -d "$(\ | ||
+ | mosquitto_sub -h localhost -u sonoffs -P sonoff -t dss/ | ||
+ | sed -E -e ' | ||
+ | )" +%s)\ | ||
+ | )) | ||
+ | if [ 10 -lt $lastUpdate ]; then | ||
+ | if [ $errcntr -lt 10 ]; then | ||
+ | let errcntr++ | ||
+ | echo "DSS Bridge state is too old (last updated $lastUpdate seconds ago, max 10 allowed). This was failure $errcntr out of 10 accepted failures" | ||
+ | else | ||
+ | echo "DSS bridge state is still too old ($lastUpdate seconds) after 10 retries. killing mqtt-dss-bridge (pid $PID) and exit with error status 1" | ||
+ | kill $PID | ||
+ | exit 1 | ||
+ | fi | ||
+ | fi | ||
+ | sleep 1 | ||
+ | done | ||
+ | </ | ||
+ | |||
+ | create the startup service file for '' | ||
+ | < | ||
+ | cat > / | ||
+ | [Unit] | ||
+ | Description=Node.js MQTT DSS Bridge | ||
+ | # Requires the mosquitto service to run first | ||
+ | Requires=After=mosquitto.service | ||
+ | |||
+ | [Service] | ||
+ | # | ||
+ | ExecStart=/ | ||
+ | # Required on some systems | ||
+ | # | ||
+ | Restart=always | ||
+ | # Restart service after 10 seconds if wrapper exits with code > 0 | ||
+ | RestartSec=10 | ||
+ | # Output to syslog | ||
+ | StandardOutput=syslog | ||
+ | StandardError=syslog | ||
+ | SyslogIdentifier=mqtt-dss-bridge | ||
+ | User=mqtt-dss-bridge | ||
+ | Group=mqtt-dss-bridge | ||
+ | Environment=NODE_ENV=production | ||
+ | |||
+ | [Install] | ||
+ | WantedBy=multi-user.target | ||
+ | EOF | ||
+ | </ | ||
+ | |||
+ | create systemd service for '' | ||
+ | cat > / | ||
+ | [Unit] | ||
+ | Description=Node.js Node-RED | ||
+ | Requires=node-red.service | ||
+ | After=node-red.service | ||
+ | |||
+ | [Service] | ||
+ | ExecStart=/ | ||
+ | # Required on some systems | ||
+ | WorkingDirectory=/ | ||
+ | Restart=always | ||
+ | # Restart service after 10 seconds if node service crashes | ||
+ | RestartSec=10 | ||
+ | # Output to syslog | ||
+ | StandardOutput=syslog | ||
+ | StandardError=syslog | ||
+ | SyslogIdentifier=node-red | ||
+ | User=node-red | ||
+ | Group=node-red | ||
+ | Environment=NODE_ENV=production PORT=1880 | ||
+ | |||
+ | [Install] | ||
+ | WantedBy=multi-user.target | ||
+ | EOF | ||
+ | </ | ||
+ | |||
+ | create a rule for '' | ||
+ | < | ||
+ | cat > / | ||
+ | if \$programname == ' | ||
+ | if \$programname == ' | ||
+ | EOF | ||
+ | </ | ||
+ | create a rule for '' | ||
+ | < | ||
+ | cat > / | ||
+ | if \$programname == ' | ||
+ | if \$programname == ' | ||
+ | EOF | ||
+ | </ | ||
+ | |||
+ | restart '' | ||
+ | systemctl restart rsyslog.service | ||
+ | systemctl daemon-reload | ||
+ | systemctl start mqtt-dss-bridge.service | ||
+ | systemctl start node-red.service | ||
+ | check if the services are all running fine. if that is the case, enable them to autostart on boot: | ||
+ | systemctl enable mqtt-dss-bridge.service | ||
+ | systemctl enable node-red | ||
+ | |||
+ | now restore your node-red settings | ||
+ | |||
+ | ===== Next Steps ===== | ||
+ | try to get '' | ||
===== Future projects ===== | ===== Future projects ===== | ||
- | eventually I'd like to write a script that uses the [[https:// | + | eventually I'd like to write a script that uses the [[https:// |
+ | |||
+ | see my progress on that at [[MQTT for digitalSTROM]] |