Dokumentation zur DFComDLL.dll 
(Vers. 04.01.01)

Inhalt:

1     Einleitung

Die DLL "DFComDLL.dll" stellt die grundlegenden Funktionen für die Kommunikation über RS232 bzw. RS485 sowie TCP / IP zur Verfügung. Sie wird ab Version 2.0.0 vom AESetup zu 100% verwendet. Die vorhandenen AEIII+ Techniken wurden auf die PZE Master IV Hardware übertragen, welche durch eine spezielle Initialisierungsroutine angesprochen werden kann.

1.1     Kanal und Busnummer ?

Multithreading ist auf einem Kanalobjekt nicht erlaubt. Pro Kanal nur ein Thread !!

Abbildung 1

Die Abb. 1 zeigt einen möglichen Hardwareaufbau mit Datafox - Geräten. Dieses Beispiel soll der Verdeutlichung der Begriffe Kanal und Busnummer dienen.  Die Kanalnummer (ChannelID) ist vergleichbar mit einem Straßennamen. Die Busnummer (DeviceID) ist vergleichbar mit der Hausnummer eines Gebäudes (wird im RS485-Netzwerk verwendet). Im abgebildeten Beispiel gibt es insgesamt drei Kanäle (ChannelIDs). 

Um Informationen an die Geräte zu schicken ist es notwendig, dass der jeweilige Kanal (ChannelID) zuvor geöffnet wurde. In Analogie zum Strassenbeispiel würde dies geöffneten Bahnschranken entsprechen. 

Es ist nicht notwendig jedes Mal den verwendeten Kanal (ChannelID) zu schließen, wenn die Kommunikation mit einem Gerät beendet wurde (eine Bahnschranke wird ebenfalls nicht nach jedem durchgefahrenen Auto geschlossen). Die Kommunikationskanäle können beim Start des Programms geöffnet werden (siehe 1.2 Programmaufbau). Ein Schließen der Kommunikationskanäle (ChannelIDs) ist normalerweise erst bei Programmbeendigung notwendig oder wenn es gewisse Situationen erfordern. 
Notwendig ist das Schließen eines Kanals nach der Kommunikationsunterbrechung bei TCP/IP -Verbindungen,  Modemverbindungen. 

1.1.1     Kanal

Die Kanalnummer (ChannelID) ist vergleichbar mit einem Strassennamen. Jedes Gerät gehört genau zu einem Kommunikationskanal. Die Anzahl der möglichen Kanäle ist auf maximal 250 festgelegt (erlaubter Wertebereich: 1-250). Pro Kanal ist eine Geräteanzahl (siehe Busnummer) von 1..n Einzelgeräten (Endgeräten) möglich. Die maximale Anzahl n  (max. sind 31 Geräte pro Kanal möglich) wird von dem gewählten Verbindungsschema (siehe Abb.1) bestimmt.      

Tabelle 1
Verbindungsschema	Verbindungsart	von - auf	max.  Anzahl  Geräte  pro  Kanal	zu verwendende  Busnummern  bei  Funktionsaufrufen
RS232 RS232	direkt	RS232-RS232	n = 1	immer mit 254 !!
RS232 RS485	über Umsetzer	RS232-RS485	n = 31	von 1 bis 31
TCP/IP TCP/IP	direkt	TCP/IP-TCP/IP	n = 1	immer mit 254 !!
TCP/IP RS485	über COM-Server	TCP/IP-RS485	n = 31	von 1 bis 31
TCP/IP RS232	über COM-Server	TCP/IP-RS232	n = 1	immer mit 254 !!

1.1.2     Busnummer

Die Busnummer (DeviceID) ist vergleichbar mit der Hausnummer eines Gebäudes. Diese Nummer wird zur Adressierung eines bestimmten Gerätes benötigt. In RS485 Netzwerken (Bussystemen) benötigt jedes Endgerät eine eindeutige Nummer. Diese Nummer (Busnummer) wird an jedem Gerät in dessen BIOS eingestellt. Die maximale Anzahl ist auf 31 Geräte begrenzt (erlaubte Busnummern: 1-31und 254*).

	Die Busnummer 254 hat eine besondere Bedeutung. Sie darf nicht in RS485 Netzwerken verwendet werden. Über diese Busnummer ist jedes Gerät im RS232 Modus ansprechbar. Wenn kein RS485 Bus angesprochen wird ist bei Funktionsaufrufen (wenn nötig) für die Busnummer (DeviceID) immer 254 anzugeben.

		Die Einstellung der Busnumme ist ab der Firmware Version 04.00.21 des PZE Masters IV nur noch möglich:
		wenn das Gerät mit der RS485 Option ausgestattet ist
		wenn im BIOS unter communication / interface die RS485 Kommunikation für das Gerät gewählt wurde
Wird  nicht die Kommunikationsart RS485 (ab der Firmware Version 04.00.21 des PZE Master IV) gewählt, ist die Busnummer des Gerätes automatisch 254.

1.2  Programmaufbau

Abbildung 2

Das nebenstehende Schema (Abb.2) zeigt eine mögliche Grundstruktur für ein Programm, für den in Abb.1 gezeigten Hardwareaufbau. Prinzipiell sollte ein Programmierprojekt wie im nebenstehenden Schema aufgebaut sein.  Nach dem Start des Programms werden alle benötigten Kanäle (ChannelIDs) initialisiert. Im Normalfall ist es völlig ausreichend wenn bei Beendigung des Programms die geöffneten Kanäle (ChannelIDs) geschlossen werden. Nach der Initialisierung der Kanäle können die Endgeräte beliebig oft angesprochen werden. Eine erneute Initialisierung wäre nur im Falle einer Kommunikations- unterbrechung notwendig. Hierzu ist der betroffene Kanal erst einmal explizit mit der Funktion DFComClose zu schließen. Erst nach dem Schließen des Kanals ist es zulässig mit einer Initialisierungsfunktion diesen wieder zu öffnen.   Mit der Funktion DFCGetComPort hat man zum Beispiel die Möglichkeit zu überprüfen ob eine bestimmte Kanalnummer (ChannelID) bereits geöffnet wurde (bzw. noch geöffnet ist).  Cpp Beispiel: Überprüfen ob der Kanal 2 geöffnet ist if ( DFCGetComPort( 2 )  != -1) {     printf ( "Kanal 2 bereits geöffnet.\n" );   }  else {     printf ( "Kanal 2 nicht geöffnet.\n" );    }

1.3     Versionsänderungen

1.4     Funktionsweise der DLL

Die DLL ist als Schnittstelle zwischen einer Anwendung und dem AEIII+ / PZE Master IV zu sehen. Alle Befehle werden von der Anwendung an die DLL gerichtet (AESetup ab Version 02.00.00), dort verarbeitet und gegebenenfalls an das anzusprechende Gerät weitergeleitet.

Behandlung von Datensätzen

Die Datensätze werden ab der Firmwareversion 03.01.20 beim AEIII+ sowie 04.00.21 beim PZE Master IV in der chronologischen Reihenfolge geliefert. Die Onlinedatensätze werden nicht mehr während dem abholen von offline Datensätzen zwischengeschoben.

Anmerkung zur Datensatz- und Listenbeschreibung (Tabellendefinitionen)

Bei offen gehaltenen Kanälen ist folgendes zusätzlich zu beachten.

• Prüfen ob alle anzusprechenden Geräte im Kanal einen Fehler bei "eigentlich" geöffnetem Kanal liefern.
• Die Verbindung des Kanals mit DFCComClose schließen.
• Neuverbindung durch DFCComOpenSerial, DFCComOpenSocket, DFCComOpenIV je nach Gerätetyp und Verbindungsart.

1.5     Allgemeine Hinweise

Der C-Compiler dekoriert die in den Funktionsprototypen angegebenen Namen. Vor den Namen wird das Zeichen "_" gesetzt und an den Namen wird die Anzahl der übergebenen Parameter in Längen - Byte durch "@" getrennt angehängt. Zusätzlich zum Funktionsprototyp werden daher auch die dekorierten Namen angegeben. Sie werden z.B. bei Verwendung von Visual Basic oder Delphi zum Import benötigt.

Beim Arbeiten mit der DLL ist es unter Umständen hilfreich, das Tool "Depends" oder "Dependency Walker" einzusetzen. So können alle in der DLL vorhandenen Funktionen und die erwarteten Parameterbytes angezeigt werden. Dieses Tool ist im Umfang von Visual Studio 6.0 enthalten. Dieser Export ist weiter unten bei jeder Funktion angegeben.

