Component: RFID (MFRC522) (Wireless)
From Flowcode Help
Jump to navigationJump to search| Author | Ben Rowland and STibor |
| Version | 3.0 |
| Category | Wireless |
Contents
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.
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_MFRC522.fcfx
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.
Here is a basic example program to read and modify data stored on a Mifare RFID tag.
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 |
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 | |
|
|
Simulation |
|
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 |
==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 |
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 | |
|
|
Simulation |
|
|
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 |
