Component: RFID (MFRC522) (Wireless)

Author	Ben Rowland and STibor
Version	3.0
Category	Wireless

RFID (MFRC522) component

Functions designed to work with the MFRC522 contactless reader IC. The MFRC522 supports all variants of the MIFARE Mini, MIFARE 1K, MIFARE 4K, MIFARE Ultralight, MIFARE DESFire EV1 and MIFARE Plus RF identification protocols.

Detailed description

No detailed description exists yet for this component

Examples

Here is a basic example program that reads the UID from a Mifare RFID tag and displays on an LCD. If the UID matches the UID stored in memory then a solenoid will fire allowing a door to be unlocked etc.

Display UID

Here is a basic example program to read and modify data stored on a Mifare RFID tag.

Read Write Test

Downloadable macro reference

	CompareUID
Compares the UID from the ReadCardSerial macro with 4 byte UID. Returns 0 if the addresses match.
- BYTE	Add0
- BYTE	Add1
- BYTE	Add2
- BYTE	Add3
- BYTE	Return

	IsNewCardPresent
Is there a card present for us to communicate with. Returns 0 for no card and 1 for valid card present.
- BYTE	Return

	GetType
Translates the SAK (Select Acknowledge) to a PICC type
- BYTE	sak
The SAK byte returned from PICC_Select
- BYTE	Return

	AntennaOff
Switches off the RFID antenna to save power. The antenna must be switched on again before communicating with an RFID tag.
- VOID	Return

	ReadCardSerial
Simple wrapper around PICC_Select. Returns true if a UID could be read. Remember to call PICC_IsNewCardPresent(), PICC_RequestA() or PICC_WakeupA() first. The read UID is available in the class variable uid.
- BYTE	Return

	MifareWrite
Writes to a block of data on a MIFARE type tag
- BYTE	BlockAddress
- BYTE	Buffer
- BYTE	BufferSize
- BYTE	Return

	Select
- BYTE	ValidBits
- BYTE	Return

	StopCrypto
Used to exit the PCD from its authenticated state. Remember to call this function after communicating with an authenticated PICC - otherwise no new communications can start.
- VOID	Return

	MifareRead
Reads from a block of data on a MIFARE type tag
- BYTE	BlockAddress
- BYTE	Buffer
- BYTE	BufferSize
- BYTE	Return

	Authenticate
This command manages MIFARE authentication to enable a secure communication to any MIFARE Mini, MIFARE 1K and MIFARE 4K card. All keys are set to FFFFFFFFFFFFh at chip delivery. The authentication is described in the MFRC522 datasheet section 10.3.1.9.
- BYTE	Command
PICC_CMD_MF_AUTH_KEY_A or PICC_CMD_MF_AUTH_KEY_B
- BYTE	BlockAddress
The block number
- BYTE	Key
Crypteo key to use
- BYTE	Return

	HaltA
Instructs a PICC in state ACTIVE(*) to go to state HALT
- BYTE	Return

	ReadUIDByte
- BYTE	Index
0-9 = UID Data Bytes, 10 = UID Length, 11 = UID SAK
- BYTE	Return

	AntennaOn
Switches on the RFID antenna. Called as part of the Initialise macro.
- VOID	Return

	Initialise
Initialises the RFID module ready for interaction with RFID tags.
- VOID	Return

	CardBitmap
Displays a monochrome bitmap read from the card on the LCD
- BYTE	X
Range 0-127
- BYTE	Y
Range 0-31
- STRING	Filename
- BYTE	Return

	CardRecordMic
Records an audio stream on the card from the microphone
- BYTE	BitDepth
0=8-bit, 1=16-bit
- BYTE	SampleRate
Sample Rate 0=8KHz, 1=16KHz
- UINT	RecordTime
Time to record for in seconds, Range 0-65535
- STRING	Filename
- BYTE	Return

	CardOpen
Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK
- STRING	Filename
- BYTE	Return

	Forwards
Drives the robot forwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	ReadBearing
Reads the compass bearing based on the degrees clockwise from magnetic north.
[[File:]] -	Return

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
[[File:]] -	Return

	LCDDrawLine
Allows a single pixel width line to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ServoAutoMoveToPosition
Allows one of the servo positions to move gradually to a new position
- BYTE	Channel
Range 0-3
- BYTE	Position
Range 0-255
- VOID	Return

	ReadAllValue
Reads a single value stored from the read all command Index dictates which sensor value to read
- BYTE	Index
0=SW, 1-8=IR, 9-10=Line, 11=Light, 12=Mic, 13-15=Accel
- UINT	Return

	LCDBacklight
Allows the LCD backlight brighntess to be adjusted
- BYTE	Intensity
Range 0-100, 0=Off, 1=Min Brightness, 100=Max Brightness
- VOID	Return

	LCDDrawRect
Allows a rectangle to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ReadLine
Reads one of the IR line sensors 0-1 0=Left, 1=Right
- BYTE	index
0=Left, 1=Right
- UINT	Return

	ServoDisable
Allows one of the servo outputs 0-3 to be disabled
- BYTE	Channel
Range 0-3
- VOID	Return

	ServoEnable
Allows one of the servo outputs 0-3 to be enabled
- BYTE	Channel
Range 0-3
- VOID	Return

	CardReadByte
Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end
- BYTE	Return

	CardErase
Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK
- STRING	Filename
- BYTE	Return

	CardWriteByte
Appends a byte to the end of the currently open file
- BYTE	Data
- VOID	Return

	EncoderRead
Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit.
- BYTE	index
0=Left, 1=Right
- UINT	Return

	SetMotors
Sets the motor speeds without feedback Range -100 to 100
[[File:]] -	Left
Range -100 to 100
[[File:]] -	Right
Range -100 to 100
- VOID	Return

	Backwards
Drives the robot backwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	EncoderReset
Resets the motor encoder counters
- VOID	Return

	LCDVerbose
Allows the LCD to automatically report the API commands as they get processed. Default - verbose on
- BYTE	State
0=Off 1=On
- VOID	Return

	SetProp
Allows the COM port property to be set from a parent component.
- STRING	PropName
- ULONG	PropVal
- VOID	Return

	CardInit
Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK
- BYTE	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	LCDClear
Clears the LCD
- VOID	Return

Property reference

	Properties
	Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Reset
MFRC522 Reset Pin
	Simulations
	Label
	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API