Dokumentation zur DFComDLL.dll / DFCom_x64.dll 
(Vers. 04.02.02)

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 DatafoxStudioIV / AESetup zu 100% verwendet. Die vorhandenen AEIII+ Techniken wurden auf die MasterIV Hardware übertragen, welche durch eine spezielle Initialisierungsroutine angesprochen werden kann.

Datafox StudioIV - Setupprogramm Einstellung des Gerätes für die Datenerfassung. Kommunikations-DLL Per DLL ist eine direkte Kommunikation zwischen Gerät und Anwendungssoftware möglich. Dies ist damit die beste Art der Anbindung für Softwarehersteller (OEMs). Die Kommunikation über die DLL ist bidirektional und kann sowohl online als auch offline erfolgen. HTTP In diesem Modus sendet das Terminal die Datensätze direkt an einen Webserver. Datafox stellt Ihnen ein PHP-Muster-Script zur Datenentgegennahme und Quittierung bereit. Siehe Produkt-DVD. Datafox-Talk Schnittstellenprogramm zum Datenaustausch über Dateien oder Datenbank. Diese Lösung ist ideal für Endkunden oder Händler, die Datafox-Produkte an z.B. Warenwirtschaft, ERP, ... anbinden wollen.

Abbildung: Einbindungsmethoden zur Datenübertragung MasterIV-Serie

1.1     Was sind Kanalnummer 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 (ChannelID's).

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 Exemplarischer 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     Was ist die Kanalnummer (channelID)?

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     Was ist die Busnummer (deviceID)?

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-31 und 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 Busnummer ist ab der Firmware Version 04.00.21 des PZE-MastersIV 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-MasterIV) gewählt, ist die Busnummer des Gerätes automatisch 254.

1.2  Exemplarischer 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 die Schnittstelle zwischen einer Softwareanwendung und den AEIII+ / MasterIV - Geräten. Alle die Geräte betreffenden Aufgaben werden von der Softwareanwendung an die DLL übergeben, dort verarbeitet und gegebenenfalls an das anzusprechende Gerät weitergeleitet.

Behandlung von Datensätzen

Um Datensätze aus den Geräten zu lesen muss zuerst die jeweilige Kommunikationsschnittstelle mit einer der Funktionen DFCComOpenSerial, DFCComOpenSocket (AEIII+) oder DFCComOpenIV (MasterIV) erfolgreich initialisiert werden.

verwendende Technik bei AEIII+
Danach wird mit der Methode DFCComCollectData das Gerät mit der angegebenen Busnummer bekannt gegeben und der erste Datensatz (oder alle Daten, je nach Firmwareversion) aus dem Gerät gelesen. Die Funktion DFCComGetDatensatz bestätigt diesen zuvor durch DFCComCollectData ausgelesenen Datensatz, übergibt die Daten in den zur verfügung zu stellenden Datenpuffer und liest den ggf. nächsten Datensatz aus dem Gerätespeicher aus. Dieser wird dann bei dem nächsten Aufruf von DFCComGetDatensatz quittiert und in den Datenpuffer übergeben. Auf diese Weise werden durch folgeaufrufe der Funktion DFCComGetDatensatz einzelne Datensätze aus dem Gerät an die Anwendung übergeben.

Zu verwendende Technik bei MasterIV
Danach wird mit der Methode DFCReadRecord das Gerät angesprochen und der erste Datensatz aus dem Gerät gelesen. Nach erfolgreicher Verarbeitung des Datensatzes durch Ihre Anwendung muss mit der Funktion DFCQuitRecord der zuvor gelesenen Datensatz quittiert werden. Erst nach erfolgreicher Ausführung der quittierung wird durch die Firmware auf den nächsten Datensatz gewechselt. Durch erneuten Aufruf der Funktion bestätigt diesen zuvor durch DFCComCollectData ausgelesenen Datensatz, übergibt die Daten in den zur verfügung zu stellenden Datenpuffer und liest den ggf. nächsten Datensatz aus dem Gerätespeicher aus. Dieser wird dann bei dem nächsten Aufruf von DFCComGetDatensatz quittiert und in den Datenpuffer übergeben. Auf diese Weise werden durch folgeaufrufe der Funktion DFCComGetDatensatz einzelne Datensätze aus dem Gerät an die Anwendung übergeben.

