mirror of
https://github.com/1technophile/OpenMQTTGateway.git
synced 2026-03-06 15:28:29 +01:00
* Add OpenHAB3 tutorial and BLE binary * Small text changes Just a few small text changes, also writing out OMG as OpenMQTTGateway, probably clearer for new to OMG users. Co-authored-by: DigiH <github@digih.net>
7.4 KiB
7.4 KiB
(Option 1) Upload from the web
::: tip Running on a tablet or phone If you want to use the BLE decoding capabilities of OpenMQTTGateway with a tablet or smartphone you can use Theengs App. :::
You can upload the firmware to your ESP device directly from here.
- Plug in your ESP to a USB port.
- Select the firmware in the box below.
- Click the install button and choose the port that the ESP is connected to.
- Wait until the process is complete.
- Once completed you can configure your Wifi and MQTT credentials
The table below describes the libraries and the modules of each board configuration.
| Firmware | Boards compatible | Description | RF | IR | BLE | LORA |
|---|---|---|---|---|---|---|
| ESP32 | ||||||
| esp32-lolin32lite-ble | ESP32 Lolin lite | Suitable for low power with BLE gateway, tutorial | - | - | X | - |
| esp32-m5atom | M5Atom | Compact enclosure ESP32 with BLE gateway | - | (Emit) | X | - |
| esp32-m5stack-ble | M5Stack Core | Expandable module with BLE gateway, display, and little IR emitter | - | - | X | - |
| esp32-m5stick-ble | M5Stick Grey | Expandable module with BLE gateway and little IR emitter | - | (Emit) | X | - |
| esp32-m5stick-c-ble | M5Stick C Orange | Expandable module with BLE gateway, display, and little IR emitter | - | (Emit) | X | - |
| esp32-m5stick-cp-ble | M5Stick C Plus Orange | Expandable module with BLE gateway, display, and little IR emitter | - | (Emit) | X | - |
| esp32-m5tough-ble | M5Tough rugged | Expandable module with BLE gateway and display, suitable for outdoor | - | - | X | - |
| esp32-olimex-gtw-ble-eth | Olimex Ethernet Gateway (non POE) | BLE gateway with external antenna as an option | - | - | X | - |
| esp32-olimex-gtw-ble-poe | Olimex Ethernet Gateway (POE) | BLE gateway with external antenna as an option | - | - | X | - |
| esp32-olimex-gtw-ble-poe-iso | Olimex Ethernet Gateway (POE + ISO) | BLE gateway with external antenna as an option | - | - | X | - |
| esp32-olimex-gtw-ble-wifi | Olimex Ethernet Gateway (non POE) using wifi | BLE gateway | - | - | X | - |
| esp32dev-ble-cont | ESP32 dev board | BLE gateway with continuous scanning, suitable in particular for door and window BLE sensors (and all the others) | - | - | X | - |
| esp32dev-ble | ESP32 dev board | BLE gateway with one scan every 55s per default | - | - | X | - |
| esp32dev-ble-openhab | ESP32 dev board | BLE gateway with one scan every 55s per default and OpenHAB discovery | - | - | X | - |
| esp32dev-ble-mqtt-undecoded | ESP32 dev board | BLE gateway with the decoding offloaded to Theengs Gateway | - | - | X | - |
| esp32dev-gf-sun-inverter | ESP32 dev board | RS232 reading of GridFree Sun Inverter | - | - | - | - |
| esp32dev-ir | ESP32 dev board | Infrared (Emitting and receiving) using IRremoteESP8266 | - | X | - | - |
| esp32dev-multi_receiver | ESP32 dev board | Multi RF library with the possibility to switch between ESPilight, RTL_433_ESP, NewRemoteSwitch and RCSwitch, need CC1101 | X | - | - | - |
| esp32dev-pilight-CC1101 | ESP32 dev board | Gateway using ESPilight library only, need CC1101 | X | - | - | - |
| esp32dev-pilight | ESP32 dev board | Gateway using ESPilight without the need of CC1101 | X | - | - | - |
| esp32dev-pilight-somfy-CC1101 | ESP32 dev board | Gateway using Somfy Remote and ESPilight library, need CC1101 | X | - | - | - |
| esp32dev-rf | ESP32 dev board | RF gateway using RCSwitch library | X | - | - | - |
| esp32dev-rtl_433 | ESP32 dev board | Gateway using RTL_433_ESP library, need CC1101 | X | - | - | - |
| esp32dev-somfy-CC1101 | ESP32 dev board | Gateway using Somfy Remote library, need CC1101 | X | - | - | - |
| esp32dev-weatherstation | ESP32 dev board | Gateway to retrieve weather station data Ventus W174/W132 (tested), Auriol H13726, Hama EWS 1500, Meteoscan W155/W160 using WeatherStationDataRx | X | - | - | - |
| esp32feather-ble | ESP32 Feather Adafruit | BLE for the Adafruit Feather board | - | - | X | - |
| heltec-wifi-lora32-868 | ESP32 HELTEC LORA V2 | LORA communication 868Mhz using arduino-LoRA | - | - | - | X |
| heltec-wifi-lora32-915 | ESP32 HELTEC LORA V2 | LORA communication 915Mhz using arduino-LoRA | - | - | - | X |
| tinypico-ble | ESP32 TinyPICO | BLE Gateway | - | - | X | - |
| ttgo-lora32-v1-868 | ESP32 TTGO LORA V1 | LORA communication 868Mhz using arduino-LoRA | - | - | - | X |
| ttgo-lora32-v1-915 | ESP32 TTGO LORA V1 | LORA communication 915Mhz using arduino-LoRA | - | - | - | X |
| ttgo-tbeam | ESP32 TTGO T BEAM | BLE gateway with battery holder | - | - | X | - |
| esp32dev-ble-datatest | ESP32 dev board | Default BLE gateway with additional servicedata, manufacturerdata and service uuid for analysing decoding issues | - | - | X | - |
| ESP8266 | ||||||
| nodemcuv2-2g | ESP8266 board | SMS gateway, need A6/A7 GSM module | - | - | - | - |
| nodemcuv2-ble | ESP8266 board | BLE gateway, need HM10 Module | - | - | X | - |
| nodemcuv2-ir | ESP8266 board | Infrared gateway using IRremoteESP8266 | - | X | - | - |
| nodemcuv2-rf-cc1101 | ESP8266 board | RF gateway using RCSwitch library, need CC1101 | X | - | - | - |
| nodemcuv2-rf | ESP8266 board | RF gateway using RCSwitch library | X | - | - | - |
| nodemcuv2-rf2-cc1101 | ESP8266 board | KAKU RF gateway using NewRemoteSwitch library, need CC1101 | X | - | - | |
| nodemcuv2-rf2 | ESP8266 board | KAKU RF gateway using NewRemoteSwitch library | X | - | - | - |
| nodemcuv2-pilight | ESP8266 board | Gateway using ESPilight without the need of CC1101 | X | - | - | - |
| nodemcuv2-RS232 | ESP8266 board | RS232 gateway | - | - | - | - |
| nodemcuv2-somfy-cc1101 | ESP8266 board | Somfy RF gateway using Somfy Remote library, need CC1101 | X | - | - | - |
| nodemcuv2-weatherstation | ESP8266 board | RF gateway using WeatherStationDataRx library | X | - | - | - |
| rf-wifi-gateway | ESP8266 board | RF gateway for USB stick using RCSwitch library | X | - | - | - |
| rfbridge | ESP8255 board | RF gateway for the Sonoff RF Bridge relying on the internal decoder | X | - | - | - |
| sonoff-rfbridge-direct | ESP8255 board | RF gateway for the Sonoff RF Bridge requiring direct hack, relying on ESPilight library, tutorial | X | - | - | - |
| sonoff-basic | ESP8255 board | Wifi relay | - | - | - | - |
| sonoff-basic-rfr3 | ESP8255 board | Wifi relay and RF receiver using RCSwitch library, tutorial | Rec | - | - | - |