CCAux  2.20.0.0
CCAux API reference
Functions
AuxVersion functions

Functions

EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV GetAuxVersion (void)
 
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV AuxVersion_release (AUXVERSIONHANDLE)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFPGAVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getSSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFullSSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFrontVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getDMCUVersion (AUXVERSIONHANDLE, int index, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getIOMCUVersion (AUXVERSIONHANDLE, int index, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getOSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxDrvVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdMcuVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getAllCanFdMcuVersions (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, int index)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdApiVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFullOSVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFullCCAuxVersion (AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)
 

Detailed Description

Functions in the AuxVersion class

Function Documentation

◆ AuxVersion_getAllCanFdMcuVersions()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getAllCanFdMcuVersions ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build,
int  index 
)

Get the CAN FD microcontroller firmware version on platforms supporting more than one CAN FD microcontroller.

Supported Platform(s): XM9, X1200

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
indexIndex of canfd mcu (index starts at 1)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getAllCanFdMcuVersions(pAuxVersion, &major, &minor, &release, &build, canfdmcu_index);
cout << setw(column_width) << "CAN FD MCU " << canfdmcu_index << " version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getAllCanFdMcuVersions(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, int index)
@ ERR_SUCCESS
Definition: CCAuxTypes.h:163

◆ AuxVersion_getCanFdApiVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCanFdApiVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the CAN FD Windows API version.

Supported Platform(s): XL5, XM9

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

◆ AuxVersion_getCanFdMcuVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCanFdMcuVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the CAN FD microcontroller firmware version.

Supported Platform(s): XL5, XM9, X1200

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getCanFdMcuVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "CAN FD MCU Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdMcuVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_getCCAuxDrvVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCCAuxDrvVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the CrossControl CCAux CCAuxDrv version. Can be used to check that the correct driver is loaded.

Supported Platform(s): XL, XM

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getCCAuxDrvVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "CCAux Driver Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxDrvVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_getCCAuxVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getCCAuxVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the CrossControl CCAux API version. CCAux includes: CCAuxService/ccauxd - Windows Service/Linux daemon. CCAux2.dll/libccaux2 - The implementation of this API.

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getCCAuxVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "CC Aux Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_getDMCUVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getDMCUVersion ( AUXVERSIONHANDLE  ,
int  index,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the display microcontroller software version

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

Parameters
indexIndex of mcu
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ AuxVersion_getFPGAVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFPGAVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the FPGA software version

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getFPGAVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "FPGA Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFPGAVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_getFrontVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFrontVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the front microcontroller software version

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getFrontVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "Front Micro Controller Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFrontVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_getFullCCAuxVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFullCCAuxVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build,
char_t tag,
uint32_t  len 
)

Get the CrossControl CCAux API version including tag name. CCAux includes: CCAuxService/ccauxd - Windows Service/Linux daemon. CCAux2.dll/libccaux2 - The implementation of this API.

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
tagTag name
lenNumber of chars to read from the tag name (max 100)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getCCAuxVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "CC Aux Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;

◆ AuxVersion_getFullOSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFullOSVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build,
char_t tag,
uint32_t  len 
)

Get the CrossControl Operating System version including tag name.

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
tagTag name
lenNumber of chars to read from the tag name (max 100)
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

◆ AuxVersion_getFullSSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getFullSSVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build,
char_t tag,
uint32_t  len 
)

Get the System Supervisor software full version string

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
taga return pointer to the version string
lenis the tag buffer size
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

◆ AuxVersion_getIOMCUVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getIOMCUVersion ( AUXVERSIONHANDLE  ,
int  index,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the IO microcontroller software version

Supported Platform(s): Yukon, V510, V710

Parameters
indexIndex of mcu
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ AuxVersion_getOSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getOSVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the CrossControl Operating System version.

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getOSVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "Operating System Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getOSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_getSSVersion()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_getSSVersion ( AUXVERSIONHANDLE  ,
uint8_t major,
uint8_t minor,
uint8_t release,
uint8_t build 
)

Get the System Supervisor software version

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

Parameters
majorMajor version number
minorMinor version number
releaseRelease version number
buildBuild version number
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = AuxVersion_getSSVersion(pAuxVersion, &major, &minor, &release, &build);
cout << setw(column_width) << "System Supervisor Version: ";
cout << (int)major << "." << (int)minor << "." << (int)release << "." << (int)build << endl;
else
cout << "unknown" << endl;
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getSSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)

◆ AuxVersion_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::AuxVersion_release ( AUXVERSIONHANDLE  )

Delete the AuxVersion object.

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

Returns
-

Example Usage:

assert(pAuxVersion);
output_versions(pAuxVersion);
AuxVersion_release(pAuxVersion);
EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV GetAuxVersion(void)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV AuxVersion_release(AUXVERSIONHANDLE)
void * AUXVERSIONHANDLE
Definition: AuxVersion.h:33

◆ GetAuxVersion()

EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetAuxVersion ( void  )

Factory function that creates instances of the AuxVersion object.

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

Returns
AUXVERSIONHANDLE to an allocated AuxVersion object. The returned handle needs to be deallocated using the AuxVersion_release(AUXVERSIONHANDLE) method when it's no longer needed. Returns NULL if it fails to allocate memory.

Example Usage:

assert(pAuxVersion);
output_versions(pAuxVersion);
AuxVersion_release(pAuxVersion);