Specific firmware features for uFR Zero Series NFC readers

Functions
UFR_STATUS DL_API	GetDiscoveryLoopSetup (OUT uint8_t *setupStruct, VAR uint32_t *len)
UFR_STATUS DL_API	SetDiscoveryLoop (IN const uint8_t *setupStruct, uint32_t len)
UFR_STATUS DL_API	GetMobileUniqueIdAid (OUT uint8_t *aid, VAR uint32_t *len)
UFR_STATUS DL_API	SetMobileUniqueIdAid (IN const uint8_t *aid, uint32_t len)

Detailed Description

Function Documentation

GetDiscoveryLoopSetup()

UFR_STATUS DL_API GetDiscoveryLoopSetup	(	OUT uint8_t *	setupStruct,
		VAR uint32_t *	len )

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

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

SetDiscoveryLoop()

UFR_STATUS DL_API SetDiscoveryLoop	(	IN const uint8_t *	setupStruct,
		uint32_t	len )

Function sets the reader’s discovery loop.

Parameters

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

GetMobileUniqueIdAid()

UFR_STATUS DL_API GetMobileUniqueIdAid	(	OUT uint8_t *	aid,
		VAR uint32_t *	len )

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

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

SetMobileUniqueIdAid()

UFR_STATUS DL_API SetMobileUniqueIdAid	(	IN const uint8_t *	aid,
		uint32_t	len )

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

aid	Pointer to the array of bytes containing the new AID.
len	Size of the new AID in bytes.

Returns

Operation status