update (#489)

add fastled doc

add links to bootloaders and boot app0

Arduino IDE upload instructions add

add community

README.md

@@ -6,19 +6,16 @@
 [![Download count](https://img.shields.io/github/downloads/1technophile/OpenMQTTGateway/total.svg)](https://github.com/1technophile/OpenMQTTGateway/releases)
 [![HitCount](http://hits.dwyl.io/1technophile/https://githubcom/1technophile/OpenMQTTGateway.svg)](http://hits.dwyl.io/1technophile/https://githubcom/1technophile/OpenMQTTGateway)
 
-**Questions, support please don't open an issue, go first to the [wiki](https://github.com/1technophile/OpenMQTTGateway/wiki) and if you not find your answer go to [the community forum](https://community.openmqttgateway.com)**
+**Questions, support please don't open an issue, go first to the [docs](https://docs.openmqttgateway.com) and if you not find your answer go to [the community forum](https://community.openmqttgateway.com)**
 
 # OpenMQTTGateway
-[![](https://github.com/1technophile/OpenMQTTGateway/blob/master/img/OpenMQTTGateway.jpg)](https://github.com/1technophile/OpenMQTTGateway/wiki)
+[![](https://github.com/1technophile/OpenMQTTGateway/blob/development/docs/img/OpenMQTTGateway.jpg)](https://community.openmqttgateway.com)
-
-To know the main functions of the gateway see below
-https://1technophile.github.io/OpenMQTTGateway/
 
 Download OpenMQTTGateway from the [releases page](https://github.com/1technophile/OpenMQTTGateway/releases)
 
 The reference sheet, with the list of all functions, pinouts is [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=0)
 
-A list of supported 433mhz devices (and others) is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079), door/window sensors, PIR sensors, smoke detectors, weather stations...
+A list of supported devices is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079), door/window sensors, PIR sensors, smoke detectors, weather stations...
 
 A list of compatible components to build your gateway is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277), nodemcu, esp32, emitters and receivers...
 

docs/.vuepress/config.js

@@ -3,7 +3,13 @@ module.exports = {
       lineNumbers: true
     },
     title: 'OpenMQTTGateway',
-    description: 'One gateway, many technologies',
+    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"}],
+    ],
     themeConfig: {
       smoothScroll: true,
       repo: '1technophile/OpenMQTTGateway',
@@ -51,6 +57,7 @@ module.exports = {
           children: [
             'upload/binaries',
             'upload/pio'
+            'upload/arduino-ide'
           ]
         },
         {
@@ -82,7 +89,9 @@ module.exports = {
           title: '6 - Participate 💻',   // required
           sidebarDepth: 1,    // optional, defaults to 1
           children: [
-            'CONTRIBUTING',
+            'participate/development',
+            'participate/community',
+            'participate/financial_support',
             ['https://github.com/1technophile/OpenMQTTGateway/blob/development/LICENSE.txt','License']
           ]
         }

docs/CONTRIBUTING.md

@@ -1,37 +0,0 @@
-# Contributing
-
-I like pull requests from everyone. By participating in this project, you
-agree to follow the code of conduct below
-
-[code of conduct]: https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md
-
-Fork the [development branch](https://github.com/1technophile/OpenMQTTGateway/tree/development), then clone the repo
-
-Make your modification,
-* If you want to add a new gateway, name it `ZgatewayXXX`, `XXX` replaced by your gateway communication type, can be more than three letters
-* If you want to add a new sensor, name it `ZsensorYYY`, `YYY` replaced by your sensor type, can be more than three letters
-* If you want to add a new actuator, name it `ZactuatorZZZ`, `ZZZ` replaced by your actuator type, can be more than three letters
-
-Review your code, compile it for Arduino Uno and ESP8266
-
-Test it localy on your hardware config
-
-If you modify `User_config.h` during your developments you need to report your modifications into Test_config.h
-https://github.com/1technophile/OpenMQTTGateway/blob/master/tests/Test_config.h 
-Indeed during the continuous integration process `User_config.h` is replaced by `Test_config.h`. 
-`Test_config.h` as much more gateway/sensors enabled for the test than the default `User_config.h`
-
-Emit a pull request
-
-Verify the travis CI compilation results
-
-Request for review
-
-I may suggest some changes or improvements or alternatives.
-
-Some things that will increase the chance that your pull request is accepted:
-* Comment your code
-* Ask eventually for design guidelines
-* Write a [good commit message][commit].
-
-[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

docs/README.md

@@ -1,9 +1,9 @@
-OpenMQTTGateway project goal is to concentrate in one gateway different technologies, decreasing by the way the number of proprietary gateways needed and hiding the different technologies singularity behind a simple & wide spread communication protocol; [MQTT](http://mqtt.org/).
+OpenMQTTGateway project goal is to concentrate in one gateway different technologies, decreasing by the way the number of proprietary gateways needed, and hiding the different technologies singularity behind a simple & wide spread communication protocol; [MQTT](http://mqtt.org/).
 
 ![Overview](./img/OpenMQTTGateway.png)
 
-OpenMQTTGateway support very mature technologies like basic 433mhz/315mhz protocols & infrared so as to make your old dumb devices "smart" and avoid you to throw then away. These devices have also the advantages of having a lower cost compared to Zwave or more sophisticated protocols.
+OpenMQTTGateway support very mature technologies like basic 433mhz/315mhz protocols & infrared (IR) so as to make your old dumb devices "smart" and avoid you to throw then away. These devices have also the advantages of having a lower cost compared to Zwave or more sophisticated protocols.
-And support also up to date technologies like Bluetooth Low Energy or LORA.
+OMG support also up to date technologies like Bluetooth Low Energy (BLE) or LORA.
 
 To have an overview of the supported PIR, door, water, smoke sensors, sirens, rings, beacons, switchs & weather stations you can take a look to the 
 [compatible devices list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079)

docs/participate/community.md

@@ -0,0 +1,4 @@
+# Community participation
+The first entry step for participating to OMG is sharing and discussing with the [community](https://community.openmqttgateway.com), by sharing your experiences and answering to other questions you are giving back what the others gave to you.
+
+You can use the forum to ask questions, post answers, suggest features and discuss about home automation or Internet of things in a more general way. 

docs/participate/development.md

@@ -1,4 +1,4 @@
-# Contributing
+# Development contributions
 
 I like pull requests from everyone. By participating in this project, you
 agree to follow the code of conduct below

docs/upload/arduino-ide.md

@@ -0,0 +1,26 @@
+# Upload with Arduino IDE
+
+* 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 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
+* Change the settings and the desired gateways into user_config.h (uncomment the modules you want)
+
+*Example for the use of RF gateway*
+```C++
+#define ZgatewayRF     "RF"       //ESP8266, Arduino, ESP32
+//#define ZgatewayIR     "IR"       //ESP8266, Arduino,         Sonoff RF Bridge
+//#define ZgatewayLORA   "LORA"       //ESP8266, Arduino, ESP32
+//#define ZgatewayPilight "Pilight" //ESP8266, Arduino, ESP32
+//#define ZgatewayBT     "BT"       //ESP8266, ESP32
+```
+
+* Change the pins or parameters corresponding to the modules choosen, for RF you can change the pins into config_RF.h
+* Choose the board on the Arduino IDE
+* Select the port corresponding to the board
+* Open the serial monitor and set 115200 bauds
+* Upload ➡️
+* You should see the logs into the serial monitor

docs/upload/binaries.md

@@ -5,6 +5,8 @@ Nevertheless you will not be able to change advanced parameters, if you want to
 Download the binary corresponding to your board and gateway [here](https://github.com/1technophile/OpenMQTTGateway/releases) from github and uncompress it.
 
 ## ESP32
+* Download the bootloader [here](https://github.com/espressif/arduino-esp32/raw/master/tools/sdk/bin/bootloader_dio_80m.bin)
+* Download the boot_app0 from [here](https://github.com/espressif/arduino-esp32/raw/master/tools/partitions/boot_app0.bin)
 * Download the flash tool utility from espressif:
 https://www.espressif.com/en/products/hardware/esp32/resources
 * Uncompress the package

docs/use/actuators.md

@@ -20,6 +20,18 @@ ON command
 `mosquitto_pub -t home/OpenMQTTGateway_MEGA/commands/MQTTtoONOFF -m '{"pin":15,"state":1}'`
 
 ## FASTLED
+### The FASTLED module support 2 different operation modes
+1. control one specific RGB LED
+* Set color
+* Set blink
+
+2. Start fire animation (Fire2012)
+
+### Hardware wiring
+Theoreticaly it should be possible to use every free IO pin. But after some tests only pin D2 works at WEMOS D1. Other platforms can work.
+The default setting use NEOPIXEL (WS2812B). The simplest wiring is direct connect D2 to data pin of LED stripe and connect VCC/GND to power source. You should also add an capacitor.
+
+