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

STLM75 library firmware
AN3108
Table 7. Reset API function
Name
Description
Function name
Function prototype
Behavior description
Input parameter {x}
Output parameter {x}
Reset
TS_ErrStatus Reset (TempSensorType* pThis)
Reset the Micro/Sensor I²C communication.
pThis - object pointer
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:
void TS_ResetI2C_Peripheral(TS_I2C_SettingsType* pI2C_Settings);
void TS_InitI2C_Peripheral(TS_I2C_SettingsType* pI2C_Settings);
Example:
...
/* Reset the I2C communication */
pObjTempSensor->Reset(pObjTempSensor);
TempSensor:: SetI2C_Settings API function
Table 8 describes the SetI2C_Settings function of the TempSensor structure.
This function is called by the TempSensor:Init function during the initialization phase,
therefore it’s not necessary to directly call it. The final application can specifically call this
function in order to change the I²C peripheral settings after initialization.
Table 8. SetI2C_Settings API function
Name
Description
Function name
SetI2C_Settings
Function prototype
Behavior description
TS_ErrStatus SetI2C_Settings (TempSensorType* pThis,
TS_I2C_SettingsType* pI2C_Settings)
Set the STLM75 I2C peripheral settings copying the right values from the
passed parameter
Input parameter {x}
pThis - Object pointer;
pI2C_Settings - A I2C peripheral structure pointer;
Output parameter {x}
None
Return value
Required preconditions
TS_OK if successful, TS_ERROR otherwise
NewTempSensorObj function must have been called before.
Called functions
HAL function:
void TS_InitI2C_Peripheral(TS_I2C_SettingsType* pI2C_Settings);
20/44
Doc ID 16793 Rev 1