AN3108 Datasheet, PDF (28/44 Pages) STMicroelectronics – STLM75 firmware library for the STM32F10x

STLM75 library firmware
AN3108
Table 17. GetTempHysteresis (continued)
Name
Description
Behavior description
Return the Hysteresis temperature structure pointer.
Input parameter {x}
pThis - Object pointer;
bForceRegisterRead - if TS_TRUE reads the value from the register
otherwise the last read value returns
Output parameter {x}
Return value
None
Hysteresis temperature pointer if successful, TS_NULL_PTR otherwise
Required preconditions
Called functions
NewTempSensorObj, TempSensor:: Init functions must have been called
before.
HAL function:
TS_ErrStatus TS_SetPointerRegister(…);
TS_ErrStatus TS_FillDataFromRegister (…);
Example:
TS_TemperatureType* pStrTemperature;
/* Get the Hysteresis temperature structure pointer forcing a STLM75
register reading */
pStrTemperature = pObjTempSensor->GetTempHysteresis
(pObjTempSensor, TS_TRUE);
TempSensor:: SetTempOverLimit API function
Table 18 describes the SetTempOverLimit function of the TempSensor structure.
Table 18. SetTempOverLimit
Name
Description
Function name
SetTempOverLimit
Function prototype
TS_ErrStatus SetTempOverLimit (TempSensorType* pThis,
TS_TemperatureType* pTemperature)
Behavior description
Set the 16-bit Over-limit temperature register value.
Input parameter {x}
pThis - Object pointer;
pTemperature - Over-limit temperature structure pointer
Output parameter {x}
None
Return value
Required preconditions
TS_OK if successful, TS_ERROR otherwise
NewTempSensorObj, TempSensor:: Init functions must have been called
before.
Called functions
HAL function:
TS_ErrStatus TS_SetPointerRegister(…);
TS_ErrStatus TS_FillRegisterFromData(…);
28/44
Doc ID 16793 Rev 1