CCAux  2.17.0.0
CCAux API reference
About.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * About.h
6 *
7 * Version 2.17.0.0", 2019-10-22
8 *
9 * (c) CrossControl 2010-2019
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 
55  EXTERN_C
56  CCAUXDLL_API
57  ABOUTHANDLE
58  CCAUXDLL_CALLING_CONV
59  GetAbout(void);
60 
71  EXTERN_C
72  CCAUXDLL_API
73  void
74  CCAUXDLL_CALLING_CONV
75  About_release(ABOUTHANDLE);
76 
91  EXTERN_C
92  CCAUXDLL_API
93  eErr
94  CCAUXDLL_CALLING_CONV
95  About_getMainPCBSerial (ABOUTHANDLE, char_t* buff, int32_t len);
96 
111  EXTERN_C
112  CCAUXDLL_API
113  eErr
114  CCAUXDLL_CALLING_CONV
115  About_getUnitSerial (ABOUTHANDLE, char_t* buff, int32_t len);
116 
131  EXTERN_C
132  CCAUXDLL_API
133  eErr
134  CCAUXDLL_CALLING_CONV
135  About_getMainPCBArt (ABOUTHANDLE, char_t* buff, int32_t length);
136 
151  EXTERN_C
152  CCAUXDLL_API
153  eErr
154  CCAUXDLL_CALLING_CONV
155  About_getMainManufacturingDate (ABOUTHANDLE, char_t* buff, int32_t len);
156 
171  EXTERN_C
172  CCAUXDLL_API
173  eErr
174  CCAUXDLL_CALLING_CONV
175  About_getMainHWversion (ABOUTHANDLE, char_t* buff, int32_t len);
176 
191  EXTERN_C
192  CCAUXDLL_API
193  eErr
194  CCAUXDLL_CALLING_CONV
195  About_getMainProdRev (ABOUTHANDLE, char_t* buff, int32_t len);
196 
211  EXTERN_C
212  CCAUXDLL_API
213  eErr
214  CCAUXDLL_CALLING_CONV
215  About_getMainProdArtNr (ABOUTHANDLE, char_t* buff, int32_t len);
216 
229  EXTERN_C
230  CCAUXDLL_API
231  eErr
232  CCAUXDLL_CALLING_CONV
233  About_getNrOfETHConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
234 
247  EXTERN_C
248  CCAUXDLL_API
249  eErr
250  CCAUXDLL_CALLING_CONV
251  About_getNrOfCANConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
252 
265  EXTERN_C
266  CCAUXDLL_API
267  eErr
268  CCAUXDLL_CALLING_CONV
269  About_getNrOfVideoConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
270 
283  EXTERN_C
284  CCAUXDLL_API
285  eErr
286  CCAUXDLL_CALLING_CONV
287  About_getNrOfUSBConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
288 
301  EXTERN_C
302  CCAUXDLL_API
303  eErr
304  CCAUXDLL_CALLING_CONV
305  About_getNrOfSerialConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
306 
319  EXTERN_C
320  CCAUXDLL_API
321  eErr
322  CCAUXDLL_CALLING_CONV
323  About_getNrOfDigIOConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
324 
337  EXTERN_C
338  CCAUXDLL_API
339  eErr
340  CCAUXDLL_CALLING_CONV
341  About_getIsDisplayAvailable (ABOUTHANDLE, bool* available);
342 
355  EXTERN_C
356  CCAUXDLL_API
357  eErr
358  CCAUXDLL_CALLING_CONV
359  About_getIsTouchScreenAvailable (ABOUTHANDLE, bool* available);
360 
375  EXTERN_C
376  CCAUXDLL_API
377  eErr
378  CCAUXDLL_CALLING_CONV
379  About_getIsPCBBluetoothAvailable (ABOUTHANDLE, bool* available);
380 
396  EXTERN_C
397  CCAUXDLL_API
398  eErr
399  CCAUXDLL_CALLING_CONV
400  About_getDisplayResolution (ABOUTHANDLE, char_t* buff, int32_t len);
401 
416  EXTERN_C
417  CCAUXDLL_API
418  eErr
419  CCAUXDLL_CALLING_CONV
420  About_getAddOnPCBSerial (ABOUTHANDLE, char_t* buff, int32_t len);
421 
436  EXTERN_C
437  CCAUXDLL_API
438  eErr
439  CCAUXDLL_CALLING_CONV
440  About_getAddOnPCBArt (ABOUTHANDLE, char_t* buff, int32_t length);
441 
456  EXTERN_C
457  CCAUXDLL_API
458  eErr
459  CCAUXDLL_CALLING_CONV
460  About_getAddOnManufacturingDate (ABOUTHANDLE, char_t* buff, int32_t len);
461 
476  EXTERN_C
477  CCAUXDLL_API
478  eErr
479  CCAUXDLL_CALLING_CONV
480  About_getAddOnHWversion (ABOUTHANDLE, char_t* buff, int32_t len);
481 
494  EXTERN_C
495  CCAUXDLL_API
496  eErr
497  CCAUXDLL_CALLING_CONV
498  About_getIsWLANMounted (ABOUTHANDLE, bool* mounted);
499 
512  EXTERN_C
513  CCAUXDLL_API
514  eErr
515  CCAUXDLL_CALLING_CONV
516  About_getIsGPSMounted (ABOUTHANDLE, bool* mounted);
517 
530  EXTERN_C
531  CCAUXDLL_API
532  eErr
533  CCAUXDLL_CALLING_CONV
534  About_getIsGPRSMounted (ABOUTHANDLE, bool* mounted);
535 
548  EXTERN_C
549  CCAUXDLL_API
550  eErr
551  CCAUXDLL_CALLING_CONV
552  About_getIsBTMounted (ABOUTHANDLE, bool* mounted);
553 
564  EXTERN_C
565  CCAUXDLL_API
566  eErr
567  CCAUXDLL_CALLING_CONV
568  About_getFrontPcbRev(ABOUTHANDLE, uint8_t* major, uint8_t* minor);
569 
582  EXTERN_C
583  CCAUXDLL_API
584  eErr
585  CCAUXDLL_CALLING_CONV
586  About_getIsIOExpanderMounted (ABOUTHANDLE, bool* mounted);
587 
597  EXTERN_C
598  CCAUXDLL_API
599  eErr
600  CCAUXDLL_CALLING_CONV
601  About_getIOExpanderValue (ABOUTHANDLE, uint16_t* value);
602 
618  EXTERN_C
619  CCAUXDLL_API
620  eErr
621  CCAUXDLL_CALLING_CONV
622  About_hasOsBooted (ABOUTHANDLE, bool* bootComplete);
623 
636  EXTERN_C
637  CCAUXDLL_API
638  eErr
639  CCAUXDLL_CALLING_CONV
640  About_getIsAnybusMounted (ABOUTHANDLE, bool* mounted);
641 
654  EXTERN_C
655  CCAUXDLL_API
656  eErr
657  CCAUXDLL_CALLING_CONV
658  About_getNrOfCfgInConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
659 
672  EXTERN_C
673  CCAUXDLL_API
674  eErr
675  CCAUXDLL_CALLING_CONV
676  About_getNrOfPWMOutConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
677 
690  EXTERN_C
691  CCAUXDLL_API
692  eErr
693  CCAUXDLL_CALLING_CONV
694  About_getNrOfButtons (ABOUTHANDLE, int32_t* numbuttons);
695 
708  EXTERN_C
709  CCAUXDLL_API
710  eErr
711  CCAUXDLL_CALLING_CONV
712  About_getNrOfAnalogInputs (ABOUTHANDLE, int32_t* numanalogins);
713 
724  EXTERN_C
725  CCAUXDLL_API
726  eErr
727  CCAUXDLL_CALLING_CONV
728  About_getUserEepromData(ABOUTHANDLE, char_t* buff, uint16_t length);
729 
740  EXTERN_C
741  CCAUXDLL_API
742  eErr
743  CCAUXDLL_CALLING_CONV
744  About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t* buff, uint16_t length);
745 
747 #ifdef __cplusplus
748 } /* namespace CrossControl */
749 #endif
750 
751 #endif /* CC_ABOUT_H_ */
752 
753 
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CCPlatform.h
CrossControl::About_getNrOfETHConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfETHConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getMainHWversion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getIsTouchScreenAvailable
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsTouchScreenAvailable(ABOUTHANDLE, bool *available)
CrossControl::About_getNrOfButtons
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons(ABOUTHANDLE, int32_t *numbuttons)
CrossControl::About_getNrOfSerialConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getIsPCBBluetoothAvailable
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable(ABOUTHANDLE, bool *available)
CrossControl::About_getAddOnPCBArt
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)
CrossControl::About_getMainPCBArt
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)
CrossControl::About_getMainPCBSerial
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl
Definition: About.h:30
CrossControl::About_setUserEepromData
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length)
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::About_getIsBTMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsBTMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getAddOnPCBSerial
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getMainManufacturingDate
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getNrOfCfgInConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCfgInConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_hasOsBooted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_hasOsBooted(ABOUTHANDLE, bool *bootComplete)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CrossControl::About_getIsGPSMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPSMounted(ABOUTHANDLE, bool *mounted)
int32_t
signed int int32_t
Definition: CCAuxTypes.h:46
CrossControl::About_getNrOfAnalogInputs
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfAnalogInputs(ABOUTHANDLE, int32_t *numanalogins)
CrossControl::About_getIsDisplayAvailable
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsDisplayAvailable(ABOUTHANDLE, bool *available)
CrossControl::About_getUserEepromData
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUserEepromData(ABOUTHANDLE, char_t *buff, uint16_t length)
CCAuxErrors.h
CrossControl::GetAbout
EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV GetAbout(void)
CrossControl::About_getNrOfDigIOConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getNrOfUSBConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getIsWLANMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsWLANMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getIOExpanderValue
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIOExpanderValue(ABOUTHANDLE, uint16_t *value)
CrossControl::About_getDisplayResolution
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getDisplayResolution(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getIsGPRSMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPRSMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getIsAnybusMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getNrOfVideoConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getFrontPcbRev
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getFrontPcbRev(ABOUTHANDLE, uint8_t *major, uint8_t *minor)
CrossControl::About_getNrOfCANConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getAddOnHWversion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getIsIOExpanderMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getAddOnManufacturingDate
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getNrOfPWMOutConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfPWMOutConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getMainProdRev
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdRev(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getMainProdArtNr
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdArtNr(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getUnitSerial
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUnitSerial(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV About_release(ABOUTHANDLE)
char_t
char char_t
Definition: CCAuxTypes.h:27
CrossControl::ABOUTHANDLE
void * ABOUTHANDLE
Definition: About.h:33
Generated on Tue Oct 22 2019 17:00:44 for CCAux by   doxygen 1.8.14