Skip to content

Commit a05fd01

Browse files
1technophile1technophile
authored
remove default path when cliking on sidebar menus (#502)
change link to sources add credits and some shape for readme add cleargrass with air pressure and mi band add PWA add plugins Add new boards improve doc with boars and ble devices
1 parent 235413a commit a05fd01

File tree

5 files changed

+65
-29
lines changed

5 files changed

+65
-29
lines changed

‎docs/.vuepress/config.js

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@ module.exports = {
55
title: 'OpenMQTTGateway',
66
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.',
77
head: [
8-
['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/img/apple-touch-icon.png"}],
98
['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/img/favicon-32x32.png"}],
109
['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/img/favicon-16x16.png"}],
11-
['link', { rel: "shortcut icon", href: "/img/apple-touch-icon.png"}],
10+
['link', { rel: 'icon', href: '/img/Openmqttgateway_logo_mini.png' }],
11+
['link', { rel: 'manifest', href: '/manifest.json' }],
12+
['meta', { name: 'theme-color', content: '#3eaf7c' }],
13+
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
14+
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
15+
['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/img/apple-touch-icon.png"}],
16+
['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }],
17+
['meta', { name: 'msapplication-TileImage', content: '/icons/msapplication-icon-144x144.png' }],
18+
['meta', { name: 'msapplication-TileColor', content: '#000000' }]
1219
],
1320
themeConfig: {
1421
smoothScroll: true,
@@ -27,7 +34,6 @@ module.exports = {
2734
['/','0 - What is it for 🏠'],
2835
{
2936
title: '1 - Prerequisites🧭', // required
30-
path: '/prerequisites/devices/', // optional, which should be a absolute path.
3137
//collapsable: true, // optional, defaults to true
3238
sidebarDepth: 1, // optional, defaults to 1
3339
children: [
@@ -38,7 +44,6 @@ module.exports = {
3844
},
3945
{
4046
title: '2 - Set it up 🔨', // required
41-
path: '/setitup/rf', // optional, which should be a absolute path.
4247
sidebarDepth: 1, // optional, defaults to 1
4348
children: [
4449
'setitup/rf',
@@ -52,7 +57,6 @@ module.exports = {
5257
},
5358
{
5459
title: '3 - Upload ➡️', // required
55-
path: '/upload/binaries', // optional, which should be a absolute path.
5660
sidebarDepth: 1, // optional, defaults to 1
5761
children: [
5862
'upload/binaries',
@@ -62,7 +66,6 @@ module.exports = {
6266
},
6367
{
6468
title: '4 - Use ✈️', // required
65-
path: '/use/rf', // optional, which should be a absolute path.
6669
sidebarDepth: 1, // optional, defaults to 1
6770
children: [
6871
'use/rf',
@@ -77,7 +80,6 @@ module.exports = {
7780
},
7881
{
7982
title: '5 - Integrate 🎉', // required
80-
path: '/integrate/openhab2/', // optional, which should be a absolute path.
8183
sidebarDepth: 1, // optional, defaults to 1
8284
children: [
8385
'integrate/openhab2',
@@ -95,5 +97,13 @@ module.exports = {
9597
]
9698
}
9799
]
98-
}
100+
},
101+
plugins: [
102+
['@vuepress/pwa', {
103+
serviceWorker: true,
104+
updatePopup: true
105+
}],
106+
['@vuepress/medium-zoom', true],
107+
['@vuepress/nprogress']
108+
]
99109
}

‎docs/prerequisites/board.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,29 @@ Or can actutate things (LED chipsets, relays).
88

99
Here is some information to find the board suitable for your need, you have the choice between wifi, ethernet and off the shelves devices:
1010

11-
Off the shelves wifi
12-
* SONOFF RF Bridge
13-
* Sonoff RFR3
14-
* Sonoff Basic
15-
* Wifi RF Gateway
11+
|Off the shelves wifi boards|RF|IR|BLE|LORA|GSM|Button|Relay|
12+
|-|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
13+
|Sonoff RF Bridge (*) |X|[needs an hack](https://1technophile.blogspot.com/2018/02/adding-infrared-emitter-to-sonoff-rf.html)|-|-|-|-|-|
14+
|All bare ESP32|-|-|X|-|-|-|-|
15+
|M5Stack Basic|-|-|X|-|-|-|-|
16+
|M5Stick C|-|sending|X|-|-|X|X|
17+
|TTGO LORA32|-|-|-|X|-|-|-|
18+
|Sonoff RFR3|receiving [needs an hack](https://1technophile.blogspot.com/2019/08/new-sonoff-rfr3-as-433tomqtt-gateway.html)|-|-|-|-|X|X|
19+
|Sonoff Basic|-|-|-|-|-|X|X|
20+
|RF WIFI GATEWAY|[receiving](https://1technophile.blogspot.com/2019/09/hack-of-rf-wifi-gateway-usb-stick.html)|-|-|-|-|-|-|
21+
22+
'(*)' *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.*
1623

1724
![boards](../img/OpenMQTTGateway_boards_sonoff.png)
1825

19-
Wifi/Ethernet:
20-
* ESP8266
21-
* ESP32
22-
* Arduino Mega with an ethernet shield
23-
* Arduino Uno with an ethernet shield
26+
|DIY boards|RF|IR|BLE|LORA|GSM|Button|Relay|
27+
|-|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
28+
|Arduino UNO|X|X(limited compared to ESP)|X|-|X|X|
29+
|Arduino MEGA|X|X(limited compared to ESP)|X|-|-|X|X|
30+
|ESP32|X|X|X|X|not tested|X|X|
31+
|ESP8266|X|X|X|not tested|X|X|X|
32+
33+
*Note that Pilight is only supported on ESP for the moment.*
2434

2535
![boards](../img/OpenMQTTGateway_boards.png)
2636

‎docs/prerequisites/devices.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
11
# Devices
2-
A list of verified compatible devices is maintained [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit?usp=sharing).
2+
**A list of verified compatible devices is maintained [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit?usp=sharing).**
33

44
Added to that is an overview of devices supported by OpenMQTTGateway:
5-
* 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.
5+
## For radio frequency devices
6+
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).
7+
Note that for the moment RF, RF2 and Pilight can not be activated on the same boards together.
68

79
![boards](../img/OpenMQTTGateway_devices_rf1.png ':size=250%')
810
![boards](../img/OpenMQTTGateway_devices_rf2.png ':size=250%')
911
![boards](../img/OpenMQTTGateway_devices_rf3.png ':size=250%')
1012

11-
* 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 :
12-
** Mi Flora (temperature/moisture/luminance/fertility)
13-
** Mi Jia (temperature/humidity)
14-
** Clear Grass (temperature/humidity)
15-
** LYWDS02 Clock (temperature/humidity)
16-
** Mi Scale (weight)
13+
## For BLE devices
14+
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.
15+
16+
|Devices|Measurements|
17+
|-|:-:|
18+
| BLE watches with fixed mac|rssi for presence detection|
19+
| BLE beacons keychains|rssi for presence detection|
20+
| XIAOMI Mi Flora |temperature/moisture/luminance/fertility|
21+
| XIAOMI Mi Jia |temperature/humidity/battery|
22+
| ClearGrass |temperature/humidity/battery|
23+
| ClearGrass with atmospheric pressure |temperature/humidity/air pressure|
24+
| LYWDS02 Clock |temperature/humidity|
25+
| XIAOMI Mi Scale |weight|
26+
| XIAOMI Mi band |steps|
27+
1728

1829
![boards](../img/OpenMQTTGateway_devices_ble.png ':size=250%')
1930

20-
* 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!
31+
## For infrared IR devices
32+
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!
2133

22-
* 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.
34+
## LORA
35+
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.

‎docs/setitup/ir.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,6 @@ Connect the Emitter and Receiver to a 5V supply source, and the ground of your s
2727

2828
## ESP32 Hardware setup
2929
![IR](../img/OpenMQTTgateway_ESP32_Addon_IR.png)
30+
31+
## Credits
32+
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.

‎docs/upload/arduino-ide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* First download the last version of the Arduino IDE from the arduino [website](https://www.arduino.cc/en/Main/Software)
44
* Add ESP32 boards by following this [tutorial](https://github.com/espressif/arduino-esp32/blob/master/docs/arduino-ide/boards_manager.md)
55
* Add ESP8266 boards by following this [tutorial](https://github.com/esp8266/Arduino#installing-with-boards-manager)
6-
* Download OpenMQTTGateway code from the [release page](https://github.com/1technophile/OpenMQTTGateway/releases)
6+
* Download OpenMQTTGateway code (OpenMQTTGateway_sources.zip) from the [release page](https://github.com/1technophile/OpenMQTTGateway/releases) and unzip it
77
* Download the libraries package corresponding to your board and module wished into the same page (example esp32-m5stick-c-ble-libraries.zip)
88
* Unzip the libraries into your arduino libraries folder (example D:/Users/XXXX/Documents/Arduino/libraries)
99
* Open the file main.ino from OpenMQTTGateway/main folder

0 commit comments

Comments
 (0)