CCAux  2.20.0.0
CCAux API reference
About.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 2023 CrossControl AB
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; with
8  * version 2.1 of the License.
9  */
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 {
31 #endif
32 
33 typedef void *ABOUTHANDLE;
34 
55 EXTERN_C
56 CCAUXDLL_API
58 CCAUXDLL_CALLING_CONV
59 GetAbout(void);
60 
71 EXTERN_C
72 CCAUXDLL_API
73 void CCAUXDLL_CALLING_CONV About_release(ABOUTHANDLE);
74 
89 EXTERN_C
90 CCAUXDLL_API
91 eErr CCAUXDLL_CALLING_CONV About_getMainPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len);
92 
107 EXTERN_C
108 CCAUXDLL_API
109 eErr CCAUXDLL_CALLING_CONV About_getUnitSerial(ABOUTHANDLE, char_t *buff, int32_t len);
110 
125 EXTERN_C
126 CCAUXDLL_API
127 eErr CCAUXDLL_CALLING_CONV About_getMainPCBArt(ABOUTHANDLE, char_t *buff, int32_t length);
128 
143 EXTERN_C
144 CCAUXDLL_API
145 eErr CCAUXDLL_CALLING_CONV About_getMainManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len);
146 
161 EXTERN_C
162 CCAUXDLL_API
163 eErr CCAUXDLL_CALLING_CONV About_getMainHWversion(ABOUTHANDLE, char_t *buff, int32_t len);
164 
179 EXTERN_C
180 CCAUXDLL_API
181 eErr CCAUXDLL_CALLING_CONV About_getMainProdRev(ABOUTHANDLE, char_t *buff, int32_t len);
182 
197 EXTERN_C
198 CCAUXDLL_API
199 eErr CCAUXDLL_CALLING_CONV About_getMainProdArtNr(ABOUTHANDLE, char_t *buff, int32_t len);
200 
213 EXTERN_C
214 CCAUXDLL_API
215 eErr CCAUXDLL_CALLING_CONV About_getNrOfETHConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
216 
229 EXTERN_C
230 CCAUXDLL_API
231 eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
232 
245 EXTERN_C
246 CCAUXDLL_API
247 eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
248 
261 EXTERN_C
262 CCAUXDLL_API
263 eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
264 
277 EXTERN_C
278 CCAUXDLL_API
279 eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
280 
293 EXTERN_C
294 CCAUXDLL_API
295 eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
296 
309 EXTERN_C
310 CCAUXDLL_API
311 eErr CCAUXDLL_CALLING_CONV About_getIsDisplayAvailable(ABOUTHANDLE, bool *available);
312 
325 EXTERN_C
326 CCAUXDLL_API
327 eErr CCAUXDLL_CALLING_CONV About_getIsTouchScreenAvailable(ABOUTHANDLE, bool *available);
328 
343 EXTERN_C
344 CCAUXDLL_API
345 eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable(ABOUTHANDLE, bool *available);
346 
362 EXTERN_C
363 CCAUXDLL_API
364 eErr CCAUXDLL_CALLING_CONV About_getDisplayResolution(ABOUTHANDLE, char_t *buff, int32_t len);
365 
380 EXTERN_C
381 CCAUXDLL_API
382 eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len);
383 
398 EXTERN_C
399 CCAUXDLL_API
400 eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBArt(ABOUTHANDLE, char_t *buff, int32_t length);
401 
416 EXTERN_C
417 CCAUXDLL_API
418 eErr CCAUXDLL_CALLING_CONV About_getAddOnManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len);
419 
434 EXTERN_C
435 CCAUXDLL_API
436 eErr CCAUXDLL_CALLING_CONV About_getAddOnHWversion(ABOUTHANDLE, char_t *buff, int32_t len);
437 
450 EXTERN_C
451 CCAUXDLL_API
452 eErr CCAUXDLL_CALLING_CONV About_getIsWLANMounted(ABOUTHANDLE, bool *mounted);
453 
466 EXTERN_C
467 CCAUXDLL_API
468 eErr CCAUXDLL_CALLING_CONV About_getIsGPSMounted(ABOUTHANDLE, bool *mounted);
469 
482 EXTERN_C
483 CCAUXDLL_API
484 eErr CCAUXDLL_CALLING_CONV About_getIsGPRSMounted(ABOUTHANDLE, bool *mounted);
485 
498 EXTERN_C
499 CCAUXDLL_API
500 eErr CCAUXDLL_CALLING_CONV About_getIsBTMounted(ABOUTHANDLE, bool *mounted);
501 
512 EXTERN_C
513 CCAUXDLL_API
514 eErr CCAUXDLL_CALLING_CONV About_getFrontPcbRev(ABOUTHANDLE, uint8_t *major, uint8_t *minor);
515 
528 EXTERN_C
529 CCAUXDLL_API
530 eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted(ABOUTHANDLE, bool *mounted);
531 
541 EXTERN_C
542 CCAUXDLL_API
543 eErr CCAUXDLL_CALLING_CONV About_getIOExpanderValue(ABOUTHANDLE, uint16_t *value);
544 
560 EXTERN_C
561 CCAUXDLL_API
562 eErr CCAUXDLL_CALLING_CONV About_hasOsBooted(ABOUTHANDLE, bool *bootComplete);
563 
576 EXTERN_C
577 CCAUXDLL_API
578 eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted(ABOUTHANDLE, bool *mounted);
579 
592 EXTERN_C
593 CCAUXDLL_API
594 eErr CCAUXDLL_CALLING_CONV About_getNrOfCfgInConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
595 
608 EXTERN_C
609 CCAUXDLL_API
610 eErr CCAUXDLL_CALLING_CONV About_getNrOfPWMOutConnections(ABOUTHANDLE, uint8_t *NrOfConnections);
611 
624 EXTERN_C
625 CCAUXDLL_API
626 eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons(ABOUTHANDLE, int32_t *numbuttons);
627 
640 EXTERN_C
641 CCAUXDLL_API
642 eErr CCAUXDLL_CALLING_CONV About_getNrOfAnalogInputs(ABOUTHANDLE, int32_t *numanalogins);
643 
654 EXTERN_C
655 CCAUXDLL_API
656 eErr CCAUXDLL_CALLING_CONV About_getUserEepromData(ABOUTHANDLE, char_t *buff, uint16_t length);
657 
668 EXTERN_C
669 CCAUXDLL_API
670 eErr CCAUXDLL_CALLING_CONV About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length);
671 
673 #ifdef __cplusplus
674 } /* namespace CrossControl */
675 #endif
676 
677 #endif /* CC_ABOUT_H_ */
unsigned short uint16_t
Definition: CCAuxTypes.h:38
char char_t
Definition: CCAuxTypes.h:17
signed int int32_t
Definition: CCAuxTypes.h:36
unsigned char uint8_t
Definition: CCAuxTypes.h:37
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable(ABOUTHANDLE, bool *available)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_setUserEepromData(ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPRSMounted(ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCfgInConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsDisplayAvailable(ABOUTHANDLE, bool *available)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfAnalogInputs(ABOUTHANDLE, int32_t *numanalogins)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsTouchScreenAvailable(ABOUTHANDLE, bool *available)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdRev(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons(ABOUTHANDLE, int32_t *numbuttons)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted(ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsBTMounted(ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfPWMOutConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted(ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPSMounted(ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getFrontPcbRev(ABOUTHANDLE, uint8_t *major, uint8_t *minor)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV About_release(ABOUTHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUserEepromData(ABOUTHANDLE, char_t *buff, uint16_t length)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_hasOsBooted(ABOUTHANDLE, bool *bootComplete)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getDisplayResolution(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfETHConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsWLANMounted(ABOUTHANDLE, bool *mounted)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIOExpanderValue(ABOUTHANDLE, uint16_t *value)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUnitSerial(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdArtNr(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV GetAbout(void)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections(ABOUTHANDLE, uint8_t *NrOfConnections)
Definition: About.h:30
void * ABOUTHANDLE
Definition: About.h:33
eErr
Definition: CCAuxTypes.h:162