CCAux  2.20.0.0
CCAux API reference
Functions
Telematics functions

Functions

EXTERN_C CCAUXDLL_API TELEMATICSHANDLE CCAUXDLL_CALLING_CONV GetTelematics (void)
 
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Telematics_release (TELEMATICSHANDLE)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getTelematicsAvailable (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPRSPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPRSStartUpPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getWLANPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getWLANStartUpPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getBTPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getBTStartUpPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPSPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPSStartUpPowerStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPSAntennaStatus (TELEMATICSHANDLE, CCStatus *status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setGPRSPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setGPRSStartUpPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setWLANPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setWLANStartUpPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setBTPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setBTStartUpPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setGPSPowerStatus (TELEMATICSHANDLE, CCStatus status)
 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_setGPSStartUpPowerStatus (TELEMATICSHANDLE, CCStatus status)
 

Detailed Description

Functions in the Telematics class

Function Documentation

◆ GetTelematics()

EXTERN_C CCAUXDLL_API TELEMATICSHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetTelematics ( void  )

Factory function that creates instances of the Telematics object.

Supported Platform(s): XM, XA, XS

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

Example Usage:

assert(pTelematics);
telematics_example(pTelematics);
Telematics_release(pTelematics);
EXTERN_C CCAUXDLL_API TELEMATICSHANDLE CCAUXDLL_CALLING_CONV GetTelematics(void)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV Telematics_release(TELEMATICSHANDLE)
void * TELEMATICSHANDLE
Definition: Telematics.h:34

◆ Telematics_getBTPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getBTPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get Bluetooth power status.

Supported Platform(s): XM, XA, XS

Parameters
statusBluetooth power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getBTPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "Bluetooth power is " << ((status == Enabled) ? "ON" : "OFF") << endl;
}
{
cout << "getBLPowerStatus: Bluetooth is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getBLPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getBTPowerStatus(TELEMATICSHANDLE, CCStatus *status)
EXTERN_C CCAUXDLL_API char_t const *CCAUXDLL_CALLING_CONV GetErrorStringA(eErr errCode)
@ Enabled
Definition: CCAuxTypes.h:155
@ ERR_SUCCESS
Definition: CCAuxTypes.h:163
@ ERR_TELEMATICS_BT_NOT_AVAILABLE
Definition: CCAuxTypes.h:193

◆ Telematics_getBTStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getBTStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get Bluetooth power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusBluetooth power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getBTStartUpPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "Bluetooth power is " << ((status == Enabled) ? "Enabled" : "Disabled") << " at start-up" << endl;
}
{
cout << "getBTStartUpPowerStatus: Bluetooth is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getBTStartUpPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getBTStartUpPowerStatus(TELEMATICSHANDLE, CCStatus *status)

◆ Telematics_getGPRSPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getGPRSPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get GPRS power status.

Supported Platform(s): XM, XA, XS

Parameters
statusGPRS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getGPRSPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "GSM/GPRS power is " << ((status == Enabled) ? "ON" : "OFF") << endl;
}
{
cout << "getGPRSPowerStatus: GSM/GPRS is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getGPRSPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPRSPowerStatus(TELEMATICSHANDLE, CCStatus *status)
@ ERR_TELEMATICS_GPRS_NOT_AVAILABLE
Definition: CCAuxTypes.h:191

◆ Telematics_getGPRSStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getGPRSStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get GPRS power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusGPRS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getGPRSStartUpPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "GSM/GPRS power is " << ((status == Enabled) ? "Enabled" : "Disabled") << " at start-up" << endl;
}
{
cout << "getGPRSStartUpPowerStatus: GSM/GPRS is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getGPRSStartUpPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPRSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus *status)

◆ Telematics_getGPSAntennaStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getGPSAntennaStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get GPS antenna status. Antenna open/short detection. The status is set to disabled if no antenna is present or a short is detected. Note, This function is only supported on revision A Telematic Addon Cards (produced before 2015-09).

Supported Platform(s): XM

Parameters
statusGPS antenna power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getGPSAntennaStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "GPS antenna status: " << ((status == Enabled) ? "OK" : "ERROR: Open connection or short-circuit")
<< endl;
}
{
cout << "getGPSAntennaStatus: GPS is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getGPSAntennaStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPSAntennaStatus(TELEMATICSHANDLE, CCStatus *status)
@ ERR_TELEMATICS_GPS_NOT_AVAILABLE
Definition: CCAuxTypes.h:194

◆ Telematics_getGPSPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getGPSPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get GPS power status. Note that it can take some time after calling setGPSPowerStatus before the status is reported correctly.

Supported Platform(s): XM, XA, XS

Parameters
statusGPS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getGPSPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "GPS power is " << ((status == Enabled) ? "ON" : "OFF") << endl;
}
{
cout << "getGPSPowerStatus: GPS is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getGPSPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPSPowerStatus(TELEMATICSHANDLE, CCStatus *status)

◆ Telematics_getGPSStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getGPSStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get GPS power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusGPS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getGPSStartUpPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "GPS power is " << ((status == Enabled) ? "Enabled" : "Disabled") << " at start-up" << endl;
}
{
cout << "getGPSStartUpPowerStatus: GPS is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getGPSStartUpPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getGPSStartUpPowerStatus(TELEMATICSHANDLE, CCStatus *status)

◆ Telematics_getTelematicsAvailable()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getTelematicsAvailable ( TELEMATICSHANDLE  ,
CCStatus status 
)

Is a telematics add-on card installed?

Supported Platform(s): XM, XA, XS

Parameters
statusEnabled if a telematics add-on card is installed, otherwise Disabled.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getTelematicsAvailable(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "Telematics add-on board: " << ((status == Enabled) ? "available" : "not available") << endl;
if (status == Disabled)
return;
}
else
{
cout << "Error(" << err << ") in function getTelematicsAvailable: " << GetErrorStringA(err) << endl;
return;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getTelematicsAvailable(TELEMATICSHANDLE, CCStatus *status)
@ Disabled
Definition: CCAuxTypes.h:154

◆ Telematics_getWLANPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getWLANPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get WLAN power status.

Supported Platform(s): XM, XA, XS

Parameters
statusWLAN power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getWLANPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "WLAN power is " << ((status == Enabled) ? "ON" : "OFF") << endl;
}
{
cout << "getWLANPowerStatus: WLAN is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getWLANPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getWLANPowerStatus(TELEMATICSHANDLE, CCStatus *status)
@ ERR_TELEMATICS_WLAN_NOT_AVAILABLE
Definition: CCAuxTypes.h:192

◆ Telematics_getWLANStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_getWLANStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus status 
)

Get WLAN power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusWLAN power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

err = Telematics_getWLANStartUpPowerStatus(pTelematics, &status);
if (err == ERR_SUCCESS)
{
cout << "WLAN power is " << ((status == Enabled) ? "Enabled" : "Disabled") << " at start-up" << endl;
}
{
cout << "getWLANStartUpPowerStatus: WLAN is not available on this platform" << endl;
}
else
{
cout << "Error(" << err << ") in function getWLANStartUpPowerStatus: " << GetErrorStringA(err) << endl;
}
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV Telematics_getWLANStartUpPowerStatus(TELEMATICSHANDLE, CCStatus *status)

◆ Telematics_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::Telematics_release ( TELEMATICSHANDLE  )

Delete the Telematics object.

Supported Platform(s): XM, XA, XS

Returns
-

Example Usage:

assert(pTelematics);
telematics_example(pTelematics);
Telematics_release(pTelematics);

◆ Telematics_setBTPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setBTPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set Bluetooth power status.

Supported Platform(s): XM, XA, XS

Parameters
statusBluetooth power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setBTStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setBTStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set Bluetooth power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusBluetooth power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setGPRSPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setGPRSPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set GPRS modem power status.

Supported Platform(s): XM, XA, XS

Parameters
statusGPRS modem power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setGPRSStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setGPRSStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set GPRS power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusGPRS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setGPSPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setGPSPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set GPS power status.

Supported Platform(s): XM, XA, XS

Parameters
statusGPS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setGPSStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setGPSStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set GPS power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusGPS power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setWLANPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setWLANPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set WLAN power status.

Supported Platform(s): XM, XA, XS

Parameters
statusWLAN power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ Telematics_setWLANStartUpPowerStatus()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::Telematics_setWLANStartUpPowerStatus ( TELEMATICSHANDLE  ,
CCStatus  status 
)

Set WLAN power status at startup and at resume from suspended mode.

Supported Platform(s): XM, XA, XS

Parameters
statusWLAN power status.
Returns
error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.