Skip to content

Commit

Permalink
Bye Readme, hello Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
couin3 committed Apr 14, 2020
1 parent 83d9a3b commit a768048
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.pio
.vscode
pictures/Full size/
9 changes: 0 additions & 9 deletions README

This file was deleted.

62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Binary file added pictures/RFLink-ESP_OLED.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pictures/RFLink-ESP_OLED_2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pictures/RFLink-ESP_Pinout.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pictures/RFLink-ESP_RXB6.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pictures/RFLink-ESP_Receivers.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a768048

Please sign in to comment.