NFC ZigBee 3.0 Modules and Libraries: nci_nwk.h File Reference

NCI Network NDEF reading and writing (interface)

nci_nwk.h contains high level APIs for reading and writing a network NDEF to the NTAGs placed in the reader's field which is suitable for use in commissioning devices into IEEE 802.15.4 based networks.

The typical set up sequence is the same for the data APIs (described in nci.h).

A typical sequence to read data is shown below. Data must be read when the NTAG is placed into the field usually in response to the E_NCI_EVENT_PRESENT event.

• NCI_vTick() is called by the application
• APP_NciCbEvent(E_NCI_EVENT_PRESENT) is called in the application when an NTAG is placed into the field.
• NCI_NWK_eRead() is called by the application, handing control of the low-level data APIs over to the NDEF data module. A pointer to be filled in with the address of the read and a pointer to store the NDEF payload is provided. This function call will return E_NCI_NWK_READING if the request is successful.
• NCI_NWK_eTick() should then be called regularly by the application (replacing the calls to NCI_vTick()).
• If NCI_NWK_eTick() returns E_NCI_NWK_READ_OK the read was successful. The NDEF payload and the address of the read will have been placed into the pointers provided in the NCI_NWK_eRead() call.
• If NCI_NWK_eTick() returns E_NCI_NWK_READ_FAIL the read was unsuccessful.
• If the interaction with the NDEF data is finished NCI_NWK_eStop() should be called followed by a call to NCI_vRegCbEvent() to reclaim the NCI event callback, followed by regular calls to NCI_vTick(). NCI_NWK_eStop() includes a call to NCI_bEnd().

A typical sequence to write the NDEF payload data is shown below. Data must be written when the NTAG is in the field. Data may be written following a successful read as shown below:

• NCI_NWK_eTick() returns E_NCI_NWK_READ_OK indicating a successful read.
• The NDEF payload contents are updated for writing.
• NCI_NWK_eWrite() is called by the application, handing control of the low-level data APIs over to the NDEF data module. A pointer with the address of the write and a pointer to NDEF payload data to be written is provided. This function call will return E_NCI_NWK_WRITING if the request is successful.
• NCI_NWK_eTick() should then be called regularly by the application (continuing to replace the calls to NCI_vTick()).
• If NCI_NWK_eTick() returns E_NCI_NWK_WRITE_OK the write was successful.
• If NCI_NWK_eTick() returns E_NCI_NWK_WRITE_FAIL the write was unsuccessful.
• If the interaction with the NDEF data is finished NCI_NWK_eStop() should be called followed by a call to NCI_vRegCbEvent() to reclaim the NTAG event callback, followed by regular calls to NCI_vTick(). NCI_NWK_eStop() includes a call to NCI_bEnd().

The message sequence chart below shows a sequence of function calls for initialisation, an NDEF read and an NDEF write: