uFCoder 2.62
Loading...
Searching...
No Matches
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 GetBuildNumberM (UFR_HANDLE hndUFR, VAR uint8_t *build)
 Multi reader support. Returns reader firmware build version as one byte representation.
 
c_string DL_API GetReaderDescriptionM (UFR_HANDLE hndUFR)
 Multi reader support. This function returns the reader's descriptive name. Return type is string. No parameters required.
 
UFR_STATUS DL_API GetReaderFirmwareVersionM (UFR_HANDLE hndUFR, VAR uint8_t *version_major, VAR uint8_t *version_minor)
 Multi reader support. Returns reader firmware version as two byte representation of higher and lower byte.
 
UFR_STATUS DL_API GetReaderHardwareVersionM (UFR_HANDLE hndUFR, VAR uint8_t *version_major, VAR uint8_t *version_minor)
 Multi reader support. Returns reader hardware version as two byte representation of higher and lower byte.
 
UFR_STATUS DL_API GetReaderSerialDescriptionM (UFR_HANDLE hndUFR, OUT uint8_t pSerialDescription[8])
 Multi reader support. Returns reader’s descriptive name as a row of 8 chars.
 
UFR_STATUS DL_API GetReaderSerialNumberM (UFR_HANDLE hndUFR, IN uint32_t *lpulSerialNumber)
 Multi reader support. Returns reader serial number as a pointer to 4 byte value.
 
UFR_STATUS DL_API GetReaderTypeM (UFR_HANDLE hndUFR, IN uint32_t *lpulReaderType)
 Multi reader support. Returns reader type as a pointer to 4 byte value.
 
UFR_STATUS DL_API ReaderStillConnectedM (UFR_HANDLE hndUFR, VAR uint32_t *connected)
 Multi reader support. 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

◆ GetBuildNumberM()

UFR_STATUS DL_API GetBuildNumberM ( UFR_HANDLE hndUFR,
VAR uint8_t * build )

Multi reader support. Returns reader firmware build version as one byte representation.

Parameters
hndUFRhandle of the uFR device
buildpointer to build variable
Returns
Operation status

◆ GetReaderDescriptionM()

c_string DL_API GetReaderDescriptionM ( UFR_HANDLE hndUFR)

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

Parameters
hndUFRhandle of the uFR device
Returns
Returns the reader's descriptive name.

◆ GetReaderFirmwareVersionM()

UFR_STATUS DL_API GetReaderFirmwareVersionM ( UFR_HANDLE hndUFR,
VAR uint8_t * version_major,
VAR uint8_t * version_minor )

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

Parameters
hndUFRhandle of the uFR device
version_majorpointer to version major variable
version_minorpointer to version minor variable
Returns
Operation status

◆ GetReaderHardwareVersionM()

UFR_STATUS DL_API GetReaderHardwareVersionM ( UFR_HANDLE hndUFR,
VAR uint8_t * version_major,
VAR uint8_t * version_minor )

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

Parameters
hndUFRhandle of the uFR device
version_majorpointer to version major variable
version_minorpointer to version minor variable
Returns
Operation status

◆ GetReaderSerialDescriptionM()

UFR_STATUS DL_API GetReaderSerialDescriptionM ( UFR_HANDLE hndUFR,
OUT uint8_t pSerialDescription[8] )

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

Parameters
hndUFRhandle of the uFR device
pSerialDescriptionpointer to pSerialDescription array
Returns
Operation status

◆ GetReaderSerialNumberM()

UFR_STATUS DL_API GetReaderSerialNumberM ( UFR_HANDLE hndUFR,
IN uint32_t * lpulSerialNumber )

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

Parameters
hndUFRhandle of the uFR device
lpulSerialNumberpointer to lpulSerialNumber variable. “lpulSerialNumber “ as result holds 4 byte serial number value.
Returns
Operation status

◆ GetReaderTypeM()

UFR_STATUS DL_API GetReaderTypeM ( UFR_HANDLE hndUFR,
IN uint32_t * lpulReaderType )

Multi reader support. Returns reader type as a pointer to 4 byte value.

Parameters
hndUFRhandle of the uFR device
lpulReaderTypepointer 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

◆ ReaderStillConnectedM()

UFR_STATUS DL_API ReaderStillConnectedM ( UFR_HANDLE hndUFR,
VAR uint32_t * connected )

Multi reader support. Retrieve info if reader is still connected to host.

Parameters
hndUFRhandle of the uFR device
connectedpointer 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