Application Note. Anbindung von Kunden-Software an SpiderControl Web Visualisierung

Transkript

1 of 10 Application Note Anbindung von Kunden-Software an SpiderControl Web Visualisierung Connection of customer software to SpiderControl Web visualization Version Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 1 / 10

2 Inhalt 1. Grundsätzlicher Aufbau Zugriff über URL Klasse DataServer DLL Integration des Webservers in die Kundenapplikation... 9 Content 1. General composition Access via URL class DataServer DLL Integration of a web server into customer applications Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 2 / 10

3 1. Grundsätzlicher Aufbau Der MicroBrowser der XS-Serie ist in der Lage, Web-HMI s darzustellen, welche entweder mit dem SpiderControl HMI Editor, einem dazu kompatiblen OEM Produkt oder der CoDeSys Webvisu erstellt wurden. Alle diese Webvisualisierungen können normalerweise in einem Standardbrowser (z.b. als Java Applet) angezeigt werden. Der MicroBrowser ist eine in C implementierte Runtime, welche spezifisch diese Projekte auf demselben Weg anzeigen kann. Der SpiderControl HMI Editor ist ein rein grafisches Entwicklungswerkzeug, mit welchem man auf einfachste Weise interaktive Bedieneroberflächen zeichnen kann. Es stehen umfangreiche Funktioselemente wie Text-, Editfelder, DropDown Listen, Buttons, Grafikelemente (Raster und Vektorgrafik) sowie viele weitere Objekte zur Verfügung, welche auch das Design von komplexen Bedienerseiten ermöglichen. Dieser Editor erstellt eine HTML Seite sowie alle dazugehörigen Projektfiles, welche auf das Root-Verzeichnis des Webservers kopiert werden sollen. Dieser Webserver befindet sich in dem hier beschriebenen Fall auf dem PC, wo auch die SW des Kunden laufen soll. Auf der XS-Serie muss nun die IP Adresse des PC s sowie der Name der erzeugten HTML Seite angegeben werden, sodass sich dieses die Webvisualisierung laden und die Datenkommunikation mit dem Webserver aufnehmen kann. Die Datenkommunikation erfolgt dabei im Polling Betrieb, sodass der MicroBrowser automatisch immer den letzten Stand der Variablen anzeigen kann. Der Webserver ist dazu mit einem Datenserver verbunden, welcher als API über eine Funktion zum Lesen- bzw. Schreiben der Variablen verfügt. Die Variablen werden an dieser Schnittstelle über ihren symbolischen Variablennamen identifiziert, welcher auch bei der Projektierung des HMI s mit dem Grafikeditor verwendet wurde. HTML Pages Java Applets HTML Web-Server Data Web-Browser Your Application Data Server Action Embedded System TCP/IP Ethernet XS Panel Client PC, Web-Terminal Um eine Verbindung mit der eigenen Software des Kunden zu bekommen, gibt es nun verschiedene Möglichkeiten. Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 3 / 10

4 1. General composition The SpiderControl MicroBrowser is an application which is capable of displaying Web-HMI s which have been created using SpiderControl HMI editor, CoDeSys web visualization, or a compatible OEM product. In most cases, these web visualizations can be displayed using a standard web browser (e.g. as a Java applet). SpiderControl micro browser is a C based runtime, which is specifically designed to display visualization projects while minimizing other features that are not required for this task. SpiderControl HMI editor is a graphical development tool that allows the user to draw an interactive operating interface with minimal effort. It provides an extensive tool box, optical elements (both bit-mapped and vectorial), and a wide range of further objects which render it possible to design complex interface sites. The editor will generate both the HTML site and all associated project files. All of these need to be transfered to the web server s root directory. In this example, the web server is located on the same PC which will run the customer s application. To access this server, the XS device s network connection needs to be configured to use the IP address of this server. The name of the generated HTML site needs to be entered in the micro browser on the XS device to start communication with the server and load the visualization data. The micro browser is running in polling mode, therefore all variables are steadily updated. Data synchronisation between web server and web clients is done by the server, which, as an API, has a readwrite function that identifies the variables via the same symbolic name that is used in the HMI project of the editor. To finally connect to the third party / customer software, there are different options, as described in the following sections. Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 4 / 10

5 2. Zugriff über URL Klasse Es kann ein bestehender DataServer verwendet werden, welcher jede Variable, welche zum Lesen oder Schreiben angefragt wird, automatisch in einer internen verketteten Liste angelegt und mit dem Wert 0 inintialisiert wird. Diese Variablen sind für alle Clients als globale Variablen über Web-Services sichtbar. Der Kunde kann nun aus seiner Applikation heraus per http einen Webservice zum lesen/schreiben aufrufen, um so Daten mit dem MicroBrowser auszutauschen. Die Webservices heißen: RedaVal um variable Werte zu lesen WriteVal um variable Werte zu schreiben Die folgenden Befehle erfolgen durch die HTTP GET Anfrage: Beispiel-Rückmeldung (HTTP Kopfzeile nicht enthalten): 92 Diese beiden Befehle werden genutzt, um direkt eine ppo Variable zu lesen oder schreiben. In den meisten Entwicklungsumgebungen gibt es dafür vorgesehene Klassen, welche auf einfachste Weise so ein Kommando absetzen können. Dazu sind auf Anfrage Sourcecodebeispiele in Java oder C# verfügbar. Mit SpiderLinkDLL ist es möglich, diese Funktionen in einer C-Notation anzubieten und in Kundenprojekten einzubinden. Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 5 / 10

