CCAux  2.7.2.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.7.2.0, 2014-08-25
8 *
9 * (c) maximatecc 2013
10 *
11 * File description:
12 * Get information about the CCpilot computer.
13 *
14 * Use the function GetAbout() to get a handle to pass on to the other functions.
15 * Use the method About_release(ABOUTHANDLE) to return the handle.
16 *
17 * Example Usage:
18 * @include about_example.cpp
19 *
20 ************************************************/
21 
22 #ifndef CC_ABOUT_H_
23 #define CC_ABOUT_H_
24 
25 #include "CCAuxErrors.h"
26 #include "CCPlatform.h"
27 
28 #ifdef __cplusplus
29 namespace CrossControl {
30 #endif
31 
32  typedef void* ABOUTHANDLE;
33 
48  EXTERN_C
49  CCAUXDLL_API
50  ABOUTHANDLE
51  CCAUXDLL_CALLING_CONV
52  GetAbout(void);
53 
54 
65  EXTERN_C
66  CCAUXDLL_API
67  void
68  CCAUXDLL_CALLING_CONV
69  About_release(ABOUTHANDLE);
70 
71 
86  EXTERN_C
87  CCAUXDLL_API
88  eErr
89  CCAUXDLL_CALLING_CONV
90  About_getMainPCBSerial (ABOUTHANDLE, char* buff, int len);
91 
106  EXTERN_C
107  CCAUXDLL_API
108  eErr
109  CCAUXDLL_CALLING_CONV
110  About_getUnitSerial (ABOUTHANDLE, char* buff, int len);
111 
126  EXTERN_C
127  CCAUXDLL_API
128  eErr
129  CCAUXDLL_CALLING_CONV
130  About_getMainPCBArt (ABOUTHANDLE, char* buff, int length);
131 
146  EXTERN_C
147  CCAUXDLL_API
148  eErr
149  CCAUXDLL_CALLING_CONV
150  About_getMainManufacturingDate (ABOUTHANDLE, char* buff, int len);
151 
166  EXTERN_C
167  CCAUXDLL_API
168  eErr
169  CCAUXDLL_CALLING_CONV
170  About_getMainHWversion (ABOUTHANDLE, char* buff, int len);
171 
186  EXTERN_C
187  CCAUXDLL_API
188  eErr
189  CCAUXDLL_CALLING_CONV
190  About_getMainProdRev (ABOUTHANDLE, char* buff, int len);
191 
206  EXTERN_C
207  CCAUXDLL_API
208  eErr
209  CCAUXDLL_CALLING_CONV
210  About_getMainProdArtNr (ABOUTHANDLE, char* buff, int len);
211 
224  EXTERN_C
225  CCAUXDLL_API
226  eErr
227  CCAUXDLL_CALLING_CONV
228  About_getNrOfETHConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
229 
242  EXTERN_C
243  CCAUXDLL_API
244  eErr
245  CCAUXDLL_CALLING_CONV
246  About_getNrOfCANConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
247 
260  EXTERN_C
261  CCAUXDLL_API
262  eErr
263  CCAUXDLL_CALLING_CONV
264  About_getNrOfVideoConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
265 
278  EXTERN_C
279  CCAUXDLL_API
280  eErr
281  CCAUXDLL_CALLING_CONV
282  About_getNrOfUSBConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
283 
296  EXTERN_C
297  CCAUXDLL_API
298  eErr
299  CCAUXDLL_CALLING_CONV
300  About_getNrOfSerialConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
301 
314  EXTERN_C
315  CCAUXDLL_API
316  eErr
317  CCAUXDLL_CALLING_CONV
318  About_getNrOfDigIOConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
319 
332  EXTERN_C
333  CCAUXDLL_API
334  eErr
335  CCAUXDLL_CALLING_CONV
336  About_getIsDisplayAvailable (ABOUTHANDLE, bool* available);
337 
350  EXTERN_C
351  CCAUXDLL_API
352  eErr
353  CCAUXDLL_CALLING_CONV
354  About_getIsTouchScreenAvailable (ABOUTHANDLE, bool* available);
355 
371  EXTERN_C
372  CCAUXDLL_API
373  eErr
374  CCAUXDLL_CALLING_CONV
375  About_getDisplayResolution (ABOUTHANDLE, char* buff, int len);
376 
377 
392  EXTERN_C
393  CCAUXDLL_API
394  eErr
395  CCAUXDLL_CALLING_CONV
396  About_getAddOnPCBSerial (ABOUTHANDLE, char* buff, int len);
397 
412  EXTERN_C
413  CCAUXDLL_API
414  eErr
415  CCAUXDLL_CALLING_CONV
416  About_getAddOnPCBArt (ABOUTHANDLE, char* buff, int length);
417 
432  EXTERN_C
433  CCAUXDLL_API
434  eErr
435  CCAUXDLL_CALLING_CONV
436  About_getAddOnManufacturingDate (ABOUTHANDLE, char* buff, int len);
437 
452  EXTERN_C
453  CCAUXDLL_API
454  eErr
455  CCAUXDLL_CALLING_CONV
456  About_getAddOnHWversion (ABOUTHANDLE, char* buff, int len);
457 
470  EXTERN_C
471  CCAUXDLL_API
472  eErr
473  CCAUXDLL_CALLING_CONV
474  About_getIsWLANMounted (ABOUTHANDLE, bool* mounted);
475 
488  EXTERN_C
489  CCAUXDLL_API
490  eErr
491  CCAUXDLL_CALLING_CONV
492  About_getIsGPSMounted (ABOUTHANDLE, bool* mounted);
493 
506  EXTERN_C
507  CCAUXDLL_API
508  eErr
509  CCAUXDLL_CALLING_CONV
510  About_getIsGPRSMounted (ABOUTHANDLE, bool* mounted);
511 
524  EXTERN_C
525  CCAUXDLL_API
526  eErr
527  CCAUXDLL_CALLING_CONV
528  About_getIsBTMounted (ABOUTHANDLE, bool* mounted);
529 
540  EXTERN_C
541  CCAUXDLL_API
542  eErr
543  CCAUXDLL_CALLING_CONV
544  About_getFrontPcbRev(ABOUTHANDLE, unsigned char* major, unsigned char* minor);
545 
558  EXTERN_C
559  CCAUXDLL_API
560  eErr
561  CCAUXDLL_CALLING_CONV
562  About_getIsIOExpanderMounted (ABOUTHANDLE, bool* mounted);
563 
564 
574  EXTERN_C
575  CCAUXDLL_API
576  eErr
577  CCAUXDLL_CALLING_CONV
578  About_getIOExpanderValue (ABOUTHANDLE, unsigned short* value);
579 
595  EXTERN_C
596  CCAUXDLL_API
597  eErr
598  CCAUXDLL_CALLING_CONV
599  About_hasOsBooted (ABOUTHANDLE, bool* bootComplete);
600 
613  EXTERN_C
614  CCAUXDLL_API
615  eErr
616  CCAUXDLL_CALLING_CONV
617  About_getIsAnybusMounted (ABOUTHANDLE, bool* mounted);
618 
631  EXTERN_C
632  CCAUXDLL_API
633  eErr
634  CCAUXDLL_CALLING_CONV
635  About_getNrOfCfgInConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
636 
637 
650  EXTERN_C
651  CCAUXDLL_API
652  eErr
653  CCAUXDLL_CALLING_CONV
654  About_getNrOfPWMOutConnections (ABOUTHANDLE, unsigned char* NrOfConnections);
655 
656 
669  EXTERN_C
670  CCAUXDLL_API
671  eErr
672  CCAUXDLL_CALLING_CONV
673  About_getNrOfButtons (ABOUTHANDLE, int* numbuttons);
674 
675 
686  EXTERN_C
687  CCAUXDLL_API
688  eErr
689  CCAUXDLL_CALLING_CONV
690  About_getUserEepromData(ABOUTHANDLE, char* buff, unsigned short length);
691 
702  EXTERN_C
703  CCAUXDLL_API
704  eErr
705  CCAUXDLL_CALLING_CONV
706  About_setUserEepromData(ABOUTHANDLE, unsigned short startpos, const char* buff, unsigned short length);
707 
708 #ifdef __cplusplus
709 } /* namespace CrossControl */
710 #endif
711 
712 #endif /* CC_ABOUT_H_ */
713 
714 
Generated on Mon Aug 25 2014 17:48:49 for CCAux by   doxygen 1.8.3.1