CCAux  2.8.3.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
Telematics.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * Telematics.h
6 *
7 * Version 2.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Power control and status functions for the optional telematics add-on card
14  *
15  * Use the function GetTelematics() to get a handle to pass on to the other functions.
16  * Use the method Telematics_release(TELEMATICSHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include telematics_example.cpp
20  *
21  ************************************************/
22 
23 #ifndef CC_TELEMATICS_H
24 #define CC_TELEMATICS_H
25 
26 #include "CCAuxErrors.h"
27 #include "CCAuxTypes.h"
28 #include "CCPlatform.h"
29 
30 #ifdef __cplusplus
31 namespace CrossControl {
32 #endif
33 
34  typedef void* TELEMATICSHANDLE;
35 
49  EXTERN_C
50  CCAUXDLL_API
51  TELEMATICSHANDLE
52  CCAUXDLL_CALLING_CONV
53  GetTelematics(void);
54 
65  EXTERN_C
66  CCAUXDLL_API
67  void
68  CCAUXDLL_CALLING_CONV
69  Telematics_release(TELEMATICSHANDLE);
70 
83  EXTERN_C
84  CCAUXDLL_API
85  eErr
86  CCAUXDLL_CALLING_CONV
87  Telematics_getTelematicsAvailable(TELEMATICSHANDLE, CCStatus* status);
88 
101  EXTERN_C
102  CCAUXDLL_API
103  eErr
104  CCAUXDLL_CALLING_CONV
105  Telematics_getGPRSPowerStatus(TELEMATICSHANDLE, CCStatus* status);
106 
119  EXTERN_C
120  CCAUXDLL_API
121  eErr
122  CCAUXDLL_CALLING_CONV
123  Telematics_getGPRSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus* status);
124 
137  EXTERN_C
138  CCAUXDLL_API
139  eErr
140  CCAUXDLL_CALLING_CONV
141  Telematics_getWLANPowerStatus(TELEMATICSHANDLE, CCStatus* status);
142 
155  EXTERN_C
156  CCAUXDLL_API
157  eErr
158  CCAUXDLL_CALLING_CONV
159  Telematics_getWLANStartUpPowerStatus(TELEMATICSHANDLE, CCStatus* status);
160 
173  EXTERN_C
174  CCAUXDLL_API
175  eErr
176  CCAUXDLL_CALLING_CONV
177  Telematics_getBTPowerStatus(TELEMATICSHANDLE, CCStatus* status);
178 
191  EXTERN_C
192  CCAUXDLL_API
193  eErr
194  CCAUXDLL_CALLING_CONV
195  Telematics_getBTStartUpPowerStatus(TELEMATICSHANDLE, CCStatus* status);
196 
210  EXTERN_C
211  CCAUXDLL_API
212  eErr
213  CCAUXDLL_CALLING_CONV
214  Telematics_getGPSPowerStatus(TELEMATICSHANDLE, CCStatus* status);
215 
228  EXTERN_C
229  CCAUXDLL_API
230  eErr
231  CCAUXDLL_CALLING_CONV
232  Telematics_getGPSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus* status);
233 
248  EXTERN_C
249  CCAUXDLL_API
250  eErr
251  CCAUXDLL_CALLING_CONV
252  Telematics_getGPSAntennaStatus(TELEMATICSHANDLE, CCStatus* status);
253 
263  EXTERN_C
264  CCAUXDLL_API
265  eErr
266  CCAUXDLL_CALLING_CONV
267  Telematics_setGPRSPowerStatus(TELEMATICSHANDLE, CCStatus status);
268 
278  EXTERN_C
279  CCAUXDLL_API
280  eErr
281  CCAUXDLL_CALLING_CONV
282  Telematics_setGPRSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
283 
293  EXTERN_C
294  CCAUXDLL_API
295  eErr
296  CCAUXDLL_CALLING_CONV
297  Telematics_setWLANPowerStatus(TELEMATICSHANDLE, CCStatus status);
298 
308  EXTERN_C
309  CCAUXDLL_API
310  eErr
311  CCAUXDLL_CALLING_CONV
312  Telematics_setWLANStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
313 
323  EXTERN_C
324  CCAUXDLL_API
325  eErr
326  CCAUXDLL_CALLING_CONV
327  Telematics_setBTPowerStatus(TELEMATICSHANDLE, CCStatus status);
328 
338  EXTERN_C
339  CCAUXDLL_API
340  eErr
341  CCAUXDLL_CALLING_CONV
342  Telematics_setBTStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
343 
353  EXTERN_C
354  CCAUXDLL_API
355  eErr
356  CCAUXDLL_CALLING_CONV
357  Telematics_setGPSPowerStatus(TELEMATICSHANDLE, CCStatus status);
358 
368  EXTERN_C
369  CCAUXDLL_API
370  eErr
371  CCAUXDLL_CALLING_CONV
372  Telematics_setGPSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
373 
374 #ifdef __cplusplus
375 } /* namespace CrossControl */
376 #endif
377 
378 #endif /* CC_TELEMATICS_H */
379 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1