[DOCS] typo fixes (#1816)
This commit is contained in:
DigiH authored and GitHub committed
1 parent
fb42293631
commit
5421f0e995
15 files changed
+49
-49
No files matched your search
+2
-2
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: ESP32 BLE MQTT Gateway
|
||||
title: BLE ESP32 gateway
|
||||
description: Versatile BLE gateway that scans and decodes data from various Bluetooth devices. It integrates seamlessly with MQTT brokers and controllers like Home Assistant and OpenHAB. Monitor temperature, humidity, pressure, and more for smarter control.
|
||||
---
|
||||
# BLE gateway
|
||||
@@ -262,7 +262,7 @@ The default value is set into config_BT.h
|
||||
|
||||
## Store BLE configuration into the gateway
|
||||
|
||||
Open MQTT Gateway has the capability to save the current configuration and reload it at startup.
|
||||
OpenMQTTGateway has the capability to save the current configuration and reload it at startup.
|
||||
|
||||
To store the running configuration into the gateway, use the command:
|
||||
|
||||
|
||||
+1
-1
@@ -54,7 +54,7 @@ This command can also be used with other controllers that does not support the i
|
||||
If the new connection fails the gateway will fallback to the previous connection.
|
||||
:::
|
||||
|
||||
## Change the Gateway password
|
||||
## Change the gateway password
|
||||
|
||||
The password must be 8 characters minimum.
|
||||
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Infrared MQTT Gateway
|
||||
title: Infrared gateway
|
||||
description: Unlock the potential of Infrared technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems abd controllers like Home Assistant and OpenHAB.
|
||||
---
|
||||
|
||||
|
||||
+19
-19
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: LORA MQTT Gateway
|
||||
description: Explore the LORA MQTT gateway, designed for integration with devices utilizing LORA technology, including the MakerFab soil and moisture sensor, devices from PricelessTookit. Unlock long range communication with the power of LORA..
|
||||
title: LoRa gateway
|
||||
description: Explore the LoRa MQTT gateway, designed for integration with devices utilizing LoRa technology, including the MakerFab soil and moisture sensor, devices from PricelessTookit. Unlock long range communication with the power of LoRa..
|
||||
---
|
||||
# LORA gateway
|
||||
# LoRa gateway
|
||||
|
||||
## What is a LORA gateway
|
||||
## What is a LoRa gateway
|
||||
A LoRa (Long Range) gateway is a device that facilitates communication between LoRa nodes and networks, enabling the transmission and reception of data over long distances using the LoRa modulation technique. It's designed to work with devices that utilize LoRa technology, such as the MakerFab soil and moisture sensor, devices from PricelessTookit and DIY sensors.
|
||||
|
||||
The primary distinction between a LoRa gateway and a LoRaWAN gateway lies in the protocol and network architecture:
|
||||
|
||||
LoRa Gateway: Focuses solely on the physical layer, utilizing the LoRa modulation for communication. It's responsible for receiving and transmitting raw LoRa signals without concerning itself with network protocols or data handling at higher layers. Being focused solely on the physical layer, a LoRa Gateway offers greater flexibility for customization and experimentation. The OpenMQTTGateway LoRa gateway receives raw LoRa signals, processes them, and publishes the data to an MQTT topic. Conversely, it can subscribe to MQTT topics and send commands to LoRa devices. This gateway is particularly useful for DIY projects, home automation enthusiasts, and scenarios where direct integration of LoRa devices with MQTT is desired.
|
||||
LoRa gateway: Focuses solely on the physical layer, utilizing the LoRa modulation for communication. It's responsible for receiving and transmitting raw LoRa signals without concerning itself with network protocols or data handling at higher layers. Being focused solely on the physical layer, a LoRa gateway offers greater flexibility for customization and experimentation. The OpenMQTTGateway LoRa gateway receives raw LoRa signals, processes them, and publishes the data to an MQTT topic. Conversely, it can subscribe to MQTT topics and send commands to LoRa devices. This gateway is particularly useful for DIY projects, home automation enthusiasts, and scenarios where direct integration of LoRa devices with MQTT is desired.
|
||||
|
||||
LoRaWAN Gateway: Operates at a higher layer and is part of the LoRaWAN network architecture. LoRaWAN is a protocol specification built on top of the LoRa technology, providing features like adaptive data rate, encryption, and multi-channel/multi-modulation. A LoRaWAN gateway handles the data from multiple LoRa nodes, forwards it to a centralized network server, which then manages the data and communicates back to the nodes.
|
||||
LoRaWAN gateway: Operates at a higher layer and is part of the LoRaWAN network architecture. LoRaWAN is a protocol specification built on top of the LoRa technology, providing features like adaptive data rate, encryption, and multi-channel/multi-modulation. A LoRaWAN gateway handles the data from multiple LoRa nodes, forwards it to a centralized network server, which then manages the data and communicates back to the nodes.
|
||||
|
||||
In essence, while both gateways utilize LoRa technology for communication, a LoRaWAN gateway is more sophisticated, offering advanced features and integration with the LoRaWAN network infrastructure. The LoRa gateway, with its simpler architecture, is ideal for small networks of nodes, offering easier setup and configuration, making it an interesting choice for users keen on experimenting with LoRa technology.
|
||||
|
||||
## Configuring the LORA gateway
|
||||
## Configuring the LoRa gateway
|
||||
|
||||
The LORA gateway can be configured by MQTT commands or by using the WebUI, here are the parameters available, they can be combined with the key "save" or "erase":
|
||||
The LoRa gateway can be configured by MQTT commands or by using the WebUI, here are the parameters available, they can be combined with the key "save" or "erase":
|
||||
* txpower: 0 to 14
|
||||
* spreadingfactor: 7 to 12
|
||||
* frequency: 433000000, 868000000, 915000000
|
||||
@@ -30,18 +30,18 @@ The LORA gateway can be configured by MQTT commands or by using the WebUI, here
|
||||
* onlyknown: boolean
|
||||
|
||||
With the WebUI:
|
||||
|
||||
|
||||
|
||||
With MQTT commands:
|
||||
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoLORA/config -m '{"frequency":"433000000","save":true}'`
|
||||
|
||||
## Receiving data from LORA signal
|
||||
## Receiving data from LoRa signal
|
||||
|
||||
Subscribe to all the messages with mosquitto or open your MQTT client software:
|
||||
|
||||
` sudo mosquitto_sub -t +/# -v`
|
||||
|
||||
Generate your LORA signals by using another LORA module, you can flash the sender program from [this example](../../examples/LoraTemperature/) to an ESP32 LORA board, this sample node will generate a LORa signal containing the ESP32 internal temperature.
|
||||
Generate your LoRa signals by using another LoRa module, you can flash the sender program from [this example](../../examples/LoraTemperature/) to an ESP32 LoRa board, this sample node will generate a LoRa signal containing the ESP32 internal temperature.
|
||||
|
||||
Once one board flashed with OMG and the other with the sender program you should receive regular packets into `home/OpenMQTTGateway_ESP32_LORA_TEST/LORAtoMQTT/AABBCCDDEEFF` like below:
|
||||
|
||||
@@ -51,7 +51,7 @@ Once one board flashed with OMG and the other with the sender program you should
|
||||
{"id":"AA:BB:CC:DD:EE:FF","rssi":-16,"snr":9.5,"pferror":-3581,"packetSize":9,"tempc":"57"}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Messages that contain non-printable characters will be converted to hexadecimal and look like this:
|
||||
```json
|
||||
@@ -63,25 +63,25 @@ And from a supported device (in this case, a WiPhone), looks like this:
|
||||
```json
|
||||
{"rssi":-50,"snr":9.25,"pferror":20728,"packetSize":30,"from":"123ABC","to":"000000","message":"Hi from WiPhone","type":"WiPhone"}
|
||||
```
|
||||
## Send data by MQTT to convert it on LORA signal
|
||||
## Send data by MQTT to convert it on LoRa signal
|
||||
`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoLORA -m '{"message":"hello OMG1"}'`
|
||||
|
||||
This command will send by LORA the message "hello OMG1" and use the default parameters defined in [config_LORA.h](https://github.com/1technophile/OpenMQTTGateway/blob/4b8d28179b63ae3f3d454da57ec8c109c159c386/config_LORA.h#L32)
|
||||
This command will send by LoRa the message "hello OMG1" and use the default parameters defined in [config_LORA.h](https://github.com/1technophile/OpenMQTTGateway/blob/4b8d28179b63ae3f3d454da57ec8c109c159c386/config_LORA.h#L32)
|
||||
|
||||
|
||||
|
||||
If you want to test that your sending works you can use another TTGO LORA module, you can flash the receiver program from [this repository](https://github.com/LilyGO/TTGO-LORA32-V2.0) and the SSD1306 library [there](https://github.com/ThingPulse/esp8266-oled-ssd1306)
|
||||
If you want to test that your sending works you can use another TTGO LoRa module, you can flash the receiver program from [this repository](https://github.com/LilyGO/TTGO-LORA32-V2.0) and the SSD1306 library [there](https://github.com/ThingPulse/esp8266-oled-ssd1306)
|
||||
|
||||
## Send data by MQTT with advanced LORA parameters
|
||||
## Send data by MQTT with advanced LoRa parameters
|
||||
|
||||
* Plain text message: `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoLORA -m '{"message":"test8","txpower":17}'`\
|
||||
will make LORA use the a txpower of 17 when sending the message "test8"
|
||||
will make LoRa use the a txpower of 17 when sending the message "test8"
|
||||
* Binary message: `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoLORA" -m '{"hex":"01C0FFEE"}'`\
|
||||
will send binary 0x01C0FFEE
|
||||
* WiPhone message: `mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoLORA" -m '{"message":"test","type":"WiPhone","to":"123ABC","from":"FFFFFF"}'`\
|
||||
will send "test" to a WiPhone with chip ID 123ABC
|
||||
|
||||
More info on where the LORA library is born [@sandeepmistry](https://github.com/sandeepmistry/arduino-LoRa/blob/master/API.md#radio-parameters)
|
||||
More info on where the LoRa library is born [@sandeepmistry](https://github.com/sandeepmistry/arduino-LoRa/blob/master/API.md#radio-parameters)
|
||||
|
||||
Tutorial on how to leverage LORA for a mailbox sensor from [PricelessToolkit](https://www.youtube.com/channel/UCz75N6inuLHXnRC5tqagNLw):
|
||||
Tutorial on how to leverage LoRa for a mailbox sensor from [PricelessToolkit](https://www.youtube.com/channel/UCz75N6inuLHXnRC5tqagNLw):
|
||||
<iframe width="560" height="315" src="https://www.youtube.com/embed/6DftaHxDawM" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
|
||||
+7
-7
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: 433Mhz MQTT Gateway
|
||||
title: RF gateways (RTL_433/RCSwitch/RF/RF2)
|
||||
description: Unlock the potential of RF 433 MHz technology with our universal gateway. Decode signals from various devices, and integrate seamlessly with MQTT systems and controllers like Home Assistant and OpenHAB.
|
||||
---
|
||||
|
||||
@@ -11,7 +11,7 @@ An RF (Radio Frequency) gateway is a device that facilitates communication betwe
|
||||
|
||||
The primary advantage of using an RF gateway is its ability to bridge the gap between the world of RF devices, which might include sensors, remote controls, and other RF-based gadgets, and modern smart home systems or applications. This enables users to integrate a wide range of devices into their smart home setup, even if those devices were not originally designed for such integration.
|
||||
|
||||
In the context of the 433MHz MQTT Gateway, the device not only decodes RF signals but also allows for seamless integration with MQTT systems. This means that signals from RF devices can be easily published to MQTT topics, and likewise, MQTT messages can be translated into RF signals for transmission. This two-way communication capability makes the gateway a powerful tool for expanding the capabilities of both RF devices and MQTT systems.
|
||||
In the context of the 433MHz MQTT gateway, the device not only decodes RF signals but also allows for seamless integration with MQTT systems. This means that signals from RF devices can be easily published to MQTT topics, and likewise, MQTT messages can be translated into RF signals for transmission. This two-way communication capability makes the gateway a powerful tool for expanding the capabilities of both RF devices and MQTT systems.
|
||||
|
||||
OpenMQTTGateway leverages several libraries for RF communication:
|
||||
| Library | Description | Device Support | Resource Requirements | Flexibility | Integration Capabilities |
|
||||
@@ -164,24 +164,24 @@ Delta applied to RSSI floor noise level to determine start and end of signal, de
|
||||
|
||||
### Switching Active Receiver Module
|
||||
|
||||
Switching of the active transceiver (RTL_433 receiver only) module is available between the RF, RF2, RTL_433 and Pilight Gateway modules, allowing for changing of signal decoders without redeploying the openMQTTGateway package. Sending a JSON message to the command topic of the desired receiver will change the active transceiver module.
|
||||
Switching of the active transceiver (RTL_433 receiver only) module is available between the RF, RF2, RTL_433 and Pilight gateway modules, allowing for changing of signal decoders without redeploying the openMQTTGateway package. Sending a JSON message to the command topic of the desired receiver will change the active transceiver module.
|
||||
|
||||
To enable the RF Gateway module send a json message to the RF Gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
To enable the RF gateway module send a json message to the RF gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
|
||||
Example:
|
||||
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTto433" -m '{"active":true}'`
|
||||
|
||||
To enable the PiLight Gateway module send a json message to the PiLight Gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
To enable the PiLight gateway module send a json message to the PiLight gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
|
||||
Example:
|
||||
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoPilight" -m '{"active":true}'`
|
||||
|
||||
To enable the RF2 Gateway module send a json message to the RF2 Gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
To enable the RF2 gateway module send a json message to the RF2 gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
|
||||
Example:
|
||||
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoRF2" -m '{"active":true}'`
|
||||
|
||||
To enable the RTL_433 Gateway module send a json message to the RTL_433 Gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
To enable the RTL_433 gateway module send a json message to the RTL_433 gateway module command subject with the key being 'active', and any value. The value at this time is ignored.
|
||||
|
||||
Example:
|
||||
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoRTL_433" -m '{"active":true}'`
|
||||
|
||||
Reference in new issue
Block a user