6 2. Access via URL class Given the case that an existing SpiderControl Web-server and an included DataServer is to be used, this server will automatically generate an internal database of all variables which are requested for read / write access. These variables will allow access for all external web-clients and will have an initial value 0. For data exchange between the customer s application and the micro browser, there are two web services: ReadVal for reading variable values WriteVal for writing variable values The following commands are sent using the HTTP GET request: Example reply (HTTP header not included): 92 These two commands are used to read or write directly a ppo variable. Most development environments provide pre-defined classes to allow easy implementation of these commands. Coding examples in Java or C# are provided on demand. With SpiderDLL, it is also possible to implement this function into the customer s application using C code. Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 6 / 10

7 3. DataServer DLL Eine weitere Integrationsmöglichkeit besteht darin, den DataServer als DLL in eine Kundenapplikation zu integrieren. Dieselbe DLL wird somit durch den Webserver als auch durch die Kundenapplikation verwendet. Der Kunde kann die Funktionen zum Lesen und Schreiben der Variablen auscodieren und von dort eigene Funktionen aufrufen. Er erhält den Variablennamen als String und muss durch einen geeigneten Compare die von ihm gewünschte Variable kopieren oder eine Funktion aufrufen. Der Vorteil dieser Variante gegenüber der ersten besteht primär darin, dass eine Interaktion (wie z.b. drücken einer Taste oder Eingabe eines Wertes) auf der XS-Serie direkt auf eine eigene Funktion abgebildet werden kann, während bei der erstgenannten Variante eine solche Interaktion durch Lesen der entsprechenden Variablen gepollt werden müsste. Diese DLL kann als VisualStudio Projekt im Source Code zur Verfügung gestellt werden. Die DLL ist in C/C++ implementiert. Das Grundprinzip für den Aufbau des DataServers ist in den folgenden beiden Funktionen ersichtlich: void DS_readVal(char *varname, char *value) { if (strcmp(varname, "version") == 0) sprintf(value, "%i", version); else if (strcmp(varname, "var1") == 0) sprintf(value, "%f", var1); else if (strcmp(varname, "text_1") == 0) sprintf(value, "%s", text_1); else sprintf(value, "Variable %s not found in Database.\n", varname); } void DS_writeVal(char *varname, char *value) { if (strcmp(varname, "version") == 0) sscanf(value, "%i", &version); else if (strcmp(varname, "var1") == 0) sscanf(value, "%f", &var1); else if (strcmp(varname, "text_1") == 0) sscanf(value, "%s", text_1); else sprintf(value, "Variable %s not found in Database.\n", varname); } Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 7 / 10

8 3. DataServer DLL Another option is to implement the DataServer into the customer s application as a DLL, so that both will access the same DLL. It is neccessary to code the variable calls within the customer s application to do this. All variable names are of string type. In order to use variables in functions, the variable values need to be copied to local variables within the customer s application using a suitable compare. The main benefit of this is that any user interaction at the XS panel locally calls a function, instead of polling the request due to the neccessity to read variables from the server first. The source code of this DLL can be provided as a VisualStudio project. It is implemented in C/C++. The basic principle of the DataServer s structure consists of the following read and write functions: void DS_readVal(char *varname, char *value) { if (strcmp(varname, "version") == 0) sprintf(value, "%i", version); else if (strcmp(varname, "var1") == 0) sprintf(value, "%f", var1); else if (strcmp(varname, "text_1") == 0) sprintf(value, "%s", text_1); else sprintf(value, "Variable %s not found in Database.\n", varname); } void DS_writeVal(char *varname, char *value) { if (strcmp(varname, "version") == 0) sscanf(value, "%i", &version); else if (strcmp(varname, "var1") == 0) sscanf(value, "%f", &var1); else if (strcmp(varname, "text_1") == 0) sscanf(value, "%s", text_1); else sprintf(value, "Variable %s not found in Database.\n", varname); } Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 8 / 10

9 4. Integration des Webservers in die Kundenapplikation Als dritte Variante kann der gesamte Webserver im Sourcecode in ein Projekt des Kunden integriert werden. Die Schnittstelle für die Variablen ist dabei dieselbe (DataServer) wie in Variante 2. Der Vorteil der dritten Lösung liegt darin, dass alle Komponenten in die Kundenapplikation integriert sind und somit eine monolithische, einfach zu verteilende Lösung entsteht. Der Webserver kann als VisualStudio Projekt im Source Code zur Verfügung gestellt werden. Der Webserver ist in C/C++ implementiert. Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 9 / 10

10 4. Integration of a web server into customer applications The third option to implement the web server is to compile it s source code directly within the customer s project. Interface for variable calls is again a DataServer, as described above. Choosing this method will result in the integration of all components into one monolithic application, making it easy to distribute to other devices. The source code of the web server can be provided as a VisualStudio project. It is implemented in C/C++. Anbindung Fremdsoftware an SpiderControl / Connection of customer software to SpiderControl 10 / 10