diff --git a/README.md b/README.md index 8ef78d4..2764fa9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![Build](https://github.com/1technophile/OpenMQTTGateway/workflows/Build/badge.svg?branch=development) ![Check Code Format](https://github.com/1technophile/OpenMQTTGateway/workflows/Check%20Code%20Format/badge.svg?branch=development) -[![OpenMQTTGateway capabilities](https://github.com/1technophile/OpenMQTTGateway/blob/development/docs/img/OpenMQTTGateway.png)](https://community.openmqttgateway.com) +[![OpenMQTTGateway capabilities](https://github.com/1technophile/OpenMQTTGateway/blob/development/docs/.vuepress/public/img/OpenMQTTGateway.png)](https://community.openmqttgateway.com) OpenMQTTGateway aims to unify various technologies and protocols into a single firmware. This reduces the need for multiple physical bridges and streamlines diverse technologies under the widely-used [MQTT](http://mqtt.org/) protocol. @@ -30,9 +30,9 @@ Support open-source development through sponsorship and gain exclusive access to ### Theengs Bridge, Bluetooth gateway (BLE) with external antenna -[Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerfull BLE to MQTT gateway for over [90 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity. +[Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerfull BLE to MQTT gateway for over [100 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity. -[![Theengs bridge view](./docs/img/Theengs-Bridge-ble-gateway.png)](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) +[![Theengs bridge view](./docs/.vuepress/public/img/Theengs-Bridge-ble-gateway.png)](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) ### Theengs Plug, Bluetooth gateway (BLE) gateway and Smart Plug @@ -44,7 +44,7 @@ Support open-source development through sponsorship and gain exclusive access to * Presence detection (beta), * Local connectivity first. -[![Theengs plug view](./docs/img/Theengs-Plug-OpenMQTTGateway.png)](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) +[![Theengs plug view](./docs/.vuepress/public/img/Theengs-Plug-OpenMQTTGateway.png)](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) Support the project by purchasing the [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) or the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) diff --git a/docs/.vuepress/public/img/OpenMQTTGateway-sensors-ble.png b/docs/.vuepress/public/img/OpenMQTTGateway-sensors-ble.png new file mode 100644 index 0000000..9ae8daf Binary files /dev/null and b/docs/.vuepress/public/img/OpenMQTTGateway-sensors-ble.png differ diff --git a/docs/.vuepress/public/img/OpenMQTTGateway.png b/docs/.vuepress/public/img/OpenMQTTGateway.png new file mode 100644 index 0000000..e8ce218 Binary files /dev/null and b/docs/.vuepress/public/img/OpenMQTTGateway.png differ diff --git a/docs/img/Theengs-Bridge-ble-gateway.png b/docs/.vuepress/public/img/Theengs-Bridge-ble-gateway.png similarity index 100% rename from docs/img/Theengs-Bridge-ble-gateway.png rename to docs/.vuepress/public/img/Theengs-Bridge-ble-gateway.png diff --git a/docs/img/Theengs-Plug-OpenMQTTGateway.png b/docs/.vuepress/public/img/Theengs-Plug-OpenMQTTGateway.png similarity index 100% rename from docs/img/Theengs-Plug-OpenMQTTGateway.png rename to docs/.vuepress/public/img/Theengs-Plug-OpenMQTTGateway.png diff --git a/docs/README.md b/docs/README.md index 4ff2eba..b627c90 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,8 @@ OpenMQTTGateway aims to unify various technologies and protocols into a single firmware. This reduces the need for multiple physical bridges and streamlines diverse technologies under the widely-used [MQTT](http://mqtt.org/) protocol. -![Overview of the protocols and compatible controllers](./img/OpenMQTTGateway.png) +
+Overview of the protocols and compatible controllers +
# What is an MQTT gateway or bridge ? @@ -67,9 +69,13 @@ Support open-source development through sponsorship and gain exclusive access to ### Theengs Bridge, BLE gateway with external antenna -[Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerfull BLE to MQTT gateway for over [90 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity. +[Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerfull BLE to MQTT gateway for over [100 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity. -[![Theengs bridge view](./img/Theengs-Bridge-ble-gateway.png)](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) +
+ + Theengs bridge view + +
### Theengs Plug, BLE gateway and Smart Plug @@ -81,7 +87,11 @@ Support open-source development through sponsorship and gain exclusive access to * Presence detection (beta), * Local connectivity first. -[![Theengs plug view](./img/Theengs-Plug-OpenMQTTGateway.png)](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) +
+ + Theengs plug view + +
Support the project by purchasing the [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) or the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) diff --git a/docs/img/OpenMQTTGateway-sensors-ble.png b/docs/img/OpenMQTTGateway-sensors-ble.png deleted file mode 100644 index de03925..0000000 Binary files a/docs/img/OpenMQTTGateway-sensors-ble.png and /dev/null differ diff --git a/docs/img/OpenMQTTGateway.png b/docs/img/OpenMQTTGateway.png deleted file mode 100644 index 937d1a2..0000000 Binary files a/docs/img/OpenMQTTGateway.png and /dev/null differ diff --git a/docs/prerequisites/board.md b/docs/prerequisites/board.md index 874fbca..9b019d9 100644 --- a/docs/prerequisites/board.md +++ b/docs/prerequisites/board.md @@ -17,7 +17,11 @@ If you want to use the BLE decoding capabilities of OpenMQTTGateway with a table [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerful BLE to MQTT gateway for over [90 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity. -[![Theengs bridge view](../img/Theengs-Bridge-ble-gateway.png)](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) +
+ + Theengs bridge view + +
[Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) is available flashed with OpenMQTTGateway, and brings the functions below: * BLE to MQTT gateway, tens of Bluetooth devices supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors, @@ -27,7 +31,11 @@ If you want to use the BLE decoding capabilities of OpenMQTTGateway with a table * Presence detection (beta), * Local connectivity first. -[![Theengs plug view](../img/Theengs-Plug-OpenMQTTGateway.png)](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) +
+ + Theengs plug view + +
Support the project by purchasing the [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) or the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) The plug is available in North America only, other regions are planned. diff --git a/docs/use/ble.md b/docs/use/ble.md index 15776a1..4f64032 100644 --- a/docs/use/ble.md +++ b/docs/use/ble.md @@ -11,11 +11,25 @@ Data are transmitted to an MQTT broker, where it can be used to trigger events a With the ability to monitor and analyze data such as temperature, humidity, moisture, luminance, weight, pressure, fine particles, and more, the BLE gateway provides a flexible and customizable solution for integrating BLE technology into your control and monitoring systems. -![BLE sensors and devices](../img/OpenMQTTGateway-sensors-ble.png) +
+ BLE sensors and devices +
-## The first plug-and-play OpenMQTTGateway BLE gateway and Smart Plug! +## Products powered by OpenMQTTGateway -[Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) is available flashed with OpenMQTTGateway, and brings the functions below: +### Theengs Bridge, BLE gateway with external antenna + +[Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) is a powerfull BLE to MQTT gateway for over [100 sensors](https://decoder.theengs.io/devices/devices.html). Equipped with an Ethernet port, and external antenna, ensuring an enhanced range for your BLE sensors. It supports also WiFi connectivity. + +
+ + Theengs bridge view + +
+ +### Theengs Plug, BLE gateway and Smart Plug + +[Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) brings the following features: * BLE to MQTT gateway, tens of [Bluetooth devices](https://compatible.openmqttgateway.com/index.php/devices/ble-devices/) supported thanks to Theengs Decoder library. The plug uses an ESP32 acting as a BLE to Wifi gateway to scan, decode and forward the data of the nearby sensors, * Smart plug that can be controlled remotely, * Energy consumption monitoring, @@ -23,10 +37,13 @@ With the ability to monitor and analyze data such as temperature, humidity, mois * Presence detection (beta), * Local connectivity first. -[![Theengs plug view](../img/Theengs-Plug-OpenMQTTGateway.png)](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) +
+ + Theengs plug view + +
-Support the project by purchasing the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) -The plug is available in North America only, other regions are planned. +Support the project by purchasing the [Theengs bridge](https://shop.theengs.io/products/theengs-bridge-esp32-ble-mqtt-gateway-with-ethernet-and-external-antenna) or the [Theengs plug](https://shop.theengs.io/products/theengs-plug-smart-plug-ble-gateway-and-energy-consumption) ## Disable or enable the BLE gateway (default: true, available with HA discovery)