EEPROM manipulation

Functions
UFR_STATUS DL_API	ReaderKeyWriteM (UFR_HANDLE hndUFR, IN const uint8_t *aucKey, uint8_t ucKeyIndex)
UFR_STATUS DL_API	ReaderKeysLockM (UFR_HANDLE hndUFR, IN const uint8_t *password)
UFR_STATUS DL_API	ReaderKeysUnlockM (UFR_HANDLE hndUFR, IN const uint8_t *password)
UFR_STATUS DL_API	ReadUserDataM (UFR_HANDLE hndUFR, OUT uint8_t *aucData)
UFR_STATUS DL_API	ReadUserDataExtM (UFR_HANDLE hndUFR, OUT uint8_t *aucData)
UFR_STATUS DL_API	WriteUserDataM (UFR_HANDLE hndUFR, IN const uint8_t *aucData)
UFR_STATUS DL_API	WriteUserDataExtM (UFR_HANDLE hndUFR, IN const uint8_t *aucData)
UFR_STATUS DL_API	ChangeReaderPasswordM (UFR_HANDLE hndUFR, IN uint8_t *old_password, IN uint8_t *new_password)
UFR_STATUS DL_API	ReaderEepromWriteM (UFR_HANDLE hndUFR, IN uint8_t *data, uint32_t address, uint32_t size, IN uint8_t *password)
UFR_STATUS DL_API	ReaderEepromReadM (UFR_HANDLE hndUFR, OUT uint8_t *data, uint32_t address, uint32_t size)

Detailed Description

Function Documentation

ReaderKeyWriteM()

UFR_STATUS DL_API ReaderKeyWriteM	(	UFR_HANDLE	hndUFR,
		IN const uint8_t *	aucKey,
		uint8_t	ucKeyIndex )

Multi reader support. Store a new key or change existing key under provided index parameter.The keys are in a special area in EEPROM that can not be read anymore which gains protection.

Parameters

hndUFR	handle of the uFR device
aucKey	Pointer to an array of 6 bytes containing the key. Default key values are always “FF FF FF FF FF FF” hex.
ucKeyIndex	key Index. Possible values ​​are 0 to 31.

Returns

Operation status

ReaderKeysLockM()

UFR_STATUS DL_API ReaderKeysLockM	(	UFR_HANDLE	hndUFR,
		IN const uint8_t *	password )

Multi reader support. Lock reader’s keys to prevent further changing.

Parameters

hndUFR	handle of the uFR device
password	pointer to the 8 bytes array containing valid password.

Returns

Operation status

ReaderKeysUnlockM()

UFR_STATUS DL_API ReaderKeysUnlockM	(	UFR_HANDLE	hndUFR,
		IN const uint8_t *	password )

Multi reader support. Unlock reader’s keys if they are locked with previous function. The factory setting is that reader keys are unlocked.

Parameters

hndUFR	handle of the uFR device
password	pointer to the 8 bytes array containing valid password.

Returns

Operation status

ReadUserDataM()

UFR_STATUS DL_API ReadUserDataM	(	UFR_HANDLE	hndUFR,
		OUT uint8_t *	aucData )

Multi reader support. Read user data written in device NV memory. User data is 16 byte long. From version 5.0.86. function ReadUserDataExt added. When using this function, user data is 32 bytes long.

Parameters

hndUFR	handle of the uFR device
aucData	pointer to a 16 bytes array containing user data, or 32 bytes for ReadUserDataExt

Returns

Operation status

ReadUserDataExtM()

UFR_STATUS DL_API ReadUserDataExtM	(	UFR_HANDLE	hndUFR,
		OUT uint8_t *	aucData )

Multi reader support. Read user data written in device NV memory. User data is 16 byte long. From version 5.0.86. function ReadUserDataExt added. When using this function, user data is 32 bytes long.

Parameters

hndUFR	handle of the uFR device
aucData	pointer to a 16 bytes array containing user data, or 32 bytes for ReadUserDataExt

Returns

Operation status

WriteUserDataM()

UFR_STATUS DL_API WriteUserDataM	(	UFR_HANDLE	hndUFR,
		IN const uint8_t *	aucData )

Multi reader support. Write user data into the device's NV memory. User data is 16 byte long. From version 5.0.86. function WriteUserDataExt added. When using this function, user data is 32 bytes long.

Parameters

hndUFR	handle of the uFR device
aucData	pointer to a 16 byte array containing user data, or 32 bytes for ReadUserDataExt

Returns

Operation status

WriteUserDataExtM()

UFR_STATUS DL_API WriteUserDataExtM	(	UFR_HANDLE	hndUFR,
		IN const uint8_t *	aucData )

Multi reader support. Write user data into the device's NV memory. User data is 16 byte long. From version 5.0.86. function WriteUserDataExt added. When using this function, user data is 32 bytes long.

Parameters

hndUFR	handle of the uFR device
aucData	pointer to a 16 byte array containing user data, or 32 bytes for ReadUserDataExt

Returns

Operation status

ChangeReaderPasswordM()

UFR_STATUS DL_API ChangeReaderPasswordM	(	UFR_HANDLE	hndUFR,
		IN uint8_t *	old_password,
		IN uint8_t *	new_password )

Multi reader support. This function is used in Common, Advance and Access Control set of functions. It defines/changes password which I used for:

• Locking/unlocking keys stored into reader
• Setting date/time of RTC

Parameters

hndUFR	handle of the uFR device
old_password	pointer to the 8 bytes array containing current password
new_password	pointer to the 8 bytes array containing new password

Returns

Operation status

ReaderEepromWriteM()

UFR_STATUS DL_API ReaderEepromWriteM	(	UFR_HANDLE	hndUFR,
		IN uint8_t *	data,
		uint32_t	address,
		uint32_t	size,
		IN uint8_t *	password )

Multi reader support. Function writes array of data into EEPROM. Maximal length of array is 128 bytes. Function requires password which length is 8 bytes. Factory password is “11111111” (0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31).

Parameters

hndUFR	handle of the uFR device
data	pointer to array containing data
address	address of first data
size	length of array
password	pointer to array containing password

Returns

Operation status

ReaderEepromReadM()

UFR_STATUS DL_API ReaderEepromReadM	(	UFR_HANDLE	hndUFR,
		OUT uint8_t *	data,
		uint32_t	address,
		uint32_t	size )

Multi reader support. Function returns array of data read from EEPROM. Maximal length of array is 128 bytes.

Parameters

hndUFR	handle of the uFR device
data	pointer to array containing data from EEPROM
address	address of first data
size	length of array

Returns

Operation status