Die Datei DFComDll.lib muss in den Projekteinstellungen bei den Optionen "Link" in Visual C++ Projekten bei den Objekt / Bibliothek-Modulen eingetragen sein und beim Kompilieren des Projektes im Projektverzeichnis liegen (oder in dem in den Einstellungen eingestellten Pfad). Bei der Programmierung in C++ kann die Headerdatei aus dem Beispielcode verwendet werden. Auch für Visual Basic ist ein Modul mit den notwendigen Exportangaben vorhanden. 

1.5.1     Listen

Für die Listen ist in der DLL pro Kanal ein Puffer vorhanden. Mit der Funktion DFCClrListenBuffer wird der DLL - Puffer im entsprechenden Kanal gelöscht. Es ist nicht möglich einzelne Listen zu löschen. Es ist auch nicht möglich eine einzelne Liste "Nachzuladen".

Die Verarbeitung erfolgt in zwei Schritten. Zuerst wird der DLL interne Puffer durch einen Aufruf der Funktion DFCMakeListe für jede Liste mit Listendaten gefüllt. Danach werden die Listendaten durch Aufruf der Funktion DFCLoadListen in das Gerät übertragen. Zu beachten ist, dass alle im Setup definierten Listen nacheinander mit der Funktion DFCMakeListe in den Puffer der DLL übertragen werden. Durch Übertragung der Listendaten mit DFCLoadListen werden immer alle Listen auf einmal übertragen und alle alten Listen im Gerät automatisch gelöscht. 

Wenn eine Liste geändert werden soll, müssen alle Listen im Puffer gelöscht und neu erzeugt werden. Der DLL interne Puffer wird für jede "ComNum" getrennt geführt. Die Listendaten müssen daher auch für jede verwendete "ComNum" getrennt aufgebaut werden. 

Wenn an einer "ComNum" mehrere Geräte angeschlossen sind, die unterschiedliche Listen benötigen, müssen die Listendaten vor der Übertragung zu der entsprechenden Busnummer, deren Gerät eine unterschiedene Listenstruktur hat, neu in den Puffer der DLL geladen werden.

Ablauf des Listenladen:

• Alte Listen im Buffer mit "DFCClrListenBuffer" löschen.
• Neue Listen durch ein oder mehrfachen Aufruf von "DFCMakeListe" anlegen.
• Listen mit "DFCLoadListen" in das Gerät mit der entsprechenden Busnummer laden.

Testsoftware für die Listen liegt in folgenden Dateien bei: 

• "DllListenTest.exe" Einfaches Testprogramm um eine Liste in ein Gerät zu laden.
• "DllListenTest.ZIP" Quelldateien für das Testprogramm (Visual C++ 6.0). 
• "AepTSetup.aes" Setupdatei für das Testprogramm (muss vor dem Test in das Gerät geladen werden!).

Die Testliste besteht aus den 3 Namen: 
Mueller, Maier und Schmidt mit den Personalnummern: 101, 102 und 103.

1.5.2     Datentypen

Die Datentypen werden meist ohne Vorzeichenbehaftung genutzt ( unsigned ).
Es werden folgende Datentypen verwendet:

1.5.3     Fehler

Die meisten Funktionen bieten eine Fehlerauswertung über das Error Argument nach folgender Tabelle, nachdem sie mit einer "if (DFCxxx == 0)" Abfrage gescheitert sind. 
Folgende Fehler können im Error-Parameter auftreten:

1.5.4     Hintergrundloggen

In der DLL ist ein Logmechanismus für ein Hintergrundloggen eingebracht, welches alle Funktionsaufrufe in Dateien (Standard: YYYY_MM_DD_DFComDLL_channelID.log) die in einem angelegten Ordner (Standard: DFComLog) liegen schreibt. Dieses Hintergrundloggen ist Standardmäßig aktiviert und kann über die Initialisierungsdatei "DFCom.ini" gesteuert werden. Es werden die letzten fünf aufeinanderfolgenden Anwendungstage mitgeschnitten und die so gesammelten Daten umfassen im Mittel ein Datenvolumen von ca. 300MB.

