Reader and library

Topics
	Communication with the reader
	Information about the reader
	EEPROM manipulation
	Signalization (default)
	RGB Signalization
	Specific firmware features for uFR & uFR Zero Series NFC readers
	uFR Online Reader specific commands
	uFR library support for Base HD NFC readers
	Support for NXP SAM (Secure Application Module)
	Helper library functions

Functions
UFR_STATUS DL_API	GetDiscoveryLoopSetupM (UFR_HANDLE hndUFR, uint8_t *setupStruct, uint32_t *len)
UFR_STATUS DL_API	SetDiscoveryLoopM (UFR_HANDLE hndUFR, const uint8_t *setupStruct, uint32_t len)
UFR_STATUS DL_API	GetMobileUniqueIdAidM (UFR_HANDLE hndUFR, uint8_t *aid, uint32_t *len)
UFR_STATUS DL_API	SetMobileUniqueIdAidM (UFR_HANDLE hndUFR, const uint8_t *aid, uint32_t len)
UFR_STATUS DL_API	UfrSetBadSelectCardNrMaxM (UFR_HANDLE hndUFR, uint8_t bad_select_nr_max)
UFR_STATUS DL_API	UfrGetBadSelectCardNrMaxM (UFR_HANDLE hndUFR, VAR uint8_t *bad_select_nr_max)

Detailed Description

/**

Function Documentation

GetDiscoveryLoopSetupM()

UFR_STATUS DL_API GetDiscoveryLoopSetupM	(	UFR_HANDLE	hndUFR,
		uint8_t *	setupStruct,
		uint32_t *	len )

Multi reader support. Function returns reader’s serialized discovery loop structure i.e. C union (following gcc example): typedef union { __attribute ((packed)) struct { uint16_t flags; uint32_t RFU; }; __attribute ((packed)) struct { uint8_t byte0; uint8_t byte1; uint32_t RFU; } bytes; __attribute ((packed)) struct { uint8_t legacy:1; uint8_t enable_type_a:1; uint8_t enable_type_b:1; uint8_t enable_apple_ecp:1; uint8_t enable_hce:1; uint8_t auto_select_dlogic_aid:1; uint8_t auto_select_apple_vas:1; uint8_t auto_select_google_vas:1; uint8_t RFU_flags; uint32_t RFU; } bits; } discovery_loop_setup_t; sizeof (discovery_loop_setup_t) is 6 bytes.

Parameters

hndUFR	handle of the uFR device
setupStruct	Pointer to the array of bytes that should have at least sizeof (discovery_loop_setup_t) i.e. 6 bytes previously allocated.
len	Pointer to the variable containing actual size of the data array before calling this function (at least sizeof (discovery_loop_setup_t) i.e. 6 bytes) and after the successful execution contains size of the data returned by the reader.

Returns

Operation status

SetDiscoveryLoopM()

UFR_STATUS DL_API SetDiscoveryLoopM	(	UFR_HANDLE	hndUFR,
		const uint8_t *	setupStruct,
		uint32_t	len )

Multi reader support. Function sets the reader’s discovery loop.

Parameters

hndUFR	handle of the uFR device
setupStruct	Pointer to the serialized discovery loop structure.
len	Size of the serialized discovery loop structure. e.g. sizeof (discovery_loop_setup_t) i.e. 6 bytes

Returns

Operation status

GetMobileUniqueIdAidM()

UFR_STATUS DL_API GetMobileUniqueIdAidM	(	UFR_HANDLE	hndUFR,
		uint8_t *	aid,
		uint32_t *	len )

Multi reader support. Function returns the AID set in the reader to retrieve the mobile phone's unique ID. If the reader’s AID has never been set using SetMobileUniqueIdAid(), the function returns UFR_READING_ERROR status and the reader uses the default AID which is {0xF0, 0x01, 0x02, 0x03, 0x04, 0x05}. Minimum AID length is 5 bytes. Maximum AID len is 16 bytes. For details, see the example project at the https://www.d-logic.com/code/nfc-rfid-reader-sdk/ufr-aid_for_mobile_unique_id_setup.

Parameters

hndUFR	handle of the uFR device
aid	Pointer to the array of bytes that should have at least 16 bytes previously allocated.
len	Pointer to the variable containing actual size of the data array before calling this function (at least 16) and after the successful execution contains size of the data returned by the reader (max. 16 bytes)

Returns

Operation status

SetMobileUniqueIdAidM()

UFR_STATUS DL_API SetMobileUniqueIdAidM	(	UFR_HANDLE	hndUFR,
		const uint8_t *	aid,
		uint32_t	len )

Multi reader support. Function sets the reader’s AID to retrieve the mobile phone's unique ID. Minimum AID length is 5 bytes. Maximum AID len is 16 bytes. The default (factory) uFR AID is {0xF0, 0x01, 0x02, 0x03, 0x04, 0x05}. Minimum AID length is 5 bytes. Maximum AID len is 16 bytes. For details, see the example project at the https://www.d-logic.com/code/nfc-rfid-reader-sdk/ufr-aid_for_mobile_unique_id_setup.

Parameters

hndUFR	handle of the uFR device
aid	Pointer to the array of bytes containing the new AID.
len	Size of the new AID in bytes.

Returns

Operation status

UfrSetBadSelectCardNrMaxM()

UFR_STATUS DL_API UfrSetBadSelectCardNrMaxM	(	UFR_HANDLE	hndUFR,
		uint8_t	bad_select_nr_max )

Multi reader support. The function allows you to set the number of unsuccessful card selections before it can be considered that the card is not placed on the reader. Period between two card selections is approximately 10ms. Default value of this parameter is 20 i.e. 200ms. This parameter can be set in the range of 0 to 254. This is useful for asynchronous card ID transmission, if parameter send_removed_enable in function SetAsyncCardIdSendConfig is set. Then you can set a lower value of the number of unsuccessful card selections, in order to send information to the card removed was faster. A small value of this parameter may cause a false report that the card is not present, and immediately thereafter true report that the card is present.

Parameters

hndUFR	handle of the uFR device
bad_select_nr_max	number of unsuccessful card selections

Returns

Operation status

UfrGetBadSelectCardNrMaxM()

UFR_STATUS DL_API UfrGetBadSelectCardNrMaxM	(	UFR_HANDLE	hndUFR,
		VAR uint8_t *	bad_select_nr_max )

Multi reader support. The function returns value of maximal unsuccessful card selections, which is set in reader.

Parameters

hndUFR	handle of the uFR device
bad_select_nr_max	pointer to number of unsuccessful card selections

Returns

Operation status