diff --git a/.gitignore b/.gitignore index b9f3806a..a0f40bb3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .pio .vscode +pictures/Full size/ diff --git a/README b/README deleted file mode 100644 index ce753c2b..00000000 --- a/README +++ /dev/null @@ -1,9 +0,0 @@ -R42: - ESP Version, based on R29 -Special thanks to: -Axellum, Etimou, Schmurtz, Zoomx - -R29: - Last Original RFLink with known open sourced files - -Special thanks to: -Alex, Benoit, Bert, Christophe, Deennoo, Jelle, John, Jonas, Gerrit, Goran, Mark, Martinus, Maurice, Paul, Pim, Remco, Richard, Rob, Sebastien, Thibaut, William -and everyone who contributed with feedback, suggestions, debug data, tests etc. diff --git a/README.md b/README.md new file mode 100644 index 00000000..6f2a18f7 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# RFLink ESP +This is an RF to MQTT gateway build for an ESP8266 board (see #MCU for more). + +It receive OOK 433MHz signals, then it identifies, decodes and push them over MQTT. + +Projet is based on RFlink project "R29" (see rflink.nl, latest known open source shard version). + +## 1. MCU +We use extensively Wemos ESP8266 D1 mini clone. + +This is default settings in Platformio.ini and RFLink.h files. + +You may use: +- Other ESP8266/ESP8255 based boards, when no pins limitations. NodeMCUv2 is known working. +- ESP32 based boards should work too. Although we need feedbacks there. +- Arduino board (Uno, Pro Mini, Mega) are working too, of course without WiFi/MQTT part. + +## 2. Receiver / Transmitter / Transceiver +We mainly use RXB6 receiver. +It is simple, steady, running on 3.3v, easy to find and cheap. + +Many other receivers will do! +Simply *** Please avoid generic noname receiver *** + +![Receivers](https://github.com/couin3/RFLink/blob/master/pictures/RFLink-ESP_Receivers.jpg "Receivers") + +## 3. OLED display +You can use an OLED display! We used SSD1306 128x64 I2C screen for our testings. + +*** This is highly experimental ***, and thus not activated by default. + +![OLED](https://github.com/couin3/RFLink/blob/master/pictures/RFLink-ESP_OLED_2.jpg "OLED") + +## 4. IDE +- We strongly recommend using PlatformIO IDE (https://platformio.org/install) +- You may alternatively use Arduino IDE 1.8.10 (https://www.arduino.cc/en/Guide/HomePage) + +## 5. Framework +We use Arduino Core for ESP8266 https://github.com/esp8266/Arduino + +## 6. Libraries +So far, in addition of core libraries, we use: +- PubSubClient for MQTT messaging https://github.com/knolleary/pubsubclient +- u8g2/u8x8 library for OLED display https://github.com/olikraus/u8g2 +- AutoConnect for simplified configuration (incomming v2.0) https://hieromon.github.io/AutoConnect + +## 7. Additional info +### Pinout +- We aim to the simplest possible connexion. +- You may add decoupling capacitors and antenna to improve results. + +| Name | D1 mini | RXB6 | +|---------------|---------|-------| +| PIN_RF_TX_VCC | D5 | 5 VCC | +| PIN_RF_TX_NA | D6 | 6 DER | +| PIN_RF_TX_DATA| D7 | 7 DAT | +| PIN_RF_TX_GND | D8 | 8 GND | + +![Pinout](https://github.com/couin3/RFLink/blob/master/pictures/RFLink-ESP_Pinout.jpg "Pinout") + +### Thanks +Special thanks to: Axellum, Etimou, Schmurtz, Zoomx diff --git a/pictures/RFLink-ESP_OLED.jpg b/pictures/RFLink-ESP_OLED.jpg new file mode 100644 index 00000000..3d3d4192 Binary files /dev/null and b/pictures/RFLink-ESP_OLED.jpg differ diff --git a/pictures/RFLink-ESP_OLED_2.jpg b/pictures/RFLink-ESP_OLED_2.jpg new file mode 100644 index 00000000..8a6e5cf0 Binary files /dev/null and b/pictures/RFLink-ESP_OLED_2.jpg differ diff --git a/pictures/RFLink-ESP_Pinout.jpg b/pictures/RFLink-ESP_Pinout.jpg new file mode 100644 index 00000000..88144002 Binary files /dev/null and b/pictures/RFLink-ESP_Pinout.jpg differ diff --git a/pictures/RFLink-ESP_RXB6.jpg b/pictures/RFLink-ESP_RXB6.jpg new file mode 100644 index 00000000..aafd3494 Binary files /dev/null and b/pictures/RFLink-ESP_RXB6.jpg differ diff --git a/pictures/RFLink-ESP_Receivers.jpg b/pictures/RFLink-ESP_Receivers.jpg new file mode 100644 index 00000000..8e2798b5 Binary files /dev/null and b/pictures/RFLink-ESP_Receivers.jpg differ