Jump to content

Component: RFID (MFRC522) (Wireless): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
 
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Ben Rowland and STibor
| Ben Rowland and STibor
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 3.0 (Release)
| 3.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Wireless
| 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.


==[[File:Component Icon 3f8d29a6_40a6_4d5e_a254_190c86d9ebb7.png|Image]] RFID (MFRC522) component==
==Component Source Code==
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.


==Examples==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_MFRC522.fcfx FC_Comp_Source_MFRC522.fcfx]
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.


{{Fcfile|MFRC522_UID_Test.fcfx|Display UID}}
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_MFRC522.fcfx FC_Comp_Source_MFRC522.fcfx]


==Detailed description==


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


{{Fcfile|MFRC522_Read_Write.fcfx|Read Write Test}}


==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>CompareUID</tt></u></span>===
Compares the UID from the ReadCardSerial macro with 4 byte UID.


Returns 0 if the addresses match.


'''Parameters'''


:[[Variable Types|BYTE]] ''Add0''


:[[Variable Types|BYTE]] ''Add1''


:[[Variable Types|BYTE]] ''Add2''


:[[Variable Types|BYTE]] ''Add3''




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>IsNewCardPresent</tt></u></span>===
Is there a card present for us to communicate with.


Returns 0 for no card and 1 for valid card present.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>GetType</tt></u></span>===
''No detailed description exists yet for this component''
Translates the SAK (Select Acknowledge) to a PICC type


'''Parameters'''
==Examples==


:[[Variable Types|BYTE]] ''sak''
::The SAK byte returned from PICC_Select




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>AntennaOff</tt></u></span>===
Switches off the RFID antenna to save power.


The antenna must be switched on again before communicating with an RFID tag.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ReadCardSerial</tt></u></span>===
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.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>MifareWrite</tt></u></span>===
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.
Writes to a block of data on a MIFARE type tag


'''Parameters'''
{{Fcfile|MFRC522_UID_Test.fcfx|Display UID}}


:[[Variable Types|BYTE]] ''BlockAddress''


:[[Variable Types|BYTE]] ''Buffer''
Here is a basic example program to read and modify data stored on a Mifare RFID tag.


:[[Variable Types|BYTE]] ''BufferSize''
{{Fcfile|MFRC522_Read_Write.fcfx|Read Write Test}}




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>Select</tt></u></span>===
''<span style="color:red;">No additional information</span>''






'''Parameters'''


:[[Variable Types|BYTE]] ''ValidBits''




'''Return value'''
==Macro reference==


:[[Variable Types|BYTE]]
===AntennaOff===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''AntennaOff'''
|-
| colspan="2" | Switches off the RFID antenna to save power. The antenna must be switched on again before communicating with an RFID tag.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>StopCrypto</tt></u></span>===
===AntennaOn===
Used to exit the PCD from its authenticated state.
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''AntennaOn'''
|-
| colspan="2" | Switches on the RFID antenna. Called as part of the Initialise macro.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


Remember to call this function after communicating with an authenticated PICC - otherwise no new communications can start.


