Component: Temperature (TMP117) (Environmental): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix TSL
Version	1.0
Category	Environmental

Temperature (TMP117) component

The TMP117 provides high accuracy temperature monitoring via a digital I2C interface.

Detailed description

No detailed description exists yet for this component

Examples

A basic example which moves an object on the panel. When the object is in range of the sensor the sensor output goes high, otherwise the sensor output goes low. PhotoTransistorDemo

Macro reference

Initialise

	Initialise
Sets up the I2C ready for operation and initialises the sensor with the default settings. Returns 1 if the device is correctly identified.
- BOOL	Return

ReadRegister

	ReadRegister

- BYTE	Address

- UINT	Return

ReadTemperature

	ReadTemperature
Reads the temperature as a floating point value in Celcius.
- FLOAT	Return

ReadTemperatureF

	ReadTemperatureF
Reads the temperature as a floating point value in Fahrenheit
- FLOAT	Return

SetMode

	SetMode
Sets the mode of the sensor and therefore the amount of power consumed by the sensor.
- BYTE	Mode
0=Shutdown, 3=Triggered, 7=Continuous
- VOID	Return

SetTemperatureOffset

	SetTemperatureOffset
Allows an offset to be written to offset the output temperature
- FLOAT	Offset
Temperature offset in degrees C
- VOID	Return

WriteRegister

	WriteRegister

- BYTE	Address

- UINT	Value

- VOID	Return

Property reference

	Properties
	Connections
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Settings
	Address A0
Sets the I2C device address based on the state of the device AD0 pin
	Default Mode
Sets the default mode of the sensor on initialise. Can be overridden using the SetMode macro.
	Standby Time
Sets the amount of time to wait between samples to save power.
	Averaging Count
Sets the number of samples used for each averaging period. Can be overridden using the SetAveragingCount macro.
	Alert Polarity

	Alert Type

	Simulation
	Simulate Comms

	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API
Specifies the API component on the panel to interact with to provide comms simulation.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Temperature_TMP117.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Temperature_TMP117.fcfx

@@ Line 84: / Line 84: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Sets up the I2C ready for operation and initialises the sensor with the default settings. Returns 1 if the device is correctly identified.&nbsp;
@@ Line 98: / Line 98: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRegister'''
+| width="90%" class="mtx-class-macrohead" | '''ReadRegister'''
 |-
 | colspan="2" | &nbsp;
@@ Line 117: / Line 117: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTemperature'''
+| width="90%" class="mtx-class-macrohead" | '''ReadTemperature'''
 |-
 | colspan="2" | Reads the temperature as a floating point value in Celcius.&nbsp;
@@ Line 131: / Line 131: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTemperatureF'''
+| width="90%" class="mtx-class-macrohead" | '''ReadTemperatureF'''
 |-
 | colspan="2" | Reads the temperature as a floating point value in Fahrenheit&nbsp;
@@ Line 145: / Line 145: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
+| width="90%" class="mtx-class-macrohead" | '''SetMode'''
 |-
 | colspan="2" | Sets the mode of the sensor and therefore the amount of power consumed by the sensor.&nbsp;
@@ Line 164: / Line 164: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTemperatureOffset'''
+| width="90%" class="mtx-class-macrohead" | '''SetTemperatureOffset'''
 |-
 | colspan="2" | Allows an offset to be written to offset the output temperature&nbsp;
@@ Line 183: / Line 183: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRegister'''
+| width="90%" class="mtx-class-macrohead" | '''WriteRegister'''
 |-
 | colspan="2" | &nbsp;
@@ Line 208: / Line 208: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-
@@ Line 246: / Line 246: @@
 | colspan="2" | Baud rate to be used&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
+| width="90%" class="mtx-class-propfolder" | Settings
 |-
 |-
@@ Line 280: / Line 280: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)