(877)898-1005

0

Orders Over $200 = Free Ground Shipping
Under $200 = Basic Shipping Starts at $3.99
Mailing List
Previous (Project 3) Table of Contents Next (Read Range)

RFIDuino - Appendix A: Library Documentation



The following functions are availble in the RFIDuino Library for Arduino. The library is compatible and has been tested with Arduino 1.0.1.

decodeTag

Syntax:

cardCheck = rfiduino.decodeTag(tag_data)

Description:

This function will scan for a RFID tag being swiped across the RFIDuino antenna. Once a tag has been detected, this function will decode the tag's response into the a 5-byte ID number. This number will then be stored in the reference array, tag_data

Parameters:

tag_data, a referernce to an array of bytes that will hold the ID of the tag

Returns:

A boolean value true if a tag is succefully read. Otherwise a false is returned

Notes:

This function uses the manchester decoding method to convert the tag's response into usable data. See here for a more technical analysis of this decoding method.

transferToBuffer

Syntax:

rfiduino.transferToBuffer(tag_data, tag_data_buffer)

Description:

Transfers the contents of tag_data to tag_data_buffer.

Parameters:

tag_data, a array of 5 bytes, is the transfer source.
tag_data_buffer, a array of 5 bytes, is the transfer target.

Returns:

None

Notes:

This function is a basic loop that moves each value from tag_data to tag_data_buffer.

compareTagData

Syntax:

rfiduino.compareTagData(tag_data_1, tag_data_2)

Description:

Compares the two arrays tag_data_1 and tag_data_2.

Parameters:

< span class="codePhrase">tag_data_1, a array of 5 bytes
tag_data_2, a array of 5 bytes.

Returns:

A boolean true if both arrays are identical. Otherwise a false is returned.

Notes:

This function is a basic loop that compares each value in the two arrays against each other.

errorSound

Syntax:

rfiduino.errorSound()

Description:

Sound 3 monotone notes on the buzzer to indicate an error.

Parameters:

When no parameter is present the function will write to the default buzzer pin for the RFIDuino (pin 5). By including an integer pin number, this can be overridden.

Returns:

None

Notes:

This function uses the Arduino tone() to sound 3 notes. The note frequencies have been choosen to work with the piezo buzzer on the RFIDuino. Some frequencies may work better than others.

successSound

Syntax:

rfiduino.successSound()

Description:

Sound 3 melodic notes on the buzzer to indicate a successful event.

Parameters:

When no parameter is present the function will write to the default buzzer pin for the RFIDuino (pin 5). By including an integer pin number, this can be overridden.

Returns:

None

Notes:

This function uses the Arduino tone() to sound 3 notes. The note frequencies have been choosen to work with the piezo buzzer on the RFIDuino. Some frequencies may work better than others.

Previous (Project 3) Next (Read Range)
robot
robotics shop robots robotics company robot shop
SSL

Shopping Cart Software by AmeriCommerce.