Difference between revisions of "Component: RFID (BL0197) (E-blocks 2)"
From Flowcode Help
Jump to navigationJump to search|  (XML import) | |||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| style="width:50%" | |
| − | |||
| − | {|  | ||
| |- | |- | ||
| − | | width="20%" style="color: gray;" | Author | + | | width="20%" style="color:gray;" | Author | 
| | Matrix Ltd. | | Matrix Ltd. | ||
| |- | |- | ||
| − | | width="20%" style="color: gray;" | Version | + | | width="20%" style="color:gray;" | Version | 
| − | | 2.0  | + | | 2.0 | 
| |- | |- | ||
| − | | width="20%" style="color: gray;" | Category | + | | width="20%" style="color:gray;" | Category | 
| | E-blocks 2 | | E-blocks 2 | ||
| |} | |} | ||
| + | ==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: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBlocks2_RFID_BL0197.fcfx FC_Comp_Source_EBlocks2_RFID_BL0197.fcfx] | |
| − | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBlocks2_RFID_BL0197.fcfx FC_Comp_Source_EBlocks2_RFID_BL0197.fcfx] | ||
| − | == | + | ==Detailed description== | 
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ''No detailed description exists yet for this component'' | ||
| − | + | ==Examples== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | '' | + | ''<span style="color:red;">No additional examples</span>'' | 
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | ==Macro reference== | ||
| − | '''Return  | + | ===DecrementRFIDValue=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DecrementRFIDValue''' | ||
| + | |- | ||
| + | | colspan="2" | Perfoms a 32-bit decrement on the number held in location page or block.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Src | ||
| + | |- | ||
| + | | colspan="2" | Page / Block  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Dst | ||
| + | |- | ||
| + | | colspan="2" | Page / Block  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Key_Type | ||
| + | |- | ||
| + | | colspan="2" | Needed for MIFARE Commands  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| + | ===FormatRFIDValue=== | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FormatRFIDValue''' | ||
| + | |- | ||
| + | | colspan="2" | Initialises the internal buffer of the Microcontroller so that it is ready to perform a Increment, Decrement or Transfer command.  | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | ''' | + | ===GetRFIDStatus=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRFIDStatus''' | ||
| + | |- | ||
| + | | colspan="2" | Collect the status of the RFID device (see help for the explaination of the status byte).  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| + | ===GetRFIDTypeID=== | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRFIDTypeID''' | ||
| + | |- | ||
| + | | colspan="2" | 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.  | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | :'' | + | ===GetRFIDUID=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRFIDUID''' | ||
| + | |- | ||
| + | | colspan="2" | Collects the UID from a RFID device. Stores the result into the UID buffer and returns the response of the module.  | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | === | + | ===IncrementRFIDValue=== | 
| − | Perfoms a 32-bit increment on the number held in location page or block. | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | 
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IncrementRFIDValue''' | ||
| + | |- | ||
| + | | colspan="2" | Perfoms a 32-bit increment on the number held in location page or block.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Src | ||
| + | |- | ||
| + | | colspan="2" | Page / Block  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Dst | ||
| + | |- | ||
| + | | colspan="2" | Page / Block  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Key_Type | ||
| + | |- | ||
| + | | colspan="2" | Needed for MIFARE Commands  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | :[[ | + | ===Initialise=== | 
| − | :: | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | 
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Configures the RFID device by presetting the Osc type and Mode via the Flowcode component properties.  | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | :[[ | + | ===IsTagPresent=== | 
| − | :: | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | 
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsTagPresent''' | ||
| + | |- | ||
| + | | colspan="2" | Checks to see if a card is present. Returns 0 if no tag is present. Returns 1 if a valid tag is present.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | '''Return  | + | ===ReadRFIDBlock=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRFIDBlock''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a block of information from the RFID device.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Key_Type | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| + | ===ReadRFIDBuffer=== | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRFIDBuffer''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a byte of data from the incoming buffer.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | The address of the buffer 0 - 15  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | ''' | + | ===ReadRFIDUID=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRFIDUID''' | ||
| + | |- | ||
| + | | colspan="2" | Reads a byte of data from the UID buffer.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | The address of the buffer 0 - 7  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | :[[ | + | ===SetBeep=== | 
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBeep''' | ||
| + | |- | ||
| + | | colspan="2" | Allows the buzzer output to be configured  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | BeepDelay | ||
| + | |- | ||
| + | | colspan="2" | 0 = Off, 1 = 40mS, 2 = 80mS, 3 = 120mS etc.  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | :[[ | + | ===SetCardType=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetCardType''' | ||
| + | |- | ||
| + | | colspan="2" | Allows the RFID tag type to be configured  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | TagType | ||
| + | |- | ||
| + | | colspan="2" | 0 = MIFARE, 1 = ICODE, 2 = ISO14443B  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | :[[ | + | ===StoreRFIDKey=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''StoreRFIDKey''' | ||
| + | |- | ||
| + | | colspan="2" | Stores a 6 byte key for use with MIFARE type devices that require authorisation.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Key | ||
| + | |- | ||
| + | | colspan="2" | Key Location 0 - 31  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | D0 | ||
| + | |- | ||
| + | | colspan="2" | Least significant byte of key  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | D1 | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | D2 | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | D3 | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | D4 | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | D5 | ||
| + | |- | ||
| + | | colspan="2" | Most significant byte of key  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| + | ===TransferRFIDValue=== | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransferRFIDValue''' | ||
| + | |- | ||
| + | | colspan="2" | Perfoms a 32-bit block data transfer on the number held in location page or block.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Src | ||
| + | |- | ||
| + | | colspan="2" | Page / Block  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Dst | ||
| + | |- | ||
| + | | colspan="2" | Page / Block  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Key_Type | ||
| + | |- | ||
| + | | colspan="2" | Needed for MIFARE Commands  | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | :[[ | + | ===WriteRFIDBlock=== | 
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRFIDBlock''' | ||
| + | |- | ||
| + | | colspan="2" | Writes a block of information to the RFID device.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | Remote RFID Block Address.  | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Key_Type | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | === | + | ===WriteRFIDBuffer=== | 
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRFIDBuffer''' | |
| − | + | |- | |
| − | + | | colspan="2" | Writes a byte of data to the outgoing buffer.  | |
| − | + | |- | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |
| − | + | | width="90%" | Address | |
| − | + | |- | |
| − | + | | colspan="2" | The address of the buffer 0 - 15  | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |
| − | + | | width="90%" | Data | |
| − | + | |- | |
| − | = | + | | colspan="2" | The data to be stored in the buffer location 0 - 255.  | 
| − | + | |- | |
| − | + | | 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'' | |
| − | + | |} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | = | ||
| − | |||
| − | |||
| − | ''' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | = | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | : | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | = | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ===WriteRFIDModule=== | |
| − | == | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | 
| − | + | |- | |
| − | '' | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | 
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRFIDModule''' | ||
| + | |- | ||
| + | | colspan="2" | Stores a byte of data to the internal EEPROM of the RFID module at the address specified.  | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Data | ||
| + | |- | ||
| + | | colspan="2" |   | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| ==Property reference== | ==Property reference== | ||
| − | |||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''   | |
| − | + | |- | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Card_Type | |
| − | + | |- | |
| − | + | | colspan="2" |   | |
| − | Amount of time to activate the buzzer when detecting a new RFID tag. | + | |- | 
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Beep Delay | |
| − | + | |- | |
| − | + | | colspan="2" | Amount of time to activate the buzzer when detecting a new RFID tag.  | |
| − | + | |- | |
| − | UART Channel selector | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | 
| − | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | |
| − | 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. | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | 
| − | + | | width="90%" | Channel | |
| − | + | |- | |
| − | + | | colspan="2" | 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.  | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | Baud rate option selector | + | | width="90%" | Baud Options | 
| − | + | |- | |
| − | + | | colspan="2" | Baud rate option selector  | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | |
| − | + | | width="90%" | Baud Rate | |
| − | + | |- | |
| − | + | | colspan="2" |   | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | |
| − | + | | width="90%" | TX | |
| − | + | |- | |
| − | + | | colspan="2" | Pin to be used for Transmit data  | |
| − | + | |- | |
| − | Pin to be used for Transmit data | + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | 
| − | + | | width="90%" | RX | |
| − | + | |- | |
| − | + | | colspan="2" | Pin to be used for Receive data  | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | |
| − | Pin to be used for Receive data | + | | width="90%" | Card Detect (LED) | 
| − | + | |- | |
| − | + | | colspan="2" |   | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | |
| − | + | | width="90%" | CTS | |
| − | + | |- | |
| − | + | | colspan="2" |   | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |
| − | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | |
| − | + | |- | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | |
| − | + | | width="90%" | Label | |
| − | + | |- | |
| − | + | | colspan="2" |   | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
| − | + | | width="90%" | Scope Traces | |
| − | + | |- | |
| − | + | | colspan="2" | 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.  | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
| − | + | | width="90%" | Console Data | |
| − | + | |- | |
| − | + | | colspan="2" | Selects if the console data is automatically generated or not  | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | |
| − | + | | width="90%" | Console Columns | |
| − | Selects if the scope traces are automatically added to the data recorder window or not. | + | |- | 
| − | + | | colspan="2" | Number of characters that can be displayed on a single line of the console.  | |
| − |      Simulation - draws an approximation of the UART data onto the scope trace. | + | |- | 
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − |      ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. | + | | width="90%" | Data Source | 
| − | + | |- | |
| − | + | | colspan="2" | 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.  | |
| − | + | |} | |
| − | |||
| − | |||
| − | Selects if the console data is automatically generated or not | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Number of characters that can be displayed on a single line of the console. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | 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   | ||
| − | |||
| − | |||
Latest revision as of 13:10, 7 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 DecrementRFIDValue
- 5.2 FormatRFIDValue
- 5.3 GetRFIDStatus
- 5.4 GetRFIDTypeID
- 5.5 GetRFIDUID
- 5.6 IncrementRFIDValue
- 5.7 Initialise
- 5.8 IsTagPresent
- 5.9 ReadRFIDBlock
- 5.10 ReadRFIDBuffer
- 5.11 ReadRFIDUID
- 5.12 SetBeep
- 5.13 SetCardType
- 5.14 StoreRFIDKey
- 5.15 TransferRFIDValue
- 5.16 WriteRFIDBlock
- 5.17 WriteRFIDBuffer
- 5.18 WriteRFIDModule
 
- 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
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 | 
GetRFIDStatus
|   | GetRFIDStatus | 
| Collect the status of the RFID device (see help for the explaination of the status byte). | |
|  - UINT | Return | 
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 | 
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 | 
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 | 
Initialise
|   | Initialise | 
| Configures the RFID device by presetting the Osc type and Mode via the Flowcode component properties. | |
|  - 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 | 
ReadRFIDBlock
|   | ReadRFIDBlock | 
| Reads a block of information from the RFID device. | |
|  - BYTE | Address | 
|  - BYTE | Key_Type | 
|  - BYTE | Return | 
ReadRFIDBuffer
|   | ReadRFIDBuffer | 
| Reads a byte of data from the incoming buffer. | |
|  - BYTE | Address | 
| The address of the buffer 0 - 15 | |
|  - BYTE | Return | 
ReadRFIDUID
|   | ReadRFIDUID | 
| Reads a byte of data from the UID buffer. | |
|  - BYTE | Address | 
| The address of the buffer 0 - 7 | |
|  - BYTE | Return | 
SetBeep
|   | SetBeep | 
| Allows the buzzer output to be configured | |
|  - BYTE | BeepDelay | 
| 0 = Off, 1 = 40mS, 2 = 80mS, 3 = 120mS etc. | |
|  - BYTE | Return | 
SetCardType
|   | SetCardType | 
| Allows the RFID tag type to be configured | |
|  - BYTE | TagType | 
| 0 = MIFARE, 1 = ICODE, 2 = ISO14443B | |
|  - BYTE | Return | 
StoreRFIDKey
TransferRFIDValue
WriteRFIDBlock
|   | WriteRFIDBlock | 
| Writes a block of information to the RFID device. | |
|  - BYTE | Address | 
| Remote RFID Block Address. | |
|  - BYTE | Key_Type | 
|  - BYTE | Return | 
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 | 
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 | 








