CCAux  2.20.0.0
CCAux API reference
Functions
About functions

Functions

EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV GetAbout (void)
 
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_getUnitSerial (ABOUTHANDLE, char_t *buff, int32_t len)
 
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_getMainManufacturingDate (ABOUTHANDLE, char_t *buff, int32_t len)
 
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_getMainProdRev (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_getNrOfETHConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections (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_getIsTouchScreenAvailable (ABOUTHANDLE, bool *available)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable (ABOUTHANDLE, bool *available)
 
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_getAddOnPCBSerial (ABOUTHANDLE, char_t *buff, int32_t len)
 
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_getAddOnManufacturingDate (ABOUTHANDLE, char_t *buff, int32_t len)
 
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_getIsWLANMounted (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_getIsGPRSMounted (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_getFrontPcbRev (ABOUTHANDLE, uint8_t *major, uint8_t *minor)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted (ABOUTHANDLE, bool *mounted)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIOExpanderValue (ABOUTHANDLE, uint16_t *value)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_hasOsBooted (ABOUTHANDLE, bool *bootComplete)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted (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_getNrOfPWMOutConnections (ABOUTHANDLE, uint8_t *NrOfConnections)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons (ABOUTHANDLE, int32_t *numbuttons)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfAnalogInputs (ABOUTHANDLE, int32_t *numanalogins)
 
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_setUserEepromData (ABOUTHANDLE, uint16_t startpos, const char_t *buff, uint16_t length)
 

Detailed Description

Functions in the About class

Function Documentation

◆ About_getAddOnHWversion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnHWversion ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get Add on hardware version.

Supported Platform(s): XL, XM, XS, XA

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getAddOnHWversion(pAbout, buffer, buffer_len);
cout << "Add on hardware version: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnHWversion(ABOUTHANDLE, char_t *buff, int32_t len)
@ ERR_SUCCESS
Definition: CCAuxTypes.h:163

◆ About_getAddOnManufacturingDate()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnManufacturingDate ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get Add on manufacturing date.

Supported Platform(s): XL, XM, XS, XA

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getAddOnManufacturingDate(pAbout, buffer, buffer_len);
cout << "Add on manufacturing date: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getAddOnPCBArt()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnPCBArt ( ABOUTHANDLE  ,
char_t buff,
int32_t  length 
)

Get Add on PCB article number.

Supported Platform(s): XL, XM, XS, XA

Parameters
buffText output buffer.
lengthMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getAddOnPCBArt(pAbout, buffer, buffer_len);
cout << "Add on PCB article number: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)

◆ About_getAddOnPCBSerial()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getAddOnPCBSerial ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get Add on PCB serial number.

Supported Platform(s): XL, XM, XS, XA

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getAddOnPCBSerial(pAbout, buffer, buffer_len);
cout << "Add on PCB serial number: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getAddOnPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getDisplayResolution()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getDisplayResolution ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get display resolution.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned. The display resolution will be returned in the format "1024x768"
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getDisplayResolution(pAbout, buffer, buffer_len);
cout << "Display resolution: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getDisplayResolution(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getFrontPcbRev()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getFrontPcbRev ( ABOUTHANDLE  ,
uint8_t major,
uint8_t minor 
)

Get the front hardware pcb revision in the format major.minor (e.g. 1.1).

Supported Platform(s): XA, XS

Parameters
majorThe major pcb revision.
minorThe minor pcb revision.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ About_getIOExpanderValue()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIOExpanderValue ( ABOUTHANDLE  ,
uint16_t value 
)

Get Value for IO Expander

Supported Platform(s): XA, XS

Parameters
valueIO Expander value.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ About_getIsAnybusMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsAnybusMounted ( ABOUTHANDLE  ,
bool *  mounted 
)

Get Anybus mounting status.

Supported Platform(s): XA, XS

Parameters
mountedIs Anybus mounted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isAnybusMounted;
err = CrossControl::About_getIsAnybusMounted(pAbout, &isAnybusMounted);
cout << "Anybus mounted: " << (isAnybusMounted ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsAnybusMounted(ABOUTHANDLE, bool *mounted)

◆ About_getIsBTMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsBTMounted ( ABOUTHANDLE  ,
bool *  mounted 
)

Get BlueTooth module mounting status.

Supported Platform(s): XL, XM, XS, XA

Parameters
mountedIs module mounted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isBTMounted;
err = About_getIsBTMounted(pAbout, &isBTMounted);
cout << "BT mounted: " << (isBTMounted ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsBTMounted(ABOUTHANDLE, bool *mounted)

◆ About_getIsDisplayAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsDisplayAvailable ( ABOUTHANDLE  ,
bool *  available 
)

Get Display module status. (Some product variants does not have a display)

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
availableIs display available?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool displayAvailable;
err = About_getIsDisplayAvailable(pAbout, &displayAvailable);
cout << "Display available: " << (displayAvailable ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsDisplayAvailable(ABOUTHANDLE, bool *available)

◆ About_getIsGPRSMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsGPRSMounted ( ABOUTHANDLE  ,
bool *  mounted 
)

Get GPRS module mounting status.

Supported Platform(s): XL, XM, XS, XA

Parameters
mountedIs module mounted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isGPRSMounted;
err = About_getIsGPRSMounted(pAbout, &isGPRSMounted);
cout << "GPRS mounted: " << (isGPRSMounted ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPRSMounted(ABOUTHANDLE, bool *mounted)

◆ About_getIsGPSMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsGPSMounted ( ABOUTHANDLE  ,
bool *  mounted 
)

Get GPS module mounting status.

Supported Platform(s): XL, XM, XS, XA

Parameters
mountedIs module mounted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isGPSMounted;
err = About_getIsGPSMounted(pAbout, &isGPSMounted);
cout << "GPS mounted: " << (isGPSMounted ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsGPSMounted(ABOUTHANDLE, bool *mounted)

◆ About_getIsIOExpanderMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsIOExpanderMounted ( ABOUTHANDLE  ,
bool *  mounted 
)

Get IO Expander mounting status.

Supported Platform(s): XA, XS

Parameters
mountedIs IO Expander mounted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isIOExpanderMounted;
err = CrossControl::About_getIsIOExpanderMounted(pAbout, &isIOExpanderMounted);
cout << "IOExpander mounted: " << (isIOExpanderMounted ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsIOExpanderMounted(ABOUTHANDLE, bool *mounted)

◆ About_getIsPCBBluetoothAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsPCBBluetoothAvailable ( ABOUTHANDLE  ,
bool *  available 
)

Get PCB mounted bluetooth status. Not to be confused with the bluetooth module mounted on the telematics add on board

Supported Platform(s): VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
availableIs bluetooth available?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool pcbBluetoothAvailable;
err = About_getIsPCBBluetoothAvailable(pAbout, &pcbBluetoothAvailable);
cout << "PCB Bluetooth available: " << (pcbBluetoothAvailable ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsPCBBluetoothAvailable(ABOUTHANDLE, bool *available)

◆ About_getIsTouchScreenAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsTouchScreenAvailable ( ABOUTHANDLE  ,
bool *  available 
)

Get Display TouchScreen status.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
availableIs TouchScreen available?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool touchScreenAvailable;
err = About_getIsTouchScreenAvailable(pAbout, &touchScreenAvailable);
cout << "TouchScreen available: " << (touchScreenAvailable ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsTouchScreenAvailable(ABOUTHANDLE, bool *available)

◆ About_getIsWLANMounted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getIsWLANMounted ( ABOUTHANDLE  ,
bool *  mounted 
)

Get WLAN module mounting status.

Supported Platform(s): XL, XM, XS, XA, Yukon, V510, V710, V1000, V1200, X1200

Parameters
mountedIs module mounted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isWLANMounted;
err = About_getIsWLANMounted(pAbout, &isWLANMounted);
cout << "WLAN mounted: " << (isWLANMounted ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getIsWLANMounted(ABOUTHANDLE, bool *mounted)

◆ About_getMainHWversion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainHWversion ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get main hardware version (PCB revision).

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getMainHWversion(pAbout, buffer, buffer_len);
cout << "Main hardware version: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainHWversion(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getMainManufacturingDate()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainManufacturingDate ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get main manufacturing date.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getMainManufacturingDate(pAbout, buffer, buffer_len);
cout << "Manufacturing date: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainManufacturingDate(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getMainPCBArt()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainPCBArt ( ABOUTHANDLE  ,
char_t buff,
int32_t  length 
)

Get main PCB article number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lengthMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getMainPCBArt(pAbout, buffer, buffer_len);
cout << "Main PCB article number: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBArt(ABOUTHANDLE, char_t *buff, int32_t length)

◆ About_getMainPCBSerial()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainPCBSerial ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get main PCB serial number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getMainPCBSerial(pAbout, buffer, buffer_len);
cout << "Main PCB serial: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainPCBSerial(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getMainProdArtNr()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainProdArtNr ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get main product article number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getMainProdArtNr(pAbout, buffer, buffer_len);
cout << "Main product article number: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdArtNr(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getMainProdRev()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getMainProdRev ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get main product revision.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getMainProdRev(pAbout, buffer, buffer_len);
cout << "Main product revision: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getMainProdRev(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getNrOfAnalogInputs()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfAnalogInputs ( ABOUTHANDLE  ,
int32_t numanalogins 
)

Get number of external analog inputs.

Supported Platform(s): VI2

Parameters
numanaloginsNumber of external analog inputs.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

◆ About_getNrOfButtons()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfButtons ( ABOUTHANDLE  ,
int32_t numbuttons 
)

Get number of configurable buttons.

Supported Platform(s): VC, VA, VS, VI2, V510, V710, V1000, V1200, Yukon

Parameters
numbuttonsNumber of configurable buttons.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

int nrOfButtons;
err = About_getNrOfButtons(pAbout, &nrOfButtons);
cout << "Nr of configurable buttons: " << (int)nrOfButtons << endl;
cout << "About_getNrOfButtons: Not supported" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfButtons(ABOUTHANDLE, int32_t *numbuttons)
@ ERR_NOT_SUPPORTED
Definition: CCAuxTypes.h:165

◆ About_getNrOfCANConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfCANConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of CAN connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
NrOfConnectionsReturns the number of connections.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfCANConnections;
err = About_getNrOfCANConnections(pAbout, &nrOfCANConnections);
cout << "Nr of CAN connections: " << (int)nrOfCANConnections << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCANConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfCfgInConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfCfgInConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of configurable input connections present.

Supported Platform(s): VC, VA, VS, VI2

Parameters
NrOfConnectionsReturns the number of inputs.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfCfgIn;
err = About_getNrOfCfgInConnections(pAbout, &nrOfCfgIn);
cout << "Nr of configurable inputs: " << (int)nrOfCfgIn << endl;
cout << "About_getNrOfCfgInConnections: Not supported" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfCfgInConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfDigIOConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfDigIOConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of digital I/O connections present.

Supported Platform(s): XL, XM, XS, XA

Parameters
NrOfConnectionsReturns the number of input or input/output connections.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfDigIOConnections;
err = About_getNrOfDigIOConnections(pAbout, &nrOfDigIOConnections);
cout << "Nr of digital I/O connections: " << (int)nrOfDigIOConnections << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfDigIOConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfETHConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfETHConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of Ethernet connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
NrOfConnectionsReturns the number of connections.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfEthConnections;
err = About_getNrOfETHConnections(pAbout, &nrOfEthConnections);
cout << "Nr of ethernet connections: " << (int)nrOfEthConnections << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfETHConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfPWMOutConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfPWMOutConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of PWM Output connections present.

Supported Platform(s): VC, VA, VI2

Parameters
NrOfConnectionsReturns the number of outputs.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfPwmOut;
err = About_getNrOfPWMOutConnections(pAbout, &nrOfPwmOut);
cout << "Nr of PWM outputs: " << (int)nrOfPwmOut << endl;
cout << "About_getNrOfPWMOutConnections: Not supported" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfPWMOutConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfSerialConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfSerialConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of serial port (RS232) connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
NrOfConnectionsReturns the number of connections.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfSerialConnections;
err = About_getNrOfSerialConnections(pAbout, &nrOfSerialConnections);
cout << "Nr of serial connections: " << (int)nrOfSerialConnections << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfSerialConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfUSBConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfUSBConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of USB connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
NrOfConnectionsReturns the number of connections.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfUSBConnections;
err = About_getNrOfUSBConnections(pAbout, &nrOfUSBConnections);
cout << "Nr of USB connections: " << (int)nrOfUSBConnections << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfUSBConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getNrOfVideoConnections()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getNrOfVideoConnections ( ABOUTHANDLE  ,
uint8_t NrOfConnections 
)

Get number of Video connections present.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
NrOfConnectionsReturns the number of connections.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

unsigned char nrOfVideoConnections;
err = About_getNrOfVideoConnections(pAbout, &nrOfVideoConnections);
cout << "Nr of video connections: " << (int)nrOfVideoConnections << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getNrOfVideoConnections(ABOUTHANDLE, uint8_t *NrOfConnections)

◆ About_getUnitSerial()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getUnitSerial ( ABOUTHANDLE  ,
char_t buff,
int32_t  len 
)

Get unit serial number.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
buffText output buffer.
lenMaximum length of the output buffer. If the actual length of the data is greater, an error will be returned.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = About_getUnitSerial(pAbout, buffer, buffer_len);
cout << "Unit serial: " << buffer << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_getUnitSerial(ABOUTHANDLE, char_t *buff, int32_t len)

◆ About_getUserEepromData()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_getUserEepromData ( ABOUTHANDLE  ,
char_t buff,
uint16_t  length 
)

Get User Eeprom data. The user eeprom holds 4096 bytes of data which are fully accessible. Data is always read from position 0.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA

Parameters
buffdata buffer.
lengthdata buffer length or number of data bytes to read.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code.

◆ About_hasOsBooted()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_hasOsBooted ( ABOUTHANDLE  ,
bool *  bootComplete 
)

Get the status of the OS boot process. In Linux, drivers may be delay-loaded at start-up. If the application is started early in the boot-process, this function can be used to determine when full functionality can be obtained from the API/drivers.

Supported Platform(s): XA, XS, VC, VA, VI2, VS, V700, Yukon, V510, V710, V1000, V1200, X1200

Parameters
bootCompleteIs the OS fully booted?
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

bool isBootComplete;
err = CrossControl::About_hasOsBooted(pAbout, &isBootComplete);
cout << "System bootup complete: " << (isBootComplete ? "YES" : "NO") << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV About_hasOsBooted(ABOUTHANDLE, bool *bootComplete)

◆ About_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::About_release ( ABOUTHANDLE  )

Delete the About object.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Returns
-

Example Usage:

ABOUTHANDLE pAbout = ::GetAbout();
assert(pAbout);
list_about_information(pAbout);
About_release(pAbout);
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV About_release(ABOUTHANDLE)
EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV GetAbout(void)
void * ABOUTHANDLE
Definition: About.h:33

◆ About_setUserEepromData()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::About_setUserEepromData ( ABOUTHANDLE  ,
uint16_t  startpos,
const char_t buff,
uint16_t  length 
)

Set User Eeprom data. The user eeprom holds 4096 bytes of data which are fully accessible.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA

Parameters
startposeeprom write start position.
buffdata buffer.
lengthbuffer length to write.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code.

◆ GetAbout()

EXTERN_C CCAUXDLL_API ABOUTHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetAbout ( void  )

Factory function that creates instances of the About object.

Supported Platform(s): XL, XL5, XM, XM9, XS, XA, VC, VA, VS, VI2, V700, Yukon, V510, V710, V1000, V1200, X1200

Returns
ABOUTHANDLE to an allocated About object. The returned handle needs to be deallocated using the About_release(ABOUTHANDLE) method when it's no longer needed.

Returns NULL if it fails to allocate memory.

Example Usage:

ABOUTHANDLE pAbout = ::GetAbout();
assert(pAbout);
list_about_information(pAbout);
About_release(pAbout);