NFC ZigBee 3.0 Modules and Libraries: app_ntag_icode.h Source File

NFC ZigBee 3.0

previous page next page
NFC ZigBee 3.0 Modules and Libraries
NFC Commissioning using ZigBee Installation Codes
app_ntag_icode.h
Go to the documentation of this file.
1 /*****************************************************************************
2  *
3  * MODULE: JN-AN-1217 Base Device Application
4  *
5  * COMPONENT: app_ntag_icode.h
6  *
7  * DESCRIPTION: Application layer for NTAG (Installation Code encryption)
8  *
9  ****************************************************************************
10  *
11  * This software is owned by NXP B.V. and/or its supplier and is protected
12  * under applicable copyright laws. All rights are reserved. We grant You,
13  * and any third parties, a license to use this software solely and
14  * exclusively on NXP products [NXP Microcontrollers such as JN5168, JN5179].
15  * You, and any third parties must reproduce the copyright and warranty notice
16  * and any other legend of ownership on each copy or partial copy of the
17  * software.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  * Copyright NXP B.V. 2017. All rights reserved
32  *
33  ***************************************************************************/
50 #ifndef APP_NTAG_ICODE_H_
51 #define APP_NTAG_ICODE_H_
52 
53 /****************************************************************************/
54 /*** Include Files ***/
55 /****************************************************************************/
56 #include <jendefs.h>
57 #include <ntag.h>
58 
59 /****************************************************************************/
60 /*** Macro Definitions ***/
61 /****************************************************************************/
62 #define APP_NTAG_ADDRESS 0xFFU
63 #define APP_NTAG_I2C_LOCATION FALSE
64 #define APP_NTAG_I2C_FREQUENCY_HZ 100000
65 #define APP_NTAG_TICK_MS 5
67 /****************************************************************************/
68 /*** Type Definitions ***/
69 /****************************************************************************/
70 
71 /****************************************************************************/
72 /*** Exported Functions ***/
73 /****************************************************************************/
74 /****************************************************************************
75  *
76  * NAME: APP_bNtagPdmLoad
77  */
106 PUBLIC bool_t APP_bNtagPdmLoad(void);
107 
108 /****************************************************************************
109  *
110  * NAME: APP_vNtagStart
111  */
137 PUBLIC void APP_vNtagStart(
138  uint8 u8ApplicationEndpoint
139  );
140 
141 /****************************************************************************
142  *
143  * NAME: APP_vNtagStop
144  */
151 PUBLIC void APP_vNtagStop(void);
152 
153 /****************************************************************************
154  *
155  * NAME: APP_cbNtagTimer
156  */
180 PUBLIC void APP_cbNtagTimer(void *pvParams);
181 
182 /****************************************************************************
183  *
184  * NAME: APP_cbNtagEvent()
185  */
198 PUBLIC void APP_cbNtagEvent(
199  teNtagEvent eNtagEvent,
200  uint32 u32Address,
201  uint32 u32Length,
202  uint8 *pu8Data
203  );
204 
205 /****************************************************************************/
206 /*** Exported Variables ***/
207 /****************************************************************************/
208 
209 #endif /* APP_NTAG_ICODE_H_ */
210 /****************************************************************************/
211 /*** END OF FILE ***/
212 /****************************************************************************/
APP_cbNtagTimer
PUBLIC void APP_cbNtagTimer(void *pvParams)
ZTIMER callback function.
APP_bNtagPdmLoad
PUBLIC bool_t APP_bNtagPdmLoad(void)
Reads NTAG PDM records during initialisation and initiates out of band commissioning if an appropriat...
APP_vNtagStop
PUBLIC void APP_vNtagStop(void)
Stops processing data in the NTAG.
teNtagEvent
teNtagEvent
Definition: ntag.h:146
ntag.h
NTAG driver for reading and writing data (interface)
APP_cbNtagEvent
PUBLIC void APP_cbNtagEvent(teNtagEvent eNtagEvent, uint32 u32Address, uint32 u32Length, uint8 *pu8Data)
NTAG event callback function.
APP_vNtagStart
PUBLIC void APP_vNtagStart(uint8 u8ApplicationEndpoint)
Starts processing data in the NTAG.
Generated by   doxygen 1.8.13
previous page start next page