TCP/IP - NFC Bricklet

This is the description of the TCP/IP protocol for the NFC Bricklet. General information and technical specifications for the NFC Bricklet are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletNFC.set_mode
Function ID:
  • 1
Request:
  • mode – Type: uint8, Range: See meanings, Default: 0
Response:
  • no response

Sets the mode. The NFC Bricklet supports four modes:

  • Off
  • Card Emulation (Cardemu): Emulates a tag for other readers
  • Peer to Peer (P2P): Exchange data with other readers
  • Reader: Reads and writes tags

If you change a mode, the Bricklet will reconfigure the hardware for this mode. Therefore, you can only use functions corresponding to the current mode. For example, in Reader mode you can only use Reader functions.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Off
  • 1 = Cardemu
  • 2 = P2P
  • 3 = Reader
  • 4 = Simple
BrickletNFC.get_mode
Function ID:
  • 2
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings, Default: 0

Returns the mode as set by set_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Off
  • 1 = Cardemu
  • 2 = P2P
  • 3 = Reader
  • 4 = Simple
BrickletNFC.reader_request_tag_id
Function ID:
  • 3
Request:
  • empty payload
Response:
  • no response

After you call reader_request_tag_id the NFC 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 CALLBACK_READER_STATE_CHANGED callback or you can poll reader_get_state to find out about the state change.

If the state changes to ReaderRequestTagIDError it means that either there was no tag present or that the tag has an incompatible type. If the state changes to ReaderRequestTagIDReady it means that a compatible tag was found and that the tag ID has been saved. You can now read out the tag ID by calling reader_get_tag_id_low_level.

If two tags are in the proximity of the NFC Bricklet, this function will cycle through the tags. To select a specific tag you have to call reader_request_tag_id until the correct tag ID is found.

In case of any ReaderError state the selection is lost and you have to start again by calling reader_request_tag_id.

BrickletNFC.reader_get_tag_id_low_level
Function ID:
  • 4
Request:
  • empty payload
Response:
  • tag_type – Type: uint8, Range: See meanings
  • tag_id_length – Type: uint8, Range: [0 to 32]
  • tag_id_data – Type: uint8[32], Range: [0 to 255]

Returns the tag type and the tag ID. This function can only be called if the NFC Bricklet is currently in one of the ReaderReady states. The returned tag ID is the tag ID that was saved through the last call of reader_request_tag_id.

To get the tag ID of a tag the approach is as follows:

  1. Call reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  3. Call reader_get_tag_id_low_level

The following meanings are defined for the elements of this function:

For tag_type:

  • 0 = Mifare Classic
  • 1 = Type1
  • 2 = Type2
  • 3 = Type3
  • 4 = Type4
BrickletNFC.reader_get_state
Function ID:
  • 5
Request:
  • empty payload
Response:
  • state – Type: uint8, Range: See meanings
  • idle – Type: bool

Returns the current reader state of the NFC Bricklet.

On startup the Bricklet will be in the ReaderInitialization state. The initialization will only take about 20ms. After that it changes to ReaderIdle.

The Bricklet is also reinitialized if the mode is changed, see set_mode.

The functions of this Bricklet can be called in the ReaderIdle state and all of the ReaderReady and ReaderError states.

Example: If you call reader_request_page, the state will change to ReaderRequestPage until the reading of the page is finished. Then it will change to either ReaderRequestPageReady if it worked or to ReaderRequestPageError if it didn't. If the request worked you can get the page by calling reader_read_page_low_level.

The same approach is used analogously for the other API functions.

The following meanings are defined for the elements of this function:

For state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Request Tag ID
  • 130 = Request Tag ID Ready
  • 194 = Request Tag ID Error
  • 3 = Authenticate Mifare Classic Page
  • 131 = Authenticate Mifare Classic Page Ready
  • 195 = Authenticate Mifare Classic Page Error
  • 4 = Write Page
  • 132 = Write Page Ready
  • 196 = Write Page Error
  • 5 = Request Page
  • 133 = Request Page Ready
  • 197 = Request Page Error
  • 6 = Write NDEF
  • 134 = Write NDEF Ready
  • 198 = Write NDEF Error
  • 7 = Request NDEF
  • 135 = Request NDEF Ready
  • 199 = Request NDEF Error
BrickletNFC.reader_write_ndef_low_level
Function ID:
  • 6
Request:
  • ndef_length – Type: uint16, Range: [0 to 213]
  • ndef_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • ndef_chunk_data – Type: uint8[60], Range: [0 to 255]
Response:
  • no response

Writes NDEF formated data.

This function currently supports NFC Forum Type 2 and 4.

The general approach for writing a NDEF message is as follows:

  1. Call reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call reader_get_tag_id_low_level and check if the expected tag was found, if it was not found got back to step 1
  4. Call reader_write_ndef_low_level with the NDEF message that you want to write
  5. Wait for state to change to ReaderWriteNDEFReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
BrickletNFC.reader_request_ndef
Function ID:
  • 7
Request:
  • empty payload
Response:
  • no response

Reads NDEF formated data from a tag.

This function currently supports NFC Forum Type 1, 2, 3 and 4.

The general approach for reading a NDEF message is as follows:

  1. Call reader_request_tag_id
  2. Wait for state to change to RequestTagIDReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call reader_get_tag_id_low_level and check if the expected tag was found, if it was not found got back to step 1
  4. Call reader_request_ndef
  5. Wait for state to change to ReaderRequestNDEFReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  6. Call reader_read_ndef_low_level to retrieve the NDEF message from the buffer
BrickletNFC.reader_read_ndef_low_level
Function ID:
  • 8
Request:
  • empty payload
Response:
  • ndef_length – Type: uint16, Range: [0 to 213]
  • ndef_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • ndef_chunk_data – Type: uint8[60], Range: [0 to 255]

Returns the NDEF data from an internal buffer. To fill the buffer with a NDEF message you have to call reader_request_ndef beforehand.

BrickletNFC.reader_authenticate_mifare_classic_page
Function ID:
  • 9
Request:
  • page – Type: uint16, Range: [0 to 216 - 1]
  • key_number – Type: uint8, Range: See meanings
  • key – Type: uint8[6], Range: [0 to 255]
Response:
  • no response

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 reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call reader_get_tag_id_low_level and check if the expected tag was found, if it was not found got back to step 1
  4. Call reader_authenticate_mifare_classic_page with page and key for the page
  5. Wait for state to change to ReaderAuthenticatingMifareClassicPageReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  6. Call reader_request_page or reader_write_page_low_level to read/write page

The authentication will always work for one whole sector (4 pages).

The following meanings are defined for the elements of this function:

For key_number:

  • 0 = A
  • 1 = B
BrickletNFC.reader_write_page_low_level
Function ID:
  • 10
Request:
  • page – Type: uint16, Range: See meanings
  • data_length – Type: uint16, Range: [0 to 213]
  • data_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • data_chunk_data – Type: uint8[58], Range: [0 to 255]
Response:
  • no response

Writes a maximum of 8192 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
  • NFC Forum Type 1 page size: 8 byte
  • NFC Forum Type 2 page size: 4 byte
  • NFC Forum Type 3 page size: 16 byte
  • NFC Forum Type 4: No pages, page = file selection (CC or NDEF, see below)

The general approach for writing to a tag is as follows:

  1. Call reader_request_tag_id
  2. Wait for state to change to ReaderRequestTagIDReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call reader_get_tag_id_low_level and check if the expected tag was found, if it was not found got back to step 1
  4. Call reader_write_page_low_level with page number and data
  5. Wait for state to change to ReaderWritePageReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)

If you use a Mifare Classic tag you have to authenticate a page before you can write to it. See reader_authenticate_mifare_classic_page.

NFC Forum Type 4 tags are not organized into pages but different files. We currently support two files: Capability Container file (CC) and NDEF file.

Choose CC by setting page to 3 or NDEF by setting page to 4.

The following meanings are defined for the elements of this function:

For page:

  • 3 = Type4 Capability Container
  • 4 = Type4 NDEF
BrickletNFC.reader_request_page
Function ID:
  • 11
Request:
  • page – Type: uint16, Range: See meanings
  • length – Type: uint16, Range: [0 to 213]
Response:
  • no response

Reads a maximum of 8192 bytes starting from the given page and stores them into a buffer. The buffer can then be read out with reader_read_page_low_level. How many pages are read depends on the tag type. The page sizes are as follows:

  • Mifare Classic page size: 16 byte
  • NFC Forum Type 1 page size: 8 byte
  • NFC Forum Type 2 page size: 4 byte
  • NFC Forum Type 3 page size: 16 byte
  • NFC Forum Type 4: No pages, page = file selection (CC or NDEF, see below)

The general approach for reading a tag is as follows:

  1. Call reader_request_tag_id
  2. Wait for state to change to RequestTagIDReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  3. If looking for a specific tag then call reader_get_tag_id_low_level and check if the expected tag was found, if it was not found got back to step 1
  4. Call reader_request_page with page number
  5. Wait for state to change to ReaderRequestPageReady (see reader_get_state or CALLBACK_READER_STATE_CHANGED callback)
  6. Call reader_read_page_low_level 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 reader_authenticate_mifare_classic_page.

NFC Forum Type 4 tags are not organized into pages but different files. We currently support two files: Capability Container file (CC) and NDEF file.

Choose CC by setting page to 3 or NDEF by setting page to 4.

The following meanings are defined for the elements of this function:

For page:

  • 3 = Type4 Capability Container
  • 4 = Type4 NDEF
BrickletNFC.reader_read_page_low_level
Function ID:
  • 12
Request:
  • empty payload
Response:
  • data_length – Type: uint16, Range: [0 to 213]
  • data_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • data_chunk_data – Type: uint8[60], Range: [0 to 255]

Returns the page data from an internal buffer. To fill the buffer with specific pages you have to call reader_request_page beforehand.

BrickletNFC.cardemu_get_state
Function ID:
  • 14
Request:
  • empty payload
Response:
  • state – Type: uint8, Range: See meanings
  • idle – Type: bool

Returns the current cardemu state of the NFC Bricklet.

On startup the Bricklet will be in the CardemuInitialization state. The initialization will only take about 20ms. After that it changes to CardemuIdle.

The Bricklet is also reinitialized if the mode is changed, see set_mode.

The functions of this Bricklet can be called in the CardemuIdle state and all of the CardemuReady and CardemuError states.

Example: If you call cardemu_start_discovery, the state will change to CardemuDiscover until the discovery is finished. Then it will change to either CardemuDiscoverReady if it worked or to CardemuDiscoverError if it didn't.

The same approach is used analogously for the other API functions.

The following meanings are defined for the elements of this function:

For state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Discover
  • 130 = Discover Ready
  • 194 = Discover Error
  • 3 = Transfer NDEF
  • 131 = Transfer NDEF Ready
  • 195 = Transfer NDEF Error
BrickletNFC.cardemu_start_discovery
Function ID:
  • 15
Request:
  • empty payload
Response:
  • no response

Starts the discovery process. If you call this function while a NFC reader device is near to the NFC Bricklet the state will change from CardemuDiscovery to CardemuDiscoveryReady.

If no NFC reader device can be found or if there is an error during discovery the cardemu state will change to CardemuDiscoveryError. In this case you have to restart the discovery process.

If the cardemu state changes to CardemuDiscoveryReady you can start the NDEF message transfer with cardemu_write_ndef_low_level and cardemu_start_transfer.

BrickletNFC.cardemu_write_ndef_low_level
Function ID:
  • 16
Request:
  • ndef_length – Type: uint16, Range: [0 to 255]
  • ndef_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • ndef_chunk_data – Type: uint8[60], Range: [0 to 255]
Response:
  • no response

Writes the NDEF message that is to be transferred to the NFC peer.

The maximum supported NDEF message size in Cardemu mode is 255 byte.

You can call this function at any time in Cardemu mode. The internal buffer will not be overwritten until you call this function again or change the mode.

BrickletNFC.cardemu_start_transfer
Function ID:
  • 17
Request:
  • transfer – Type: uint8, Range: See meanings
Response:
  • no response

You can start the transfer of a NDEF message if the cardemu state is CardemuDiscoveryReady.

Before you call this function to start a write transfer, the NDEF message that is to be transferred has to be written via cardemu_write_ndef_low_level first.

After you call this function the state will change to CardemuTransferNDEF. It will change to CardemuTransferNDEFReady if the transfer was successful or CardemuTransferNDEFError if it wasn't.

The following meanings are defined for the elements of this function:

For transfer:

  • 0 = Abort
  • 1 = Write
BrickletNFC.p2p_get_state
Function ID:
  • 19
Request:
  • empty payload
Response:
  • state – Type: uint8, Range: See meanings
  • idle – Type: bool

Returns the current P2P state of the NFC Bricklet.

On startup the Bricklet will be in the P2PInitialization state. The initialization will only take about 20ms. After that it changes to P2PIdle.

The Bricklet is also reinitialized if the mode is changed, see set_mode.

The functions of this Bricklet can be called in the P2PIdle state and all of the P2PReady and P2PError states.

Example: If you call p2p_start_discovery, the state will change to P2PDiscover until the discovery is finished. Then it will change to either P2PDiscoverReady* if it worked or to P2PDiscoverError if it didn't.

The same approach is used analogously for the other API functions.

The following meanings are defined for the elements of this function:

For state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Discover
  • 130 = Discover Ready
  • 194 = Discover Error
  • 3 = Transfer NDEF
  • 131 = Transfer NDEF Ready
  • 195 = Transfer NDEF Error
BrickletNFC.p2p_start_discovery
Function ID:
  • 20
Request:
  • empty payload
Response:
  • no response

Starts the discovery process. If you call this function while another NFC P2P enabled device is near to the NFC Bricklet the state will change from P2PDiscovery to P2PDiscoveryReady.

If no NFC P2P enabled device can be found or if there is an error during discovery the P2P state will change to P2PDiscoveryError. In this case you have to restart the discovery process.

If the P2P state changes to P2PDiscoveryReady you can start the NDEF message transfer with p2p_start_transfer.

BrickletNFC.p2p_write_ndef_low_level
Function ID:
  • 21
Request:
  • ndef_length – Type: uint16, Range: [0 to 255]
  • ndef_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • ndef_chunk_data – Type: uint8[60], Range: [0 to 255]
Response:
  • no response

Writes the NDEF message that is to be transferred to the NFC peer.

The maximum supported NDEF message size for P2P transfer is 255 byte.

You can call this function at any time in P2P mode. The internal buffer will not be overwritten until you call this function again, change the mode or use P2P to read an NDEF messages.

BrickletNFC.p2p_start_transfer
Function ID:
  • 22
Request:
  • transfer – Type: uint8, Range: See meanings
Response:
  • no response

You can start the transfer of a NDEF message if the P2P state is P2PDiscoveryReady.

Before you call this function to start a write transfer, the NDEF message that is to be transferred has to be written via p2p_write_ndef_low_level first.

After you call this function the P2P state will change to P2PTransferNDEF. It will change to P2PTransferNDEFReady if the transfer was successfull or P2PTransferNDEFError if it wasn't.

If you started a write transfer you are now done. If you started a read transfer you can now use p2p_read_ndef_low_level to read the NDEF message that was written by the NFC peer.

The following meanings are defined for the elements of this function:

For transfer:

  • 0 = Abort
  • 1 = Write
  • 2 = Read
BrickletNFC.p2p_read_ndef_low_level
Function ID:
  • 23
Request:
  • empty payload
Response:
  • ndef_length – Type: uint16, Range: [0 to 213]
  • ndef_chunk_offset – Type: uint16, Range: [0 to 216 - 1]
  • ndef_chunk_data – Type: uint8[60], Range: [0 to 255]

Returns the NDEF message that was written by a NFC peer in NFC P2P mode.

The NDEF message is ready if you called p2p_start_transfer with a read transfer and the P2P state changed to P2PTransferNDEFReady.

BrickletNFC.simple_get_tag_id_low_level
Function ID:
  • 29
Request:
  • index – Type: uint8, Range: [0 to 255]
Response:
  • tag_type – Type: uint8, Range: See meanings
  • tag_id_length – Type: uint8, Range: [0 to 10]
  • tag_id_data – Type: uint8[10], Range: [0 to 255]
  • last_seen – Type: uint32, Range: [0 to 232 - 1]

The following meanings are defined for the elements of this function:

For tag_type:

  • 0 = Mifare Classic
  • 1 = Type1
  • 2 = Type2
  • 3 = Type3
  • 4 = Type4

New in version 2.0.6 (Plugin).

Advanced Functions

BrickletNFC.set_detection_led_config
Function ID:
  • 25
Request:
  • config – Type: uint8, Range: See meanings, Default: 3
Response:
  • no response

Sets the detection LED configuration. By default the LED shows if a card/reader is detected.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Detection
BrickletNFC.get_detection_led_config
Function ID:
  • 26
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_detection_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Detection
BrickletNFC.set_maximum_timeout
Function ID:
  • 27
Request:
  • timeout – Type: uint16, Unit: 1 ms, Range: [0 to 216 - 1], Default: 2000
Response:
  • no response

Sets the maximum timeout.

This is a global maximum used for all internal state timeouts. The timeouts depend heavily on the used tags etc. For example: If you use a Type 2 tag and you want to detect if it is present, you have to use reader_request_tag_id and wait for the state to change to either the error state or the ready state.

With the default configuration this takes 2-3 seconds. By setting the maximum timeout to 100ms you can reduce this time to ~150-200ms. For Type 2 this would also still work with a 20ms timeout (a Type 2 tag answers usually within 10ms). A type 4 tag can take up to 500ms in our tests.

If you need a fast response time to discover if a tag is present or not you can find a good timeout value by trial and error for your specific tag.

By default we use a very conservative timeout, to be sure that any tag can always answer in time.

New in version 2.0.1 (Plugin).

BrickletNFC.get_maximum_timeout
Function ID:
  • 28
Request:
  • empty payload
Response:
  • timeout – Type: uint16, Unit: 1 ms, Range: [0 to 216 - 1], Default: 2000

Returns the timeout as set by set_maximum_timeout

New in version 2.0.1 (Plugin).

BrickletNFC.get_spitfp_error_count
Function ID:
  • 234
Request:
  • empty payload
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletNFC.set_status_led_config
Function ID:
  • 239
Request:
  • config – Type: uint8, Range: See meanings, Default: 3
Response:
  • no response

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletNFC.get_status_led_config
Function ID:
  • 240
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletNFC.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletNFC.reset
Function ID:
  • 243
Request:
  • empty payload
Response:
  • no response

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletNFC.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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

Callbacks

BrickletNFC.CALLBACK_READER_STATE_CHANGED
Function ID:
  • 13
Response:
  • state – Type: uint8, Range: See meanings
  • idle – Type: bool

This callback is called if the reader state of the NFC Bricklet changes. See reader_get_state for more information about the possible states.

The following meanings are defined for the elements of this function:

For state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Request Tag ID
  • 130 = Request Tag ID Ready
  • 194 = Request Tag ID Error
  • 3 = Authenticate Mifare Classic Page
  • 131 = Authenticate Mifare Classic Page Ready
  • 195 = Authenticate Mifare Classic Page Error
  • 4 = Write Page
  • 132 = Write Page Ready
  • 196 = Write Page Error
  • 5 = Request Page
  • 133 = Request Page Ready
  • 197 = Request Page Error
  • 6 = Write NDEF
  • 134 = Write NDEF Ready
  • 198 = Write NDEF Error
  • 7 = Request NDEF
  • 135 = Request NDEF Ready
  • 199 = Request NDEF Error
BrickletNFC.CALLBACK_CARDEMU_STATE_CHANGED
Function ID:
  • 18
Response:
  • state – Type: uint8, Range: See meanings
  • idle – Type: bool

This callback is called if the cardemu state of the NFC Bricklet changes. See cardemu_get_state for more information about the possible states.

The following meanings are defined for the elements of this function:

For state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Discover
  • 130 = Discover Ready
  • 194 = Discover Error
  • 3 = Transfer NDEF
  • 131 = Transfer NDEF Ready
  • 195 = Transfer NDEF Error
BrickletNFC.CALLBACK_P2P_STATE_CHANGED
Function ID:
  • 24
Response:
  • state – Type: uint8, Range: See meanings
  • idle – Type: bool

This callback is called if the P2P state of the NFC Bricklet changes. See p2p_get_state for more information about the possible states.

The following meanings are defined for the elements of this function:

For state:

  • 0 = Initialization
  • 128 = Idle
  • 192 = Error
  • 2 = Discover
  • 130 = Discover Ready
  • 194 = Discover Error
  • 3 = Transfer NDEF
  • 131 = Transfer NDEF Ready
  • 195 = Transfer NDEF Error

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletNFC.set_bootloader_mode
Function ID:
  • 235
Request:
  • mode – Type: uint8, Range: See meanings
Response:
  • status – Type: uint8, Range: See meanings

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

For status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletNFC.get_bootloader_mode
Function ID:
  • 236
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletNFC.set_write_firmware_pointer
Function ID:
  • 237
Request:
  • pointer – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
Response:
  • no response

Sets the firmware pointer for write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletNFC.write_firmware
Function ID:
  • 238
Request:
  • data – Type: uint8[64], Range: [0 to 255]
Response:
  • status – Type: uint8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletNFC.write_uid
Function ID:
  • 248
Request:
  • uid – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletNFC.read_uid
Function ID:
  • 249
Request:
  • empty payload
Response:
  • uid – Type: uint32, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.