Component: RFID (BL0197) (E-blocks 2)

Author	Matrix Ltd.
Version	2.0
Category	E-blocks 2

RFID (BL0197) component

Low level routines for controlling a BL0197 RFID E-block 2 board. Complete with macros to control the tag type and buzzer parameters.

Component Source Code

Please click here to view the component source code (Beta): FC_Comp_Source_EBlocks2_RFID_BL0197.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	GetRFIDTypeID
Collects the 3 bytes required to determine which kind of MIFARE device is present. Stores the result into the local buffer 0 - 2 and returns the response of the module.
- BYTE	Return

	SetCardType
Allows the RFID tag type to be configured
- BYTE	TagType
0 = MIFARE, 1 = ICODE, 2 = ISO14443B
- BYTE	Return

	WriteRFIDBlock
Writes a block of information to the RFID device.
- BYTE	Address
Remote RFID Block Address.
- BYTE	Key_Type
- BYTE	Return

	WriteRFIDModule
Stores a byte of data to the internal EEPROM of the RFID module at the address specified.
- BYTE	Address
- BYTE	Data
- BYTE	Return

	DecrementRFIDValue
Perfoms a 32-bit decrement on the number held in location page or block.
- BYTE	Src
Page / Block
- BYTE	Dst
Page / Block
- BYTE	Key_Type
Needed for MIFARE Commands
- BYTE	Return

	FormatRFIDValue
Initialises the internal buffer of the Microcontroller so that it is ready to perform a Increment, Decrement or Transfer command.
- VOID	Return

	IncrementRFIDValue
Perfoms a 32-bit increment on the number held in location page or block.
- BYTE	Src
Page / Block
- BYTE	Dst
Page / Block
- BYTE	Key_Type
Needed for MIFARE Commands
- BYTE	Return

	StoreRFIDKey
Stores a 6 byte key for use with MIFARE type devices that require authorisation.
- BYTE	Key
Key Location 0 - 31
- BYTE	D0
Least significant byte of key
- BYTE	D1
- BYTE	D2
- BYTE	D3
- BYTE	D4
- BYTE	D5
Most significant byte of key
- BYTE	Return

	WriteRFIDBuffer
Writes a byte of data to the outgoing buffer.
- BYTE	Address
The address of the buffer 0 - 15
- BYTE	Data
The data to be stored in the buffer location 0 - 255.
- VOID	Return

	GetRFIDStatus
Collect the status of the RFID device (see help for the explaination of the status byte).
- UINT	Return

	ReadRFIDBuffer
Reads a byte of data from the incoming buffer.
- BYTE	Address
The address of the buffer 0 - 15
- BYTE	Return

	TransferRFIDValue
Perfoms a 32-bit block data transfer on the number held in location page or block.
- BYTE	Src
Page / Block
- BYTE	Dst
Page / Block
- BYTE	Key_Type
Needed for MIFARE Commands
- BYTE	Return

	GetRFIDUID
Collects the UID from a RFID device. Stores the result into the UID buffer and returns the response of the module.
- BYTE	Return

	ReadRFIDUID
Reads a byte of data from the UID buffer.
- BYTE	Address
The address of the buffer 0 - 7
- BYTE	Return

	IsTagPresent
Checks to see if a card is present. Returns 0 if no tag is present. Returns 1 if a valid tag is present.
- BOOL	Return

	SetBeep
Allows the buzzer output to be configured
- BYTE	BeepDelay
0 = Off, 1 = 40mS, 2 = 80mS, 3 = 120mS etc.
- BYTE	Return

	ReadRFIDBlock
Reads a block of information from the RFID device.
- BYTE	Address
- BYTE	Key_Type
- BYTE	Return

	Initialise
Configures the RFID device by presetting the Osc type and Mode via the Flowcode component properties.
- BYTE	Return

Property reference

	Properties
	Card_Type
	Beep Delay
Amount of time to activate the buzzer when detecting a new RFID tag.
	Connections
	Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.
	Baud Options
