uFR library support for Base HD NFC readers

Functions related to toggling BaseHD reader relay and access control. More...

Functions
UFR_STATUS DL_API	UfrOutControlM (UFR_HANDLE hndUFR, uint8_t output_nr, uint8_t invert, uint8_t cycle_nr, uint8_t on_duration, uint8_t off_duration)
	Multi reader support. Function controls the output pin on the reader.
UFR_STATUS DL_API	UfrXrcGetIoStateM (UFR_HANDLE hndUFR, VAR uint8_t *intercom, VAR uint8_t *door, VAR uint8_t *relay_state)
	Multi reader support. Function returns states of 3 IO pins.
UFR_STATUS DL_API	UfrXrcLockOnM (UFR_HANDLE hndUFR, uint16_t pulse_duration)
	Multi reader support. Electric strike switches when the function is called. Pulse duration determined by function.
UFR_STATUS DL_API	UfrXrcRelayStateM (UFR_HANDLE hndUFR, uint8_t state)
	Multi reader support. Function switches relay.

Detailed Description

Functions related to toggling BaseHD reader relay and access control.

Function Documentation

UfrOutControlM()

UFR_STATUS DL_API UfrOutControlM	(	UFR_HANDLE	hndUFR,
		uint8_t	output_nr,
		uint8_t	invert,
		uint8_t	cycle_nr,
		uint8_t	on_duration,
		uint8_t	off_duration )

Multi reader support. Function controls the output pin on the reader.

Parameters

hndUFR	handle of the uFR device
output_nr	ordinal number of hardware specific output pin
invert	1 output is inverted, 0 output is normal
cycle_nr	Number of on-off cycles. If the cycle number is 0, the output state will be infinite, or until this will be changed with the next function call (output state is 1 if the invert is 0, and 0 if invert is 1).
on_duration	On duration in ms. If the invert is 0 output state is 1, and if invert is 1 output state is 0.
off_duration	Off duration in ms. If the invert is 0 output state is 0, and if invert is 1 output state is 1. This state of the output pin remains after the completion of the on-off cycle.

Returns

Operation status

UfrXrcGetIoStateM()

UFR_STATUS DL_API UfrXrcGetIoStateM	(	UFR_HANDLE	hndUFR,
		VAR uint8_t *	intercom,
		VAR uint8_t *	door,
		VAR uint8_t *	relay_state )

Multi reader support. Function returns states of 3 IO pins.

Parameters

hndUFR	handle of the uFR device
intercom	shows that there is voltage at the terminals for intercom connection, or not
door	shows that the door's magnetic switch opened or closed
relay_state	is 1 if relay switch on, and 0 if relay switch off

Returns

Operation status

UfrXrcLockOnM()

UFR_STATUS DL_API UfrXrcLockOnM	(	UFR_HANDLE	hndUFR,
		uint16_t	pulse_duration )

Multi reader support. Electric strike switches when the function is called. Pulse duration determined by function.

Parameters

hndUFR	handle of the uFR device
pulse_duration	pulse_duration is strike switch on period in ms

Returns

Operation status

UfrXrcRelayStateM()

UFR_STATUS DL_API UfrXrcRelayStateM	(	UFR_HANDLE	hndUFR,
		uint8_t	state )

Multi reader support. Function switches relay.

Parameters

hndUFR	handle of the uFR device
state	if the state is 1, then relay is switch on, and if state is 0, then relay is switch off

Returns

Operation status