Die Datensätze werden ab der Firmwareversion 03.01.20 beim AEIII+ sowie 04.00.21 beim PZE-MasterIV in der chronologischen Reihenfolge geliefert.

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 durchführen.

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 des Setups

Speicherverwaltung der Listen

Jeder Kanal verwaltet seinen eigenen Speicher für die 20 möglichen Listen. Für jede zu importierende Liste wird entsprechend ihrer Größe ein dynamischer Speicher reserviert. Mit der Funktion DFCClrListenBuffer werden alle reservierten Speicher im entsprechenden Kanal freigegeben.

Achtung: 

Übertragen von Listen

Die Verarbeitung erfolgt in zwei Schritten. Zuerst wird der DLL interne Speicher 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 Speicher der DLL übertragen werden. Durch Aufruf der Funktion DFCLoadListen werden dann alle zuvor importieren Listen auf einmal übertragen und alle entsprechend alten Listen im Gerät automatisch gelöscht.

Achtung: 

Übertragen einzelner Listen

Um eine einzelne Liste zu übertragen importieren Sie diese mit DFCMakeListe und übertragen sie dann mit DFCLoadListen. Die Funktion DFCLoadListen überträgt immer alle zuvor importierten Listen, egal ob eine oder mehrere.

Achtung: 

Achtung: 

Löschen von Listen

Es ist nicht möglich einzelne Listen komplett zu entfernen. Dies geschieht lediglich nach Übertragung einer Setupdatei. Durch Aufruf der Funktion DFCMakeListe mit der Datensatzanzahl 0 wird die Liste in der DLL als Leere Liste importiert und durch Aufruf der Funktion DFCLoadListen wird diese dann übertragen.

Beschreibung der Übernahme von Listen

Beschreibung wie die Listenübernahme der Firmware arbeitet. Die Listenübernahme des Setups ist je nach gewähltem Betriebsmodus "Normal, MDE" oder "PZE Modus 1, 2" leicht verschieden.

Listen für Betriebsmodus "Normal, MDE"

Nach übertragen einer oder mehrerer Listen, werden diese in folgenden Situationen übernommen:

• Ein begonnener Menüeintrag (ob im Hauptmenü oder Untermenü) wird abgeschlossen,
• Das Gerät befindet sich im Menü (ob im Hauptmenü oder Untermenü) selbst.

Listen für den Betriebsmodus "PZE Modus 1, 2"

Zusätzlich zu den Situationen des Betriebsmodus "Normal, MDE", die hier auch gelten, kommt noch der einstellbare Tastentimeout dazu. Erfolgt keine Bedienung des Geräts für den eingestellten Tastentimeout, durchläuft das Gerät zwangsläufig das Hauptmenü und die Listendaten werden dadurch übernommen.

Listen für die Zutrittskontrolle

Nach übertragen einer oder mehrerer Zutrittslisten wird die Zutrittskontrolle gestoppt und die Listendaten in das System übernommen. Danach nimmt die Zutrittskontrolle ihren Betrieb wieder auf.

Listen für Timeboys

Nach übertragen einer oder mehrerer Listen für Timeboys, werden diese sofort übernommen, sofern nicht gerade eine Übertragung der bereits vorliegenden Listen in einen Timeboy aktiv ist. Dann wird die aktuelle Übertragung zuerst abgeschlossen bevor die neuen Listendaten übernommen werden.

Beim AEIII+ sowie MasterIV Firmwareversionen < 04.01.00

Hier müssen immer alle definierten Listen des Setups importiert und übertragen 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: 

• "DllTest.exe" Einfaches Testprogramm um eine Liste in ein Gerät zu laden.
• "DllTestSource.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: 2007_02_05_DFComDLL_1.log

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

Initialisierungsdatei

Bedeutung der Schlüsselwerte in der Sektion Log:

• Enable: Aktivieren des Hintergrundloggens. Wertebereich 0 = Nicht loggen, 1 = Loggen aktiviert.
• Path: Gibt das Basisverzeichnis an. Bei Verwendung von Backslash-Zeichen \ müssen diese doppelt eingegeben werden.
• Folder: Das zu verwendende Unterverzeichnis, dieses wird wenn nicht bereits vorhanden angelegt.
• Trace: Gibt an ob das DLL eigene Detaillog aktiviert sein soll. Wertebereich ist 1 = Ja aktivieren, 0 = Nein.
  Bitte beachten Sie, dass hierbei größere Datenmengen anfallen.
