Component: RFID (EB052, RWD MICODE) (Wireless)

Author	Matrix Ltd.
Version	2.0
Category	Wireless

RFID (EB052, RWD-MICODE) component

Low level routines for controlling a RF Solutions RFID interface Allows communications between Mifare, ICode and HiTag type RFID tags. Also available in the form of the EB052 RFID E-block.

Detailed description

No detailed description exists yet for this component

Examples

Reading the status

The status of the RFID module is read using the "GetRFIDStatus" macro which returns a byte which is then displayed using the PORTB pins. RFID Status Status byte breakdown for Mifare.

Status byte breakdown for ICode.

Status byte breakdown for HiTag.

Status byte breakdown for EM Marin.

Reading and Writing Data

Example which talks to a ICode type card and allows the data to be read and written via a keypad. RFID Read/Write

Macro compatibility

Not all the macros can be used with all card types, here is a list of RFID transponder types and the macros that are compatible.

Downloadable 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

	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

	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

	ReadRXSignalStrength
Returns the current received signal strength.
- BYTE	Return

	Uninitialise
Powers down the RF module. The module must be re-initialised before it can be used again.
- VOID	Return

	CheckBuffer
Checks for incoming data for a specific period of time. Returns a value greater then 250 to indicate a failure. Returns the length of the incoming data buffer to indicate success.
- BYTE	Timeout
Time to wait before returning no data available
- BYTE	Return

	GetBufferData
Returns a value from the incoming receive data buffer.
- BYTE	Index
Specifies which position in the buffer to read data from
- BYTE	Return

	ReceiveString
Puts the RF module in data mode and attempts to receive a string of bytes from the RF connection.
- BYTE	Length
Specifies the maximum number of bytes to try and receive
- BYTE	Timeout
Specifies how many milliseconds to wait for valid data before returning.
- STRING	Return

	Initialise
Starts up and configures the RF module ready for use. The macro will return a value greater then 0 if the module has been started correctly, otherwise the macro will return a 0.
- BYTE	Return

	Initialise
Sets up the 1-Wire output pin ready for communications.
- VOID	Return

	Initialise
Starts up the UART to allow communications and initialises the states of the various Modbus Coils, Inputs and Registers to 0.
- VOID	Return

	Initialise
Initialises the MIDI component and sets up the UART.
- VOID	Return

	CommsBaud
Sets the Baud rate of the alt communications channel
- BYTE	Baud
Range: 0-7 : 0=1200 / 7=115200
- VOID	Return

	LCDOptions
Controls some of the LCD options
- BYTE	Foreground
Range: 0-1
- BYTE	Background
Range: 0-1
- BYTE	Transparent
Range: 0-1
- VOID	Return

	LCDVerbose
Controls the Verbose mode. When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required.
- BYTE	Mode
Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode
- VOID	Return

	ReadDigitalInput
Reads a single digital input.
- BYTE	Channel
- BYTE	Return

	PWMConfig
Sets the PWM configuration. Channel = 0 - 1 : 0 = EN_AB, A, B / 1 = EN_CD, C, D Period = 0 - 65535 Scaler = 0 - 3 : 0=1:1 1=1:8 2=1:64 3=1:256
- BYTE	Channel
Range 0-1
- UINT	Period
Range: 0-65535
- BYTE	Scaler
Range: 0-3
- VOID	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	PWMDuty
Sets a single PWM channel duty. Channel = 0 - 5 : 0=EN_AB, 1=A, 2=B, 3=C, 4=D, 5=EN_CD Duty = 0 - 65535
- BYTE	Channel
Range 0-5
- UINT	Duty
- VOID	Return

	LCDCursor
Sets the cursor position for the MIAC display
- BYTE	X
Range: 0-21
- BYTE	Y
Range: 0-4
- VOID	Return

	WriteTran
Allows a single transistor output to be switched on or off.
- BYTE	Channel
Range 1-4
- BYTE	Value
0 = Off, 1 = On
- VOID	Return

	Initialise
- VOID	Return

	LCDClear
Clears the MIAC display
- VOID	Return

Property reference

	Properties
	Card_Type
	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
	CTS
	Simulations
	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.