Snapdragon® Telematics Application Framework (TelAF) Interface Specification
|
Go to the source code of this file.
le_msg_ServiceRef_t taf_therm_GetServiceRef | ( | void | ) |
Get the server service reference
le_msg_SessionRef_t taf_therm_GetClientSessionRef | ( | void | ) |
Get the client session reference for the current message
void taf_therm_AdvertiseService | ( | void | ) |
Initialize the server and advertise the service.
taf_therm_TripEventHandlerRef_t taf_therm_AddTripEventHandler | ( | taf_therm_TripEventHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Reference type for the list of thermal zones. Reference type for details of one thermal zone. Reference type for details of trip point. Reference type for the list of cooling devices. Reference type for details of one cooling device. Reference type for bound cooling devices. Reference type for information about the type of trip event. States for Trip Points. Handler for trip event. Reference type used by Add/Remove functions for EVENT 'taf_therm_TripEvent' Handler for cooling level change event. Reference type used by Add/Remove functions for EVENT 'taf_therm_CoolingLevelChangeEvent' Add handler function for EVENT 'taf_therm_TripEvent'
This event provides information on trip events.
Add handler function for EVENT 'taf_therm_TripEvent'
This event provides information on trip events.
[in] | handlerPtr | The Trip Event handler. |
[in] | contextPtr |
void taf_therm_RemoveTripEventHandler | ( | taf_therm_TripEventHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_therm_TripEvent'
[in] | handlerRef |
taf_therm_CoolingLevelChangeEventHandlerRef_t taf_therm_AddCoolingLevelChangeEventHandler | ( | taf_therm_CoolingLevelChangeEventHandlerFunc_t | handlerPtr, |
void * | contextPtr | ||
) |
Add handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'
This event provides information on the change in cooling level of a cooling device.
[in] | handlerPtr | |
[in] | contextPtr |
void taf_therm_RemoveCoolingLevelChangeEventHandler | ( | taf_therm_CoolingLevelChangeEventHandlerRef_t | handlerRef | ) |
Remove handler function for EVENT 'taf_therm_CoolingLevelChangeEvent'
[in] | handlerRef |
taf_therm_ThermalZoneListRef_t taf_therm_GetThermalZonesList | ( | void | ) |
Gets the list of available thermal zones.
le_result_t taf_therm_GetThermalZonesListSize | ( | taf_therm_ThermalZoneListRef_t | ThermalZoneListRef, |
uint32_t * | thermalZoneListSizePtr | ||
) |
Gets the list size of available thermal zones.
[in] | ThermalZoneListRef | Thermal zone list reference |
[out] | thermalZoneListSizePtr | List size. |
taf_therm_ThermalZoneRef_t taf_therm_GetFirstThermalZone | ( | taf_therm_ThermalZoneListRef_t | ThermalZoneListRef | ) |
Gets the first thermal zone object reference in the list of the thermal zones retrieved with taf_therm_GetThermalZonesList().
[in] | ThermalZoneListRef | Thermal zone list reference |
taf_therm_ThermalZoneRef_t taf_therm_GetNextThermalZone | ( | taf_therm_ThermalZoneListRef_t | ThermalZoneListRef | ) |
Gets the next thermal zone object reference in the list of the thermal zones retrieved with taf_therm_GetThermalZonesList().
[in] | ThermalZoneListRef | Thermal zone list reference |
taf_therm_TripPointRef_t taf_therm_GetFirstTripPoint | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef | ) |
Gets the first trip point object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
[in] | ThermalZoneRef | Thermal zone reference |
taf_therm_TripPointRef_t taf_therm_GetNextTripPoint | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef | ) |
Gets the next trip point object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
[in] | ThermalZoneRef | Thermal zone reference |
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetFirstBoundCDev | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef | ) |
Gets the first bound cooling device object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
[in] | ThermalZoneRef | Thermal zone reference |
taf_therm_BoundCoolingDeviceRef_t taf_therm_GetNextBoundCDev | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef | ) |
Gets the next bound cooling device object reference from the thermal zone retrieved with taf_therm_GetFirstThermalZone() or taf_therm_GetNextThermalZone().
[in] | ThermalZoneRef | Thermal zone reference |
taf_therm_TripPointRef_t taf_therm_GetFirstBoundTripPoint | ( | taf_therm_BoundCoolingDeviceRef_t | BoundCoolingDeviceRef | ) |
Retrieves a reference of the first trip point for the given bound cooling device.
[in] | BoundCoolingDeviceRef | Bound cooling device reference |
taf_therm_TripPointRef_t taf_therm_GetNextBoundTripPoint | ( | taf_therm_BoundCoolingDeviceRef_t | BoundCoolingDeviceRef | ) |
Retrieves a reference of the next trip point for the given bound cooling device.
[in] | BoundCoolingDeviceRef | Bound cooling device reference |
le_result_t taf_therm_GetThermalZoneID | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef, |
uint32_t * | thermalZoneIDPtr | ||
) |
Retrieves the thermal zone ID for the given zone reference.
[in] | ThermalZoneRef | Thermal zone reference |
[out] | thermalZoneIDPtr | Thermal zone ID associated with |
le_result_t taf_therm_GetThermalZoneType | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef, |
char * | ThermalZoneType, | ||
size_t | ThermalZoneTypeSize | ||
) |
Retrieves the thermal zone type.
[in] | ThermalZoneRef | Thermal zone reference |
[out] | ThermalZoneType | Thermal zone type |
[in] | ThermalZoneTypeSize |
le_result_t taf_therm_GetThermalZoneCurrentTemp | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef, |
uint32_t * | currTempPtr | ||
) |
Retrieves the thermal zone current temperature.
[in] | ThermalZoneRef | Thermal zone reference |
[out] | currTempPtr | Thermal zone current temperature associated with |
le_result_t taf_therm_GetThermalZonePassiveTemp | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef, |
uint32_t * | passiveTempPtr | ||
) |
Retrieves the thermal zone passive temperature.
[in] | ThermalZoneRef | Thermal zone reference |
[out] | passiveTempPtr | Thermal zone passive temperature associated with |
le_result_t taf_therm_GetTripPointListSize | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef, |
uint32_t * | tripPointListSizePtr | ||
) |
Retrieves the trip point list size.
[in] | ThermalZoneRef | Thermal zone reference |
[out] | tripPointListSizePtr | The trip point device list size |
le_result_t taf_therm_GetBoundCoolingDeviceListSize | ( | taf_therm_ThermalZoneRef_t | ThermalZoneRef, |
uint32_t * | boundCoolingDeviceListSizePtr | ||
) |
Retrieves the bound cooling device list size.
[in] | ThermalZoneRef | Thermal zone reference |
[out] | boundCoolingDeviceListSizePtr | The bound cooling device list size |
le_result_t taf_therm_GetTripPointType | ( | taf_therm_TripPointRef_t | TripPointRef, |
char * | TripType, | ||
size_t | TripTypeSize | ||
) |
Retrieves the trip point type.
[in] | TripPointRef | Trip point reference |
[out] | TripType | Trip type associated with trip point |
[in] | TripTypeSize |
le_result_t taf_therm_GetTripPointThreshold | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | thresholdPtr | ||
) |
Retrieves the trip point threshold.
[in] | TripPointRef | Trip point reference |
[out] | thresholdPtr | The threshold associated with the input |
le_result_t taf_therm_GetTripPointHysterisis | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | hysterisisPtr | ||
) |
Retrieves the trip point hysteresis.
[in] | TripPointRef | Trip point reference |
[out] | hysterisisPtr | The hysteresis associated with the input |
le_result_t taf_therm_GetTripPointTripID | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | tripIDPtr | ||
) |
Retrieves the trip point trip ID.
[in] | TripPointRef | Trip point reference |
[out] | tripIDPtr | The trip ID associated with the input |
le_result_t taf_therm_GetTripPointThermalZoneID | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | tZoneIDPtr | ||
) |
Retrieves the thermal zone ID associated with the given trip point.
[in] | TripPointRef | Trip point reference |
[out] | tZoneIDPtr | The thermal zone ID associated with |
le_result_t taf_therm_GetBoundCoolingId | ( | taf_therm_BoundCoolingDeviceRef_t | BoundCoolingDeviceRef, |
uint32_t * | boundCoolingIdPtr | ||
) |
Retrieves the bound cooling device's cooling ID.
[in] | BoundCoolingDeviceRef | The bound cooling device reference |
[out] | boundCoolingIdPtr | The cooling device ID associated with |
le_result_t taf_therm_GetBoundTripPointListSize | ( | taf_therm_BoundCoolingDeviceRef_t | BoundCoolingDeviceRef, |
uint32_t * | boundTripPointListSizePtr | ||
) |
Retrieves the bound cooling device trip point list size.
[in] | BoundCoolingDeviceRef | The bound cooling device reference |
[out] | boundTripPointListSizePtr | The bound cooling device trip |
le_result_t taf_therm_GetBoundTripPointType | ( | taf_therm_TripPointRef_t | TripPointRef, |
char * | BoundTripType, | ||
size_t | BoundTripTypeSize | ||
) |
Retrieves the bound cooling device's trip point type.
[in] | TripPointRef | Trip point reference |
[out] | BoundTripType | Bound trip type associated with trip point |
[in] | BoundTripTypeSize |
le_result_t taf_therm_GetBoundTripPointThreshold | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | boundThresholdPtr | ||
) |
Retrieves the bound cooling device's trip point threshold.
[in] | TripPointRef | Trip point reference |
[out] | boundThresholdPtr | The threshold associated with the input bound |
le_result_t taf_therm_GetBoundTripPointHysterisis | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | boundHysterisisPtr | ||
) |
Retrieves the bound cooling device's trip point hysteresis.
[in] | TripPointRef | Trip point reference |
[out] | boundHysterisisPtr | The hysteresis associated with the input bound cooling device's trip point object. |
le_result_t taf_therm_GetBoundTripPointTripID | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | boundTripIDPtr | ||
) |
Retrieves the bound trip point trip ID.
[in] | TripPointRef | Trip point reference |
[out] | boundTripIDPtr | The bound trip point trip ID associated with |
le_result_t taf_therm_GetBoundTripPointThermalZoneID | ( | taf_therm_TripPointRef_t | TripPointRef, |
uint32_t * | boundTZoneIDPtr | ||
) |
Retrieves the thermal zone ID that the bound trip point is associated with.
[in] | TripPointRef | Trip point reference |
[out] | boundTZoneIDPtr | The bound thermal zone ID associated with |
le_result_t taf_therm_DeleteThermalZoneList | ( | taf_therm_ThermalZoneListRef_t | ThermalZoneListRef | ) |
Deletes the list of the thermal zones.
[in] | ThermalZoneListRef | Thermal Zone list reference |
taf_therm_CoolingDeviceListRef_t taf_therm_GetCoolingDeviceList | ( | void | ) |
Gets the list of available cooling devices.
le_result_t taf_therm_GetCoolingDeviceListSize | ( | taf_therm_CoolingDeviceListRef_t | CDevListRef, |
uint32_t * | listSizePtr | ||
) |
Gets the list size of available cooling devices.
[in] | CDevListRef | Thermal zone list reference |
[out] | listSizePtr | List size |
taf_therm_CoolingDeviceRef_t taf_therm_GetFirstCoolingDevice | ( | taf_therm_CoolingDeviceListRef_t | CDevListRef | ) |
Gets the first cooling device object reference in the list of the cooling device retrieved with taf_therm_GetCoolingDeviceList().
[in] | CDevListRef | Cooling device list reference |
taf_therm_CoolingDeviceRef_t taf_therm_GetNextCoolingDevice | ( | taf_therm_CoolingDeviceListRef_t | CDevListRef | ) |
Gets the next cooling device object reference in the list of the cooling devices retrieved with taf_therm_GetCoolingDeviceList().
[in] | CDevListRef | Cooling device reference |
le_result_t taf_therm_GetCDevID | ( | taf_therm_CoolingDeviceRef_t | CDevListRef, |
uint32_t * | cDevIDPtr | ||
) |
Retrieves the cooling device's cooling ID.
[in] | CDevListRef | Cooling device reference |
[out] | cDevIDPtr | The cooling device ID associated with the |
le_result_t taf_therm_GetCDevDescription | ( | taf_therm_CoolingDeviceRef_t | CDevListRef, |
char * | Description, | ||
size_t | DescriptionSize | ||
) |
Retrieves the cooling device description.
[in] | CDevListRef | Cooling device reference |
[out] | Description | The cooling device description associated |
[in] | DescriptionSize |
le_result_t taf_therm_GetCDevMaxCoolingLevel | ( | taf_therm_CoolingDeviceRef_t | CDevListRef, |
uint32_t * | maxCoolingLevelPtr | ||
) |
Retrieves the cooling device's maximum cooling level.
[in] | CDevListRef | Cooling device reference |
[out] | maxCoolingLevelPtr | The maximum cooling level associated with |
le_result_t taf_therm_GetCDevCurrentCoolingLevel | ( | taf_therm_CoolingDeviceRef_t | CDevListRef, |
uint32_t * | currentCoolingLevelPtr | ||
) |
Retrieves the cooling device's current cooling level.
[in] | CDevListRef | Cooling device reference |
[out] | currentCoolingLevelPtr | The current cooling level associated with |
le_result_t taf_therm_DeleteCoolingDeviceList | ( | taf_therm_CoolingDeviceListRef_t | CDevListRef | ) |
Deletes the cooling device list retrieved with taf_therm_GetCoolingDeviceList().
[in] | CDevListRef | Cooling device list reference |
taf_therm_ThermalZoneRef_t taf_therm_GetThermalZoneByName | ( | const char *LE_NONNULL | ThermalZone | ) |
Retrieves the thermal zone information of the given name.
[in] | ThermalZone | Thermal zone name |
taf_therm_CoolingDeviceRef_t taf_therm_GetCoolingDeviceByName | ( | const char *LE_NONNULL | CoolingDevice | ) |
Retrieves the information of the specific cooling device with the given name.
[in] | CoolingDevice | The cooling device name |
le_result_t taf_therm_ReleaseTripEventRef | ( | taf_therm_TripPointRef_t | tripEventRef | ) |
Releases the trip event sample reference.
[in] | tripEventRef | Trip event sample reference |
le_result_t taf_therm_ReleaseCoolingDeviceRef | ( | taf_therm_CoolingDeviceRef_t | coolingDeviceRef | ) |
Releases the cooling device sample reference.
LE_BAD_PARAMETER Invalid reference passed.
[in] | coolingDeviceRef | Cooling device sample reference |
le_result_t taf_therm_ReleaseThermalZoneRef | ( | taf_therm_ThermalZoneRef_t | thermalZoneeRef | ) |
Releases the thermal zone reference.
LE_BAD_PARAMETER Invalid reference passed.
[in] | thermalZoneeRef | Thermal zone reference |