CCAux  2.15.2.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.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
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_t* buff, int32_t len);
90 
105  EXTERN_C
106  CCAUXDLL_API
107  eErr
108  CCAUXDLL_CALLING_CONV
109  About_getUnitSerial (ABOUTHANDLE, char_t* buff, int32_t len);
110 
125  EXTERN_C
126  CCAUXDLL_API
127  eErr
128  CCAUXDLL_CALLING_CONV
129  About_getMainPCBArt (ABOUTHANDLE, char_t* buff, int32_t length);
130 
145  EXTERN_C
146  CCAUXDLL_API
147  eErr
148  CCAUXDLL_CALLING_CONV
149  About_getMainManufacturingDate (ABOUTHANDLE, char_t* buff, int32_t len);
150 
165  EXTERN_C
166  CCAUXDLL_API
167  eErr
168  CCAUXDLL_CALLING_CONV
169  About_getMainHWversion (ABOUTHANDLE, char_t* buff, int32_t len);
170 
185  EXTERN_C
186  CCAUXDLL_API
187  eErr
188  CCAUXDLL_CALLING_CONV
189  About_getMainProdRev (ABOUTHANDLE, char_t* buff, int32_t len);
190 
205  EXTERN_C
206  CCAUXDLL_API
207  eErr
208  CCAUXDLL_CALLING_CONV
209  About_getMainProdArtNr (ABOUTHANDLE, char_t* buff, int32_t len);
210 
223  EXTERN_C
224  CCAUXDLL_API
225  eErr
226  CCAUXDLL_CALLING_CONV
227  About_getNrOfETHConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
228 
241  EXTERN_C
242  CCAUXDLL_API
243  eErr
244  CCAUXDLL_CALLING_CONV
245  About_getNrOfCANConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
246 
259  EXTERN_C
260  CCAUXDLL_API
261  eErr
262  CCAUXDLL_CALLING_CONV
263  About_getNrOfVideoConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
264 
277  EXTERN_C
278  CCAUXDLL_API
279  eErr
280  CCAUXDLL_CALLING_CONV
281  About_getNrOfUSBConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
282 
295  EXTERN_C
296  CCAUXDLL_API
297  eErr
298  CCAUXDLL_CALLING_CONV
299  About_getNrOfSerialConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
300 
313  EXTERN_C
314  CCAUXDLL_API
315  eErr
316  CCAUXDLL_CALLING_CONV
317  About_getNrOfDigIOConnections (ABOUTHANDLE, uint8_t* 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 
369  EXTERN_C
370  CCAUXDLL_API
371  eErr
372  CCAUXDLL_CALLING_CONV
373  About_getIsPCBBluetoothAvailable (ABOUTHANDLE, bool* available);
374 
390  EXTERN_C
391  CCAUXDLL_API
392  eErr
393  CCAUXDLL_CALLING_CONV
394  About_getDisplayResolution (ABOUTHANDLE, char_t* buff, int32_t len);
395 
410  EXTERN_C
411  CCAUXDLL_API
412  eErr
413  CCAUXDLL_CALLING_CONV
414  About_getAddOnPCBSerial (ABOUTHANDLE, char_t* buff, int32_t len);
415 
430  EXTERN_C
431  CCAUXDLL_API
432  eErr
433  CCAUXDLL_CALLING_CONV
434  About_getAddOnPCBArt (ABOUTHANDLE, char_t* buff, int32_t length);
435 
450  EXTERN_C
451  CCAUXDLL_API
452  eErr
453  CCAUXDLL_CALLING_CONV
454  About_getAddOnManufacturingDate (ABOUTHANDLE, char_t* buff, int32_t len);
455 
470  EXTERN_C
471  CCAUXDLL_API
472  eErr
473  CCAUXDLL_CALLING_CONV
474  About_getAddOnHWversion (ABOUTHANDLE, char_t* buff, int32_t len);
475 
488  EXTERN_C
489  CCAUXDLL_API
490  eErr
491  CCAUXDLL_CALLING_CONV
492  About_getIsWLANMounted (ABOUTHANDLE, bool* mounted);
493 
506  EXTERN_C
507  CCAUXDLL_API
508  eErr
509  CCAUXDLL_CALLING_CONV
510  About_getIsGPSMounted (ABOUTHANDLE, bool* mounted);
511 
524  EXTERN_C
525  CCAUXDLL_API
526  eErr
527  CCAUXDLL_CALLING_CONV
528  About_getIsGPRSMounted (ABOUTHANDLE, bool* mounted);
529 
542  EXTERN_C
543  CCAUXDLL_API
544  eErr
545  CCAUXDLL_CALLING_CONV
546  About_getIsBTMounted (ABOUTHANDLE, bool* mounted);
547 
558  EXTERN_C
559  CCAUXDLL_API
560  eErr
561  CCAUXDLL_CALLING_CONV
562  About_getFrontPcbRev(ABOUTHANDLE, uint8_t* major, uint8_t* minor);
563 
576  EXTERN_C
577  CCAUXDLL_API
578  eErr
579  CCAUXDLL_CALLING_CONV
580  About_getIsIOExpanderMounted (ABOUTHANDLE, bool* mounted);
581 
591  EXTERN_C
592  CCAUXDLL_API
593  eErr
594  CCAUXDLL_CALLING_CONV
595  About_getIOExpanderValue (ABOUTHANDLE, uint16_t* value);
596 
612  EXTERN_C
613  CCAUXDLL_API
614  eErr
615  CCAUXDLL_CALLING_CONV
616  About_hasOsBooted (ABOUTHANDLE, bool* bootComplete);
617 
630  EXTERN_C
631  CCAUXDLL_API
632  eErr
633  CCAUXDLL_CALLING_CONV
634  About_getIsAnybusMounted (ABOUTHANDLE, bool* mounted);
635 
648  EXTERN_C
649  CCAUXDLL_API
650  eErr
651  CCAUXDLL_CALLING_CONV
652  About_getNrOfCfgInConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
653 
666  EXTERN_C
667  CCAUXDLL_API
668  eErr
669  CCAUXDLL_CALLING_CONV
670  About_getNrOfPWMOutConnections (ABOUTHANDLE, uint8_t* NrOfConnections);
671 
684  EXTERN_C
685  CCAUXDLL_API
686  eErr
687  CCAUXDLL_CALLING_CONV
688  About_getNrOfButtons (ABOUTHANDLE, int32_t* numbuttons);
689 
702  EXTERN_C
703  CCAUXDLL_API
704  eErr
705  CCAUXDLL_CALLING_CONV
706  About_getNrOfAnalogInputs (ABOUTHANDLE, int32_t* numanalogins);
707 
718  EXTERN_C
719  CCAUXDLL_API
720  eErr
721  CCAUXDLL_CALLING_CONV
722  About_getUserEepromData(ABOUTHANDLE, char_t* buff, uint16_t length);
723 
734  EXTERN_C
735  CCAUXDLL_API
736  eErr
737  CCAUXDLL_CALLING_CONV
738  About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t* buff, uint16_t length);
739 
740 #ifdef __cplusplus
741 } /* namespace CrossControl */
742 #endif
743 
744 #endif /* CC_ABOUT_H_ */
745 
746 
CrossControl::About_getNrOfAnalogInputs
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfAnalogInputs(ABOUTHANDLE, int32_t *numanalogins)
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CrossControl::About_getIsIOExpanderMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getUserEepromData
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUserEepromData(ABOUTHANDLE, char_t *buff, uint16_t length)
CCPlatform.h
CrossControl::About_setUserEepromData
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length)
CrossControl::GetAbout
EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV GetAbout(void)
CrossControl::About_getIsGPRSMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPRSMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV About_release(ABOUTHANDLE)
CrossControl::About_getMainHWversion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl
Definition: About.h:30
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)
uint16_t
unsigned short uint16_t
Definition: CCAuxTypes.h:48
CrossControl::About_getNrOfVideoConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getIsBTMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsBTMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getNrOfETHConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfETHConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
int32_t
signed int int32_t
Definition: CCAuxTypes.h:46
CrossControl::About_getMainPCBSerial
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getDisplayResolution
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getDisplayResolution(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_hasOsBooted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_hasOsBooted(ABOUTHANDLE, bool *bootComplete)
CCAuxErrors.h
CrossControl::About_getNrOfCfgInConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCfgInConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getIOExpanderValue
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIOExpanderValue(ABOUTHANDLE, uint16_t *value)
CrossControl::About_getIsPCBBluetoothAvailable
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable(ABOUTHANDLE, bool *available)
CrossControl::About_getAddOnManufacturingDate
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getFrontPcbRev
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getFrontPcbRev(ABOUTHANDLE, uint8_t *major, uint8_t *minor)
CrossControl::About_getNrOfSerialConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getIsDisplayAvailable
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsDisplayAvailable(ABOUTHANDLE, bool *available)
CrossControl::About_getIsTouchScreenAvailable
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsTouchScreenAvailable(ABOUTHANDLE, bool *available)
CrossControl::About_getNrOfDigIOConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getAddOnPCBArt
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)
CrossControl::About_getIsGPSMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPSMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getMainProdArtNr
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdArtNr(ABOUTHANDLE, char_t *buff, int32_t len)
CrossControl::About_getNrOfButtons
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons(ABOUTHANDLE, int32_t *numbuttons)
CrossControl::About_getUnitSerial
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUnitSerial(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_getNrOfCANConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getMainPCBArt
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)
CrossControl::About_getIsWLANMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsWLANMounted(ABOUTHANDLE, bool *mounted)
CrossControl::About_getAddOnHWversion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
char_t
char char_t
Definition: CCAuxTypes.h:27
CrossControl::About_getNrOfUSBConnections
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
CrossControl::About_getIsAnybusMounted
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted(ABOUTHANDLE, bool *mounted)
CrossControl::ABOUTHANDLE
void * ABOUTHANDLE
Definition: About.h:33
Generated on Wed Jul 8 2020 12:44:31 for CCAux by   doxygen 1.8.14