[DOCS] Theengs Plug highlight and SEO improvements (#1730)

* [DOCS] Theengs Plug highlight

* Add alt content for images and description
This commit is contained in:
Florian authored and GitHub committed 2023-08-11 13:04:52 -05:00
1 parent 79a8591b83
commit 7a2bb04a1b
19 files changed
+138 -109

No files matched your search

+25 -25
View File
@@ -14,28 +14,28 @@ To be able to use MQTT protocol into Jeedom and decode json payloads, [plugin jM
* Install the stable version,
* Go to the plugin configuration page next.
![](../img/Integrate_Jeedom_Install-jMQTT.png)
![Jeedom integration](../img/Integrate_Jeedom_Install-jMQTT.png)
* On the plugin configuration page, activate the plugin,
![](../img/Integrate_Jeedom_Install-Activate.png)
![Jeedom integration](../img/Integrate_Jeedom_Install-Activate.png)
* If you don't already have a MQTT Broker or you want to install Mosquitto on the local machine, then check "Install Mosquitto locally" box.
Otherwise, if you already use the "MQTT" plugin OR the "MQTT Manager" plugin OR you already have a Broker you know of, then ensure the "Install Mosquitto locally" box is uncheck,
![](../img/Integrate_Jeedom_Install-Mosquitto.png)
![Jeedom integration](../img/Integrate_Jeedom_Install-Mosquitto.png)
* Install the dependencies, if they have not already started,
![](../img/Integrate_Jeedom_Install-Deps.png)
![Jeedom integration](../img/Integrate_Jeedom_Install-Deps.png)
* Wait until they are installed, and start the Daemon,
![](../img/Integrate_Jeedom_Install-Deps-OK.png)
![Jeedom integration](../img/Integrate_Jeedom_Install-Deps-OK.png)
* Dependencies and Daemon are now OK,
![](../img/Integrate_Jeedom_Install-Daemon-OK.png)
![Jeedom integration](../img/Integrate_Jeedom_Install-Daemon-OK.png)
-> If you checked "Install Mosquitto locally", Then you can skip to "[Creation of the OMG device](#creation-of-the-omg-device)" step, jMQTT has automagically created a Broker called "local" for you.
@@ -44,13 +44,13 @@ Otherwise, if you already use the "MQTT" plugin OR the "MQTT Manager" plugin OR
* Click on "Add a broker",
* Enter "local" as Broker name (or whatever name you want),
![](../img/Integrate_Jeedom_Broker-eqTab.png)
![Jeedom integration](../img/Integrate_Jeedom_Broker-eqTab.png)
* Check "Activer" box and switch to "Broker" tab without saving (yet),
* Enter "jMQTT" as "Identifier/ClientId" so as not to interfere with other topics,
-> If your Broker is not local, then fill in "IP/Hostname of the Broker" and "Port of the Broker",
![](../img/Integrate_Jeedom_Broker-brkTab.png)
![Jeedom integration](../img/Integrate_Jeedom_Broker-brkTab.png)
* Save the device, the initial configuration of jMQTT is complete.
@@ -61,45 +61,45 @@ This step aims to create an equipment in jMQTT representing the OMG device itsel
* Go to the jMQTT plugin page via "Plugin> Domotic protocol> jMQTT",
* Click on "Add equipment" on the Broker created in step 2 (or existing one):
![](../img/Integrate_Jeedom_Eq-Add.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Add.png)
* Give it the name "gateway name" configured in step 4 (for me OMG_tuto),
* In "Registered with the Topic", put the basic topic of the EST, followed by the "gateway name", followed by a slash and a hash (for me `bt/OMG_tuto/#`), this will allow to receive all messages starting with `bt/OMG_tuto/`,
* Check the "Automatic addition of commands" box checked and the other default values,
* Activate the equipment and save:
![](../img/Integrate_Jeedom_Eq-OMG-config.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-config.png)
* Restart the OMG device, quickly commands should start to appear:
![](../img/Integrate_Jeedom_Eq-OMG-cmd-added.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-cmd-added.png)
* Let it run for 5 minutes, go smoke a coffee, you deserve it,
* Uncheck the "Automatically add commands" box and save,
* Go to the Commands tab, several info commands should have appeared:
![](../img/Integrate_Jeedom_Eq-OMG-cmds.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-cmds.png)
### Creation of the Last Will and Testament command
* The interesting command here is "LWT", put it in binary info, activate "Historize", deactivate "Display" and save:
![](../img/Integrate_Jeedom_Eq-OMG-lwt.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-lwt.png)
* In the advanced properties of the command, Configuration tab, define the "Calculation formula" `#value# == "online"`, save:
![](../img/Integrate_Jeedom_Eq-OMG-lwt-formula.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-lwt-formula.png)
* Electrically disconnect the OMG device, the control goes to 0 after about ten seconds.
Congratulations you have a command that lets you know if your OMG device is alive!
Creation of "uptime", "freemem", "frestack" and "rssi" info commands:
* Among the discovered commands, there must also be "SYStoMQTT":
![](../img/Integrate_Jeedom_Eq-OMG-SYStoMQTT.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-SYStoMQTT.png)
* Switch to JSON mode, there are various interesting sub-commands:
![](../img/Integrate_Jeedom_Eq-OMG-SYStoMQTT-json.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-SYStoMQTT-json.png)
If you want, you can create 'uptime', 'freemem', 'frestack' and 'rssi'.
@@ -107,7 +107,7 @@ If you want, you can create 'uptime', 'freemem', 'frestack' and 'rssi'.
* OMG has several commands 1 that can be executed directly in MQTT.
* Create an action command to restart the OMG device:
![](../img/Integrate_Jeedom_Eq-OMG-SYStoMQTT-restart.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-SYStoMQTT-restart.png)
(topic: `bt/OMG_tuto/commands/MQTTtoSYS/config`; payload: `{"cmd":"restart"}`)
* Press the "Test" button on the control,
@@ -125,7 +125,7 @@ If you want, you can create 'uptime', 'freemem', 'frestack' and 'rssi'.
* Check "Automatic command creation", "Enable", "Visible", and save,
* Many devices are detected and added to this equipment:
![](../img/Integrate_Jeedom_Eq-OMG-BTtoMQTT.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-BTtoMQTT.png)
* We see that the topics always end with the MAC address of the equipment,
* Once you have identified the equipment you are interested in, 2 options are available to you:
@@ -137,7 +137,7 @@ If you want, you can create 'uptime', 'freemem', 'frestack' and 'rssi'.
* Identify in the list the MAC of your devices,
* You may have seen this in the previous captures:
![](../img/Integrate_Jeedom_Eq-OMG-BTtoMQTT-mijia.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-OMG-BTtoMQTT-mijia.png)
This is exactly what you think it is!
@@ -147,28 +147,28 @@ This is exactly what you think it is!
* Leave "Automatic addition of commands" deactivated,
* Check Enable and Visible, but no need to save for now,
![](../img/Integrate_Jeedom_Eq-Mijia-Create.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Mijia-Create.png)
* In the Commands tab, create an info "tmp" command of another type on the topic `bt/OMG_tuto/BTtoMQTT/582D3431FE5F` and save:
![](../img/Integrate_Jeedom_Eq-Mijia-tmp-Cmd.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Mijia-tmp-Cmd.png)
* After a few minutes, a value arrives in the command,
* Then switch to JSON view and create the commands you need:
![](../img/Integrate_Jeedom_Eq-Mijia-tmp-Cmd-Json.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Mijia-tmp-Cmd-Json.png)
* Delete "tmp" which is no longer useful and save:
![](../img/Integrate_Jeedom_Eq-Mijia-Cmds.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Mijia-Cmds.png)
* All that remains is to do the visual part as you want it on your Dashboard:
![](../img/Integrate_Jeedom_Eq-Mijia-Dashboard.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Mijia-Dashboard.png)
For example:
![](../img/Integrate_Jeedom_Eq-Mijia-Dashboard-pimped.png)
![Jeedom integration](../img/Integrate_Jeedom_Eq-Mijia-Dashboard-pimped.png)
---