Telematics.h

Go to the documentation of this file.

/************************************************
 *
 *  CROSSCONTROL AUX API
 *
 *  Telematics.h
 *
 *  Version 2.15.2.0, 2020-07-08
 *
 *  (c) CrossControl 2010-2020
 *

 *  File description:
 *  Power control and status functions for the optional telematics add-on card
 *
 *  Use the function GetTelematics() to get a handle to pass on to the other functions. 
 *  Use the method Telematics_release(TELEMATICSHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include telematics_example.cpp
 *
 ************************************************/

#ifndef CC_TELEMATICS_H
#define CC_TELEMATICS_H

#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* TELEMATICSHANDLE;

  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);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_TELEMATICS_H */