Baud rate option selector
	Baud Rate
	TX
Pin to be used for Transmit data
	RX
Pin to be used for Receive data
	Card Detect (LED)
	CTS
	Simulation
	Label
	Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel.

==Macro reference==

	GetRFIDTypeID
Collects the 3 bytes required to determine which kind of MIFARE device is present. Stores the result into the local buffer 0 - 2 and returns the response of the module.
- BYTE	Return

	SetCardType
Allows the RFID tag type to be configured
- BYTE	TagType
0 = MIFARE, 1 = ICODE, 2 = ISO14443B
- BYTE	Return

	WriteRFIDBlock
Writes a block of information to the RFID device.
- BYTE	Address
Remote RFID Block Address.
- BYTE	Key_Type
- BYTE	Return

	WriteRFIDModule
Stores a byte of data to the internal EEPROM of the RFID module at the address specified.
- BYTE	Address
- BYTE	Data
- BYTE	Return

	DecrementRFIDValue
Perfoms a 32-bit decrement on the number held in location page or block.
- BYTE	Src
Page / Block
- BYTE	Dst
Page / Block
- BYTE	Key_Type
Needed for MIFARE Commands
- BYTE	Return

	FormatRFIDValue
Initialises the internal buffer of the Microcontroller so that it is ready to perform a Increment, Decrement or Transfer command.
- VOID	Return

	IncrementRFIDValue
Perfoms a 32-bit increment on the number held in location page or block.
- BYTE	Src
Page / Block
- BYTE	Dst
Page / Block
- BYTE	Key_Type
Needed for MIFARE Commands
- BYTE	Return

	StoreRFIDKey
Stores a 6 byte key for use with MIFARE type devices that require authorisation.
- BYTE	Key
Key Location 0 - 31
- BYTE	D0
Least significant byte of key
- BYTE	D1
- BYTE	D2
- BYTE	D3
- BYTE	D4
- BYTE	D5
Most significant byte of key
- BYTE	Return

	WriteRFIDBuffer
Writes a byte of data to the outgoing buffer.
- BYTE	Address
The address of the buffer 0 - 15
- BYTE	Data
The data to be stored in the buffer location 0 - 255.
- VOID	Return

	GetRFIDStatus
Collect the status of the RFID device (see help for the explaination of the status byte).
- UINT	Return

	ReadRFIDBuffer
Reads a byte of data from the incoming buffer.
- BYTE	Address
The address of the buffer 0 - 15
- BYTE	Return

	TransferRFIDValue
Perfoms a 32-bit block data transfer on the number held in location page or block.
- BYTE	Src
Page / Block
- BYTE	Dst
Page / Block
- BYTE	Key_Type
Needed for MIFARE Commands
- BYTE	Return

	GetRFIDUID
Collects the UID from a RFID device. Stores the result into the UID buffer and returns the response of the module.
- BYTE	Return

	ReadRFIDUID
Reads a byte of data from the UID buffer.
- BYTE	Address
The address of the buffer 0 - 7
- BYTE	Return

	IsTagPresent
Checks to see if a card is present. Returns 0 if no tag is present. Returns 1 if a valid tag is present.
- BOOL	Return

	SetBeep
Allows the buzzer output to be configured
- BYTE	BeepDelay
0 = Off, 1 = 40mS, 2 = 80mS, 3 = 120mS etc.
- BYTE	Return

	ReadRFIDBlock
Reads a block of information from the RFID device.
- BYTE	Address
- BYTE	Key_Type
- BYTE	Return

	Initialise
Configures the RFID device by presetting the Osc type and Mode via the Flowcode component properties.
- BYTE	Return

Property reference

	Properties
	Card_Type
	Beep Delay
Amount of time to activate the buzzer when detecting a new RFID tag.
	Connections
	Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.
	Baud Options
Baud rate option selector
	Baud Rate
	TX
Pin to be used for Transmit data
	RX
Pin to be used for Receive data
	Card Detect (LED)
	CTS
	Simulation
	Label
	Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel.