Files
OpenMQTT-Gateway/docs/upload/troubleshoot.md
T
f5b33104ef [DOCS] Overhaul new-user onboarding, home page, and upload flow (#2347)
Getting started:
- New 15-minute Getting Started guide featuring the two most popular
  tracks (BLE on esp32dev-ble, RF on lilygo-rtl_433), with broker setup
  and a verification step
- Sidebar restructured around the new-user journey; upload options
  numbered by ease; Gitpod upload method removed

Home page:
- VitePress hero with clear actions, larger hero image
- How-it-works pipeline diagram shared as a component (responsive via
  container queries), use-case grid, bigger video tiles without the
  image lightbox, refreshed press coverage list, functions pills
- Support section pointing to Theengs Bridge and
  github.com/sponsors/1technophile

Upload flow:
- Decision-oriented upload landing page (journey strip, method cards,
  comparison table)
- Pre-flight checklist and driver troubleshooting on the web installer
- Guided environment picker (bridge + hardware wizard) replacing the
  filter chips, with manifest-verified recommendations
- Post-flash next-steps card linking to the portal and verification

Board images:
- custom_img key in environments.ini and board photos for all
  web-flashable environments (licenses recorded); private prod_env.ini
  environments excluded from boards-info.json

Corrections:
- RF frequency coverage stated as 433/315/868/915MHz
- Removed references to the retired compatible.openmqttgateway.com
  site (BLE list is decoder.theengs.io), the discontinued Theengs
  Plug, and the private sponsor forum


Claude-Session: https://claude.ai/code/session_01TYysQW8tpmt1dWWuzKhTLi

Co-authored-by: Florian <1technophile@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-08-03 10:23:43 -05:00

4.0 KiB

Troubleshooting

Compilation/build error

This badge Build Status show you the state of the compilation of the development branch, from which the releases are made. If you see a green badge this means that the code compilation is OK with the configuration given in the docs/platformio.ini. Check your environment, boards , libraries before submitting an issue or a question.

If you get one or several of the following errors:

error: 'WIFI_STA' was not declared in this scope

error: 'class WiFiClass' has no member named 'mode'

error: no matching function for call to 'WiFiClass::macAddress()

You have a conflict between Arduino default WiFi library and ESP32 one. So as to resolve this issue you should move or remove the Arduino WiFi library (Arduino Sketchbook folder\libraries\WiFi) in order to enable the IDE to take the one from ESP32 (Arduino Sketchbook folder\hardware\espressif\arduino-esp32\libraries\WiFi) More info on this topic

Not able to send or receive RF or IR

→ Verify your power supply voltage with a multimeter, it should be 5V (can be 12V for FS1000A emitter), please note that on NodeMCU V3 the Vin does not supply 5V contrary to NodeMCU V1

→ Verify your wiring

→ To eliminate issues of OpenMQTTGateway or you home controller try uploading basic examples from the libraries directly (like SendDemo for RF or IRSendDemo for IR) and execute them. If it doesn't work this means that you have mostly an issue related with your hardware or due to IDE/library version used.

Regarding the IR led emitter you can replace it with a normal led and see if it lights up when you send an MQTT command

→ If you are only unable to receive RF on nodemcu (or if it only works when a serial connection is active):

try with D2 instead of D3 and put #define RF_RECEIVER_GPIO 4 // D2 on nodemcu in config_rf.h instead of #define RF_RECEIVER_GPIO 0 // D3 on nodemcu

Repetitive MQTT disconnections or/and commands sent to the gateway not taken into account

Most probably a network issue, don't use a guest network and if going through a firewall check its rules. To put aside gateway issue, try to connect to a local broker on the same network.

OMG ignores messages sent to it via MQTT

This can happen if the messages are too big and exceed the internal buffer size limit. To fix this, check the size of the message you're sending (in bytes). Next, open User_config.h and set mqtt_max_payload_size to be greater than that size, e.g.: #define mqtt_max_payload_size 1024

ESP Continuous restart or strange behaviour:

This can be due to corruption of the ESP flash memory, try to erase flash and upload OMG on it again.

If you didn't find your answer here post a question to the forum: Community forum

ESP does not connect to broker with TLS enabled

If you get the following error: W: failed, ssl error code=54 ("Certificate is expired or not yet valid.")

This is most probable caused by the time of the esp is not correct/synchronized. The esp uses the Network Time Protocol (NTP) to get the current time from a time server. If you get this error ntp is not configured correctly in the gateway. Uncomment //# define NTP_SERVER "pool.ntp.org" to set the pool.ntp.org as the time server. You can also choose any other ntp time server you like.

It is normal that the time synchronization process takes some time and the MQTT connection will not be successful the first time. If you set the ntp server for the gateway and keep getting the errors you should check your certificate validity duration.