Asynchronous UID Sending

Functions
UFR_STATUS DL_API	SetAsyncCardIdSendConfig (uint8_t send_enable, uint8_t prefix_enable, uint8_t prefix, uint8_t suffix, uint8_t send_removed_enable, uint32_t async_baud_rate)
UFR_STATUS DL_API	SetAsyncCardIdSendConfigEx (uint8_t send_enable, uint8_t prefix_enable, uint8_t prefix, uint8_t suffix, uint8_t send_removed_enable, uint8_t reverse_byte_order, uint8_t decimal_representation, uint32_t async_baud_rate)
UFR_STATUS DL_API	GetAsyncCardIdSendConfig (VAR uint8_t *send_enable, VAR uint8_t *prefix_enable, VAR uint8_t *prefix, VAR uint8_t *suffix, VAR uint8_t *send_removed_enable, VAR uint32_t *async_baud_rate)
UFR_STATUS DL_API	GetAsyncCardIdSendConfigEx (VAR uint8_t *send_enable, VAR uint8_t *prefix_enable, VAR uint8_t *prefix, VAR uint8_t *suffix, VAR uint8_t *send_removed_enable, VAR uint8_t *reverse_byte_order, VAR uint8_t *decimal_representation, VAR uint32_t *async_baud_rate)

Detailed Description

Function Documentation

SetAsyncCardIdSendConfig()

UFR_STATUS DL_API SetAsyncCardIdSendConfig	(	uint8_t	send_enable,
		uint8_t	prefix_enable,
		uint8_t	prefix,
		uint8_t	suffix,
		uint8_t	send_removed_enable,
		uint32_t	async_baud_rate )

This function is used for the “Asynchronous UID sending” feature. Returned string contains hexadecimal notation of card ID with one mandatory suffix character and one optional prefix character. On the uFR Zero USB series there is an option to enable USB HID keyboard simulation. It is needed to set the baud rate to 0. For example, if baud rate is setted to any other value than 0, UID is sent to UART, but if it is setted to 0 UID is sent as keyboard simulation. Example: Card ID is 0xA103C256, prefix is 0x58 ('X'), suffix is 0x59 ('Y') Returned string is “XA103C256Y” Function sets configuration parameters for this feature.

Parameters

send_enable	turn feature on/off (0/1)
prefix_enable	use prefix or not (0/1)
prefix	prefix character
suffix	suffix character
send_removed_enable	Turn feature on/off (0/1). If feature is enabled then Asynchronous UID will also be sent when removing a card from the reader field.
async_baud_rate	baud rate value (e.g. 9600)

Returns

Operation status

SetAsyncCardIdSendConfigEx()

UFR_STATUS DL_API SetAsyncCardIdSendConfigEx	(	uint8_t	send_enable,
		uint8_t	prefix_enable,
		uint8_t	prefix,
		uint8_t	suffix,
		uint8_t	send_removed_enable,
		uint8_t	reverse_byte_order,
		uint8_t	decimal_representation,
		uint32_t	async_baud_rate )

Function sets the parameters of card ID sending.

Parameters

send_enable	turn feature on/off (0/1)
prefix_enable	use prefix or not (0/1)
prefix	prefix character
suffix	suffix character
send_removed_enable	Turn feature on/off (0/1). If feature is enabled then Asynchronous UID will also be sent when removing a card from the reader field.
reverse_byte_order	Turn feature on/off (0/1). If feature is disabled then the order of bytes (UID) will be as on card. If feature is enabled then the order of bytes will be reversed then the card’s order of bytes.
decimal_representation	Turn feature on/off (0/1). If feature is enabled then the UID will be presented as a decimal number. If feature is disabled then the UID will be presented as a hexadecimal number
async_baud_rate	baud rate value (e.g. 9600)

Returns

Operation status

GetAsyncCardIdSendConfig()

UFR_STATUS DL_API GetAsyncCardIdSendConfig	(	VAR uint8_t *	send_enable,
		VAR uint8_t *	prefix_enable,
		VAR uint8_t *	prefix,
		VAR uint8_t *	suffix,
		VAR uint8_t *	send_removed_enable,
		VAR uint32_t *	async_baud_rate )

Returns info about parameters configured with previous function.

Parameters

send_enable	pointer, if feature is on/off (0/1)
prefix_enable	pointer, if prefix is used or not (0/1)
prefix	pointer to variable holding prefix character
suffix	pointer to variable holding suffix character
send_removed_enable	Pointer. If value is 0 then feature is off. Otherwise, feature is on. If feature is enabled then Asynchronous UID is sent when the card is removed from the reader field.
async_baud_rate	pointer to variable holding configured baud rate

Returns

Operation status

GetAsyncCardIdSendConfigEx()

UFR_STATUS DL_API GetAsyncCardIdSendConfigEx	(	VAR uint8_t *	send_enable,
		VAR uint8_t *	prefix_enable,
		VAR uint8_t *	prefix,
		VAR uint8_t *	suffix,
		VAR uint8_t *	send_removed_enable,
		VAR uint8_t *	reverse_byte_order,
		VAR uint8_t *	decimal_representation,
		VAR uint32_t *	async_baud_rate )

Function returns the parameters of card ID sending.

Parameters

send_enable	pointer, if feature is on/off (0/1)
prefix_enable	pointer, if prefix is used or not (0/1)
prefix	pointer to variable holding prefix character
suffix	pointer to variable holding suffix character
send_removed_enable	Pointer. If value is 0 then feature is off. Otherwise, feature is on. If feature is enabled then Asynchronous UID is sent when the card is removed from the reader field.
reverse_byte_order	Turn feature on/off (0/1). If feature is disabled then the order of bytes (UID) will be as on card. If feature is enabled then the order of bytes will be reversed then the card’s order of bytes.
decimal_representation	Turn feature on/off (0/1). If feature is enabled then the UID will be presented as a decimal number. If feature is disabled then the UID will be presented as a hexadecimal number
async_baud_rate	pointer to baud rate variable

Returns

Operation status