Darstellung
Entwickler
Eigene Software an den nomos system Controller anbinden
Dieses Handbuch zeigt, wie Sie eigene Software an den nomos system Controller anbinden: wie Sie sich verbinden und anmelden, wie Sie Werte lesen und Geräte schalten und wie die Daten aufgebaut sind. Alle Beispiele wurden an einem echten Controller ausgeführt.
Die vollständige Referenz jedes Aufrufs, jedes Events und jedes Feldes steht auf apidocs.nomos-system.com (Englisch). Dieses Handbuch erklärt die Zusammenhänge und verlinkt für Einzelheiten dorthin.
Welche Schnittstelle wofür
| Sie möchten … | Schnittstelle | Mehr dazu |
|---|---|---|
| dauerhaft verbunden sein, Geräte schalten und Änderungen sofort mitbekommen | Socket.io | Verbinden und Anmelden, Erste Schritte |
| einzelne Aufrufe aus einem Skript oder einem System ohne Socket.io absetzen | HTTP | HTTP-API |
| Werte mit einem System austauschen, das MQTT spricht | MQTT | MQTT |
| bei jeder Änderung eines Werts eine eigene Adresse aufrufen lassen | Webhook | Webhooks |
| einen KI-Assistenten auf den Controller zugreifen lassen | MCP | MCP |
| Abläufe grafisch auf dem Controller bauen | Node-RED | Node-RED |
Socket.io und HTTP bieten dieselben Aufrufe. Der Unterschied: Über Socket.io meldet der Controller Änderungen von sich aus, über HTTP antwortet er nur auf Anfragen.
Bevor Sie beginnen
- Ihr Programm erreicht den Controller im lokalen Netz. Die Adresse finden Sie in der Konfigurationsoberfläche oder in Ihrem Router.
- Legen Sie für Ihre Anbindung einen eigenen Benutzer an, mit nur den Rechten, die sie braucht. Warum, steht unter Rechte.
- Für die JavaScript-Beispiele brauchen Sie Node.js 18 oder neuer, für die HTTP-Beispiele curl.
Inhalt
- Verbinden und Anmelden: Adressen und Ports, Ablauf der Anmeldung, Sitzungen, HTTPS, Rechte, Sperre nach Fehlversuchen, Fernzugriff
- Erste Schritte: ein vollständiges Beispiel in JavaScript und mit curl
- Datenmodell: Komponenten, Properties und Werte, Räume, Bereiche, Szenen, Variablen
- HTTP-API: Aufrufe, Anmeldung, Antworten und Fehlercodes
- MQTT: Topics, Werte mitlesen und setzen, Szenen ausführen, Sicherheit
- Webhooks: eine eigene Adresse bei Wertänderungen aufrufen lassen
- MCP: der MCP-Endpunkt, Rechte der Tokens, Clients und die nomos MCP Bridge
- Node-RED: das Plugin, seine Nodes, gesperrte Funktionen, ein Beispiel-Flow
- Änderungen und Kompatibilität: was sich seit Version 2.8 für Integrationen geändert hat
Weitere Quellen
- API-Referenz mit allen Aufrufen und Events
- Node-RED Plugin auf GitHub
- Integratoren-Handbuch für alles, was in der Konfigurationsoberfläche eingestellt wird