'''Parameters'''
===Authenticate===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Authenticate'''
|-
| colspan="2" | 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Command
|-
| colspan="2" | PICC_CMD_MF_AUTH_KEY_A or PICC_CMD_MF_AUTH_KEY_B&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BlockAddress
|-
| colspan="2" | The block number&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Key
|-
| colspan="2" | Crypteo key to use&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This macro has no parameters''


===CompareUID===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''CompareUID'''
|-
| colspan="2" | Compares the UID from the ReadCardSerial macro with 4 byte UID. Returns 0 if the addresses match.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Add0
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Add1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Add2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Add3
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Return value'''


:''This call does not return a value''
===GetType===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetType'''
|-
| colspan="2" | Translates the SAK (Select Acknowledge) to a PICC type&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | sak
|-
| colspan="2" | The SAK byte returned from PICC_Select&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>MifareRead</tt></u></span>===
===HaltA===
Reads from a block of data on a MIFARE type tag
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''HaltA'''
|-
| colspan="2" | Instructs a PICC in state ACTIVE(*) to go to state HALT&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''BlockAddress''
===Initialise===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
| colspan="2" | Initialises the RFID module ready for interaction with RFID tags.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Buffer''


:[[Variable Types|BYTE]] ''BufferSize''
===IsNewCardPresent===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''IsNewCardPresent'''
|-
| colspan="2" | Is there a card present for us to communicate with.  Returns 0 for no card and 1 for valid card present.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
===MifareRead===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''MifareRead'''
|-
| colspan="2" | Reads from a block of data on a MIFARE type tag&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BlockAddress
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Buffer
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BufferSize
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]]


===MifareWrite===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''MifareWrite'''
|-
| colspan="2" | Writes to a block of data on a MIFARE type tag&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BlockAddress
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Buffer
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | BufferSize
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>Authenticate</tt></u></span>===
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.
===ReadCardSerial===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadCardSerial'''
|-
| colspan="2" | 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.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


The authentication is described in the MFRC522 datasheet section 10.3.1.9.


'''Parameters'''
===ReadUIDByte===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadUIDByte'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | 0-9 = UID Data Bytes, 10 = UID Length, 11 = UID SAK&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Command''
::PICC_CMD_MF_AUTH_KEY_A or PICC_CMD_MF_AUTH_KEY_B


:[[Variable Types|BYTE]] ''BlockAddress''
===Select===
::The block number
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Select'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ValidBits
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''Key''
::Crypteo key to use
'''Return value'''
:[[Variable Types|BYTE]]
===<span style="font-weight: normal;"><u><tt>HaltA</tt></u></span>===
Instructs a PICC in state ACTIVE(*) to go to state HALT
'''Parameters'''
:''This macro has no parameters''
'''Return value'''
:[[Variable Types|BYTE]]
===<span style="font-weight: normal;"><u><tt>ReadUIDByte</tt></u></span>===
''<span style="color:red;">No additional information</span>''
'''Parameters'''
:[[Variable Types|BYTE]] ''Index''
::0-9 = UID Data Bytes, 10 = UID Length, 11 = UID SAK
'''Return value'''
:[[Variable Types|BYTE]]
===<span style="font-weight: normal;"><u><tt>AntennaOn</tt></u></span>===
Switches on the RFID antenna.
Called as part of the Initialise macro.
'''Parameters'''
:''This macro has no parameters''
'''Return value'''
:''This call does not return a value''
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
Initialises the RFID module ready for interaction with RFID tags.
'''Parameters'''
:''This macro has no parameters''


 
===StopCrypto===
'''Return value'''
{| class="mtx-class-macrotable wikitable"
 
|-
:''This call does not return a value''
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
 
| width="90%" class="mtx-class-macrohead" | '''StopCrypto'''
 
|-
 
| colspan="2" | 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.&nbsp;
==Simulation macro reference==
|-
 
|-
''This component does not contain any simulation macros''
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Channel</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::CHANNEL''.
{| class="mtx-class-macrotable wikitable"
 
|-
SPI Channel selector
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
<span style="font-weight: normal;"><u>Prescale</u></span>
|-
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::PR_SCALE''.
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Connections
Prescale option selector
|-
 
|-
<span style="font-weight: normal;"><u>MOSI</u></span>
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Channel
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::MOSI''.
|-
 
| colspan="2" | SPI Channel selector&nbsp;
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
<span style="font-weight: normal;"><u>MISO</u></span>
| width="90%" | Prescale
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::MISO''.
| colspan="2" | Prescale option selector&nbsp;
 
|-
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | MOSI
<span style="font-weight: normal;"><u>CLK</u></span>
|-
 
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::CLK''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
| width="90%" | MISO
 
|-
<span style="font-weight: normal;"><u>CS / SS</u></span>
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::SS''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | CLK
Chip Select / Slave Select Pin  
|-
 
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
Master Mode: General purpose output pin used to select the remote SPI device.
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
Slave Mode: Hardware chip select pin input used to select the SPI device.
| width="90%" | CS / SS
 
|-
<span style="font-weight: normal;"><u>Reset</u></span>
| colspan="2" | 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. &nbsp;
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''reset''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | Reset
MFRC522 Reset Pin
|-
 
| colspan="2" | MFRC522 Reset Pin &nbsp;
<span style="font-weight: normal;"><u>Label</u></span>
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
| width="90%" class="mtx-class-propfolder" | Simulation
 
|-
''<span style="color:red;">No additional information</span>''
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="90%" | Label
 
|-
<span style="font-weight: normal;"><u>Scope Traces</u></span>
| colspan="2" | &nbsp;
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi::ScopeTraces''.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Scope Traces
Selects if the scope traces are automatically generated or not
|-
 
| colspan="2" | Selects if the scope traces are automatically generated or not&nbsp;
<span style="font-weight: normal;"><u>Console Data</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi::ConsoleData''.
| width="90%" | Console Data
 
|-
Selects if the console data is automatically generated or not
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
 
|-
<span style="font-weight: normal;"><u>Injector</u></span>
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | API
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::Injector''.
|-
 
| colspan="2" | &nbsp;
''<span style="color:red;">No additional information</span>''
|}

Latest revision as of 14:37, 13 July 2026

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.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_MFRC522.fcfx

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.

Display UID


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

Read Write Test






Macro reference

AntennaOff

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


AntennaOn

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


Authenticate

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


CompareUID

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


GetType

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


HaltA

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


Initialise

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


IsNewCardPresent

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


MifareRead

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


MifareWrite

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


ReadCardSerial

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


ReadUIDByte

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


Select

Select
 
- BYTE ValidBits
 
- BYTE Return


StopCrypto

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


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
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_RFID_(MFRC522)_(Wireless)&oldid=48143"