Logo
TIDM-CAPTIVATE-64-BUTTON Example Applications Guide  v1.00.00.00
TIDM-CAPTIVATE-64-BUTTON_WakeOnTouch/captivate_app/CAPT_App.h
1 /* --COPYRIGHT--,BSD
2  * Copyright (c) 2014, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  * --/COPYRIGHT--*/
32 //*****************************************************************************
33 // CAPT_App.h
34 //
37 //
40 //
41 //*****************************************************************************
42 
43 #ifndef CAPT_APP_H_
44 #define CAPT_APP_H_
45 
46 //*****************************************************************************
47 //
48 // CAPT_appStart() initilizes and calibrates the user interface application
49 // specified in CAPT_UserConfig. It also starts the captivate timer.
50 //
51 // \param none
52 // \return none
53 //
54 //*****************************************************************************
55 extern void CAPT_appStart(void);
56 
57 //*****************************************************************************
58 //
59 // CAPT_appHandler() performs several functions:
60 // (1) It manages the mode of the UI (Active versus Wake-on-Proximity)
61 // (2) It controls when sensors are measured
62 // (2) It handles timer requests via the flags set by the captivate ISR
63 // (3) It checks for incoming packets, if the communications stack is enabled
64 //
65 // \param none
66 // \return none
67 //
68 //*****************************************************************************
69 extern bool CAPT_appHandler(void);
70 
71 //*****************************************************************************
72 //
73 // CAPT_appSleep() puts the MCU into the low power mode specified in the
74 // global applicaiton structure, if and ONLY if no pending captivate flags
75 // exist.
76 //
77 // The flags that are checked are: detection, timer, and conversion counter.
78 //
79 // \param none
80 // \return none
81 //
82 //*****************************************************************************
83 extern void CAPT_appSleep(void);
84 
85 #endif /* CAPT_APP_H_ */
bool CAPT_appHandler(void)
Definition: source/captivate_app/CAPT_App.c:69
void CAPT_appStart(void)
Definition: source/captivate_app/CAPT_App.c:42
void CAPT_appSleep(void)
The flags that are checked are: detection, timer, and conversion counter.
Definition: source/captivate_app/CAPT_App.c:202