• Erase: Gibt an ob die Logdateien automatisch gelöscht werden. Wertebreich ist 1 = Ja automatisch löschen, 0 = Nein manuell löschen. Bitte beachten Sie dass die Dateiverwaltung nach Abschalten übernommen werden muss.
• Keep: Gibt bei Aktivierung von Erase die Anzahl zu haltender Logtage an. Wertebereich ist 1 - 100 Logtage. Logtage bedeutet hier, Tage an denen geloggt wurde.
• Elapse: Gibt an ob die Ausführungsdauer der jeweiligen Funktion in eckigen Klammern hinter jedem Logeintrag ausgegeben wird, dabei hat dieser folgende Aufteilung [Sekunden.Hundertstel].
• List: Gibt an ob die übertragenen Listendaten vor jedem Übertragen, in das Logverzeichnis exportiert werden. Die Dateinamen setzen sich aus dem Zeitstempel der Übertragung, der Kanalnummer, einem Kürzel 'L', 'E' oder Ziffer und ggf. dem Listenindex bzw. Listennamen zusammen. Wertebereich ist 0 = Keine Listendaten loggen, 1 = Listen als Binärdateien loggen, 2 = Listen als Binär- und Testdateien loggen.
  Beachten Sie dass Listen immer als Binärdateien mitgeloggt werden.

 Beispiel:

[Log]
Enable=1
Path=.\
Folder=DFComLog
Trace=0
Erase=1
Keep=10
Elapse=1
List=1

1.5.5     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.
Die Firmwareversionen unter 04.00.23 haben 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.

1.5.6     Timeboylisten übertragen

 Achtung: 

GroupID

Ist eine im Timeboy hinterlegte Nummer. Standardmäßig ist diese 0 und kann über das TbSetup gesetzt werden. Timeboys können über diese Nummer in Gruppen eingeteilt werden und über die DLL-Funktionen mit separaten Listen Versorgt werden.
Beispiel zur Erklärung:
Problem: Sie haben drei Timeboys mit dem gleichen Setup im Einsatz, möchten aber auf jedem Timeboy eine eigene Auftragsliste aufspielen.
Lösung: Sie Vergeben jedem Timeboy eine eigene GroupID und übertragen die Listen, die für alle Geräte gültig sind mit der GroupID 0 und die jeweilige Auftragsliste mit derren GroupID.

1.5.7     Übertragen von Gerätedateien (DFCUpload)

 Beim PZE-MasterIV zu beachten 

Um ein Update von einer Firmwareversion kleiner 04.00.23.769 auf eine Version >= 04.01.xx durchzuführen, muß zuvor eine Version der Reihe 04.00 >= 04.00.769 eingespielt werden. Ein Downgrade von der Versionsreihe 04.01 oder höher, auf die Versionsreihe 04.00, ist aufgrund einer möglichen Inkompatibilität zur eingesetzten Hardware, vorher zu prüfen und ggf. zu vermeiden.

Das Aufspielen einer Firmwareversion der Reihe 04.00 darf nur auf PZE-MasterIV mit einer Revision 2.0 geschehen. Die Revision können sie dem Typenschild entnehmen, dabei fehlt die Revisionsangabe hinter der Gerätebezeichnung, wenn sie 2.0 ist. Im Beispiel links ist die Revision rot umrahmt.

 Beim Update über Gerätedateiarchiv (*.dfz) ist folgendes zu beachten. 

 Allgemeine Hinweise zu allen MasterIV-Geräten 

 Bekannte Probleme und deren Fehlerbehebung 

1.5.8     IP-Adresse und Hostname

Angabe einer IP-Adresse in Punktnotation:

IP-Adresse	Beschreibung
"4.3.2.16"	Dezimale Angabe
"004.003.002.020"	Oktale Angabe
"0x4.0x3.0x2.0x10"	Hexadezimale Angabe
"4.003.002.0x10"	Mix

Bitte beachten Sie, dass vornullen zur Oktalen Angabe führen!!

Die Angabe von Hostnamen. Z. B.: www.datafox.de

1.6     Aktive Verbindung

1.6.1     Einleitung

Im nachfolgenden Dokument wird kurz Erläutert wie das Konzept der "Aktiven Verbindung" funktioniert und eingesetzt werden kann. Es bezieht sich auf die Version 4.1.5 der Firmware, DFComDLL und DatafoxStudioIV.

1.6.2     Grober Überblick

Bei der "Aktiven Verbindung" bauen die Geräte eine Verbindung zur DLL auf. Diese Verbindung bleibt über die gesamte Laufzeit bestehen und wird durch Alive-Pings sichergestellt. Das Bedeutet, dass bei einem Verbindungsabriss oder einer Verbindungsunterbrechung die Geräte selbstständig eine Neuverbindung unternehmen.

Jede bestehende "Aktive Verbindung" hat eine eindeutige Kanalnummer die über die entsprechenden DLL Funktionen abgerufen werden können. Unter Verwendung dieser Kanalnummer kann jede DLL Funktion wie gewohnt ausgeführt werden. Die Busnummer ist in diesem Fall immer 254.

Zusätzlich zur "Aktiven Verbindung" kann eine "Aktive Datensatzmeldung" konfiguriert werden. Dabei melden die Geräte der DLL ob Datensätze vorliegen.

1.6.3     Kurze Gegenüberstellung der Befehlsausführung ohne und mit "Aktiver Verbindung"

DLL ohne "Aktive Verbindung"

1. DFCComOpenIV für den Verbindungsaufbau aufrufen
2. Gewünschten Befehl ausführen. Z.B. DFCGetSeriennummer
3. DFCComClose für den Verbindungsabbau aufrufen

1. DFCGetFirstActiveChannelID, DFCGetNextActiveChannelID, DFCGetInfoActiveChannel für die Geräteermittlung aufrufen.
2. Gewünschten Befehl ausführen. Z. B. DFCGetSeriennummer

1.6.4     Starten Stoppen und Initialisieren der "Aktiven Verbindung"

Über die DLL Funktion DFCStartActiveConnection starten Sie das DLL - Modul für die "Aktive Verbindung". Dabei wird von der DLL ein Listen-Socket erstellt, an den die Geräte dann eine Verbindungsanfrage stellen können. Mit DFCStopActiveConnection beenden Sie das DLL - Modul für die Aktive Verbindung, dabei werden alle bestehenden Verbindungen getrennt.

Im Gerät geschieht die Aktivierung / Deaktivierung durch die Systemvariable COM.ACTIVE.

Die im Gerät zu hinterlegenden Verbindungsdaten können über Systemvariablen eingestellt werden. Eine Liste aller benötigten Systemvariablen für den Präfix COM finden Sie im Kapitel 4.7.

Systemvariablen können mit den DLL Funktionen DFCSetGlobVar, DFCGetGlobVar gesetzt bzw. gelesen werden.

Die Systemvariablen für Präfix COM, können über das DatafoxStudioIV eingestellt werden. Bitte beachten Sie den hierfür zuständigen Dialog unter "Kommunikation -> Aktive Verbindung - Konfiguration".

1.6.5     Melden von Datensätzen

Standardmäßig ist das Melden von Datensätzen nach dem Start der "Aktiven Verbindung" durch DFCStartActiveConnection aktiviert und die DLL verarbeitet somit die Meldungen der Geräte. Durch Aufruf der Funktion DFCSetRecordAvailable kann diese Meldungsverarbeitung der DLL aktiviert / deaktiviert werden.

Im Gerät geschieht die Aktivierung / Deaktivierung durch die Systemvariable COM.NOTIFY.

Wenn im Gerät mindestens ein Datensatz abrufbereit ist, wird dieses durch das Gerät der DLL automatisch gemeldet. Die Meldung wird in einer Prioritätswarteschlange der DLL eingereiht und kann über die Funktion DFCRecordAvailable abgerufen werden. Über diesen Funktionsaufruf wird unter anderem die "Aktive Kanalnummer" geliefert und kann zum Abrufen der Datensätze im folgenden Aufruf von DFCReadRecord verwendet werden.

1.6.6     Inbetriebnehmen und Testen

Die Aktive Verbindung sowie Melden von Datensätzen kann über das DatafoxStudioIV geprüft und in Betrieb genommen werden. Hierzu steht ein eigener Kommunikationspunkt unter "Kommunikation -> Einstellungen" zur Verfügung. Bitte beachten Sie, dass Sie bevor eine Kommunikation mit einem Gerät durchgeführt werden kann, ein Aktiver Kanal gewählt werden muss.

1.7     Umsetzung des Kommunikationsmoduls für unterschiedliche Betriebssysteme.

1.7.1     Umsetzung für Windows.

Für Windows 32bit Betriebssysteme liegt dem Bundle eine erstellte dynamik link library DFComDLL.dll bei.
Die DLL ist generell auch unter Windows 64bit Betriebssystem einsetzbar, dieses setzt jedoch vorraus, dass die einbindende Anwendung ebenfalls in einer 64bit Konfiguration erstellt wird.

1.7.2     Umsetzung für unixartige Betriebssysteme.

Für unixartige Betriebssysteme liegen dem Bundle die Quelltexte und ein Makefile bei. Das Makefile befindet sich im Projektverzeichnis DatafoxCommIV. Die Übersetzung des Projektes in eine statische oder dynamische Bibliothek kann durch Aufruf des Kommanzozeilentools make erfolgen.
Bitte beachten Sie, dass zur Erstellung eine Projektabhängige Bibliothek 'pthread' verfügbar ist.

1.7.2.1     Erstellen einer statischen und shared Library.

Erstellung von Debug oder Release
Im Makefile ist zu Beginn ein Abschnitt, der darüber entscheidet ob bei der Kompilierung eine Debug oder Release Konfiguration zum Einsatz kommt.
Bitte stellen Sie vor Erstellung sicher, dass die Konfigruation auf den Einsatzzweck passt.

Durch den Aufruf von 'make all' werden folgende Dateien erstellt. Die Pfadangaben beziehen sich auf das Projektverzeichnis DatafoxCommIV.

• lib/DFCom.a: Statische Library des Kommunikationsmoduls.
• lib/libDFCom.so: Shared Library des Kommunikationsmoduls.
• bin/Example1: Beispiel der Passiven Verbindung mit statischer Bindung.
• bin/Example1_so: Beispiel der passiven Verbindung mit dynamischer Bindung.
• bin/Example2: Beispiel der Aktiven Verbindung mit statischer Bindung.
• bin/Example2_so: Beispiel der Aktiven Verbindung mit dynamischer Bindung.

Durch den Aufruf von 'make clean' werden alle erstellen Dateien gelöscht.

 Allgemeine Hinweise zu Erstellungsproblemen 

1.8     Unterschiede zur Umsetzung des Kommunikationsmoduls für x64 Windows-Betriebssysteme.

Bei dem Import der einzelnen Funktionen ist darauf zu achten, dass sich in der Umsetzung für die x64 Plattform sämtliche Funktionsnamen nach einem einheitlichen Schema abändern.
Die jeweiligen Exportnamen der 32 und 64bit Variante sind bei jeder Funktion in der Dokumentation angegebenen.

Zur Verdeutlichung wird für einen Umstieg von 32bit auf 64bit der Unterschied anhand des Exports der Funktion DFComOpenIV beschrieben.
Exportiert von DFComDLL: _DFCComOpenIV@24
Bei der eigentlichen Deklaration in Ihrer Anwendung muss der vorgesetzte _ und das hinter dem eigentlichen Namen stehende @24 weggelassen werden, somit ergibt sich DFCComOpenIV. Diese Vorgehensweise gilt für jede der enthaltenen Funktionen.
Ggf. können Sie Sich auch den Unterschied mittels Tools wie DependencyWalker anzeigen lassen, indem Sie die 32bit und 64bit Versionen Vergleichen.
Ob die Namensänderungen sich für Sie auswirken, hängt letztlich von der verwendeten Programmiersprache ab.
Die beschriebene Namensänderung ist die einzige zu beachtende Änderung. Das Kommunikationsmodul muss sich so verhalten, wie die Umsetzung für die x86-32 Plattform.

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 )

 Achtung: 

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 )

 Achtung: 

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 )

 Achtung: 

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 )

 Achtung: 

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

 Achtung: 

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:

-                 Off

++++++++          Ok

+++++-----+++++   Error

+++++

++--+++++

++--++

+++++--+++++

++--++--++

+++++--+++++--+++++

++--+++++--++

+++++--++--+++++

+

+-+

+-+-+

++++++++++++++++

++++++++--------++++++++--------++++++++

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 !";

DFCComSendInfotext(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

 Achtung: 

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.1.28     DFCGetInfo

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetInfo(int channelID, int deviceID, char *name, char *params,
char *info, int *len, int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.29     DFCOpenComServerMode

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCOpenComServerMode(int channelID, int deviceID, char *comm, int baudRate,
int byteSize, int parity, int stopBits, int flags,int timeoutToClose, int *error);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.30     DFCCloseComServerMode

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCCloseComServerMode(int channelID, int deviceID, int *error);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.31     DFCIsChannelOpen

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCIsChannelOpen(int channelID);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.32     DFCUploadModule

Wird unterstützt ab Firmwareversion:

Deklaration:

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

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.33     DFCGetOptionFirmware

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetOptionFirmware(int channelID, int deviceID, int *mask, int *options,
int *error);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.34     DFCSetOptionFirmware

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetOptionFirmware(int channelID, int deviceID, int mask, int options,
int *error);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.35     DFCReset

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCReset(int channelID, int deviceID, int mode, int *error);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.36     DFCSetFontType

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetFontType(int channelID, int deviceID, int iType, int *error);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.37     DFCSetPassword

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetPassword(int channelID,
char *password, int *piError);

Parameter: 

Rückgabewert: 

Beschreibung:

2.1.38     DFCGetPasswordKey

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetPasswordKey(int channelID, int deviceID,
char *key, int *len, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.1.39     DFCPressVirtualKey

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCPressVirtualKey(int channelID, int deviceID, int virtualKey,
 int flags, int *piError);

Parameter:

Rückgabewert: 

Beschreibung:

2.1.40     DFCGetFlashStatus

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetFlashStatus(int channelID, int deviceID, int *status,
 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.2.3     DFCModifyStudioFile

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCModifyStudioFile(char *sourceFile, char *destFile,
char *changeData, int flags, int *piError);

Parameter: 

Rückgabewert:

Beschreibung: 

 Beispiel der XML-Daten:

<?xml version="1.0" ?>
<modify>

	<password>
		<system>
			<value>1234</value>
		</system>
		<user>
			<value>2345</value>
		</user>
		<menu_item>
			<name>MEID_003</name>
			<value>4711</value>
		</menu_item>
	</password>

	<fingerprint>
		<security_level>20</security_level>
		<image_quality>70</image_quality>
		<minutiae_count>20</minutiae_count>
	</fingerprint>

	<replace>
		<name>
			<search>MID_001</search>
			<replacement>PZE Setup</replacement>
		</name>
		<name>
			<search>MEID_001</search>
			<replacement>Kommt:</replacement>
		</name>
		<name>
			<search>MEID_002</search>
			<replacement>Geht:</replacement>
		</name>
		<name>
			<search>MEID_003</search>
			<replacement>Abwesend</replacement>
		</name>
	</replace>

</modify>

2.3     Funktionen für Listen, sowie Zutrittslisten (Version 2)

Zugriff auf die Listen im Gerät.

2.3.1     DFCOpenTable

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCOpenTable(int channelID, int deviceID, char *name, int options,
int *handle, char *reserved, int *piError); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.2     DFCCloseTable

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCCloseTable(int channelID, int deviceID, int handle, int *piError); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.3     DFCSetFilter

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetFilter(int channelID, int deviceID, int handle,
char *filter, int *piError); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.4     DFCGetFilter

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetFilter(int channelID, int deviceID, int handle,
char *filter, int *len, int *piError); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.5     DFCClearFilter

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCClearFilter(int channelID, int deviceID, int handle, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.3.6     DFCSkip

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSkip(int channelID, int deviceID, int handle,
int offset, int origin, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.3.7     DFCSetField

 Achtung: 

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCSetField(int channelID, int deviceID,
int handle, char *name, char *value, int *piError); 

Parameter:

Rückgabewert:

Beschreibung:

2.3.8     DFCGetField

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCGetField(int channelID, int deviceID, int handle,
char *name, char *value, int *len, int *piError);

Parameter:

Rückgabewert:

Beschreibung:

2.4     Funktionen für Daten

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

2.4.1     DFCComClearData

 Achtung: 

Wird unterstützt ab Firmwareversion:

Deklaration:

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

Parameter:

Rückgabewert:

Beschreibung:

2.4.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.4.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.4.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.4.5     DFCDatBCnt

Wird unterstützt ab Firmwareversion:

Deklaration:

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

Parameter:

Rückgabewert:

Beschreibung:

2.4.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.4.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.4.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.4.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.10     DFCRestoreRecords

Wird unterstützt ab Firmwareversion:

Deklaration:

extern "C" __declspec(dllexport)
int __stdcall DFCRestoreRecords(int channelID, int deviceID, int *piError);

Parameter: