[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
1 parent
79a8591b83
commit
7a2bb04a1b
19 files changed
+138
-109
No files matched your search
+16
-16
@@ -4,21 +4,21 @@
|
||||
* From AWS console, search for IOT core
|
||||
* Create a Thing and name it, this name will be used as the OpenMQTTGateway name.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Create a policy
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Add this json code to the policy
|
||||
```json
|
||||
@@ -46,26 +46,26 @@
|
||||
|
||||
* Create a new certificate
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Download certificates and key
|
||||
|
||||
|
||||
|
||||
|
||||
## Attach Policy with certificate
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Activate certificate and attach it to Thing
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Find AWS EndPoint
|
||||
|
||||
|
||||
|
||||
|
||||
## Gather the information for OpenMQTTGateway configuration
|
||||
|
||||
@@ -106,4 +106,4 @@ Enter your credentials and verify that Secure connection is marked.
|
||||
|
||||
You should see messages coming.
|
||||
|
||||
|
||||
|
||||
@@ -15,11 +15,11 @@ On OpenMQTTGateway the Home Assistant discovery is enabled by default on all bin
|
||||
|
||||
Enable discovery on your MQTT integration in HASS (activated per default).
|
||||
|
||||
|
||||
|
||||
|
||||
The gateway will need an MQTT username and password, you have to create a new user(recommended) into Home Assistant->Configuration->Users (available in admin mode) or use an existing username/pwd combination (not recommended). This user doesn't need to be an administrator.
|
||||
|
||||
|
||||
|
||||
|
||||
::: warning Note
|
||||
The max size of the username is 30 and 60 for the password.
|
||||
@@ -27,11 +27,11 @@ The max size of the username is 30 and 60 for the password.
|
||||
|
||||
OMG will use the auto discovery functionality of home assistant to create gateway and sensors into your HASS instance automatically.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
The Bluetooth and the RTL_433 gateway will create automatically devices and entities, the RF gateway will create DeviceTrigger.
|
||||
|
||||
+25
-25
@@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
* On the plugin configuration page, activate the plugin,
|
||||
|
||||
|
||||
|
||||
|
||||
* 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,
|
||||
|
||||
|
||||
|
||||
|
||||
* Install the dependencies, if they have not already started,
|
||||
|
||||
|
||||
|
||||
|
||||
* Wait until they are installed, and start the Daemon,
|
||||
|
||||
|
||||
|
||||
|
||||
* Dependencies and Daemon are now OK,
|
||||
|
||||
|
||||
|
||||
|
||||
-> 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),
|
||||
|
||||
|
||||
|
||||
|
||||
* 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",
|
||||
|
||||
|
||||
|
||||
|
||||
* 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):
|
||||
|
||||
|
||||
|
||||
|
||||
* 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:
|
||||
|
||||
|
||||
|
||||
|
||||
* Restart the OMG device, quickly commands should start to appear:
|
||||
|
||||
|
||||
|
||||
|
||||
* 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:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 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:
|
||||
|
||||
|
||||
|
||||
|
||||
* In the advanced properties of the command, Configuration tab, define the "Calculation formula" `#value# == "online"`, save:
|
||||
|
||||
|
||||
|
||||
|
||||
* 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":
|
||||
|
||||
|
||||
|
||||
|
||||
* Switch to JSON mode, there are various interesting sub-commands:
|
||||
|
||||
|
||||
|
||||
|
||||
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:
|
||||
|
||||
|
||||
|
||||
|
||||
(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:
|
||||
|
||||
|
||||
|
||||
|
||||
* 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:
|
||||
|
||||
|
||||
|
||||
|
||||
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,
|
||||
|
||||
|
||||
|
||||
|
||||
* In the Commands tab, create an info "tmp" command of another type on the topic `bt/OMG_tuto/BTtoMQTT/582D3431FE5F` and save:
|
||||
|
||||
|
||||
|
||||
|
||||
* After a few minutes, a value arrives in the command,
|
||||
* Then switch to JSON view and create the commands you need:
|
||||
|
||||
|
||||
|
||||
|
||||
* Delete "tmp" which is no longer useful and save:
|
||||
|
||||
|
||||
|
||||
|
||||
* All that remains is to do the visual part as you want it on your Dashboard:
|
||||
|
||||
|
||||
|
||||
|
||||
For example:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
+13
-13
@@ -10,7 +10,7 @@ Prerequisites: node-red, node-red-dashboard
|
||||
* Add a new broker or connect to an existing one (server field)
|
||||
* Set the topic like below with the MAC address at the end being the one of the device you want to integrate
|
||||
|
||||
|
||||
|
||||
|
||||
::: tip
|
||||
The "+" enables to process the data from all the gateways whatever name they have. So you may setup several OpenMQTTGateway, you will not have to change the Node-Red configuration.
|
||||
@@ -21,17 +21,17 @@ This configuration enables to process all the data coming from the sensor.
|
||||
* Click on done
|
||||
* So as to monitor the traffic coming; you can add a debug node with *msg.payload* as Output
|
||||
|
||||
|
||||
|
||||
|
||||
* Link it to the `mqtt in` node
|
||||
|
||||
|
||||
|
||||
|
||||
* Deploy
|
||||
* Open the debug panel
|
||||
* You should see messages coming when the gateway will receive data
|
||||
|
||||
|
||||
|
||||
|
||||
### Json message processing
|
||||
We need to process the json message so as to extract the value that we want to display.
|
||||
@@ -40,7 +40,7 @@ We need to process the json message so as to extract the value that we want to d
|
||||
* Configure it as `Move`
|
||||
* Add the msg value you would like to process example *msg.payload.tempc* and the target *msg.payload*
|
||||
|
||||
|
||||
|
||||
|
||||
* Connect the `change` node to the `mqtt in` node
|
||||
|
||||
@@ -51,7 +51,7 @@ You can now add widget so as to display the value processed above
|
||||
* Add a group and organize your dashboard
|
||||
* Add your value format to process the payload like below
|
||||
|
||||
|
||||
|
||||
|
||||
* Click on Done
|
||||
* Deploy
|
||||
@@ -59,17 +59,17 @@ You can now add widget so as to display the value processed above
|
||||
|
||||
You should see the gauge with the last value displayed
|
||||
|
||||
|
||||
|
||||
|
||||
You can also add easily a chart node:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Or a function with a notification:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Integrate RF
|
||||
@@ -77,11 +77,11 @@ Here is a simple set of flows for integrating OpenMQTTGateway with NodeRED via a
|
||||
|
||||
In this example I have used a Wemos D1 Mini with some cheap RF modules.
|
||||
|
||||
|
||||
|
||||
|
||||
A flow to receive 433MHz signals into NodeRED (you will need to update the IP address of your broker)
|
||||
|
||||
|
||||
|
||||
|
||||
```json
|
||||
[
|
||||
@@ -141,7 +141,7 @@ A flow to receive 433MHz signals into NodeRED (you will need to update the IP ad
|
||||
|
||||
A flow to send 433MHz signals from NodeRED
|
||||
|
||||
|
||||
|
||||
|
||||
```json
|
||||
[
|
||||
|
||||
@@ -12,7 +12,7 @@ If you are connecting to BLE devices it is highly recommended to set `filterConn
|
||||
:::
|
||||
|
||||
The things will appear in the inbox of the paperUI, add them and links the channels. You should see them into the control panel for further usage.
|
||||
|
||||
|
||||
|
||||
## MQTT 2 manual setup >=Openhab2.4
|
||||
You should have an MQTT broker installed (either mosquitto or the OpenHAB2 embedded one)
|
||||
|
||||
+14
-14
@@ -16,7 +16,7 @@ The goal is to disable the IPv6 address of the broker server, so that the gatewa
|
||||
4. Disable IPv6
|
||||
5. Click on Save
|
||||
|
||||
|
||||
|
||||
|
||||
::: warning Note
|
||||
If the broker is installed on another server you will also need to configure it with an IPv4 address.
|
||||
@@ -27,30 +27,30 @@ If the broker is installed on another server you will also need to configure it
|
||||
2. Click on Bindings
|
||||
3. Install the MQTT binding (you can search at the bottom right)
|
||||
|
||||
|
||||
|
||||
|
||||
4. Once installed click on Things under Settings
|
||||
5. Click on the + at the bottom right
|
||||
6. Click on MQTT Binding
|
||||
|
||||
|
||||
|
||||
|
||||
7. Click on MQTT broker
|
||||
|
||||
|
||||
|
||||
|
||||
8. Enter for the "Broker Hostname/IP" field, the IP address of your broker, if it is installed on the same server you can enter `localhost`
|
||||
|
||||
|
||||
|
||||
|
||||
9. Click on "Show Advanced" if your broker has authentication activated, if not you can go to step 11
|
||||
10. Enter the broker credentials: username and password
|
||||
|
||||
|
||||
|
||||
|
||||
11. Click on Create Thing at the bottom, you should see your MQTT Broker in the Things list with the status "online"
|
||||
|
||||
|
||||
|
||||
|
||||
Bravo👏, second step done! Now let's add the Jinja transformation service.
|
||||
|
||||
@@ -60,7 +60,7 @@ Bravo👏, second step done! Now let's add the Jinja transformation service.
|
||||
3. Install Jinja Transformation (you can search at the bottom right)
|
||||
4. Install JSONPath Transformation
|
||||
|
||||
|
||||
|
||||
|
||||
Second step done!
|
||||
|
||||
@@ -83,16 +83,16 @@ To make the auto discovery compatible with OpenHAB you have to send the followin
|
||||
## Adding the things
|
||||
1. From the Administration click on "Things" under "Settings", you should see a number in the INBOX button
|
||||
|
||||
|
||||
|
||||
|
||||
2. Click on INBOX, you should see your BLE devices and the gateway
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click on a device, a pop up "Add as Thing" should appear
|
||||
4. Rename it if you need, and click OK, repeat for each Thing discovered. The devices should appears as online progressively.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click on Model
|
||||
6. Select the location of where you want to create the Equipment
|
||||
@@ -102,13 +102,13 @@ To make the auto discovery compatible with OpenHAB you have to send the followin
|
||||
10. Rename your Equipment if you need
|
||||
11. Select the Channels
|
||||
|
||||
|
||||
|
||||
|
||||
12. Click on "Add to Model"
|
||||
13. Go to Model, if you unfold your location and Equipment you should be able to see values
|
||||
|
||||
|
||||
|
||||
|
||||
Congratulation🎉! You were able to get data from your BLE sensors into OpenHAB. You can now add the others and use the data to build pages, leverage rules and enjoy all the function of your Home Automation controller with BLE devices.
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user