Struct NfcRfidBricklet

pub struct NfcRfidBricklet { /* private fields */ }

Reads and writes NFC and RFID tags

Implementations

impl NfcRfidBricklet

pub const DEVICE_IDENTIFIER: u16 = 246u16

pub const DEVICE_DISPLAY_NAME: &'static str = "NFC/RFID Bricklet"

pub fn new(uid: Uid, connection: AsyncIpConnection) -> NfcRfidBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

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 sent 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.

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 sent and errors are silently ignored, because they cannot be detected.

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.

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

pub async fn get_state_changed_callback_receiver( &mut self, ) -> impl Stream<Item = StateChangedEvent>

This receiver is called if the state of the NFC/RFID Bricklet changes. See get_state for more information about the possible states.

pub async fn request_tag_id( &mut self, tag_type: u8, ) -> Result<(), TinkerforgeError>

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_RFID_BRICKLET_TAG_TYPE_MIFARE_CLASSIC
• NFC_RFID_BRICKLET_TAG_TYPE_TYPE1
• NFC_RFID_BRICKLET_TAG_TYPE_TYPE2

pub async fn get_tag_id(&mut self) -> Result<TagId, TinkerforgeError>

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:

1. Call [request_tag_id]
2. Wait for state to change to RequestTagIDReady (see [get_state] or [get_state_changed_callback_receiver] receiver)
3. Call [get_tag_id]

Associated constants:

• NFC_RFID_BRICKLET_TAG_TYPE_MIFARE_CLASSIC
• NFC_RFID_BRICKLET_TAG_TYPE_TYPE1
• NFC_RFID_BRICKLET_TAG_TYPE_TYPE2

pub async fn get_state(&mut self) -> Result<State, TinkerforgeError>

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_RFID_BRICKLET_STATE_INITIALIZATION
• NFC_RFID_BRICKLET_STATE_IDLE
• NFC_RFID_BRICKLET_STATE_ERROR
• NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID
• NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_READY
• NFC_RFID_BRICKLET_STATE_REQUEST_TAG_ID_ERROR
• NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE
• NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY
• NFC_RFID_BRICKLET_STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR
• NFC_RFID_BRICKLET_STATE_WRITE_PAGE
• NFC_RFID_BRICKLET_STATE_WRITE_PAGE_READY
• NFC_RFID_BRICKLET_STATE_WRITE_PAGE_ERROR
• NFC_RFID_BRICKLET_STATE_REQUEST_PAGE
• NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_READY
• NFC_RFID_BRICKLET_STATE_REQUEST_PAGE_ERROR

pub async fn authenticate_mifare_classic_page( &mut self, page: u16, key_number: u8, key: &[u8; 6], ) -> Result<(), TinkerforgeError>

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. Call [request_tag_id]
2. Wait for state to change to RequestTagIDReady (see [get_state] or [get_state_changed_callback_receiver] receiver)
3. 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
4. Call [authenticate_mifare_classic_page] with page and key for the page
5. Wait for state to change to AuthenticatingMifareClassicPageReady (see [get_state] or [get_state_changed_callback_receiver] receiver)
6. Call [request_page] or [write_page] to read/write page

Associated constants:

• NFC_RFID_BRICKLET_KEY_A
• NFC_RFID_BRICKLET_KEY_B

pub async fn write_page( &mut self, page: u16, data: &[u8; 16], ) -> Result<(), TinkerforgeError>

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. Call [request_tag_id]
2. Wait for state to change to RequestTagIDReady (see [get_state] or [get_state_changed_callback_receiver] receiver)
3. 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
4. Call [write_page] with page number and data
5. Wait for state to change to WritePageReady (see [get_state] or [get_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].

pub async fn request_page(&mut self, page: u16) -> Result<(), TinkerforgeError>

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:

1. Call [request_tag_id]
2. Wait for state to change to RequestTagIDReady (see [get_state] or [get_state_changed_callback_receiver] receiver)
3. 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
4. Call [request_page] with page number
5. Wait for state to change to RequestPageReady (see [get_state] or [get_state_changed_callback_receiver] receiver)
6. 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].

pub async fn get_page(&mut self) -> Result<Box<[u8; 16]>, TinkerforgeError>

Returns 16 bytes of data from an internal buffer. To fill the buffer with specific pages you have to call [request_page] beforehand.

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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 Isolator Bricklet is always at position ‘z’.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for NfcRfidBricklet

fn clone(&self) -> NfcRfidBricklet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.