Information about the reader

Functions related to getting information about the reader, e.g serial number, hardware/fimware version, reader type and more. More...

Functions
UFR_STATUS DL_API	GetBuildNumber (VAR uint8_t *build)
	Returns reader firmware build version as one byte representation.
UFR_STATUS DL_API	GetFtdiDriverVersion (VAR uint8_t *version_major, VAR uint8_t *version_minor, VAR uint8_t *build)
	Used to get the FTDI D2XX driver version number. The communication with the reader needs to be established via ReaderOpen() or ReaderOpenEx() beforehand.
UFR_STATUS DL_API	GetFtdiDriverVersionStr (OUT char *version_str)
	Used to get the FTDI D2XX driver version number as c-string. The communication with the reader needs to be established via ReaderOpen() or ReaderOpenEx() beforehand.
c_string DL_API	GetReaderDescription (void)
	This function returns the reader's descriptive name. Return type is string. No parameters required.
UFR_STATUS DL_API	GetReaderFirmwareVersion (VAR uint8_t *version_major, VAR uint8_t *version_minor)
	Returns reader firmware version as two byte representation of higher and lower byte.
UFR_STATUS DL_API	GetReaderHardwareVersion (VAR uint8_t *version_major, VAR uint8_t *version_minor)
	Returns reader hardware version as two byte representation of higher and lower byte.
UFR_STATUS DL_API	GetReaderSerialDescription (OUT uint8_t pSerialDescription[8])
	Returns reader’s descriptive name as a row of 8 chars.
UFR_STATUS DL_API	GetReaderSerialNumber (IN uint32_t *lpulSerialNumber)
	Returns reader serial number as a pointer to 4 byte value.
UFR_STATUS DL_API	GetReaderType (IN uint32_t *lpulReaderType)
	Returns reader type as a pointer to 4 byte value.
UFR_STATUS DL_API	ReaderStillConnected (VAR uint32_t *connected)
	Retrieve info if reader is still connected to host.

Detailed Description

Functions related to getting information about the reader, e.g serial number, hardware/fimware version, reader type and more.

Function Documentation

GetBuildNumber()

UFR_STATUS DL_API GetBuildNumber

(

VAR uint8_t *

build

)

Returns reader firmware build version as one byte representation.

Parameters

build

pointer to build variable

Returns

Operation status

GetFtdiDriverVersion()

UFR_STATUS DL_API GetFtdiDriverVersion	(	VAR uint8_t *	version_major,
		VAR uint8_t *	version_minor,
		VAR uint8_t *	build )

Used to get the FTDI D2XX driver version number. The communication with the reader needs to be established via ReaderOpen() or ReaderOpenEx() beforehand.

Parameters

version_major	Byte value indicating driver version major number
version_minor	Byte value indicating driver version minor number
build	Byte value indicating driver version build number

Returns

Operation status

GetFtdiDriverVersionStr()

UFR_STATUS DL_API GetFtdiDriverVersionStr

(

OUT char *

version_str

)

Used to get the FTDI D2XX driver version number as c-string. The communication with the reader needs to be established via ReaderOpen() or ReaderOpenEx() beforehand.

Parameters

version_str

buffer that will contain driver version as c-string.

Returns

Operation status

GetReaderDescription()

c_string DL_API GetReaderDescription

(

void

)

This function returns the reader's descriptive name. Return type is string. No parameters required.

Returns

The reader's descriptive name

GetReaderFirmwareVersion()

UFR_STATUS DL_API GetReaderFirmwareVersion	(	VAR uint8_t *	version_major,
		VAR uint8_t *	version_minor )

Returns reader firmware version as two byte representation of higher and lower byte.

Parameters

version_major	pointer to version major variable
version_minor	pointer to version minor variable

Returns

Operation status

GetReaderHardwareVersion()

UFR_STATUS DL_API GetReaderHardwareVersion	(	VAR uint8_t *	version_major,
		VAR uint8_t *	version_minor )

Returns reader hardware version as two byte representation of higher and lower byte.

Parameters

version_major	pointer to version major variable
version_minor	pointer to version minor variable

Returns

Operation status

GetReaderSerialDescription()

UFR_STATUS DL_API GetReaderSerialDescription

(

OUT uint8_t

pSerialDescription[8]

)

Returns reader’s descriptive name as a row of 8 chars.

Parameters

pSerialDescription

pointer to pSerialDescription array

Returns

Operation status

GetReaderSerialNumber()

UFR_STATUS DL_API GetReaderSerialNumber

(

IN uint32_t *

lpulSerialNumber

)

Returns reader serial number as a pointer to 4 byte value.

Parameters

lpulSerialNumber

pointer to lpulSerialNumber variable. “lpulSerialNumber “ as result holds 4 byte serial number value.

Returns

Operation status

GetReaderType()

UFR_STATUS DL_API GetReaderType

(

IN uint32_t *

lpulReaderType

)

Returns reader type as a pointer to 4 byte value.

Parameters

lpulReaderType

pointer to lpulReaderType variable. “lpulReaderType” as result - please refer to Appendix: DLogic reader type enumeration. E.g. for µFR Nano Classic readers this value is 0xD1180022.

Returns

Operation status

ReaderStillConnected()

UFR_STATUS DL_API ReaderStillConnected

(

VAR uint32_t *

connected

)

Retrieve info if reader is still connected to host.

Parameters

connected

pointer to connected variable “connected” as result: > 0 Reader is connected on system = 0 Reader is not connected on system anymore (or closed) < 0 other error “connected” - Pointer to unsigned int type variable 32 bit long, where the information about readers availability is written. If the reader is connected on system, function store 1 (true) otherwise, on some error, store zero in that variable.

Returns

Operation status