Component: RFID (Sparkfun Quiic / ID-12LA) (15209) (Wireless)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.0 |
| Category | Wireless |
Contents
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 view the component source code (Beta): FC_Comp_Source_RFID_Sparkfun_Quiic.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
ChangeI2CAddress |
| 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. | |
 - BYTE
|
NewAddress |
| Range: 7 to 120 or 0x07 - 0x78 | |
 - BOOL
|
Return |
|
|
RemoveCurrentTag |
| Removes the current Tag ID from the known tag storage. | |
 - VOID
|
Return |
|
|
StoreCurrentTag |
| 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 | |
| - BOOL
|
Return |
|
|
GetTagString |
| 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. | |
 - STRING
|
Return |
|
|
RemoveTagID |
| Removes a specific 6-byte tag ID from the known tag storage | |
| - BYTE
|
ID |
| Array of 6 bytes containing tag ID | |
| - VOID
|
Return |
|
|
GetTimeMS |
| Gets the time in milliseconds since the tag was read by the module. Must be called after CheckForTag has returned true. | |
 - ULONG
|
Return |
|
|
StoreTagID |
| 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 | |
| - BYTE
|
ID |
| Array of 6 bytes containing tag ID | |
| - BOOL
|
Return |
|
|
GetTimeS |
| Gets the time in seconds since the tag was read by the module. Must be called after CheckForTag has returned true. | |
 - UINT
|
Return |
|
|
CheckForTag |
| 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. | |
| - BOOL
|
Return |
|
|
GetTag |
| 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. | |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
IsKnownID |
| Checks to see if the last tag read by CheckForTag is saved into memory. Returns true if tag is stored in memory. | |
| - BOOL
|
Return |
|
|
Initialise |
| Initialises the I2C bus ready for communications with the module. Wipes the tag ID storage ready for data to be stored. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Device Address |
| External device address used to communicate with the module. Default 125 or 0x7D | |
|
|
Stored Tag Count |
| 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. | |
|
Connections |
|
Channel |
| Channel selection | |
|
|
Baud Select |
| Baud rate option selector | |
|
Baud Rate |
| Baud rate to be used | |
|
SDA |
| Pin used for SDA (data signal) | |
|
|
SCL |
| Pin used for SCL (clock signal) | |
|
Stop Delay |
| 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. | |
|
|
Simulation |
|
|
Scope Traces |
| 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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
API |
| Specifies the injector component on the panel to interact with to provide comms simulation. | |
==Macro reference==
|
|
ChangeI2CAddress |
| 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. | |
| - BYTE
|
NewAddress |
| Range: 7 to 120 or 0x07 - 0x78 | |
| - BOOL
|
Return |
|
|
RemoveCurrentTag |
| Removes the current Tag ID from the known tag storage. | |
| - VOID
|
Return |
|
|
StoreCurrentTag |
| 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 | |
| - BOOL
|
Return |
|
|
GetTagString |
| 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. | |
| - STRING
|
Return |
|
|
RemoveTagID |
| Removes a specific 6-byte tag ID from the known tag storage | |
| - BYTE
|
ID |
| Array of 6 bytes containing tag ID | |
| - VOID
|
Return |
|
|
GetTimeMS |
| Gets the time in milliseconds since the tag was read by the module. Must be called after CheckForTag has returned true. | |
| - ULONG
|
Return |
|
|
StoreTagID |
| 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 | |
| - BYTE
|
ID |
| Array of 6 bytes containing tag ID | |
| - BOOL
|
Return |
|
|
GetTimeS |
| Gets the time in seconds since the tag was read by the module. Must be called after CheckForTag has returned true. | |
| - UINT
|
Return |
|
|
CheckForTag |
| 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. | |
| - BOOL
|
Return |
|
|
GetTag |
| 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. | |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
IsKnownID |
| Checks to see if the last tag read by CheckForTag is saved into memory. Returns true if tag is stored in memory. | |
| - BOOL
|
Return |
|
|
Initialise |
| Initialises the I2C bus ready for communications with the module. Wipes the tag ID storage ready for data to be stored. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Device Address |
| External device address used to communicate with the module. Default 125 or 0x7D | |
|
|
Stored Tag Count |
| 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. | |
|
|
Connections |
|
|
Channel |
| Channel selection | |
|
|
Baud Select |
| Baud rate option selector | |
|
|
Baud Rate |
| Baud rate to be used | |
|
|
SDA |
| Pin used for SDA (data signal) | |
|
|
SCL |
| Pin used for SCL (clock signal) | |
|
|
Stop Delay |
| 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. | |
|
|
Simulation |
|
|
Scope Traces |
| 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. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
API |
| Specifies the injector component on the panel to interact with to provide comms simulation. | |
