Package com.tinkerforge
Class BrickletNFCRFID
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletNFCRFID
-
public class BrickletNFCRFID extends Device
Reads and writes NFC and RFID tags
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletNFCRFID.State
static interface
BrickletNFCRFID.StateChangedListener
This listener is called if the state of the NFC/RFID Bricklet changes.class
BrickletNFCRFID.TagID
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletNFCRFID(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addStateChangedListener(BrickletNFCRFID.StateChangedListener listener)
Adds a StateChanged listener.void
authenticateMifareClassicPage(int page, short keyNumber, short[] key)
Mifare Classic tags use authentication.Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.short[]
getPage()
Returns 16 bytes of data from an internal buffer.BrickletNFCRFID.State
getState()
Returns the current state of the NFC/RFID Bricklet.BrickletNFCRFID.TagID
getTagID()
Returns the tag type, tag ID and the length of the tag ID (4 or 7 bytes are possible length).void
removeStateChangedListener(BrickletNFCRFID.StateChangedListener listener)
Removes a StateChanged listener.void
requestPage(int page)
Reads 16 bytes starting from the given page and stores them into a buffer.void
requestTagID(short tagType)
To read or write a tag that is in proximity of the NFC/RFID Bricklet you first have to call this function with the expected tag type as parameter.void
writePage(int page, short[] data)
Writes 16 bytes starting from the given page.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_REQUEST_TAG_ID
public static final byte FUNCTION_REQUEST_TAG_ID
- See Also:
- Constant Field Values
-
FUNCTION_GET_TAG_ID
public static final byte FUNCTION_GET_TAG_ID
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATE
public static final byte FUNCTION_GET_STATE
- See Also:
- Constant Field Values
-
FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE
public static final byte FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_PAGE
public static final byte FUNCTION_WRITE_PAGE
- See Also:
- Constant Field Values
-
FUNCTION_REQUEST_PAGE
public static final byte FUNCTION_REQUEST_PAGE
- See Also:
- Constant Field Values
-
FUNCTION_GET_PAGE
public static final byte FUNCTION_GET_PAGE
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
TAG_TYPE_MIFARE_CLASSIC
public static final short TAG_TYPE_MIFARE_CLASSIC
- See Also:
- Constant Field Values
-
TAG_TYPE_TYPE1
public static final short TAG_TYPE_TYPE1
- See Also:
- Constant Field Values
-
TAG_TYPE_TYPE2
public static final short TAG_TYPE_TYPE2
- See Also:
- Constant Field Values
-
STATE_INITIALIZATION
public static final short STATE_INITIALIZATION
- See Also:
- Constant Field Values
-
STATE_IDLE
public static final short STATE_IDLE
- See Also:
- Constant Field Values
-
STATE_ERROR
public static final short STATE_ERROR
- See Also:
- Constant Field Values
-
STATE_REQUEST_TAG_ID
public static final short STATE_REQUEST_TAG_ID
- See Also:
- Constant Field Values
-
STATE_REQUEST_TAG_ID_READY
public static final short STATE_REQUEST_TAG_ID_READY
- See Also:
- Constant Field Values
-
STATE_REQUEST_TAG_ID_ERROR
public static final short STATE_REQUEST_TAG_ID_ERROR
- See Also:
- Constant Field Values
-
STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE
public static final short STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE
- See Also:
- Constant Field Values
-
STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY
public static final short STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY
- See Also:
- Constant Field Values
-
STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR
public static final short STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR
- See Also:
- Constant Field Values
-
STATE_WRITE_PAGE
public static final short STATE_WRITE_PAGE
- See Also:
- Constant Field Values
-
STATE_WRITE_PAGE_READY
public static final short STATE_WRITE_PAGE_READY
- See Also:
- Constant Field Values
-
STATE_WRITE_PAGE_ERROR
public static final short STATE_WRITE_PAGE_ERROR
- See Also:
- Constant Field Values
-
STATE_REQUEST_PAGE
public static final short STATE_REQUEST_PAGE
- See Also:
- Constant Field Values
-
STATE_REQUEST_PAGE_READY
public static final short STATE_REQUEST_PAGE_READY
- See Also:
- Constant Field Values
-
STATE_REQUEST_PAGE_ERROR
public static final short STATE_REQUEST_PAGE_ERROR
- See Also:
- Constant Field Values
-
KEY_A
public static final short KEY_A
- See Also:
- Constant Field Values
-
KEY_B
public static final short KEY_B
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletNFCRFID
public BrickletNFCRFID(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
requestTagID
public void requestTagID(short tagType) throws TinkerforgeException
To read or write a tag that is in proximity of the NFC/RFID Bricklet you first have to call this function with the expected tag type as parameter. It is no problem if you don't know the tag type. You can cycle through the available tag types until the tag gives an answer to the request. Currently the following tag types are supported: * Mifare Classic * NFC Forum Type 1 * NFC Forum Type 2 After you callrequestTagID(short)
the NFC/RFID Bricklet will try to read the tag ID from the tag. After this process is done the state will change. You can either register theBrickletNFCRFID.StateChangedListener
listener or you can pollgetState()
to find out about the state change. If the state changes to *RequestTagIDError* it means that either there was no tag present or that the tag is of an incompatible type. If the state changes to *RequestTagIDReady* it means that a compatible tag was found and that the tag ID could be read out. You can now get the tag ID by callinggetTagID()
. If two tags are in the proximity of the NFC/RFID Bricklet, this function will cycle through the tags. To select a specific tag you have to callrequestTagID(short)
until the correct tag id is found. In case of any *Error* state the selection is lost and you have to start again by callingrequestTagID(short)
.- Throws:
TinkerforgeException
-
getTagID
public BrickletNFCRFID.TagID getTagID() throws TinkerforgeException
Returns the tag type, tag ID and the length of the tag ID (4 or 7 bytes are possible length). This function can only be called if the NFC/RFID is currently in one of the *Ready* states. The returned ID is the ID that was saved through the last call ofrequestTagID(short)
. To get the tag ID of a tag the approach is as follows: 1. CallrequestTagID(short)
2. Wait for state to change to *RequestTagIDReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) 3. CallgetTagID()
- Throws:
TinkerforgeException
-
getState
public BrickletNFCRFID.State getState() throws TinkerforgeException
Returns the current state of the NFC/RFID Bricklet. On startup the Bricklet will be in the *Initialization* state. The initialization will only take about 20ms. After that it changes to *Idle*. The functions of this Bricklet can be called in the *Idle* state and all of the *Ready* and *Error* states. Example: If you callrequestPage(int)
, the state will change to *RequestPage* until the reading of the page is finished. Then it will change to either *RequestPageReady* if it worked or to *RequestPageError* if it didn't. If the request worked you can get the page by callinggetPage()
. The same approach is used analogously for the other API functions.- Throws:
TinkerforgeException
-
authenticateMifareClassicPage
public void authenticateMifareClassicPage(int page, short keyNumber, short[] key) throws TinkerforgeException
Mifare Classic tags use authentication. If you want to read from or write to a Mifare Classic page you have to authenticate it beforehand. Each page can be authenticated with two keys: A (``key_number`` = 0) and B (``key_number`` = 1). A new Mifare Classic tag that has not yet been written to can be accessed with key A and the default key ``[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]``. The approach to read or write a Mifare Classic page is as follows: 1. CallrequestTagID(short)
2. Wait for state to change to *RequestTagIDReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) 3. If looking for a specific tag then callgetTagID()
and check if the expected tag was found, if it was not found go back to step 1 4. CallauthenticateMifareClassicPage(int, short, short[])
with page and key for the page 5. Wait for state to change to *AuthenticatingMifareClassicPageReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) 6. CallrequestPage(int)
orwritePage(int, short[])
to read/write page- Throws:
TinkerforgeException
-
writePage
public void writePage(int page, short[] data) throws TinkerforgeException
Writes 16 bytes starting from the given page. How many pages are written depends on the tag type. The page sizes are as follows: * Mifare Classic page size: 16 byte (one page is written) * NFC Forum Type 1 page size: 8 byte (two pages are written) * NFC Forum Type 2 page size: 4 byte (four pages are written) The general approach for writing to a tag is as follows: 1. CallrequestTagID(short)
2. Wait for state to change to *RequestTagIDReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) 3. If looking for a specific tag then callgetTagID()
and check if the expected tag was found, if it was not found got back to step 1 4. CallwritePage(int, short[])
with page number and data 5. Wait for state to change to *WritePageReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) If you use a Mifare Classic tag you have to authenticate a page before you can write to it. SeeauthenticateMifareClassicPage(int, short, short[])
.- Throws:
TinkerforgeException
-
requestPage
public void requestPage(int page) throws TinkerforgeException
Reads 16 bytes starting from the given page and stores them into a buffer. The buffer can then be read out withgetPage()
. How many pages are read depends on the tag type. The page sizes are as follows: * Mifare Classic page size: 16 byte (one page is read) * NFC Forum Type 1 page size: 8 byte (two pages are read) * NFC Forum Type 2 page size: 4 byte (four pages are read) The general approach for reading a tag is as follows: 1. CallrequestTagID(short)
2. Wait for state to change to *RequestTagIDReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) 3. If looking for a specific tag then callgetTagID()
and check if the expected tag was found, if it was not found got back to step 1 4. CallrequestPage(int)
with page number 5. Wait for state to change to *RequestPageReady* (seegetState()
orBrickletNFCRFID.StateChangedListener
listener) 6. CallgetPage()
to retrieve the page from the buffer If you use a Mifare Classic tag you have to authenticate a page before you can read it. SeeauthenticateMifareClassicPage(int, short, short[])
.- Throws:
TinkerforgeException
-
getPage
public short[] getPage() throws TinkerforgeException
Returns 16 bytes of data from an internal buffer. To fill the buffer with specific pages you have to callrequestPage(int)
beforehand.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier. The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addStateChangedListener
public void addStateChangedListener(BrickletNFCRFID.StateChangedListener listener)
Adds a StateChanged listener.
-
removeStateChangedListener
public void removeStateChangedListener(BrickletNFCRFID.StateChangedListener listener)
Removes a StateChanged listener.
-
-