Struct tinkerforge::nfc_rfid_bricklet::NfcRfidBricklet
source · pub struct NfcRfidBricklet { /* private fields */ }
Expand description
Reads and writes NFC and RFID tags
Implementations
sourceimpl NfcRfidBricklet
impl NfcRfidBricklet
pub const DEVICE_IDENTIFIER: u16 = 246u16
pub const DEVICE_DISPLAY_NAME: &'static str = "NFC/RFID Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> NfcRfidBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> NfcRfidBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: NfcRfidBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: NfcRfidBrickletFunction
) -> Result<bool, GetResponseExpectedError>
Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.
For getter functions this is enabled by default and cannot be disabled, because those
functions will always send a response. For callback configuration functions it is enabled
by default too, but can be disabled by set_response_expected
.
For setter functions it is disabled by default and can be enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
See set_response_expected
for the list of function ID constants available for this function.
sourcepub fn set_response_expected(
&mut self,
fun: NfcRfidBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: NfcRfidBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
pub fn set_response_expected_all(&mut self, response_expected: bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
sourcepub fn get_state_changed_callback_receiver(
&self
) -> ConvertingCallbackReceiver<StateChangedEvent>
pub fn get_state_changed_callback_receiver(
&self
) -> ConvertingCallbackReceiver<StateChangedEvent>
This receiver is called if the state of the NFC/RFID Bricklet changes.
See Get State
for more information about the possible states.
sourcepub fn request_tag_id(&self, tag_type: u8) -> ConvertingReceiver<()>
pub fn request_tag_id(&self, tag_type: u8) -> ConvertingReceiver<()>
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 call Request Tag ID
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 the get_state_changed_callback_receiver
receiver or you can poll
Get State
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
calling Get Tag ID
.
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 call Request Tag ID
until the correct tag id is found.
In case of any Error state the selection is lost and you have to
start again by calling Request Tag ID
.
Associated constants:
- NFC_RFIDBRICKLET_TAG_TYPE_MIFARE_CLASSIC
- NFC_RFIDBRICKLET_TAG_TYPE_TYPE1
- NFC_RFIDBRICKLET_TAG_TYPE_TYPE2
sourcepub fn get_tag_id(&self) -> ConvertingReceiver<TagId>
pub fn get_tag_id(&self) -> ConvertingReceiver<TagId>
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 of Request Tag ID
.
To get the tag ID of a tag the approach is as follows:
- Call
Request Tag ID
- Wait for state to change to RequestTagIDReady (see
Get State
orget_state_changed_callback_receiver
receiver) - Call
Get Tag ID
Associated constants:
- NFC_RFIDBRICKLET_TAG_TYPE_MIFARE_CLASSIC
- NFC_RFIDBRICKLET_TAG_TYPE_TYPE1
- NFC_RFIDBRICKLET_TAG_TYPE_TYPE2
sourcepub fn get_state(&self) -> ConvertingReceiver<State>
pub fn get_state(&self) -> ConvertingReceiver<State>
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 call Request Page
, 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 calling Get Page
.
The same approach is used analogously for the other API functions.
Associated constants:
- NFC_RFIDBRICKLET_STATE_INITIALIZATION
- NFC_RFIDBRICKLET_STATE_IDLE
- NFC_RFIDBRICKLET_STATE_ERROR
- NFC_RFIDBRICKLET_STATE_REQUEST_TAG_ID
- NFC_RFIDBRICKLET_STATE_REQUEST_TAG_ID_READY
- NFC_RFIDBRICKLET_STATE_REQUEST_TAG_ID_ERROR
- NFC_RFIDBRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE
- NFC_RFIDBRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY
- NFC_RFIDBRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR
- NFC_RFIDBRICKLET_STATE_WRITE_PAGE
- NFC_RFIDBRICKLET_STATE_WRITE_PAGE_READY
- NFC_RFIDBRICKLET_STATE_WRITE_PAGE_ERROR
- NFC_RFIDBRICKLET_STATE_REQUEST_PAGE
- NFC_RFIDBRICKLET_STATE_REQUEST_PAGE_READY
- NFC_RFIDBRICKLET_STATE_REQUEST_PAGE_ERROR
sourcepub fn authenticate_mifare_classic_page(
&self,
page: u16,
key_number: u8,
key: [u8; 6]
) -> ConvertingReceiver<()>
pub fn authenticate_mifare_classic_page(
&self,
page: u16,
key_number: u8,
key: [u8; 6]
) -> ConvertingReceiver<()>
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:
- Call
Request Tag ID
- Wait for state to change to RequestTagIDReady (see
Get State
orget_state_changed_callback_receiver
receiver) - If looking for a specific tag then call
Get Tag ID
and check if the expected tag was found, if it was not found go back to step 1 - Call
Authenticate Mifare Classic Page
with page and key for the page - Wait for state to change to AuthenticatingMifareClassicPageReady (see
Get State
orget_state_changed_callback_receiver
receiver) - Call
Request Page
orWrite Page
to read/write page
Associated constants:
- NFC_RFIDBRICKLET_KEY_A
- NFC_RFIDBRICKLET_KEY_B
sourcepub fn write_page(&self, page: u16, data: [u8; 16]) -> ConvertingReceiver<()>
pub fn write_page(&self, page: u16, data: [u8; 16]) -> ConvertingReceiver<()>
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:
- Call
Request Tag ID
- Wait for state to change to RequestTagIDReady (see
Get State
orget_state_changed_callback_receiver
receiver) - If looking for a specific tag then call
Get Tag ID
and check if the expected tag was found, if it was not found got back to step 1 - Call
Write Page
with page number and data - Wait for state to change to WritePageReady (see
Get State
orget_state_changed_callback_receiver
receiver)
If you use a Mifare Classic tag you have to authenticate a page before you
can write to it. See Authenticate Mifare Classic Page
.
sourcepub fn request_page(&self, page: u16) -> ConvertingReceiver<()>
pub fn request_page(&self, page: u16) -> ConvertingReceiver<()>
Reads 16 bytes starting from the given page and stores them into a buffer.
The buffer can then be read out with Get Page
.
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:
- Call
Request Tag ID
- Wait for state to change to RequestTagIDReady (see
Get State
orget_state_changed_callback_receiver
receiver) - If looking for a specific tag then call
Get Tag ID
and check if the expected tag was found, if it was not found got back to step 1 - Call
Request Page
with page number - Wait for state to change to RequestPageReady (see
Get State
orget_state_changed_callback_receiver
receiver) - Call
Get Page
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. See Authenticate Mifare Classic Page
.
sourcepub fn get_page(&self) -> ConvertingReceiver<[u8; 16]>
pub fn get_page(&self) -> ConvertingReceiver<[u8; 16]>
Returns 16 bytes of data from an internal buffer. To fill the buffer
with specific pages you have to call Request Page
beforehand.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
pub fn get_identity(&self) -> ConvertingReceiver<Identity>
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’ or ‘d’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations
sourceimpl Clone for NfcRfidBricklet
impl Clone for NfcRfidBricklet
sourcefn clone(&self) -> NfcRfidBricklet
fn clone(&self) -> NfcRfidBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more