User Manual
awaBerry TypeScript API-Client
awaBerry Agentic API TypeScript-Client — Bibliotheksdokumentation, npm-Installationsanweisungen und typisierte Beispiele für die Geräteautomatisierung in...
awaBerry TypeScript API Client
Dieser Client ermöglicht Ihnen die Interaktion mit der awaBerry Agentic API von TypeScript aus. Nachfolgend finden Sie Voraussetzungen, Einrichtungsanweisungen und Anwendungsbeispiele.
Voraussetzungen
- Node.js installiert
- TypeScript installiert (
npm install -g typescript) - Axios-Bibliothek (
npm install axios)
Beispiele
- usageFullScenario.ts - Vollständige Szenarioimplementierung zur Eingabe von Befehlen und zum Abrufen von Ergebnissen von einem Gerät.
- usageWriteAFileToFolderAndReadBack.ts - Beispiel für Datei-Lese-/Schreibberechtigungen.
Zusätzliche Endpunkte
- /startDeviceConnectionWebsocket: Noch nicht im TypeScript-Client implementiert. Zur Verwendung fügen Sie eine Methode hinzu:
async function startDeviceConnectionWebsocket(sessionToken: string, deviceuuid: string): Promise<any> { ... }
Beispielanwendung:
const result = await startDeviceConnectionWebsocket(sessionToken, deviceuuid); console.log(result); - /getWebSocket: Noch nicht im TypeScript-Client implementiert. Zur Verwendung fügen Sie eine Methode hinzu:
async function getWebSocket(sessionToken: string, deviceuuid: string): Promise<WebSocket> { ... }
Beispielanwendung:
const ws = await getWebSocket(sessionToken, deviceuuid); ws.send("Ihre Nachricht"); ws.close();
Tests
Client-Code von GitHub herunterladen
Um die neuesten awaBerry API-Client-Implementierungen zu erhalten, befolgen Sie diese Schritte:
- Öffnen Sie ein Terminal in einem Ordner Ihrer Wahl.
- Führen Sie den folgenden Befehl aus, um das Repository zu klonen:
git clone https://github.com/awaberry/mcp_server_awaberry.git - Wechseln Sie in den Ordner
apiclients:
cd mcp_server_awaberry/apiclients
Dadurch erhalten Sie Zugriff auf alle Client-Implementierungen und Tests für Java, Python, TypeScript und Node.js.
Zurück zur Übersicht der API-Clients
