View source for Component: RFID (Sparkfun Quiic / ID-12LA) (15209) (Wireless)

From Flowcode Help

← Component: RFID (Sparkfun Quiic / ID-12LA) (15209) (Wireless)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;" | Category | Wireless |} ==RFID (Sparkfun Quiic / ID-12LA) component== Provides functions to drive the Sparkfun Quiic RFID reader module (ID-12LA). Allowing access to read 125KHz RFID tags. Suitable for applications such as tracking, logging or access control. ==Component Source Code== Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_RFID_Sparkfun_Quiic.fcfx FC_Comp_Source_RFID_Sparkfun_Quiic.fcfx] Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_RFID_Sparkfun_Quiic.fcfx FC_Comp_Source_RFID_Sparkfun_Quiic.fcfx] ==Detailed description== ''No detailed description exists yet for this component'' ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Macro reference== ===ChangeI2CAddress=== {| 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;" | '''ChangeI2CAddress''' |- | colspan="2" | Allows the I2C Device address to be changed which in turn allows more then one RFID reader to sit on the same physical I2C bus. Returns 1 if succesful.&nbsp; |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | NewAddress |- | colspan="2" | Range: 7 to 120 or 0x07 - 0x78&nbsp; |- | 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'' |} ===CheckForTag=== {| 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;" | '''CheckForTag''' |- | colspan="2" | Checks to see if a tag has been detected by the module. Returns 1 if tag has been detected. Tag ID and Time since read can be accessed using GetTag and GetTime macros.&nbsp; |- |- | 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'' |} ===GetTag=== {| 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;" | '''GetTag''' |- | colspan="2" | Gets the tag ID returned as a byte array. Must be called after CheckForTag has returned true. Byte array variable should be at least 6 bytes long.&nbsp; |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Data |- | colspan="2" | &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'' |} ===GetTagString=== {| 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;" | '''GetTagString''' |- | colspan="2" | Gets the tag ID returned as a string. Must be called after CheckForTag has returned true. String variable should be at least 13 characters long.&nbsp; |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetTimeMS=== {| 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;" | '''GetTimeMS''' |- | colspan="2" | Gets the time in milliseconds since the tag was read by the module. Must be called after CheckForTag has returned true.&nbsp; |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetTimeS=== {| 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;" | '''GetTimeS''' |- | colspan="2" | Gets the time in seconds since the tag was read by the module. Must be called after CheckForTag has returned true.&nbsp; |- |- | 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'' |} ===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" | Initialises the I2C bus ready for communications with the module. Wipes the tag ID storage ready for data to be stored.&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'' |} ===IsKnownID=== {| 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;" | '''IsKnownID''' |- | colspan="2" | Checks to see if the last tag read by CheckForTag is saved into memory. Returns true if tag is stored in memory.&nbsp; |- |- | 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'' |} ===RemoveCurrentTag=== {| 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;" | '''RemoveCurrentTag''' |- | colspan="2" | Removes the current Tag ID from the known tag storage.&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'' |} ===RemoveTagID=== {| 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;" | '''RemoveTagID''' |- | colspan="2" | Removes a specific 6-byte tag ID from the known tag storage&nbsp; |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | ID |- | colspan="2" | Array of 6 bytes containing tag ID&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'' |} ===StoreCurrentTag=== {| 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;" | '''StoreCurrentTag''' |- | colspan="2" | Stores the current detected tag as a known tag storage Returns true if the tag has been stored or false if there is no remaining room&nbsp; |- |- | 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'' |} ===StoreTagID=== {| 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;" | '''StoreTagID''' |- | colspan="2" | Stores a specific 6-byte tag ID into the known storage Returns true if the tag has been stored or false if there is no remaining room&nbsp; |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | ID |- | colspan="2" | Array of 6 bytes containing tag ID&nbsp; |- | 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'' |} ==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-21-icon.png]] | width="90%" | Device Address |- | colspan="2" | External device address used to communicate with the module. Default 125 or 0x7D&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Stored Tag Count |- | colspan="2" | Number of tags IDs to store as valid IDs for use with IsKnownID. For example max number of users for a door entry system. Each stored ID requires 6 bytes of RAM memory. Max 42.&nbsp; |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Channel |- | colspan="2" | Channel selection&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Baud Select |- | colspan="2" | Baud rate option selector&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Baud Rate |- | colspan="2" | Baud rate to be used&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | SDA |- | colspan="2" | Pin used for SDA (data signal)&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | SCL |- | colspan="2" | Pin used for SCL (clock signal)&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Stop Delay |- | colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications. &nbsp; |- | 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-7-icon.png]] | width="90%" | Scope Traces |- | colspan="2" | Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.&nbsp; |- | 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&nbsp; |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | API |- | colspan="2" | Specifies the injector component on the panel to interact with to provide comms simulation.&nbsp; |}

Return to Component: RFID (Sparkfun Quiic / ID-12LA) (15209) (Wireless).