Konsep dasar
Bagian ini menjelaskan objek-objek yang akan Anda temui. Satu kali membaca sudah cukup untuk memahami sisa dokumentasi.
Objek utama
Section titled “Objek utama”| Objek | Fungsi | Contoh |
|---|---|---|
| Workspace | Batas data dan akses. Semua objek lain hidup di dalamnya. Punya route (slug unik) yang tidak bisa diubah. | gudang-nusantara |
| Member | User yang bergabung ke workspace dengan satu atau lebih role. | Andi (Admin), Sari (Operator) |
| Role | Kumpulan permission block (scope, objek, aksi, allow/deny). | Admin, Operator, Viewer, atau kustom |
| Channel | Saluran logis tempat pesan diterbitkan. Menjadi bagian topik MQTT. | telemetri-gudang |
| Device | Perangkat yang mengirim atau menerima pesan. Punya ID, device key, dan opsional Serial. | Sensor Ruang Beku A1 |
| Gateway | Device khusus yang mewakili banyak sensor di belakangnya. | Gateway Gedung A |
| Koneksi | Izin sebuah device untuk publish dan/atau subscribe ke sebuah channel. | A1 → telemetri-gudang (publish) |
| Group | Pengelompokan berhierarki untuk device dan channel, juga sarana pewarisan izin. | Gedung A → Lantai 1 |
| Rule | Alur pemrosesan pesan: input, logic, output. Satu-satunya jalan menyimpan pesan. | Simpan ke Internal DB |
| Alarm | Kejadian yang dihasilkan rule (atau device) untuk ditangani manusia. | Suhu masuk melewati batas |
| Dashboard | Halaman widget untuk memantau data. | Pemantauan Gudang |
| Report | Laporan CSV atau PDF dari data tersimpan, bisa terjadwal. | Laporan suhu mingguan |
Alur data
Section titled “Alur data”- Device menyambung ke broker dengan username = ID device dan password = device key, lalu publish ke topik
m/<workspace>/c/<channel>[/<subtopik>]. - Broker memeriksa apakah device boleh publish ke channel itu (koneksi harus ada). Bila tidak, koneksi diputus.
- Rule yang berlangganan channel itu (Channel Subscriber) menerima pesan, menjalankan logic, lalu menjalankan output.
- Output Internal DB menyimpan pesan ke database deret waktu. Dari sana pesan bisa dibaca di Messages, dashboard, laporan, dan API.
Topik MQTT
Section titled “Topik MQTT”m/<workspace>/c/<channel>[/<subtopik>]<workspace> dan <channel> boleh berupa route (mudah dibaca) atau UUID. Subtopik bebas dan hanya berfungsi sebagai label, misalnya nama lokasi. Siapa pengirimnya tidak ada di topik: broker mencatat device yang terautentikasi sebagai publisher, jadi tidak bisa dipalsukan lewat isi pesan. Detail ada di Menyambungkan perangkat (MQTT).
Format data
Section titled “Format data”| Format | Cocok untuk | Bisa diagregasi dan digrafikkan |
|---|---|---|
| SenML (RFC 8428) | Metrik dengan satuan, standar terbuka | Ya |
| SenFlat v1 dan v2 | Perangkat dengan memori kecil, gateway, riwayat | Ya |
| JSON bebas | Payload apa pun | Tidak (hanya dilihat dan difilter) |
Penjelasan lengkap: Format payload.
Model akses
Section titled “Model akses”- Aturan dasar deny by default: tanpa izin tertulis, akses ditolak.
denyselalu mengalahkanallow. - Anda tidak bisa memberi izin yang tidak Anda miliki (anti eskalasi).
- Workspace selalu punya minimal satu Admin aktif.
- Orang yang bukan anggota workspace menerima 404, bukan 403, sehingga keberadaan workspace tidak bocor.
Rincian: Anggota dan role dan Katalog izin.
Pemilik workspace dan kuota
Section titled “Pemilik workspace dan kuota”Pembuat sebuah workspace adalah pemiliknya. Pemilik berhak menghapus workspace, memindahkan kepemilikan, dan jumlah workspace, device, serta channel miliknya dibatasi oleh kuota yang ditetapkan administrator platform. Anggota lain yang membuat device di workspace tersebut memakai kuota pemilik.