diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index dbd3d13..d0b35c5 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -5,10 +5,17 @@ module.exports = { title: 'OpenMQTTGateway', description: 'One gateway, many technologies: MQTT gateway for ESP8266, ESP32, Sonoff RF Bridge or Arduino with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.', head: [ - ['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/img/apple-touch-icon.png"}], ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/img/favicon-32x32.png"}], ['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/img/favicon-16x16.png"}], - ['link', { rel: "shortcut icon", href: "/img/apple-touch-icon.png"}], + ['link', { rel: 'icon', href: '/img/Openmqttgateway_logo_mini.png' }], + ['link', { rel: 'manifest', href: '/manifest.json' }], + ['meta', { name: 'theme-color', content: '#3eaf7c' }], + ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }], + ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }], + ['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/img/apple-touch-icon.png"}], + ['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }], + ['meta', { name: 'msapplication-TileImage', content: '/icons/msapplication-icon-144x144.png' }], + ['meta', { name: 'msapplication-TileColor', content: '#000000' }] ], themeConfig: { smoothScroll: true, @@ -27,7 +34,6 @@ module.exports = { ['/','0 - What is it for 🏠'], { title: '1 - Prerequisites🧭', // required - path: '/prerequisites/devices/', // optional, which should be a absolute path. //collapsable: true, // optional, defaults to true sidebarDepth: 1, // optional, defaults to 1 children: [ @@ -38,7 +44,6 @@ module.exports = { }, { title: '2 - Set it up 🔨', // required - path: '/setitup/rf', // optional, which should be a absolute path. sidebarDepth: 1, // optional, defaults to 1 children: [ 'setitup/rf', @@ -52,7 +57,6 @@ module.exports = { }, { title: '3 - Upload ➡️', // required - path: '/upload/binaries', // optional, which should be a absolute path. sidebarDepth: 1, // optional, defaults to 1 children: [ 'upload/binaries', @@ -62,7 +66,6 @@ module.exports = { }, { title: '4 - Use ✈️', // required - path: '/use/rf', // optional, which should be a absolute path. sidebarDepth: 1, // optional, defaults to 1 children: [ 'use/rf', @@ -77,7 +80,6 @@ module.exports = { }, { title: '5 - Integrate 🎉', // required - path: '/integrate/openhab2/', // optional, which should be a absolute path. sidebarDepth: 1, // optional, defaults to 1 children: [ 'integrate/openhab2', @@ -95,5 +97,13 @@ module.exports = { ] } ] - } + }, + plugins: [ + ['@vuepress/pwa', { + serviceWorker: true, + updatePopup: true + }], + ['@vuepress/medium-zoom', true], + ['@vuepress/nprogress'] + ] } diff --git a/docs/prerequisites/board.md b/docs/prerequisites/board.md index bdb8fc6..e60a8b3 100644 --- a/docs/prerequisites/board.md +++ b/docs/prerequisites/board.md @@ -8,19 +8,29 @@ Or can actutate things (LED chipsets, relays). Here is some information to find the board suitable for your need, you have the choice between wifi, ethernet and off the shelves devices: -Off the shelves wifi -* SONOFF RF Bridge -* Sonoff RFR3 -* Sonoff Basic -* Wifi RF Gateway +|Off the shelves wifi boards|RF|IR|BLE|LORA|GSM|Button|Relay| +|-|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|Sonoff RF Bridge (*) |X|[needs an hack](https://1technophile.blogspot.com/2018/02/adding-infrared-emitter-to-sonoff-rf.html)|-|-|-|-|-| +|All bare ESP32|-|-|X|-|-|-|-| +|M5Stack Basic|-|-|X|-|-|-|-| +|M5Stick C|-|sending|X|-|-|X|X| +|TTGO LORA32|-|-|-|X|-|-|-| +|Sonoff RFR3|receiving [needs an hack](https://1technophile.blogspot.com/2019/08/new-sonoff-rfr3-as-433tomqtt-gateway.html)|-|-|-|-|X|X| +|Sonoff Basic|-|-|-|-|-|X|X| +|RF WIFI GATEWAY|[receiving](https://1technophile.blogspot.com/2019/09/hack-of-rf-wifi-gateway-usb-stick.html)|-|-|-|-|-|-| + +'(*)' *So as to extend the number of RF protocols supported by the Sonoff RF Bridge you can apply an [hardware hack](https://1technophile.blogspot.com/2019/04/sonoff-rf-bridge-pilight-or-how-to.html), this way you will be able to use Pilight or RF2 gateway.* ![boards](../img/OpenMQTTGateway_boards_sonoff.png) -Wifi/Ethernet: -* ESP8266 -* ESP32 -* Arduino Mega with an ethernet shield -* Arduino Uno with an ethernet shield +|DIY boards|RF|IR|BLE|LORA|GSM|Button|Relay| +|-|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|Arduino UNO|X|X(limited compared to ESP)|X|-|X|X| +|Arduino MEGA|X|X(limited compared to ESP)|X|-|-|X|X| +|ESP32|X|X|X|X|not tested|X|X| +|ESP8266|X|X|X|not tested|X|X|X| + +*Note that Pilight is only supported on ESP for the moment.* ![boards](../img/OpenMQTTGateway_boards.png) diff --git a/docs/prerequisites/devices.md b/docs/prerequisites/devices.md index 1fa97e3..86a1ccc 100644 --- a/docs/prerequisites/devices.md +++ b/docs/prerequisites/devices.md @@ -1,22 +1,35 @@ # Devices -A list of verified compatible devices is maintained [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit?usp=sharing). +**A list of verified compatible devices is maintained [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit?usp=sharing).** Added to that is an overview of devices supported by OpenMQTTGateway: -* For radio frequency devices OpenMQTTGateway can support a wide range of 433mhz/315mhz devices, all the ones with SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527, HS1527 chipset are supported by the RF gateway. Added to that RF2 support Kaku and Pilight an [huge list](https://wiki.pilight.org/devices). Note that for the moment RF, RF2 and Pilight can not be activated on the same boards together. +## For radio frequency devices +OpenMQTTGateway can support a wide range of 433mhz/315mhz devices, all the ones with SC5262 / SC5272, HX2262 / HX2272, PT2262 / PT2272, EV1527, RT1527, FP1527, HS1527 chipsets are supported by the RF gateway. Added to that RF2 support Kaku and Pilight an [huge list](https://wiki.pilight.org/devices). +Note that for the moment RF, RF2 and Pilight can not be activated on the same boards together. ![boards](../img/OpenMQTTGateway_devices_rf1.png ':size=250%') ![boards](../img/OpenMQTTGateway_devices_rf2.png ':size=250%') ![boards](../img/OpenMQTTGateway_devices_rf3.png ':size=250%') -* For BLE devices OpenMQTTGateway is able to scan all the BLE devices that advertise their data so as to do presence detection. Added to that it reads values coming from : -** Mi Flora (temperature/moisture/luminance/fertility) -** Mi Jia (temperature/humidity) -** Clear Grass (temperature/humidity) -** LYWDS02 Clock (temperature/humidity) -** Mi Scale (weight) +## For BLE devices +OpenMQTTGateway is able to scan all the BLE devices that advertise their data so as to do presence detection. Added to that it can retrieve the measures from the devices below. + +|Devices|Measurements| +|-|:-:| +| BLE watches with fixed mac|rssi for presence detection| +| BLE beacons keychains|rssi for presence detection| +| XIAOMI Mi Flora |temperature/moisture/luminance/fertility| +| XIAOMI Mi Jia |temperature/humidity/battery| +| ClearGrass |temperature/humidity/battery| +| ClearGrass with atmospheric pressure |temperature/humidity/air pressure| +| LYWDS02 Clock |temperature/humidity| +| XIAOMI Mi Scale |weight| +| XIAOMI Mi band |steps| + ![boards](../img/OpenMQTTGateway_devices_ble.png ':size=250%') -* For infrared IR devices the list of supported brand is [here](https://github.com/1technophile/OpenMQTTGateway/blob/d2dd6138558909b71cc44f69665340247bd5f356/main/config_IR.h#L52), as there is also the possibility of using raw and global caché sending the possibilities of this gateway is huge! +## For infrared IR devices +the list of supported devices for ESP is [here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md), and [here](https://github.com/1technophile/OpenMQTTGateway/blob/6f73160d1421bebf2c1bbc9b8017978ff5b16520/main/config_IR.h#L123) for Arduino boards, as there is also the possibility of using raw and global caché (ESP) sending possibilities of this gateway is huge! -* LORA is more dedicated at this moment for tinkering and DIY and there is no Off the shelves devices compatible to my knowledge with this gateway. +## LORA + is more dedicated at this moment for tinkering and DIY and there is no Off the shelves devices compatible to my knowledge with this gateway. diff --git a/docs/setitup/ir.md b/docs/setitup/ir.md index 5670029..2aea1b8 100644 --- a/docs/setitup/ir.md +++ b/docs/setitup/ir.md @@ -27,3 +27,6 @@ Connect the Emitter and Receiver to a 5V supply source, and the ground of your s ## ESP32 Hardware setup ![IR](../img/OpenMQTTgateway_ESP32_Addon_IR.png) + +## Credits +This gateway exists thanks to the work done on [IRRemote](https://github.com/z3t0/Arduino-IRremote) and [IRremoteESP8266](https://github.com/crankyoldgit/IRremoteESP8266) libraries. Thanks for the works of contributors and especialy [@crankyoldgit](https://github.com/crankyoldgit) for its active contributions. diff --git a/docs/upload/arduino-ide.md b/docs/upload/arduino-ide.md index ece91c9..9b8d270 100644 --- a/docs/upload/arduino-ide.md +++ b/docs/upload/arduino-ide.md @@ -3,7 +3,7 @@ * First download the last version of the Arduino IDE from the arduino [website](https://www.arduino.cc/en/Main/Software) * Add ESP32 boards by following this [tutorial](https://github.com/espressif/arduino-esp32/blob/master/docs/arduino-ide/boards_manager.md) * Add ESP8266 boards by following this [tutorial](https://github.com/esp8266/Arduino#installing-with-boards-manager) -* Download OpenMQTTGateway code from the [release page](https://github.com/1technophile/OpenMQTTGateway/releases) +* Download OpenMQTTGateway code (OpenMQTTGateway_sources.zip) from the [release page](https://github.com/1technophile/OpenMQTTGateway/releases) and unzip it * Download the libraries package corresponding to your board and module wished into the same page (example esp32-m5stick-c-ble-libraries.zip) * Unzip the libraries into your arduino libraries folder (example D:/Users/XXXX/Documents/Arduino/libraries) * Open the file main.ino from OpenMQTTGateway/main folder