Aufbau der Logeinträge

 Beispiel: DFCom031023.log

11:14:57	DFCComOpenSerial	1	COM1	38400	150	(1) [0.1]

Initialisierungsdatei

Bedeutung der Werte: 0=Aus, 1=An

 Beispiel:

[Log]
Enable=1
Path=.\
Folder=DFComLog
Erase=1
Elapse=0

1.5.1     Uhrzeit stellen

Die Uhr in den Terminals sollte regelmäßig gestellt werden, um Abweichungen zu vermeiden. Insbesondere, wenn mehrere 
Terminals verwendet werden.
Wir empfehlen die Uhr mindestens einmal pro Tag zu stellen. Der ideale Zeitpunkt dafür ist 4:00 Uhr, da hier dann bei Sommer-/Winterzeit gleich die Uhr richtig gestellt wird.
Das Terminal hat keine automatische Sommer-/Winterzeitumstellung. Hierfür ist die Anwendung verantwortlich. 
Es ist ggf. die automatische Sommer-/Winterzeitumstellung des Betriebssystems zu aktivieren.

Zum stellen der Uhr verwenden Sie die Funktion DFCComSetTime.

2.0     Exportierte Funktionen

Die nachfolgenden Funktionen werden von der DLL zur Verfügung gestellt.

2.1     Allgemeine Funktionen

Grundlegende Funktionen zum Verbindungsaufbau und Kommunikation sowie loggen des Verbindungsablaufs.

2.1.1.1     DFCComInit ( RS232 / RS 485 )

Ruft intern die Funktion DFCComOpenSerial auf.

Wird unterstützt ab Firmwareversion:

Deklaration: 

extern "C" __declspec(dllexport)
int __stdcall DFCComInit(int iChannelNum);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.1.2     DFCComOpenSerial ( RS232 / RS 485 )

Wird unterstützt ab Firmwareversion:

Deklaration: 

extern "C" __declspec(dllexport) 
int __stdcall DFCComOpenSerial(int iChannelNum, char *szComPort, 
int iBaudRate, int iTimeOut);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.1.3     DFCComOpen ( TCP/IP )

Ruft intern die Funktion DFCComOpenSocket auf.

Wird unterstützt ab Firmwareversion:

Deklaration: 

extern "C" __declspec(dllexport)
int __stdcall DFCComOpen(int iChannelNum, char *szHost);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.1.4     DFCComOpenSocket ( TCP/IP )

Wird unterstützt ab Firmwareversion:

Deklaration: 

extern "C" __declspec(dllexport) 
int __stdcall DFCComOpenSocket(int iChannelNum, char *szRemoteIP, 
int iPortNum, int iTimeOut);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.2     DFCComOpenIV ( RS232 / RS 485 / Funk( BIM2 ) / TCP-IP )

Achtung: 

Wird unterstützt ab Firmwareversion:

Deklaration: 

extern "C" __declspec(dllexport) 
int __stdcall DFCComOpenIV(int iChannelNum, int iBusNum, int iType, 
char *szComString, int iComValue, int iComTimeOut);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.3     DFCComClose

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCComClose(int iChannelNum);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.4.1     DFCCheckAE

Ruft intern die Funktion DFCCheckDevice auf.

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCCheckAE(int iChannelNum, int iBusNum);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.4.2     DFCCheckDevice

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCCheckDevice(int iChannelNum, int iBusNum, 
int *piError, int iDevicePollRetry);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.5     DFCComSetTime

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport) 
int __stdcall DFCComSetTime(int iChannelNum, int iBusNum, 
unsigned char *pucDateTime);

Parameter:

Rückgabewert: 

Beschreibung: 

 Beispiel:

// Die Schnittstelle zum Gerät muss natürlich geöffnet
// worden sein.
unsigned char Buffer[7];

Buffer[0] = 19;
Buffer[1] = 81;
Buffer[2] = 2;
Buffer[3] = 27; // 27.02.1981 Datum
Buffer[4] = 15;
Buffer[5] = 30;
Buffer[6] = 13; // 15:30:13 Uhrzeit

// Auf Fehler wird hier nicht geprüft !!! (siehe Rückgabewert)
// Senden des DatumUhrzeit - Array 
// über Kanal 1 an Gerät mit Busnummer 2
DFCComSetTime(1, 2, Buffer);

