Functions related to uFR Online series readers only, specifically targetting the embedded ESP32 MCU. More...

Functions
UFR_STATUS DL_API	EspChangeReaderPassword (IN uint8_t old_password, IN uint8_t new_password)
	It defines/changes password which I used for:

UFR_STATUS DL_API	EspDisableWifi (void)
	This option is only avaliable in BT/BLE mode. Disable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned off device restart.

UFR_STATUS DL_API	EspDisableWifiM (UFR_HANDLE hndUFR)
	Multi reader support. This option is only avaliable in BT/BLE mode. Disable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned off device restart.

UFR_STATUS DL_API	EspEnableOnWifiM (UFR_HANDLE hndUFR)
	Multi reader support. This option is only avaliable in BT/BLE mode. Enable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned on device restart.

UFR_STATUS DL_API	EspEnableWifi (void)
	This option is only avaliable in BT/BLE mode. Enable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned on device restart.

UFR_STATUS DL_API	EspGetFirmwareVersion (OUT uint8_t major, OUT uint8_t minor, OUT uint8_t *build)
	Returns uFR Online reader firmware version.

UFR_STATUS DL_API	EspGetFirmwareVersionM (UFR_HANDLE hndUFR, OUT uint8_t major, OUT uint8_t minor, OUT uint8_t *build)
	Multi reader support. Returns uFR Online reader firmware version.

UFR_STATUS DL_API	EspGetIOState (OUT uint8_t *state)
	Function returns 6 bytes array of uint8_t that represented IO pins logic level state.

UFR_STATUS DL_API	EspGetReaderSerialNumber (VAR uint32_t *SerialNumber)
	Returns uFR Online reader serial number as a pointer to 4 byte value.

UFR_STATUS DL_API	EspGetReaderTime (OUT uint8_t *time)
	Function returns 6 bytes array of uint8_t that represents current date and time into uFR Online RTC.

UFR_STATUS DL_API	EspReaderEepromRead (OUT uint8_t *data, uint32_t address, uint32_t size)
	Function returns array of data read from EEPROM of uFR Online. Maximal length of the array is 128 bytes.

UFR_STATUS DL_API	EspReaderEepromWrite (IN uint8_t data, uint32_t address, uint32_t size, IN uint8_t password)
	Function writes array of data into EEPROM of uFR Online.

UFR_STATUS DL_API	EspReaderReset (void)
	Physical reset of uFR reader communication port.

UFR_STATUS DL_API	EspSetDisplayData (IN uint8_t *display_data, IN uint8_t data_length, uint16_t duration)
	Function enables sending data to the uFR Online. A string of data contains information about the intensity of color in each cell of the LED indication.

UFR_STATUS DL_API	EspSetIOState (uint8_t pin, uint8_t state)
	Function sets uFR Online IO pin state.

UFR_STATUS DL_API	EspSetReaderTime (IN uint8_t password, IN uint8_t time)
	Function sets the date and time into uFR Online RTC.

UFR_STATUS DL_API	EspSetTransparentReader (uint8_t reader)
	Function sets uFR Online transparent reader.

UFR_STATUS DL_API	EspTurnOff (void)
	Turn off uFR Online device.

UFR_STATUS DL_API	EspTurnOffM (UFR_HANDLE hndUFR)
	Multi reader support. Turn off uFR Online device.

Detailed Description

Functions related to uFR Online series readers only, specifically targetting the embedded ESP32 MCU.

Function Documentation

◆ EspChangeReaderPassword()

UFR_STATUS DL_API EspChangeReaderPassword	(	IN uint8_t *	old_password,
		IN uint8_t *	new_password )

It defines/changes password which I used for:

Writing in EEPROM
Setting date/time of RTC

Parameters

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

◆ EspDisableWifi()

UFR_STATUS DL_API EspDisableWifi ( void )

This option is only avaliable in BT/BLE mode. Disable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned off device restart.

Returns: Operation status

◆ EspDisableWifiM()

UFR_STATUS DL_API EspDisableWifiM ( UFR_HANDLE hndUFR )

Multi reader support. This option is only avaliable in BT/BLE mode. Disable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned off device restart.

Parameters

hndUFR handle of the uFR device

Returns: Operation status

◆ EspEnableOnWifiM()

UFR_STATUS DL_API EspEnableOnWifiM ( UFR_HANDLE hndUFR )

Multi reader support. This option is only avaliable in BT/BLE mode. Enable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned on device restart.

Parameters

hndUFR handle of the uFR device

Returns: Operation status

◆ EspEnableWifi()

UFR_STATUS DL_API EspEnableWifi ( void )

This option is only avaliable in BT/BLE mode. Enable Wifi on uFR Online device when working in BLE/BT mode. This option is saved in flash and Wifi will stay turned on device restart.

Returns: Operation status

◆ EspGetFirmwareVersion()

UFR_STATUS DL_API EspGetFirmwareVersion	(	OUT uint8_t *	major,
		OUT uint8_t *	minor,
		OUT uint8_t *	build )

Returns uFR Online reader firmware version.

Parameters

major	Major firmware version
minor	Minor firmware version
build	Build firmware version

Returns: Operation status

◆ EspGetFirmwareVersionM()

UFR_STATUS DL_API EspGetFirmwareVersionM	(	UFR_HANDLE	hndUFR,
		OUT uint8_t *	major,
		OUT uint8_t *	minor,
		OUT uint8_t *	build )

Multi reader support. Returns uFR Online reader firmware version.

Parameters

hndUFR	handle of the uFR device
major	Major firmware version
minor	Minor firmware version
build	Build firmware version

Returns: Operation status

◆ EspGetIOState()

UFR_STATUS DL_API EspGetIOState ( OUT uint8_t * state )

Function returns 6 bytes array of uint8_t that represented IO pins logic level state.

Parameters

state pointer to the 6 bytes array containing IO pins states

Returns: Operation status

◆ EspGetReaderSerialNumber()

UFR_STATUS DL_API EspGetReaderSerialNumber ( VAR uint32_t * SerialNumber )

Returns uFR Online reader serial number as a pointer to 4 byte value.

Parameters

SerialNumber pointer to SerialNumber variable. “SerialNumber “ as result holds 4 byte serial number value.

Returns: Operation status

◆ EspGetReaderTime()

UFR_STATUS DL_API EspGetReaderTime ( OUT uint8_t * time )

Function returns 6 bytes array of uint8_t that represents current date and time into uFR Online RTC.

Byte 0 represent year (current year - 2000)
Byte 1 represent month (1 - 12)
Byte 2 represent day of the month (1 - 31)
Byte 3 represent hour (0 - 23)
Byte 4 represent minute (0 - 59)
Byte 5 represent second (0 - 59)

Parameters

time	pointer to the array containing current date and time representation

Returns: Operation status

◆ EspReaderEepromRead()

UFR_STATUS DL_API EspReaderEepromRead	(	OUT uint8_t *	data,
		uint32_t	address,
		uint32_t	size )

Function returns array of data read from EEPROM of uFR Online. Maximal length of the array is 128 bytes.

Parameters

data	pointer to array containing data from EEPROM
address	address of first data
size	length of array

Returns: Operation status

◆ EspReaderEepromWrite()

UFR_STATUS DL_API EspReaderEepromWrite	(	IN uint8_t *	data,
		uint32_t	address,
		uint32_t	size,
		IN uint8_t *	password )

Function writes array of data into EEPROM of uFR Online.

Maximal length of the array is 128 bytes. Function requires a password which is 8 bytes. Factory password is “11111111” (0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31).

Parameters

data	pointer to array containing data from EEPROM
address	address of first data
size	length of array
password	pointer to array containing password

Returns: Operation status

◆ EspReaderReset()

UFR_STATUS DL_API EspReaderReset ( void )

Physical reset of uFR reader communication port.

Returns: Operation status

◆ EspSetDisplayData()

UFR_STATUS DL_API EspSetDisplayData	(	IN uint8_t *	display_data,
		IN uint8_t	data_length,
		uint16_t	duration )

Function enables sending data to the uFR Online. A string of data contains information about the intensity of color in each cell of the LED indication.

Each cell has three LEDs (red, green and blue). For each cell of the three bytes is necessary. The first byte indicates the intensity of the green color, the second byte indicates the intensity of the red color, and the third byte indicates the intensity of blue color. For example, if the display has 2 cells, an array contains 6 bytes. Value of intensity is in the range from 0 to 255. On uFR Online, there are 2 cells.From firmware version 2.7.6, RGB LEDs can be connected to pin 5 of P5 connector (GPIO connector - ESP pin 18). First 6 bytes in display_data array will be sent to internal RGB LEDs, additional bytes will be sent to external connected RGB. There is no limit for number of external cells. Array data example: 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF First 6 bytes will be sent to internal RGB and additional 3 bytes will be sent to first cell of external RGB.

Parameters

display_data	pointer to data array
data_length	number of bytes into array
duration	number of milliseconds to light. if value is 0, then rgb will light infinitely

Returns: Operation status

◆ EspSetIOState()

UFR_STATUS DL_API EspSetIOState	(	uint8_t	pin,
		uint8_t	state )

Function sets uFR Online IO pin state.

Parameters

pin	IO pin number (1 - 6)
state	IO pin state 0 - low level, 1 - high level, 2 - input

Returns: Operation status

◆ EspSetReaderTime()

UFR_STATUS DL_API EspSetReaderTime	(	IN uint8_t *	password,
		IN uint8_t *	time )

Function sets the date and time into uFR Online RTC.

Function requires the 8 bytes password entry to set date and time. Date and time are represented into a 6 bytes array in the same way as in EspGetReaderTime function. Factory password is “11111111” (0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31, 0x31).

Parameters

password	pointer to the 8 bytes array containing password
time	pointer to the 6 bytes array containing date and time representation

Returns: Operation status

◆ EspSetTransparentReader()

UFR_STATUS DL_API EspSetTransparentReader ( uint8_t reader )

Function sets uFR Online transparent reader.

Parameters

reader Transparent reader number

Returns: Operation status

◆ EspTurnOff()

UFR_STATUS DL_API EspTurnOff ( void )

Turn off uFR Online device.

Returns: Operation status

◆ EspTurnOffM()

UFR_STATUS DL_API EspTurnOffM ( UFR_HANDLE hndUFR )

Multi reader support. Turn off uFR Online device.

Parameters

hndUFR handle of the uFR device

Returns: Operation status