nfc_bricklet

func (*NFCBricklet) CardemuGetState ¶

func (device *NFCBricklet) CardemuGetState() (state CardemuState, idle bool, err error)

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

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

Example: If you call CardemuStartDiscovery, 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.

Associated constants:

• CardemuStateInitialization
• CardemuStateIdle
• CardemuStateError
• CardemuStateDiscover
• CardemuStateDiscoverReady
• CardemuStateDiscoverError
• CardemuStateTransferNDEF
• CardemuStateTransferNDEFReady
• CardemuStateTransferNDEFError

func (*NFCBricklet) CardemuStartDiscovery ¶

func (device *NFCBricklet) CardemuStartDiscovery() (err error)

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 CardemuWriteNDEF and CardemuStartTransfer.

func (*NFCBricklet) CardemuStartTransfer ¶

func (device *NFCBricklet) CardemuStartTransfer(transfer CardemuTransfer) (err error)

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

Associated constants:

• CardemuTransferAbort
• CardemuTransferWrite

func (*NFCBricklet) CardemuWriteNDEF ¶

func (device *NFCBricklet) CardemuWriteNDEF(ndef []uint8) (err error)

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.

func (*NFCBricklet) CardemuWriteNDEFLowLevel ¶

func (device *NFCBricklet) CardemuWriteNDEFLowLevel(ndefLength uint16, ndefChunkOffset uint16, ndefChunkData [60]uint8) (err error)

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.

func (*NFCBricklet) DeregisterCardemuStateChangedCallback ¶

func (device *NFCBricklet) DeregisterCardemuStateChangedCallback(registrationId uint64)

Remove a registered Cardemu State Changed callback.

func (*NFCBricklet) DeregisterP2PStateChangedCallback ¶

func (device *NFCBricklet) DeregisterP2PStateChangedCallback(registrationId uint64)

Remove a registered P2P State Changed callback.

func (*NFCBricklet) DeregisterReaderStateChangedCallback ¶

func (device *NFCBricklet) DeregisterReaderStateChangedCallback(registrationId uint64)

Remove a registered Reader State Changed callback.

func (*NFCBricklet) GetAPIVersion ¶

func (device *NFCBricklet) GetAPIVersion() [3]uint8

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.

func (*NFCBricklet) GetBootloaderMode ¶

func (device *NFCBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

• BootloaderModeBootloader
• BootloaderModeFirmware
• BootloaderModeBootloaderWaitForReboot
• BootloaderModeFirmwareWaitForReboot
• BootloaderModeFirmwareWaitForEraseAndReboot

func (*NFCBricklet) GetChipTemperature ¶

func (device *NFCBricklet) GetChipTemperature() (temperature int16, err error)

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.

func (*NFCBricklet) GetDetectionLEDConfig ¶

func (device *NFCBricklet) GetDetectionLEDConfig() (config DetectionLEDConfig, err error)

Returns the configuration as set by SetDetectionLEDConfig

Associated constants:

• DetectionLEDConfigOff
• DetectionLEDConfigOn
• DetectionLEDConfigShowHeartbeat
• DetectionLEDConfigShowDetection

func (*NFCBricklet) GetIdentity ¶

func (device *NFCBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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 <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*NFCBricklet) GetMaximumTimeout ¶

func (device *NFCBricklet) GetMaximumTimeout() (timeout uint16, err error)

Returns the timeout as set by SetMaximumTimeout

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*NFCBricklet) GetMode ¶

func (device *NFCBricklet) GetMode() (mode Mode, err error)

Returns the mode as set by SetMode.

Associated constants:

• ModeOff
• ModeCardemu
• ModeP2P
• ModeReader
• ModeSimple

func (*NFCBricklet) GetResponseExpected ¶

func (device *NFCBricklet) GetResponseExpected(functionID Function) (bool, error)

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 SetResponseExpected. 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 SetResponseExpected for the list of function ID constants available for this function.

func (*NFCBricklet) GetSPITFPErrorCount ¶

func (device *NFCBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

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.

func (*NFCBricklet) GetStatusLEDConfig ¶

func (device *NFCBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

• StatusLEDConfigOff
• StatusLEDConfigOn
• StatusLEDConfigShowHeartbeat
• StatusLEDConfigShowStatus

func (*NFCBricklet) P2PGetState ¶

func (device *NFCBricklet) P2PGetState() (state P2PState, idle bool, err error)

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

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

Example: If you call P2PStartDiscovery, 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.

Associated constants:

• P2PStateInitialization
• P2PStateIdle
• P2PStateError
• P2PStateDiscover
• P2PStateDiscoverReady
• P2PStateDiscoverError
• P2PStateTransferNDEF
• P2PStateTransferNDEFReady
• P2PStateTransferNDEFError

func (*NFCBricklet) P2PReadNDEF ¶

func (device *NFCBricklet) P2PReadNDEF() (ndef []uint8, err error)

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

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

func (*NFCBricklet) P2PReadNDEFLowLevel ¶

func (device *NFCBricklet) P2PReadNDEFLowLevel() (ndefLength uint16, ndefChunkOffset uint16, ndefChunkData [60]uint8, err error)

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

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

func (*NFCBricklet) P2PStartDiscovery ¶

func (device *NFCBricklet) P2PStartDiscovery() (err error)

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

func (*NFCBricklet) P2PStartTransfer ¶

func (device *NFCBricklet) P2PStartTransfer(transfer P2PTransfer) (err error)

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 P2PWriteNDEF 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 P2PReadNDEF to read the NDEF message that was written by the NFC peer.

Associated constants:

• P2PTransferAbort
• P2PTransferWrite
• P2PTransferRead

func (*NFCBricklet) P2PWriteNDEF ¶

func (device *NFCBricklet) P2PWriteNDEF(ndef []uint8) (err error)

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.

func (*NFCBricklet) P2PWriteNDEFLowLevel ¶

func (device *NFCBricklet) P2PWriteNDEFLowLevel(ndefLength uint16, ndefChunkOffset uint16, ndefChunkData [60]uint8) (err error)

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.

func (*NFCBricklet) ReadUID ¶

func (device *NFCBricklet) ReadUID() (uid uint32, err error)

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

func (*NFCBricklet) ReaderAuthenticateMifareClassicPage ¶

func (device *NFCBricklet) ReaderAuthenticateMifareClassicPage(page uint16, keyNumber Key, key [6]uint8) (err error)

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 ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderAuthenticateMifareClassicPage with page and key for the page
5. Wait for state to change to *ReaderAuthenticatingMifareClassicPageReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
6. Call ReaderRequestPage or ReaderWritePage to read/write page

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

Associated constants:

• KeyA
• KeyB

func (*NFCBricklet) ReaderGetState ¶

func (device *NFCBricklet) ReaderGetState() (state ReaderState, idle bool, err error)

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

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

Example: If you call ReaderRequestPage, 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 ReaderReadPage.

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

Associated constants:

• ReaderStateInitialization
• ReaderStateIdle
• ReaderStateError
• ReaderStateRequestTagID
• ReaderStateRequestTagIDReady
• ReaderStateRequestTagIDError
• ReaderStateAuthenticateMifareClassicPage
• ReaderStateAuthenticateMifareClassicPageReady
• ReaderStateAuthenticateMifareClassicPageError
• ReaderStateWritePage
• ReaderStateWritePageReady
• ReaderStateWritePageError
• ReaderStateRequestPage
• ReaderStateRequestPageReady
• ReaderStateRequestPageError
• ReaderStateWriteNDEF
• ReaderStateWriteNDEFReady
• ReaderStateWriteNDEFError
• ReaderStateRequestNDEF
• ReaderStateRequestNDEFReady
• ReaderStateRequestNDEFError

func (*NFCBricklet) ReaderGetTagID ¶

func (device *NFCBricklet) ReaderGetTagID() (tagID []uint8, tagType TagType, err error)

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

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

1. Call ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. Call ReaderGetTagID

func (*NFCBricklet) ReaderGetTagIDLowLevel ¶

func (device *NFCBricklet) ReaderGetTagIDLowLevel() (tagType TagType, tagIDLength uint8, tagIDData [32]uint8, err error)

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

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

1. Call ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. Call ReaderGetTagID

Associated constants:

• TagTypeMifareClassic
• TagTypeType1
• TagTypeType2
• TagTypeType3
• TagTypeType4

func (*NFCBricklet) ReaderReadNDEF ¶

func (device *NFCBricklet) ReaderReadNDEF() (ndef []uint8, err error)

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

func (*NFCBricklet) ReaderReadNDEFLowLevel ¶

func (device *NFCBricklet) ReaderReadNDEFLowLevel() (ndefLength uint16, ndefChunkOffset uint16, ndefChunkData [60]uint8, err error)

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

func (*NFCBricklet) ReaderReadPage ¶

func (device *NFCBricklet) ReaderReadPage() (data []uint8, err error)

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

func (*NFCBricklet) ReaderReadPageLowLevel ¶

func (device *NFCBricklet) ReaderReadPageLowLevel() (dataLength uint16, dataChunkOffset uint16, dataChunkData [60]uint8, err error)

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

func (*NFCBricklet) ReaderRequestNDEF ¶

func (device *NFCBricklet) ReaderRequestNDEF() (err error)

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 ReaderRequestTagID
2. Wait for state to change to *RequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderRequestNDEF
5. Wait for state to change to *ReaderRequestNDEFReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
6. Call ReaderReadNDEF to retrieve the NDEF message from the buffer

func (*NFCBricklet) ReaderRequestPage ¶

func (device *NFCBricklet) ReaderRequestPage(page ReaderRequest, length uint16) (err error)

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 ReaderReadPage. 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 ReaderRequestTagID
2. Wait for state to change to *RequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderRequestPage with page number
5. Wait for state to change to *ReaderRequestPageReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
6. Call ReaderReadPage 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 ReaderAuthenticateMifareClassicPage.

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.

Associated constants:

• ReaderRequestType4CapabilityContainer
• ReaderRequestType4NDEF

func (*NFCBricklet) ReaderRequestTagID ¶

func (device *NFCBricklet) ReaderRequestTagID() (err error)

After you call ReaderRequestTagID 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 RegisterReaderStateChangedCallback callback or you can poll ReaderGetState 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 ReaderGetTagID.

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

func (*NFCBricklet) ReaderWriteNDEF ¶

func (device *NFCBricklet) ReaderWriteNDEF(ndef []uint8) (err error)

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 ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderWriteNDEF with the NDEF message that you want to write
5. Wait for state to change to *ReaderWriteNDEFReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)

func (*NFCBricklet) ReaderWriteNDEFLowLevel ¶

func (device *NFCBricklet) ReaderWriteNDEFLowLevel(ndefLength uint16, ndefChunkOffset uint16, ndefChunkData [60]uint8) (err error)

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 ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderWriteNDEF with the NDEF message that you want to write
5. Wait for state to change to *ReaderWriteNDEFReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)

func (*NFCBricklet) ReaderWritePage ¶

func (device *NFCBricklet) ReaderWritePage(page ReaderWrite, data []uint8) (err error)

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 ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderWritePage with page number and data
5. Wait for state to change to *ReaderWritePageReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)

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

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.

func (*NFCBricklet) ReaderWritePageLowLevel ¶

func (device *NFCBricklet) ReaderWritePageLowLevel(page ReaderWrite, dataLength uint16, dataChunkOffset uint16, dataChunkData [58]uint8) (err error)

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 ReaderRequestTagID
2. Wait for state to change to *ReaderRequestTagIDReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)
3. If looking for a specific tag then call ReaderGetTagID and check if the expected tag was found, if it was not found got back to step 1
4. Call ReaderWritePage with page number and data
5. Wait for state to change to *ReaderWritePageReady* (see ReaderGetState or RegisterReaderStateChangedCallback callback)

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

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.

Associated constants:

• ReaderWriteType4CapabilityContainer
• ReaderWriteType4NDEF

func (*NFCBricklet) RegisterCardemuStateChangedCallback ¶

func (device *NFCBricklet) RegisterCardemuStateChangedCallback(fn func(CardemuState, bool)) uint64

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

func (*NFCBricklet) RegisterP2PStateChangedCallback ¶

func (device *NFCBricklet) RegisterP2PStateChangedCallback(fn func(P2PState, bool)) uint64

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

func (*NFCBricklet) RegisterReaderStateChangedCallback ¶

func (device *NFCBricklet) RegisterReaderStateChangedCallback(fn func(ReaderState, bool)) uint64

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

func (*NFCBricklet) Reset ¶

func (device *NFCBricklet) Reset() (err error)

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!

func (*NFCBricklet) SetBootloaderMode ¶

func (device *NFCBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

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.

Associated constants:

• BootloaderModeBootloader
• BootloaderModeFirmware
• BootloaderModeBootloaderWaitForReboot
• BootloaderModeFirmwareWaitForReboot
• BootloaderModeFirmwareWaitForEraseAndReboot
• BootloaderStatusOK
• BootloaderStatusInvalidMode
• BootloaderStatusNoChange
• BootloaderStatusEntryFunctionNotPresent
• BootloaderStatusDeviceIdentifierIncorrect
• BootloaderStatusCRCMismatch

func (*NFCBricklet) SetDetectionLEDConfig ¶

func (device *NFCBricklet) SetDetectionLEDConfig(config DetectionLEDConfig) (err error)

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.

Associated constants:

• DetectionLEDConfigOff
• DetectionLEDConfigOn
• DetectionLEDConfigShowHeartbeat
• DetectionLEDConfigShowDetection

func (*NFCBricklet) SetMaximumTimeout ¶

func (device *NFCBricklet) SetMaximumTimeout(timeout uint16) (err error)

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

.. versionadded:: 2.0.1$nbsp;(Plugin)

func (*NFCBricklet) SetMode ¶

func (device *NFCBricklet) SetMode(mode Mode) (err error)

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 * Simple: Automatically reads tag IDs

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.

Associated constants:

• ModeOff
• ModeCardemu
• ModeP2P
• ModeReader
• ModeSimple

func (*NFCBricklet) SetResponseExpected ¶

func (device *NFCBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

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.

func (*NFCBricklet) SetResponseExpectedAll ¶

func (device *NFCBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*NFCBricklet) SetStatusLEDConfig ¶

func (device *NFCBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

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.

Associated constants:

• StatusLEDConfigOff
• StatusLEDConfigOn
• StatusLEDConfigShowHeartbeat
• StatusLEDConfigShowStatus

func (*NFCBricklet) SetWriteFirmwarePointer ¶

func (device *NFCBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. 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.

func (*NFCBricklet) SimpleGetTagID ¶

func (device *NFCBricklet) SimpleGetTagID(index uint8) (tagID []uint8, tagType TagType, lastSeen uint32, err error)

.. versionadded:: 2.0.6$nbsp;(Plugin)

func (*NFCBricklet) SimpleGetTagIDLowLevel ¶

func (device *NFCBricklet) SimpleGetTagIDLowLevel(index uint8) (tagType TagType, tagIDLength uint8, tagIDData [10]uint8, lastSeen uint32, err error)

.. versionadded:: 2.0.6$nbsp;(Plugin)

Associated constants:

• TagTypeMifareClassic
• TagTypeType1
• TagTypeType2
• TagTypeType3
• TagTypeType4

func (*NFCBricklet) WriteFirmware ¶

func (device *NFCBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer 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.

func (*NFCBricklet) WriteUID ¶

func (device *NFCBricklet) WriteUID(uid uint32) (err error)

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.