2.1.6     DFCComGetTime

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCComGetTime(int iChannelNum, int iBusNum, 
unsigned char *pucDateTime);

Parameter: 

Rückgabewert: 

Beschreibung: 

Beispiel:

// Die Schnittstelle zum Gerät muss natürlich geöffnet
// worden sein.
unsigned char Buffer[7];
Buffer[0] = 19;
Buffer[1] = 81;
Buffer[2] = 2;
Buffer[3] = 27; // 27.02.1981 Datum
Buffer[4] = 15;
Buffer[5] = 30;
Buffer[6] = 13; // 15:30:13 Uhrzeit

// Aktuelles Datum und Uhrzeit über Kanal 1 von Gerät
// mit Busnummer 2 ermitteln.
// Auf Fehler wird hier nicht geprüft !!! (siehe Rückgabewert)
DFCComGetTime(1, 2, Buffer); 

// Daten ausgeben. 
printf("Jahr: %02d%02d\n", Buffer[0], Buffer[1]);
printf("Monat: %02d\n",    Buffer[2]);
printf("Tag: %02d\n",      Buffer[3]);
printf("Stunde: %02d\n",   Buffer[4]);
printf("Minute: %02d\n",   Buffer[5]);
printf("Sekunde: %02d\n",  Buffer[6]); 

2.1.7     DFCComSendMessage

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCComSendMessage(int iChannelNum, int iBusNum,
unsigned char ucDelayTime, unsigned char ucAction,
unsigned char ucAudio, char *szMessage, int iLength);

Parameter:

Rückgabewert: 

Beschreibung: 

Beispiel:

char *Buffer = "HALLO DIES IST EIN TEST !";

DFCComSendMessage(1, 254, 255, 0, 2, Buffer, 26);

2.1.8     DFCComSendInfotext

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCComSendInfotext(int iChannelNum, int iBusNum,
char *szMessage, int iLength);

Parameter: 

Rückgabewert:

Beschreibung:

Beispiel:

char *Buffer = "HALLO DIES IST EIN TEST !";

DFCComInfotext(1, 254, Buffer, 26);

2.1.9     DFCGetSeriennummer

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetSeriennummer(int iChannelNum, int iBusNum,
int *piError, int *piSerialNum); 

Parameter:

Rückgabewert: 

Beschreibung: 

2.1.10.1     DFCLogOn

 Nicht weiter in Verwendung. 

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCLogOn(char *szFileName); 

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.10.2     DFCSetLogOn

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCSetLogOn(int iChannelNum); 

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.11.1     DFCLogOff

 Nicht weiter in Verwendung. 

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCLogOff(void);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.11.2     DFCSetLogOff

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCSetLogOff(int iChannelNum);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.12     DFCSetCallBack

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCSetCallBack(int iChannelNum, int (*CBFunction)());

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.13     DFCSetLogFileName

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCSetLogFileName(int iChannelNum, 
const unsigned char *szLogFileName);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.14     DFCGetErrorText

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
void __stdcall DFCGetErrorText(int iChannelNum, int iError, 
int iLanguage, char *szText, int iLength);

Parameter: 

Rückgabewert: 

Beschreibung: 

