![]() |
Datafox DFCom - API
04.03.18
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
|
Diese Struktur enthält zusaetzliche Informationen. Mehr ...
#include <studio_setup_structs.h>
Datenfelder | |
uint16_t | doubleInputTime {} |
Zeit für "Doppelte Eingabe" PZE1/PZE2 Modus in Sekunden. Mehr ... | |
uint16_t | confirmationTime {} |
Zeit für "Bestätigungsfelder" in Sekunden. Mehr ... | |
uint8_t | daylightActive {} |
Aktivieren der Sommer-/Winterzeitumschaltung (daylight saving) Mehr ... | |
uint8_t | daylight1Month {} |
Monat in dem umgestellt wird (1 - 12). Mehr ... | |
uint8_t | daylight1Week {} |
Monatswoche in der umgestellt wird (1 - 5, wobei 5 letzte im Monat bedeutet). Mehr ... | |
uint8_t | daylight1Day {} |
Tag der Umschaltung (1 - 7, wobei 1 = Montag). Mehr ... | |
uint8_t | daylight1Hour {} |
Stunde für Umschaltung (0 - 23). Mehr ... | |
uint8_t | daylight2Month {} |
Monat in dem umgestellt wird (1 - 12). Mehr ... | |
uint8_t | daylight2Week {} |
Monatswoche in der umgestellt wird (1 - 5, wobei 5 letzte im Monat bedeutet). Mehr ... | |
uint8_t | daylight2Day {} |
Tag der Umschaltung (1 - 7, wobei 1 = Montag). Mehr ... | |
uint8_t | daylight2Hour {} |
Stunde für Umschaltung (0 - 23) Umstellung von Sommerzeit auf Winterzeit (Normalzeit) [-1 h]. Mehr ... | |
char | transponderPassword32 [9] {} |
Passwort für Hitag2 (32bit) in ASCII (Hex) abgelegt. Mehr ... | |
char | transponderPasswordA0 [13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt. Mehr ... | |
uint8_t | phgAESKey [16] {} |
Schlüssel für Kommunikationsverschlüsselung der PHG Leser. Mehr ... | |
StructFingerprint | fingerprint |
Datenstruktur zum Fingerprint. Mehr ... | |
StructTimeboyAdaption | adaption |
Anbindungsstruktur von Timboys an MasterIV. Mehr ... | |
StructGPRS | gprs |
Struktur für Zusatzangaben bezüglich GPRS, wie z. B. Alive. Mehr ... | |
StructEnergieOption | energieOption |
Struktur für Energieoption bei Mobil-MasterIV. Mehr ... | |
StructTimer | timer [4] {} |
Struktur für Timer in der Signalverarbeitung (vorgesehen sind 4 Timer a 16 Byte) Mehr ... | |
uint8_t | transponderPasswordFlag {} |
Passwortflag für Passwortverwendung von Mifare. Mehr ... | |
char | transponderPasswordB0 [13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt. Mehr ... | |
char | transponderPasswordA1 [13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt. Mehr ... | |
char | transponderPasswordB1 [13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt. Mehr ... | |
char | transponderPasswordA2 [13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt. Mehr ... | |
char | transponderPasswordB2 [13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt. Mehr ... | |
int32_t | transponderSectorTrailer {} |
Zugriffseinstellungen für den globale Sektor. Mehr ... | |
uint8_t | transponderInitialValue [17] {} |
Startwert von Mifare-Ausweis. Mehr ... | |
uint8_t | memoryUsage {} |
Speicheraufteilung zwischen Daten/Listen in %. Wert gibt die % für Daten reserviert an. Mehr ... | |
uint8_t | entranceOnline {} |
Betriebsmodus der Zutrittskontrolle. Mehr ... | |
uint8_t | entranceOnlineTimeout {} |
Timeout für die Umschaltung zwischen Online/Offline Betrieb der Zutrittskontrolle. Mehr ... | |
StructDigitalInputExt | digitalExtInput [8] {} |
Erweiterte Strukturen für die digitalen Eingänge. Mehr ... | |
char | fileName [44] {} |
Dateiname der Setupdatei. Wird vor der Übertragung durch Laderoutine der Setupdatei gesetzt. Mehr ... | |
char | fileTimestamp [20] {} |
Modifizierungszeitstempel der Setupdatei. Wird vor der Übertragung durch Laderoutine der Setupdatei gesetzt. Mehr ... | |
uint8_t | passwordSetup [17] {} |
Passwort für die Kommunikation. Mehr ... | |
StructGPS | gps |
Struktur für GPS-Datensatzerzeugung. Mehr ... | |
uint8_t | userPasswordEnable {} |
Benutzerpasswort verwenden, ansonsten wird das Systempasswort fürs Userpasswort verwendet. Mehr ... | |
uint8_t | escJumpToMainmenu {} |
Im PZE-Modus wird durch drücken der ESC-Taste das Hauptmenü angezeigt. Mehr ... | |
uint8_t | ledPerFieldFunction {} |
AE/BDE-MasterIV: LED steuerung mit Feldfunktion "LED schalten" steuern. Mehr ... | |
uint16_t | dataWriteOKTime {} |
Die Anzeigezeit der Meldung "Datenspeicherung erfolgreich". Mehr ... | |
uint8_t | dataWriteOKFontType {} |
Der verwendete Zeichensatztyp bei Meldung "Datenspeicherung erfolgreich". Mehr ... | |
uint32_t | powerActiv {} |
Gibt an ob die Energieverwaltung des Setups aktiviert ist. Mehr ... | |
uint8_t | powerClockTimerCount {} |
Gibt an wie viele Timer die zu einer Bestimmten Uhrzeit auslösen existieren dürfen. Mehr ... | |
uint8_t | spsQuery {} |
Abfrage einer angeschlossenen SPS. Feldfunktion SPS-Abfrage. Mehr ... | |
uint8_t | dataOnCard {} |
Datenarrays auf Transponderkarten schreiben. Mehr ... | |
uint8_t | acExtension {} |
Erweiterte Zutrittskontrolle verwenden. Mehr ... | |
uint16_t | acTagTimeToClose {} |
Die Zeit wie lange der Ausweis vor einen ZK Leser gehalten werden muss bis eine Schließung erfolgt. Mehr ... | |
uint16_t | acAlarmTimeout {} |
Auszeit nachdem ein Alarmdatensatz generiert wird, weil ein digitaler Eingang zu lange offen war. Mehr ... | |
uint8_t | batteryLoadOptimization {} |
Ladeerhaltung voller Akkus optimieren. Mehr ... | |
uint8_t | showSmallWatch {} |
Zusätzlich zur Anzeige der großen Uhr wird eine kleine Uhr mit Sekundenanzeige eingeblendet. Mehr ... | |
uint8_t | dontDimBacklightForCharge {} |
Die Hintergrundbeleuchtung soll nicht gedimmt werden um die Aufladung der Akku's zu beschleunigen. Mehr ... | |
uint8_t | flagsEnergie {} |
Zusätzliche Flags für bestimmtes Geräteverhalten in der Energieverwaltung. Mehr ... | |
uint16_t | displayOffAfter {} |
Display ausschalten nach [Wert] Minuten ohne Bedienung. 0 = niemals aus bis 990 = 16,5 Stunden. Mehr ... | |
uint8_t | flagsShowSetupNote {} |
Flag ob ein Hinweis zu Änderungen im Setup angezeigt werden soll. Mehr ... | |
uint8_t | phgCryptUseFlags {} |
Flags für die Zusatzsicherheitsoptionen bei ZK-Anlagen mit PHG-Lesern. Mehr ... | |
uint8_t | readerPollingFlags {} |
Flags für das Polling der Leser im Bus. Mehr ... | |
uint8_t | recordPriorityColumn [20] {} |
Spaltenindex für Priorität des Datensatzes zur Datensatzbeschreibung. 0=Keines zugewiesen, 1..MAX_FIELDS+1=Feldindex. Mehr ... | |
uint8_t | cameraUse {} |
Verwendung der eventuell integrierten Kamera. Mehr ... | |
uint8_t | cameraGrab {} |
Bei cameraUse == 2 gibt es den Prozentwert der Stichprobe an. Mehr ... | |
uint8_t | memoryUsageExtData {} |
Für Daten zu Datensätzen (Kamerabilder in diesem Moment erstmal) 0 - 90. Mehr ... | |
uint8_t | dateTimeFormatSettings {} |
Zur Einstellung des Datum- und Zeit-Formats an den Geräten. Mehr ... | |
StructKeyBox | protectionPassword |
Passwort für die verschlüsselte Werteablage. Mehr ... | |
uint8_t | useSignature {} |
Verwendung der Feldfunktion 'Unterschrift'. Mehr ... | |
uint8_t | timerTimeBaseDivisor {1} |
Zur Einstellung der Zeitbasis der Timer für die Konfiguration der Startverzögerung und des Zyklus (1 - 10) Die konfigurierten Werte (Startverzögerung und Zyklus) werden mit der Zeitbasis multipliziert. Mehr ... | |
uint8_t | commissioningMode |
Inbetriebnahmemodus bei ZK-Geräten aktiv. Mehr ... | |
uint8_t | useLongBarcode {} |
Verwendung der Feldfunktion 'Langen Barcode lesen'. Mehr ... | |
Diese Struktur enthält zusaetzliche Informationen.
Diese Struktur ist im erweiterten Speicherblock abgelegt. In dieser Struktur werden alle weiteren Informationen abgelegt.
uint16_t acAlarmTimeout {} |
Auszeit nachdem ein Alarmdatensatz generiert wird, weil ein digitaler Eingang zu lange offen war.
uint8_t acExtension {} |
Erweiterte Zutrittskontrolle verwenden.
uint16_t acTagTimeToClose {} |
Die Zeit wie lange der Ausweis vor einen ZK Leser gehalten werden muss bis eine Schließung erfolgt.
StructTimeboyAdaption adaption |
Anbindungsstruktur von Timboys an MasterIV.
uint8_t batteryLoadOptimization {} |
Ladeerhaltung voller Akkus optimieren.
uint8_t cameraGrab {} |
Bei cameraUse == 2 gibt es den Prozentwert der Stichprobe an.
uint8_t cameraUse {} |
Verwendung der eventuell integrierten Kamera.
Wert | Bedeutung |
---|---|
0 | keine Verwendung |
1 | einfache Bildaufnahme per Feldfunktion |
2 | einfache und stichprobenartige Bildaufnahme per Feldfunktion |
uint8_t commissioningMode |
Inbetriebnahmemodus bei ZK-Geräten aktiv.
uint16_t confirmationTime {} |
Zeit für "Bestätigungsfelder" in Sekunden.
uint8_t dataOnCard {} |
Datenarrays auf Transponderkarten schreiben.
uint8_t dataWriteOKFontType {} |
Der verwendete Zeichensatztyp bei Meldung "Datenspeicherung erfolgreich".
uint16_t dataWriteOKTime {} |
Die Anzeigezeit der Meldung "Datenspeicherung erfolgreich".
Wert | Bedeutung |
---|---|
0 | aus |
500 | default |
500-5000 | Zeit in 250ms Schritten |
Einheit: ms
uint8_t dateTimeFormatSettings {} |
Zur Einstellung des Datum- und Zeit-Formats an den Geräten.
Wert | Bedeutung |
---|---|
0 | augenblickliches StandardFormat = Tag.Monat.Jahr und Uhr 24 Stunden Anzeige |
1 | internationales Datumsformat Jahr-Monat-Tag und Uhr 24 Stunden Anzeige |
2 | USA Datumsformat Monat/Tag/Jahr und Uhr 24 Stunden Anzeige |
3 | USA Datumsformat Monat-Tag-Jahr und Uhr 24 Stunden Anzeige |
4 | GB Datumsformat Tag/Monat/Jahr und Uhr 24 Stunden Anzeige |
5 | GB Datumsformat Tag-Monat-Jahr und Uhr 24 Stunden Anzeige |
16 | deutsches Datumsformat Tag.Monat.Jahr und Uhr 12 Stunden Anzeige und AM/PM |
17 | internationales Datumsformat Jahr-Monat-Tag und Uhr 12 Stunden Anzeige und AM/PM |
18 | USA Datumsformat Monat/Tag/Jahr und Uhr 12 Stunden Anzeige und AM/PM |
19 | USA Datumsformat Monat-Tag-Jahr und Uhr 12 Stunden Anzeige und AM/PM |
20 | GB Datumsformat Tag/Monat/Jahr und Uhr 12 Stunden Anzeige und AM/PM |
21 | GB Datumsformat Tag-Monat-Jahr und Uhr 12 Stunden Anzeige und AM/PM |
uint8_t daylight1Day {} |
Tag der Umschaltung (1 - 7, wobei 1 = Montag).
Umstellung von Winterzeit (Normalzeit) auf Sommerzeit [+1 h].
uint8_t daylight1Hour {} |
Stunde für Umschaltung (0 - 23).
Umstellung von Winterzeit (Normalzeit) auf Sommerzeit [+1 h].
uint8_t daylight1Month {} |
Monat in dem umgestellt wird (1 - 12).
Umstellung von Winterzeit (Normalzeit) auf Sommerzeit [+1 h].
uint8_t daylight1Week {} |
Monatswoche in der umgestellt wird (1 - 5, wobei 5 letzte im Monat bedeutet).
Umstellung von Winterzeit (Normalzeit) auf Sommerzeit [+1 h].
uint8_t daylight2Day {} |
Tag der Umschaltung (1 - 7, wobei 1 = Montag).
Umstellung von Sommerzeit auf Winterzeit (Normalzeit) [-1 h].
uint8_t daylight2Hour {} |
Stunde für Umschaltung (0 - 23) Umstellung von Sommerzeit auf Winterzeit (Normalzeit) [-1 h].
uint8_t daylight2Month {} |
Monat in dem umgestellt wird (1 - 12).
Umstellung von Sommerzeit auf Winterzeit (Normalzeit) [-1 h].
uint8_t daylight2Week {} |
Monatswoche in der umgestellt wird (1 - 5, wobei 5 letzte im Monat bedeutet).
Umstellung von Sommerzeit auf Winterzeit (Normalzeit) [-1 h].
uint8_t daylightActive {} |
Aktivieren der Sommer-/Winterzeitumschaltung (daylight saving)
Wert | Bedeutung |
---|---|
0 | deaktiviert |
1 | aktiv und von Firmware auszuwerten |
StructDigitalInputExt digitalExtInput[8] {} |
Erweiterte Strukturen für die digitalen Eingänge.
uint16_t displayOffAfter {} |
Display ausschalten nach [Wert] Minuten ohne Bedienung. 0 = niemals aus bis 990 = 16,5 Stunden.
uint8_t dontDimBacklightForCharge {} |
Die Hintergrundbeleuchtung soll nicht gedimmt werden um die Aufladung der Akku's zu beschleunigen.
uint16_t doubleInputTime {} |
Zeit für "Doppelte Eingabe" PZE1/PZE2 Modus in Sekunden.
StructEnergieOption energieOption |
Struktur für Energieoption bei Mobil-MasterIV.
uint8_t entranceOnline {} |
Betriebsmodus der Zutrittskontrolle.
Wert | Bedeutung |
---|---|
0 | Offline |
1 | Online |
2 | Online/Offline mit Timeout |
uint8_t entranceOnlineTimeout {} |
Timeout für die Umschaltung zwischen Online/Offline Betrieb der Zutrittskontrolle.
uint8_t escJumpToMainmenu {} |
Im PZE-Modus wird durch drücken der ESC-Taste das Hauptmenü angezeigt.
char fileName[44] {} |
Dateiname der Setupdatei. Wird vor der Übertragung durch Laderoutine der Setupdatei gesetzt.
char fileTimestamp[20] {} |
Modifizierungszeitstempel der Setupdatei. Wird vor der Übertragung durch Laderoutine der Setupdatei gesetzt.
StructFingerprint fingerprint |
Datenstruktur zum Fingerprint.
uint8_t flagsEnergie {} |
Zusätzliche Flags für bestimmtes Geräteverhalten in der Energieverwaltung.
Bit | Bedeutung (wenn gesetzt) |
---|---|
1 | TimeboyIV soll GPS abschalten, wenn er sich in der Dockingstation befindet. |
2 | TimeboyIV soll Mobilfunk abschalten, wenn er sich in der Dockingstation befindet. |
3-8 | -FREI- |
uint8_t flagsShowSetupNote {} |
Flag ob ein Hinweis zu Änderungen im Setup angezeigt werden soll.
Bit | Bedeutung (wenn gesetzt) |
---|---|
1 | Energiesparoption "Display aus nach n Minuten ohne Bedienung." |
2 | Standardwert wurde auf 120 Minuten gesetzt |
StructGPRS gprs |
Struktur für Zusatzangaben bezüglich GPRS, wie z. B. Alive.
StructGPS gps |
Struktur für GPS-Datensatzerzeugung.
uint8_t ledPerFieldFunction {} |
AE/BDE-MasterIV: LED steuerung mit Feldfunktion "LED schalten" steuern.
uint8_t memoryUsage {} |
Speicheraufteilung zwischen Daten/Listen in %. Wert gibt die % für Daten reserviert an.
uint8_t memoryUsageExtData {} |
Für Daten zu Datensätzen (Kamerabilder in diesem Moment erstmal) 0 - 90.
uint8_t passwordSetup[17] {} |
Passwort für die Kommunikation.
uint8_t phgAESKey[16] {} |
Schlüssel für Kommunikationsverschlüsselung der PHG Leser.
uint8_t phgCryptUseFlags {} |
Flags für die Zusatzsicherheitsoptionen bei ZK-Anlagen mit PHG-Lesern.
Bit | Bedeutung (wenn gesetzt) |
---|---|
1 | Initialisierungsvector soll zusätzliche zur Verschlüsselung verwendet werden. |
2 | Sessionkeys sollen zusätzlich zur Verschlüsselung verwendet werden. |
uint32_t powerActiv {} |
Gibt an ob die Energieverwaltung des Setups aktiviert ist.
Inklusive Flags für die aktivierten Module.
uint8_t powerClockTimerCount {} |
Gibt an wie viele Timer die zu einer Bestimmten Uhrzeit auslösen existieren dürfen.
StructKeyBox protectionPassword |
Passwort für die verschlüsselte Werteablage.
uint8_t readerPollingFlags {} |
Flags für das Polling der Leser im Bus.
Bit | Bedeutung (wenn gesetzt) |
---|---|
1 | Maximale Pollingrate. |
Achtung: Dieses Bit wird ab der Version 04.03.09 nicht weiter | |
unterstützt und von der Firmware als fest gesetzt ausgewertet. | |
2 | Nur Leser aus der Reader-Liste im Bus suchen. |
uint8_t recordPriorityColumn[20] {} |
Spaltenindex für Priorität des Datensatzes zur Datensatzbeschreibung. 0=Keines zugewiesen, 1..MAX_FIELDS+1=Feldindex.
uint8_t showSmallWatch {} |
Zusätzlich zur Anzeige der großen Uhr wird eine kleine Uhr mit Sekundenanzeige eingeblendet.
uint8_t spsQuery {} |
Abfrage einer angeschlossenen SPS. Feldfunktion SPS-Abfrage.
StructTimer timer[4] {} |
Struktur für Timer in der Signalverarbeitung (vorgesehen sind 4 Timer a 16 Byte)
uint8_t timerTimeBaseDivisor {1} |
Zur Einstellung der Zeitbasis der Timer für die Konfiguration der Startverzögerung und des Zyklus (1 - 10) Die konfigurierten Werte (Startverzögerung und Zyklus) werden mit der Zeitbasis multipliziert.
Wert | Zeitbasis |
---|---|
1 | 1000ms |
2 | 500ms |
3 | 333ms |
4 | 250ms |
5 | 200ms |
6 | 167ms |
7 | 143ms |
8 | 125ms |
9 | 111ms |
10 | 100ms |
uint8_t transponderInitialValue[17] {} |
Startwert von Mifare-Ausweis.
char transponderPassword32[9] {} |
Passwort für Hitag2 (32bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 8 Zeichen (ASCII) lang sein.
char transponderPasswordA0[13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 12 Zeichen (ASCII) lang sein.
char transponderPasswordA1[13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 12 Zeichen (ASCII) lang sein.
char transponderPasswordA2[13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 12 Zeichen (ASCII) lang sein.
char transponderPasswordB0[13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 12 Zeichen (ASCII) lang sein.
char transponderPasswordB1[13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 12 Zeichen (ASCII) lang sein.
char transponderPasswordB2[13] {} |
Passwort für Mifare (48bit) in ASCII (Hex) abgelegt.
Das Passwort darf maximal 12 Zeichen (ASCII) lang sein.
uint8_t transponderPasswordFlag {} |
Passwortflag für Passwortverwendung von Mifare.
Bit | Bedeutung | ||
---|---|---|---|
1-2 | Passwortverwendung für Lesen/Schreiben A0/B0 | ||
0 | 1 | 2 | |
KeyA/KeyA | KeyA/KeyB | KeyB/KeyB | |
3-4 | Passwortverwendung für Lesen/Schreiben A1/B1 | ||
0 | 1 | 2 | |
KeyA/KeyA | KeyA/KeyB | KeyB/KeyB | |
5-6 | Passwortverwendung für Lesen/Schreiben A2/B2 | ||
0 | 1 | 2 | |
KeyA/KeyA | KeyA/KeyB | KeyB/KeyB | |
7 | -FREI- | ||
8 | Autologin | ||
Verwendung aller Passwörter für das Lesen |
int32_t transponderSectorTrailer {} |
Zugriffseinstellungen für den globale Sektor.
uint8_t useLongBarcode {} |
Verwendung der Feldfunktion 'Langen Barcode lesen'.
Wert | Bedeutung |
---|---|
0 | keine Verwendung |
1 | Verwendung möglich |
uint8_t userPasswordEnable {} |
Benutzerpasswort verwenden, ansonsten wird das Systempasswort fürs Userpasswort verwendet.
uint8_t useSignature {} |
Verwendung der Feldfunktion 'Unterschrift'.
Wert | Bedeutung |
---|---|
0 | keine Verwendung |
1 | Verwendung möglich |