uFCoder 2.62
Loading...
Searching...
No Matches
uFR library support for Base HD NFC readers

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

Functions

UFR_STATUS DL_API UfrGetInputState (uint8_t input_nr, VAR uint8_t *input_state)
 Function gets the state of the input pin on the reader.
 
UFR_STATUS DL_API UfrOutControl (uint8_t output_nr, uint8_t invert, uint8_t cycle_nr, uint8_t on_duration, uint8_t off_duration)
 Function controls the output pin on the reader.
 
UFR_STATUS DL_API UfrXrcGetIoState (VAR uint8_t *intercom, VAR uint8_t *door, VAR uint8_t *relay_state)
 Function returns states of 3 IO pins.
 
UFR_STATUS DL_API UfrXrcLockOn (uint16_t pulse_duration)
 Electric strike switches when the function is called. Pulse duration determined by function.
 
UFR_STATUS DL_API UfrXrcRelayState (uint8_t state)
 Function switches relay.
 

Detailed Description

Functions related to toggling BaseHD reader relay and access control.

Function Documentation

◆ UfrGetInputState()

UFR_STATUS DL_API UfrGetInputState ( uint8_t input_nr,
VAR uint8_t * input_state )

Function gets the state of the input pin on the reader.

Parameters
input_nrordinal number of hardware specific input pin input_state input state 1 or 0.
input_stateinput state 1 or 0.
Returns
Operation status

◆ UfrOutControl()

UFR_STATUS DL_API UfrOutControl ( uint8_t output_nr,
uint8_t invert,
uint8_t cycle_nr,
uint8_t on_duration,
uint8_t off_duration )

Function controls the output pin on the reader.

Parameters
output_nrordinal number of hardware specific output pin
invert1 output is inverted, 0 output is normal
cycle_nrNumber 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_durationOn duration in ms. If the invert is 0 output state is 1, and if invert is 1 output state is 0.
off_durationOff 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

◆ UfrXrcGetIoState()

UFR_STATUS DL_API UfrXrcGetIoState ( VAR uint8_t * intercom,
VAR uint8_t * door,
VAR uint8_t * relay_state )

Function returns states of 3 IO pins.

Parameters
intercomshows that there is voltage at the terminals for intercom connection, or notss
doorshows that the door's magnetic switch opened or closed
relay_stateis 1 if relay switch on, and 0 if relay switch off
Returns
Operation status

◆ UfrXrcLockOn()

UFR_STATUS DL_API UfrXrcLockOn ( uint16_t pulse_duration)

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

Parameters
pulse_durationpulse_duration is strike switch on period in ms
Returns
Operation status

◆ UfrXrcRelayState()

UFR_STATUS DL_API UfrXrcRelayState ( uint8_t state)

Function switches relay.

Parameters
stateif the state is 1, then relay is switch on, and if state is 0, then relay is switch off
Returns
Operation status