taf_therm_interface.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */

#ifndef TAF_THERM_INTERFACE_H_INCLUDE_GUARD
#define TAF_THERM_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

// Internal includes for this interface
#include "taf_therm_common.h"
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_therm_DisconnectHandler_t)(void *);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_therm_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_therm_SetServerDisconnectHandler
(
    taf_therm_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_therm_SetNonExitServerDisconnectHandler
(
    taf_therm_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_therm_DisconnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_TripEventHandlerRef_t taf_therm_AddTripEventHandler
(
    taf_therm_TripEventHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_therm_RemoveTripEventHandler
(
    taf_therm_TripEventHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_CoolingLevelChangeEventHandlerRef_t taf_therm_AddCoolingLevelChangeEventHandler
(
    taf_therm_CoolingLevelChangeEventHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_therm_RemoveCoolingLevelChangeEventHandler
(
    taf_therm_CoolingLevelChangeEventHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_ThermalZoneListRef_t taf_therm_GetThermalZonesList
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetThermalZonesListSize
(
    taf_therm_ThermalZoneListRef_t ThermalZoneListRef,
    uint32_t* thermalZoneListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_ThermalZoneRef_t taf_therm_GetFirstThermalZone
(
    taf_therm_ThermalZoneListRef_t ThermalZoneListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_ThermalZoneRef_t taf_therm_GetNextThermalZone
(
    taf_therm_ThermalZoneListRef_t ThermalZoneListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_TripPointRef_t taf_therm_GetFirstTripPoint
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_TripPointRef_t taf_therm_GetNextTripPoint
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetFirstBoundCDev
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetNextBoundCDev
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_TripPointRef_t taf_therm_GetFirstBoundTripPoint
(
    taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_TripPointRef_t taf_therm_GetNextBoundTripPoint
(
    taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetThermalZoneID
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef,
    uint32_t* thermalZoneIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetThermalZoneType
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef,
    char* ThermalZoneType,
    size_t ThermalZoneTypeSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetThermalZoneCurrentTemp
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef,
    uint32_t* currTempPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetThermalZonePassiveTemp
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef,
    uint32_t* passiveTempPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetTripPointListSize
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef,
    uint32_t* tripPointListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundCoolingDeviceListSize
(
    taf_therm_ThermalZoneRef_t ThermalZoneRef,
    uint32_t* boundCoolingDeviceListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetTripPointType
(
    taf_therm_TripPointRef_t TripPointRef,
    char* TripType,
    size_t TripTypeSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetTripPointThreshold
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* thresholdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetTripPointHysterisis
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* hysterisisPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetTripPointTripID
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* tripIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetTripPointThermalZoneID
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* tZoneIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundCoolingId
(
    taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef,
    uint32_t* boundCoolingIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundTripPointListSize
(
    taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef,
    uint32_t* boundTripPointListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundTripPointType
(
    taf_therm_TripPointRef_t TripPointRef,
    char* BoundTripType,
    size_t BoundTripTypeSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundTripPointThreshold
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* boundThresholdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundTripPointHysterisis
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* boundHysterisisPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundTripPointTripID
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* boundTripIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetBoundTripPointThermalZoneID
(
    taf_therm_TripPointRef_t TripPointRef,
    uint32_t* boundTZoneIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_DeleteThermalZoneList
(
    taf_therm_ThermalZoneListRef_t ThermalZoneListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_CoolingDeviceListRef_t taf_therm_GetCoolingDeviceList
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetCoolingDeviceListSize
(
    taf_therm_CoolingDeviceListRef_t CDevListRef,
    uint32_t* listSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_CoolingDeviceRef_t taf_therm_GetFirstCoolingDevice
(
    taf_therm_CoolingDeviceListRef_t CDevListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_CoolingDeviceRef_t taf_therm_GetNextCoolingDevice
(
    taf_therm_CoolingDeviceListRef_t CDevListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetCDevID
(
    taf_therm_CoolingDeviceRef_t CDevListRef,
    uint32_t* cDevIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetCDevDescription
(
    taf_therm_CoolingDeviceRef_t CDevListRef,
    char* Description,
    size_t DescriptionSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetCDevMaxCoolingLevel
(
    taf_therm_CoolingDeviceRef_t CDevListRef,
    uint32_t* maxCoolingLevelPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_GetCDevCurrentCoolingLevel
(
    taf_therm_CoolingDeviceRef_t CDevListRef,
    uint32_t* currentCoolingLevelPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_DeleteCoolingDeviceList
(
    taf_therm_CoolingDeviceListRef_t CDevListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_ThermalZoneRef_t taf_therm_GetThermalZoneByName
(
    const char* LE_NONNULL ThermalZone
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_therm_CoolingDeviceRef_t taf_therm_GetCoolingDeviceByName
(
    const char* LE_NONNULL CoolingDevice
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_ReleaseTripEventRef
(
    taf_therm_TripPointRef_t tripEventRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_ReleaseCoolingDeviceRef
(
    taf_therm_CoolingDeviceRef_t coolingDeviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_therm_ReleaseThermalZoneRef
(
    taf_therm_ThermalZoneRef_t thermalZoneeRef
);

#endif // TAF_THERM_INTERFACE_H_INCLUDE_GUARD