CCAux  2.8.3.0
CCAux API reference
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator
About.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * About.h
6 *
7 * Version 2.8.3.0, 2016-04-06
8 *
9 * (c) maximatecc 2013
10 *
11 
12  * File description:
13  * Get information about the CCpilot computer.
14  *
15  * Use the function GetAbout() to get a handle to pass on to the other functions.
16  * Use the method About_release(ABOUTHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include about_example.cpp
20  *
21  ************************************************/
22 
23 #ifndef CC_ABOUT_H_
24 #define CC_ABOUT_H_
25 
26 #include "CCAuxErrors.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* ABOUTHANDLE;
34 
49  EXTERN_C
50  CCAUXDLL_API
51  ABOUTHANDLE
52  CCAUXDLL_CALLING_CONV
53  GetAbout(void);
54 
65  EXTERN_C
66  CCAUXDLL_API
67  void
68  CCAUXDLL_CALLING_CONV
69  About_release(ABOUTHANDLE);
70 
85  EXTERN_C
86  CCAUXDLL_API
87  eErr
88  CCAUXDLL_CALLING_CONV
89  About_getMainPCBSerial (ABOUTHANDLE, char* buff, int len);
90 
105  EXTERN_C
106  CCAUXDLL_API
107  eErr
108  CCAUXDLL_CALLING_CONV
109  About_getUnitSerial (ABOUTHANDLE, char* buff, int len);
110 
125  EXTERN_C
126  CCAUXDLL_API
127  eErr
128  CCAUXDLL_CALLING_CONV
129  About_getMainPCBArt (ABOUTHANDLE, char* buff, int length);
130 
145  EXTERN_C
146  CCAUXDLL_API
147  eErr
148  CCAUXDLL_CALLING_CONV
149  About_getMainManufacturingDate (ABOUTHANDLE, char* buff, int len);
150 
165  EXTERN_C
166  CCAUXDLL_API
167  eErr
168  CCAUXDLL_CALLING_CONV
169  About_getMainHWversion (ABOUTHANDLE, char* buff, int len);
170 
185  EXTERN_C
186  CCAUXDLL_API
187  eErr
188  CCAUXDLL_CALLING_CONV
189  About_getMainProdRev (ABOUTHANDLE, char* buff, int len);
190 
205  EXTERN_C
206  CCAUXDLL_API
207  eErr
208  CCAUXDLL_CALLING_CONV
209  About_getMainProdArtNr (ABOUTHANDLE, char* buff, int len);
210 
223  EXTERN_C
224  CCAUXDLL_API
225  eErr
226  CCAUXDLL_CALLING_CONV
227  About_getNrOfETHConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
228 
241  EXTERN_C
242  CCAUXDLL_API
243  eErr
244  CCAUXDLL_CALLING_CONV
245  About_getNrOfCANConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
246 
259  EXTERN_C
260  CCAUXDLL_API
261  eErr
262  CCAUXDLL_CALLING_CONV
263  About_getNrOfVideoConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
264 
277  EXTERN_C
278  CCAUXDLL_API
279  eErr
280  CCAUXDLL_CALLING_CONV
281  About_getNrOfUSBConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
282 
295  EXTERN_C
296  CCAUXDLL_API
297  eErr
298  CCAUXDLL_CALLING_CONV
299  About_getNrOfSerialConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
300 
313  EXTERN_C
314  CCAUXDLL_API
315  eErr
316  CCAUXDLL_CALLING_CONV
317  About_getNrOfDigIOConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
318 
331  EXTERN_C
332  CCAUXDLL_API
333  eErr
334  CCAUXDLL_CALLING_CONV
335  About_getIsDisplayAvailable (ABOUTHANDLE, bool* available);
336 
349  EXTERN_C
350  CCAUXDLL_API
351  eErr
352  CCAUXDLL_CALLING_CONV
353  About_getIsTouchScreenAvailable (ABOUTHANDLE, bool* available);
354 
370  EXTERN_C
371  CCAUXDLL_API
372  eErr
373  CCAUXDLL_CALLING_CONV
374  About_getDisplayResolution (ABOUTHANDLE, char* buff, int len);
375 
390  EXTERN_C
391  CCAUXDLL_API
392  eErr
393  CCAUXDLL_CALLING_CONV
394  About_getAddOnPCBSerial (ABOUTHANDLE, char* buff, int len);
395 
410  EXTERN_C
411  CCAUXDLL_API
412  eErr
413  CCAUXDLL_CALLING_CONV
414  About_getAddOnPCBArt (ABOUTHANDLE, char* buff, int length);
415 
430  EXTERN_C
431  CCAUXDLL_API
432  eErr
433  CCAUXDLL_CALLING_CONV
434  About_getAddOnManufacturingDate (ABOUTHANDLE, char* buff, int len);
435 
450  EXTERN_C
451  CCAUXDLL_API
452  eErr
453  CCAUXDLL_CALLING_CONV
454  About_getAddOnHWversion (ABOUTHANDLE, char* buff, int len);
455 
468  EXTERN_C
469  CCAUXDLL_API
470  eErr
471  CCAUXDLL_CALLING_CONV
472  About_getIsWLANMounted (ABOUTHANDLE, bool* mounted);
473 
486  EXTERN_C
487  CCAUXDLL_API
488  eErr
489  CCAUXDLL_CALLING_CONV
490  About_getIsGPSMounted (ABOUTHANDLE, bool* mounted);
491 
504  EXTERN_C
505  CCAUXDLL_API
506  eErr
507  CCAUXDLL_CALLING_CONV
508  About_getIsGPRSMounted (ABOUTHANDLE, bool* mounted);
509 
522  EXTERN_C
523  CCAUXDLL_API
524  eErr
525  CCAUXDLL_CALLING_CONV
526  About_getIsBTMounted (ABOUTHANDLE, bool* mounted);
527 
538  EXTERN_C
539  CCAUXDLL_API
540  eErr
541  CCAUXDLL_CALLING_CONV
542  About_getFrontPcbRev(ABOUTHANDLE, unsigned char* major, unsigned char* minor);
543 
556  EXTERN_C
557  CCAUXDLL_API
558  eErr
559  CCAUXDLL_CALLING_CONV
560  About_getIsIOExpanderMounted (ABOUTHANDLE, bool* mounted);
561 
571  EXTERN_C
572  CCAUXDLL_API
573  eErr
574  CCAUXDLL_CALLING_CONV
575  About_getIOExpanderValue (ABOUTHANDLE, unsigned short* value);
576 
592  EXTERN_C
593  CCAUXDLL_API
594  eErr
595  CCAUXDLL_CALLING_CONV
596  About_hasOsBooted (ABOUTHANDLE, bool* bootComplete);
597 
610  EXTERN_C
611  CCAUXDLL_API
612  eErr
613  CCAUXDLL_CALLING_CONV
614  About_getIsAnybusMounted (ABOUTHANDLE, bool* mounted);
615 
628  EXTERN_C
629  CCAUXDLL_API
630  eErr
631  CCAUXDLL_CALLING_CONV
632  About_getNrOfCfgInConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
633 
646  EXTERN_C
647  CCAUXDLL_API
648  eErr
649  CCAUXDLL_CALLING_CONV
650  About_getNrOfPWMOutConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
651 
664  EXTERN_C
665  CCAUXDLL_API
666  eErr
667  CCAUXDLL_CALLING_CONV
668  About_getNrOfButtons (ABOUTHANDLE, int* numbuttons);
669 
680  EXTERN_C
681  CCAUXDLL_API
682  eErr
683  CCAUXDLL_CALLING_CONV
684  About_getUserEepromData(ABOUTHANDLE, char* buff, unsigned short length);
685 
696  EXTERN_C
697  CCAUXDLL_API
698  eErr
699  CCAUXDLL_CALLING_CONV
700  About_setUserEepromData(ABOUTHANDLE, unsigned short startpos, const char* buff, unsigned short length);
701 
702 #ifdef __cplusplus
703 } /* namespace CrossControl */
704 #endif
705 
706 #endif /* CC_ABOUT_H_ */
707 
708 
Generated on Wed Apr 6 2016 19:46:22 for CCAux by   doxygen 1.8.3.1