taf_therm_common.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_COMMON_H_INCLUDE_GUARD
#define TAF_THERM_COMMON_H_INCLUDE_GUARD


#include "legato.h"

#define IFGEN_TAF_THERM_PROTOCOL_ID "daa995111697d8ce10915a8c2b396337"
#define IFGEN_TAF_THERM_MSG_SIZE 48



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_THERM_TYPE_MAX_SIZE 32

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_ThermalZoneList* taf_therm_ThermalZoneListRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_ThermalZone* taf_therm_ThermalZoneRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_TripPoint* taf_therm_TripPointRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_CoolingDeviceList* taf_therm_CoolingDeviceListRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_CoolingDevice* taf_therm_CoolingDeviceRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_BoundCoolingDevice* taf_therm_BoundCoolingDeviceRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_TripEventInfo* taf_therm_TripEventInfoRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_THERM_UNKNOWN = 0,
    TAF_THERM_CRITICAL = 1,
    TAF_THERM_HOT = 2,
    TAF_THERM_PASSIVE = 3,
    TAF_THERM_ACTIVE = 4,
    TAF_THERM_CONFIGURABLE_HIGH = 5,
    TAF_THERM_CONFIGURABLE_LOW = 6
}
taf_therm_TripType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_THERM_NONE = 0,
    TAF_THERM_CROSSED_UNDER = 1,
    TAF_THERM_CROSSED_OVER = 2
}
taf_therm_TripEventType_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_TripEventHandler* taf_therm_TripEventHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_therm_CoolingLevelChangeEventHandler* taf_therm_CoolingLevelChangeEventHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_therm_TripEventHandlerFunc_t)
(
        taf_therm_TripPointRef_t tripPoint,
        taf_therm_TripEventType_t type,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_therm_CoolingLevelChangeEventHandlerFunc_t)
(
        taf_therm_CoolingDeviceRef_t coolingDevice,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_therm_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_therm_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_therm_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_TripEventHandlerRef_t ifgen_taf_therm_AddTripEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripEventHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_therm_RemoveTripEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripEventHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_CoolingLevelChangeEventHandlerRef_t ifgen_taf_therm_AddCoolingLevelChangeEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingLevelChangeEventHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_therm_RemoveCoolingLevelChangeEventHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingLevelChangeEventHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_ThermalZoneListRef_t ifgen_taf_therm_GetThermalZonesList
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZonesListSize
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneListRef_t ThermalZoneListRef,
        uint32_t* thermalZoneListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetFirstThermalZone
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneListRef_t ThermalZoneListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetNextThermalZone
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneListRef_t ThermalZoneListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetFirstTripPoint
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetNextTripPoint
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_BoundCoolingDeviceRef_t ifgen_taf_therm_GetFirstBoundCDev
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_BoundCoolingDeviceRef_t ifgen_taf_therm_GetNextBoundCDev
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetFirstBoundTripPoint
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_TripPointRef_t ifgen_taf_therm_GetNextBoundTripPoint
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef,
        uint32_t* thermalZoneIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef,
        char* ThermalZoneType,
        size_t ThermalZoneTypeSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZoneCurrentTemp
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef,
        uint32_t* currTempPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetThermalZonePassiveTemp
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef,
        uint32_t* passiveTempPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointListSize
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef,
        uint32_t* tripPointListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundCoolingDeviceListSize
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t ThermalZoneRef,
        uint32_t* boundCoolingDeviceListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        char* TripType,
        size_t TripTypeSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointThreshold
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* thresholdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointHysterisis
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* hysterisisPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointTripID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* tripIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetTripPointThermalZoneID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* tZoneIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundCoolingId
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef,
        uint32_t* boundCoolingIdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointListSize
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_BoundCoolingDeviceRef_t BoundCoolingDeviceRef,
        uint32_t* boundTripPointListSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointType
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        char* BoundTripType,
        size_t BoundTripTypeSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointThreshold
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* boundThresholdPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointHysterisis
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* boundHysterisisPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointTripID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* boundTripIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetBoundTripPointThermalZoneID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t TripPointRef,
        uint32_t* boundTZoneIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_DeleteThermalZoneList
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneListRef_t ThermalZoneListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_CoolingDeviceListRef_t ifgen_taf_therm_GetCoolingDeviceList
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetCoolingDeviceListSize
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceListRef_t CDevListRef,
        uint32_t* listSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetFirstCoolingDevice
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceListRef_t CDevListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetNextCoolingDevice
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceListRef_t CDevListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetCDevID
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceRef_t CDevListRef,
        uint32_t* cDevIDPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetCDevDescription
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceRef_t CDevListRef,
        char* Description,
        size_t DescriptionSize
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetCDevMaxCoolingLevel
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceRef_t CDevListRef,
        uint32_t* maxCoolingLevelPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_GetCDevCurrentCoolingLevel
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceRef_t CDevListRef,
        uint32_t* currentCoolingLevelPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_DeleteCoolingDeviceList
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceListRef_t CDevListRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_ThermalZoneRef_t ifgen_taf_therm_GetThermalZoneByName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL ThermalZone
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_therm_CoolingDeviceRef_t ifgen_taf_therm_GetCoolingDeviceByName
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        const char* LE_NONNULL CoolingDevice
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_ReleaseTripEventRef
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_TripPointRef_t tripEventRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_ReleaseCoolingDeviceRef
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_CoolingDeviceRef_t coolingDeviceRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_therm_ReleaseThermalZoneRef
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_therm_ThermalZoneRef_t thermalZoneeRef
);

#endif // TAF_THERM_COMMON_H_INCLUDE_GUARD