Difference between revisions of "Component: RFID (BL0197) (E-blocks 2)"
From Flowcode Help
Jump to navigationJump to searchLine 49: | Line 49: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
+ | |||
+ | |||
Line 55: | Line 57: | ||
==Macro reference== | ==Macro reference== | ||
+ | ===GetRFIDTypeID=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 68: | Line 71: | ||
+ | ===SetCardType=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 86: | Line 90: | ||
+ | ===WriteRFIDBlock=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 109: | Line 114: | ||
+ | ===WriteRFIDModule=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 132: | Line 138: | ||
+ | ===DecrementRFIDValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 160: | Line 167: | ||
+ | ===FormatRFIDValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 173: | Line 181: | ||
+ | ===IncrementRFIDValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 201: | Line 210: | ||
+ | ===StoreRFIDKey=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 249: | Line 259: | ||
+ | ===WriteRFIDBuffer=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 272: | Line 283: | ||
+ | ===GetRFIDStatus=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 285: | Line 297: | ||
+ | ===ReadRFIDBuffer=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 303: | Line 316: | ||
+ | ===TransferRFIDValue=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 331: | Line 345: | ||
+ | ===GetRFIDUID=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 344: | Line 359: | ||
+ | ===ReadRFIDUID=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 362: | Line 378: | ||
+ | ===IsTagPresent=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 375: | Line 392: | ||
+ | ===SetBeep=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 393: | Line 411: | ||
+ | ===ReadRFIDBlock=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 416: | Line 435: | ||
+ | ===Initialise=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- |
Revision as of 11:49, 3 February 2023
Author | Matrix Ltd. |
Version | 2.0 |
Category | E-blocks 2 |
Contents
- 1 RFID (BL0197) component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 GetRFIDTypeID
- 5.2 SetCardType
- 5.3 WriteRFIDBlock
- 5.4 WriteRFIDModule
- 5.5 DecrementRFIDValue
- 5.6 FormatRFIDValue
- 5.7 IncrementRFIDValue
- 5.8 StoreRFIDKey
- 5.9 WriteRFIDBuffer
- 5.10 GetRFIDStatus
- 5.11 ReadRFIDBuffer
- 5.12 TransferRFIDValue
- 5.13 GetRFIDUID
- 5.14 ReadRFIDUID
- 5.15 IsTagPresent
- 5.16 SetBeep
- 5.17 ReadRFIDBlock
- 5.18 Initialise
- 6 Property reference
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 download the component source project: FC_Comp_Source_EBlocks2_RFID_BL0197.fcfx
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
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
SetCardType | |
Allows the RFID tag type to be configured | |
- BYTE | TagType |
0 = MIFARE, 1 = ICODE, 2 = ISO14443B | |
- BYTE | Return |
WriteRFIDBlock
WriteRFIDBlock | |
Writes a block of information to the RFID device. | |
- BYTE | Address |
Remote RFID Block Address. | |
- BYTE | Key_Type |
- BYTE | Return |
WriteRFIDModule
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
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
FormatRFIDValue | |
Initialises the internal buffer of the Microcontroller so that it is ready to perform a Increment, Decrement or Transfer command. | |
- VOID | Return |
IncrementRFIDValue
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
WriteRFIDBuffer
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
GetRFIDStatus | |
Collect the status of the RFID device (see help for the explaination of the status byte). | |
- UINT | Return |
ReadRFIDBuffer
ReadRFIDBuffer | |
Reads a byte of data from the incoming buffer. | |
- BYTE | Address |
The address of the buffer 0 - 15 | |
- BYTE | Return |
TransferRFIDValue
GetRFIDUID
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
ReadRFIDUID | |
Reads a byte of data from the UID buffer. | |
- BYTE | Address |
The address of the buffer 0 - 7 | |
- BYTE | Return |
IsTagPresent
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
SetBeep | |
Allows the buzzer output to be configured | |
- BYTE | BeepDelay |
0 = Off, 1 = 40mS, 2 = 80mS, 3 = 120mS etc. | |
- BYTE | Return |
ReadRFIDBlock
ReadRFIDBlock | |
Reads a block of information from the RFID device. | |
- BYTE | Address |
- BYTE | Key_Type |
- BYTE | Return |
Initialise
Initialise | |
Configures the RFID device by presetting the Osc type and Mode via the Flowcode component properties. | |
- BYTE | Return |