<< Click to Display Table of Contents >> Navigation: Arbeiten mit CanEasy > Automatisierung mit CanEasy > Webserver API |
Verwendung
Clients können direkt die REST-API nutzen oder den .NET Wrapper aus der Demonstrator Suite verwenden.
(Siehe "Examples\WebAPIClient")
Es handelt sich um ein C# .NET Core 6 Projekt. Um es auszuführen, muss mindestens das .Net Core SDK Version 6 installiert sein.
Um dieses Beispiel auszuführen, kann in der Konsole einfach "dotnet run" eingeben oder VS-Code verwendet werden.
Eine weitere Möglichkeit ist die Verwendung des COM-Server-Wrappers "Schleissheimer CanEasy WebServer Client".
Dieser vereinfacht den Zugriff auf auf die Rest-API und sollte z.B. aus VBA oder Python verwendet werden.
Funktionen
Funktion |
Beschreibung |
AddFileToDBFromClient |
Sendet eine Datenbasis-Datei (z.B. xml, dbc) vom Client-PC an den Server und lädt sie in den Arbeitsbereich. |
AddFileToDBFromServer |
Lädt eine Datei, die sich auf dem Server befindet. |
Connect |
URL und Port, die für die Verbindung mit dem Server verwendet werden. |
CreateMarker |
Fügt eine Markierung in die Aufzeichnung ein. |
Execute |
Führt eine Scheduler Tabelle aus oder sendet eine Botschaft/Service aus der Datenbasis. Erfordert den String-Referenz auf das Datenbasis-Element. |
IsSimulationRunning |
Gibt true zurück, wenn die Simulation läuft. |
LoadsWorkspaceFromClient |
Sendet einen Arbeitsbereich (csm-Datei) vom Client-PC an den Server und lädt diesen. |
LoadsWorkspaceFromServer |
Lädt einen Arbeitsbereich, der sich auf dem Server befindet. |
SaveRecordOnClient |
Speichert die komplette Aufzeichnung (celog-Datei) in einem Ordner auf dem Client-PC. |
SaveRecordOnServer |
Speichert die komplette Aufzeichnung (celog-Datei) in einem Ordner auf dem Server-PC. |
SimStart |
Startet die Simulation. |
SimStop |
Stoppt die Simulation. |
Value |
Erwartet eine String-Referenz auf ein Wertelement (wie ein Signal oder eine Umgebungsvariable) und gibt ein IValue-Objekt zurück, das das Setzen oder Lesen des Wertes ermöglicht. |
WorkspacePath |
Gibt den aktuellen Pfad zum Arbeitsbereich CanEasy zurück. |