AN3108 datasheet(14/44 Pages) STMICROELECTRONICS

14 / 44 page

STLM75 library firmware

AN3108

14/44

Doc ID 16793 Rev 1

TempSensorObj API types/properties/functions

This section describes the TempSensor structure, all its exported API functions and all the

defined types. See Figure 2.

Below you can find a description of the defined types used by the TempSensor object

source code and a description of its properties and methods. Except for TempSensorType,

all API layer types are defined in the TempSensorTypes.h file.

TempSensorType type

The TempSensorType is defined in the following TempSensorObj.h file. The final

TempSensor object is an instance of this defined structure.

The following described structure type can be considered as an OOP-class including private

and public properties and public methods.

All the structure fields with a prefix name of 'm_' can be considered as private properties.

This means these structure fields must not be directly accessed by the final application and

Getxxx methods should be used instead. Clearly the final application could access these

private members, but it should NEVER do so.

The final application must interact with this library using the following public properties and

methods only, as described in Figure 2 and in the following sections.

#define TEMP_SENSOR_OBJ

/* Temperature Sensor definition */ \

*/ \

/* PRIVATE PROPERTIES */ \

TS_u8

m_Configuration;

TS_TemperatureType

m_Temperature;

TS_TemperatureType

m_TempHysteresis;

TS_TemperatureType

m_TempOverLimit;

TS_RegistersType

m_Registers;

TS_I2C_SettingsType m_I2C_Settings;

*/ \

/* PUBLIC PROPERTIES */ \

TS_SignalsType

Signals;

/* The Micro/STLM75 signals */ \

TS_u32

TimeoutTicks; /* Timeout in ticks */ \

*/ \

/* PUBLIC METHODS

*/ \

TS_ErrStatus

(*Init)

(TempSensorType*);

TS_ErrStatus

(*Reset)

(TempSensorType*);

TS_ErrStatus

(*SetI2C_Settings)

(TempSensorType*,

TS_I2C_SettingsType* pI2C_Settings); \

TS_ErrStatus

(*SetSignals)

(TempSensorType*,

TS_SignalsType* pSignals); \

AN3108 Datasheet(PDF) 14 Page - STMicroelectronics

AN3108 Datasheet(HTML) 14 Page - STMicroelectronics

Html Pages

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

Datasheet Download

Link URL