2.1.15     DFCSetGlobVar

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetGlobVar(int iChannelNum, int iBusNum,
unsigned char *pucVar, int iType, unsigned char *pucValue, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.1.16     DFCGetGlobVar

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetGlobVar(int iChannelNum, int iBusNum,
unsigned char *pucVar, int iType, unsigned char *pucValue, 
int iValueLength, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.1.17     DFCCloseRelay

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCCloseRelay(int iChannelNum, int iBusNum, int iNum, 
int iTime, int *piError); 

Parameter:

Rückgabewert: 

Beschreibung:

2.1.18     DFCGetRelayState

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetRelayState(int iChannelNum, int iBusNum, int iNum, 
int *piState, int *piTime, int *piError); 

Parameter:

Rückgabewert: 

Beschreibung:

2.1.19     DFCOpenRelay

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCOpenRelay(int iChannelNum, int iBusNum, int iNum,
int *piError);

Parameter:

Rückgabewert: 

Beschreibung:

2.1.20     DFCGetDevicePollRetry

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetDevicePollRetry(int iChannelNum);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.21     DFCGetComPort

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
HANDLE __stdcall DFCGetComPort(int iChannelNum);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.22     DFCSetComPort

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetComPort(int iChannelNum, HANDLE hComPort, 
int iType, int iComValue, int iTimeOut);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.23     DFCWrite

Achtung: 

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCWrite(int iChannelNum, char *pBuf, int iLength,
int *piWriteLength, int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.24     DFCRead

Achtung: 

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCRead(int iChannelNum, char *pBuf, int iLength,
int *piReadLength, int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

Hinweis:

Es ist wichtig, nicht nur den Rückgabeparameter auf seinen Wert zu überprüfen. Ob ein Fehler vorlag ist nur in Verbindung mit dem zurückgelieferten Error-Code möglich. Handelt es sich um eine serielle Verbindung und es waren keine Daten zum lesen verfügbar wird von der Funktion ein Returnwert von 1 zurückgegeben. Bei einer TCP/IP Verbindung wird allerdings ein Returnwert von 0 zurückgeliefert, wenn es keine Daten zu lesen gab. Es empfiehlt sich für eine Fehlerbehandlung dieser Funktion grundsätzlich den Errorcode zu verwenden (ist dieser ≠0 lag ein Fehler vor).  Verbindung Returnwert ReadLength Error Status  Beschreibung seriell =1 =0 =0 Ok es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war jedoch 0 seriell =1 >0 =0 OK es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war >=1 TCP/IP =0 =0 =0 Ok es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war jedoch 0 TCP/IP =1 >0 =0 Ok es wurde erfolgreich gelesen, die Anzahl der gelesenen Zeichen war >=1 seriell TCP/IP =0 >=0 ≠0 Error es wurde nicht erfolgreich gelesen, in ReadLength steht die Anzahl und in Buf die Zeichen die bis zum Auftreten des Fehlers gelesen  werden konnten. !! Wichtig: Die entsprechenden Funktionen der DLL für den Timeboy, haben genau das entgegengesetzte Verhalten wenn es keine Daten zu lesen gab!

2.1.25     DFCUpload

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCUpload(int iChannelNum, int iBusNum, char *szFileName,
int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.26     DFCGetVersionFirmware

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetVersionFirmware(int iChannelNum, int iBusNum,
char *szVersion, int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.27     DFCGetVersionFirmwareFromFile

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetVersionFirmwareFromFile(int iChannelNum, 
char *szFileName,char *szVersion, int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

2.2     Funktionen für Setup

Konfigurationsdaten mit dem Gerät abgleichen.

2.2.1     DFCSetupLaden

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetupLaden(int iChannelNum, int iBusNum,
char *szFileName, int *piError);

Parameter: 

Rückgabewert:

Beschreibung: 

2.2.2     DFCDownload

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCDownload(int iChannelNum, int iBusNum,
char *szFileName, int *piError);

Parameter: 

Rückgabewert:

Beschreibung: 

2.3     Funktionen für Daten

Sammeln der anfallenden Daten aus den Geräten und Interpretieren der gelieferten Informationen durch Abgleich mit Gerätekonfiguration.

2.3.1     DFCComClearData

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCComClearData(int iChannelNum, int iBusNum); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.2     DFCComCollectData

Ruft intern die Funktion DFCReadRecord auf.

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCComCollectData(int iChannelNum, int iBusNum, 
int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.3.3     DFCComGetDatensatz

Ruft intern die Funktionen DFCQuitRecord, DFCReadRecord auf.

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCComGetDatensatz(int iChannelNum, unsigned char *pucBuf,
int *piLength, int *piError); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.4     DFCLoadDatensatzbeschreibung

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCLoadDatensatzbeschreibung(int iChannelNum, int iBusNum,
int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.3.5     DFCDatBCnt

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCDatBCnt(int iChannelNum); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.6     DFCDatBDatensatz

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCDatBDatensatz(int iChannelNum,
int iDataNum, unsigned char *szName, int *piFieldCount);

Parameter:

Rückgabewert:

Beschreibung:

2.3.7     DFCDatBFeld

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCDatBFeld(int iChannelNum, int iDataNum,
int iField, unsigned char *szName, int *piType, int *piLength);

Parameter:

Rückgabewert:

Beschreibung:

2.3.8     DFCReadRecord

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCReadRecord(int channelID, int deviceID, 
char *buf, int *length, int *err);

Parameter:

Rückgabewert:

Beschreibung:

2.3.9     DFCQuitRecord

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCQuitRecord(int channelID, int deviceID, int *err);

Parameter:

Rückgabewert:

Beschreibung:

2.4     Funktionen für Listen

Aufbereiten von Listendaten und laden dieser in die Geräte.

2.4.1     DFCMakeListe

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCMakeListe(
int iChannelNum, int iListNum, int iLineCount, int iListSize, 
unsigned char *pucBuf, int iListMemSizeNum);

Parameter:

Rückgabewert:

Beschreibung:

2.4.2     DFCLoadListen

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCLoadListen(int iChannelNum, int iBusNum, 
int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.4.3     DFCClrListenBuffer

Wird unterstützt ab Firmwareversion:

Deklaration:

Parameter:

Rückgabewert:

Beschreibung:

2.4.4     DFCLoadListenbeschreibung

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCLoadListenbeschreibung(int iChannelNum, int iBusNum,
int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.4.5     DFCListBCnt

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCListBCnt(int iChannelNum);

Parameter:

Rückgabewert:

Beschreibung:

2.4.6     DFCListBDatensatz

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCListBDatensatz(int iChannelNum, int iDataNum,
unsigned char *szName, int *piFieldCount, int *piVar);

Parameter:

Rückgabewert:

Beschreibung:

2.4.7     DFCListBFeld

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCListBFeld(int iChannelNum, int iDataNum, 
int iField, unsigned char *szName, int *piType, int *piLength);

Parameter: 

Rückgabewert: 

Beschreibung:

2.5     Funktionen für Zutrittskontrolllisten (Version 1)

Aufbereiten und laden von Listendaten für die Zutrittskontrolle.

2.5.1     DFCMakeEntranceList

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCMakeEntranceList(
int iChannelNum, int iListNum, int iLineCount, int iListSize, 
unsigned char *pucBuf, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.5.2     DFCLoadEntranceList

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCLoadEntranceList(int iChannelNum, int iBusNum, 
int iListNum, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.5.3     DFCClearEntranceListBuffer

Wird unterstützt ab Firmwareversion:

Deklaration:

Parameter:

Rückgabewert:

Beschreibung:

2.6     Funktionen für Zutrittskontrolllisten (Version 2)

Aufbereiten und laden von Listendaten für die Zutrittskontrolle.

2.6.1     DFCMakeEntrance2List

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCMakeEntrance2List(
int iChannelNum, int iListNum, int iLineCount, int iListSize, 
unsigned char *pucBuf, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.6.2     DFCLoadEntrance2List

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCLoadEntrance2List(int iChannelNum, int iBusNum, 
int iListNum, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.6.3     DFCClearEntrance2ListBuffer

Wird unterstützt ab Firmwareversion:

Deklaration:

Parameter:

Rückgabewert:

Beschreibung:

3. Datenstruktur

Die verwendeten Datenstrukturen werden nachfolgend erklärt.

3.1     Aufbau der Datensätze im ByteArray

Es wird in jedem Datensatz die zugehörige Datensatzbeschreibung aus dem Setup mitgeführt.
Ein an die Anwendung überlieferter Datensatz sieht immer wie folgt aus:

Es werden immer alle Felder eines Datensatzes aufeinanderfolgend und in der im Setup definierten Feldbreite (eventuell plus einem Terminierungszeichen) geliefert. 
Bitte beachten Sie, dass alle als ASCII - Feld definierten Felder ein zusätzliches Terminierungszeichen erhalten, wodurch ein im Setup mit einem Byte definiertes Feld in den "Daten des Datensatzes" zwei Byte umfasst!

Mit Hilfe der Auswertefunktionen für die Datensatzbeschreibungen und Listenbeschreibungen können Sie die "Daten des Datensatzes" interpretieren. Das Terminierungszeichen ist in der Angabe zur Feldbreite des  jeweiligen Datensatzfeldes enthalten.

3.2 Datum und Uhrzeit im ByteArray

Das Datum - Uhrzeit Feld in einem Datensatz sieht wie folgt aus: