Dokumentasi
Panduan Penggunaan
Semua yang perlu kamu tahu untuk mengkoneksikan, mengontrol,
dan mengembangkan OpenRelay — dari MQTT topics hingga akses dashboard.
Protokol MQTT
Topics & Pesan
OpenRelay menggunakan protokol MQTT standar, kompatibel dengan
Home Assistant, Node-RED, dan semua client MQTT lainnya.
home/relay/sensor/N/v
PUB
home/relay/relay/N/set
SUB
Koneksi Broker
Info Broker & Jaringan
OpenRelay menggunakan HiveMQ sebagai MQTT broker default.
Kamu bisa mengganti ke broker privat melalui konfigurasi firmware.
Broker Publik (Default)
Host
broker.hivemq.com
Port TCP
1883
WSS URL
wss://broker.hivemq.com
WSS Port
8884
WSS Path
/mqtt
Auth
Tidak Diperlukan
Status
Memeriksa...
Konfigurasi ESP32
MQTT Prefix
home/relay
Buffer Size
2048 bytes
Static mqttBuf
2560 bytes
AP SSID
ESP32-Relay
AP Password
relay1234
Hostname
relaycrtl
OTA Password
relay_ota
Contoh Payload
Format Pesan MQTT
Format JSON yang diterima dan dikirim OpenRelay.
Kompatibel dengan Home Assistant MQTT integration.
{
"relay": 3,
"on": true
}
{ "relay": 3, "pulse": 500 }
{ "relay": 3, "timer": 60 }
{
"relays": [
{
"id": 0,
"name": "Relay 0",
"on": false
}
],
"sensors": []
}
{
"pattern": {
"steps": [
{
"mask": 1,
"duration_ms": 500
}
],
"repeat": -1
}
}
"ON" // relay aktif
"OFF" // relay tidak aktif
// atau JSON:
{
"on": true,
"id": 3,
"name": "Relay 3"
}
Cara Akses
Mulai Sekarang
Tiga cara untuk mengakses dan mengontrol OpenRelay —
pilih yang paling sesuai dengan kebutuhanmu.
🌐
Remote Dashboard
Dashboard web siap pakai di GitHub Pages. Kontrol relay dari
browser menggunakan MQTT over WSS. Tidak butuh instalasi apapun.
relay-remote-web (GitHub Pages)
📟
Web UI Lokal
Akses dashboard langsung dari ESP32 melalui IP perangkat.
Tersimpan di LittleFS dan tersedia tanpa koneksi internet.
http://relaycrtl.local
📡
MQTT Direct
Gunakan client MQTT apapun — Home Assistant, Node-RED,
MQTT Explorer — dengan prefix home/relay.
broker.hivemq.com : 1883
WiFi Access Point untuk setup pertama — klik untuk menyalin: