CCAux  2.7.2.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.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Power control and status functions for the optional telematics add-on card
13 *
14 * Use the function GetTelematics() to get a handle to pass on to the other functions.
15 * Use the method Telematics_release(TELEMATICSHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include telematics_example.cpp
19 *
20 ************************************************/
21 
22 #ifndef CC_TELEMATICS_H
23 #define CC_TELEMATICS_H
24 
25 #include "CCAuxErrors.h"
26 #include "CCAuxTypes.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* TELEMATICSHANDLE;
34 
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 
247  EXTERN_C
248  CCAUXDLL_API
249  eErr
250  CCAUXDLL_CALLING_CONV
251  Telematics_getGPSAntennaStatus(TELEMATICSHANDLE, CCStatus* status);
252 
262  EXTERN_C
263  CCAUXDLL_API
264  eErr
265  CCAUXDLL_CALLING_CONV
266  Telematics_setGPRSPowerStatus(TELEMATICSHANDLE, CCStatus status);
267 
277  EXTERN_C
278  CCAUXDLL_API
279  eErr
280  CCAUXDLL_CALLING_CONV
281  Telematics_setGPRSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
282 
292  EXTERN_C
293  CCAUXDLL_API
294  eErr
295  CCAUXDLL_CALLING_CONV
296  Telematics_setWLANPowerStatus(TELEMATICSHANDLE, CCStatus status);
297 
307  EXTERN_C
308  CCAUXDLL_API
309  eErr
310  CCAUXDLL_CALLING_CONV
311  Telematics_setWLANStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
312 
322  EXTERN_C
323  CCAUXDLL_API
324  eErr
325  CCAUXDLL_CALLING_CONV
326  Telematics_setBTPowerStatus(TELEMATICSHANDLE, CCStatus status);
327 
337  EXTERN_C
338  CCAUXDLL_API
339  eErr
340  CCAUXDLL_CALLING_CONV
341  Telematics_setBTStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
342 
352  EXTERN_C
353  CCAUXDLL_API
354  eErr
355  CCAUXDLL_CALLING_CONV
356  Telematics_setGPSPowerStatus(TELEMATICSHANDLE, CCStatus status);
357 
367  EXTERN_C
368  CCAUXDLL_API
369  eErr
370  CCAUXDLL_CALLING_CONV
371  Telematics_setGPSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus status);
372 
373 #ifdef __cplusplus
374 } /* namespace CrossControl */
375 #endif
376 
377 #endif /* CC_TELEMATICS_H */
378 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1