Difference between revisions of "Component: Temp / Humidity (SHT21) (Environmental)"

Latest revision as of 10:26, 20 October 2023

Author	Matrix TSL
Version	2.0
Category	Environmental

Temp / Humidity (SHT21) component

Humidity and temperature sensor using an SHT21 IC connected via I2C. On screen GUI allows temperature and humidity values to be simulated, and will show all I2C communication in a console window.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetHumidityData

	GetHumidityData
Returns the raw register pair value
- UINT	Return

GetHumidityInt

	GetHumidityInt
returns the relative Humidity reading as an integer value
- INT	Return

GetHumidityReal

	GetHumidityReal
returns the Humidity reading as a float value
- FLOAT	Return

GetTemperatureData

	GetTemperatureData
Returns the raw register pair value
- UINT	Return

GetTemperatureInt

	GetTemperatureInt
Return temperature reading as an integer value in degrees C
- INT	Return

GetTemperatureReal

	GetTemperatureReal
Return temperature reading as a float value in degrees C
- FLOAT	Return

Initialise

	Initialise
Initialises the component ready for I2C communications
- VOID	Return

Property reference

	Properties
	Channel
Channel selection
	SDA
Pin used for SDA (data signal)
	SDA Remap Pin

	SCL
Pin used for SCL (clock signal)
	SCL Remap Pin

	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	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.
	Simulation
	Simulation Comms

@@ Line 73: / Line 73: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 79: / Line 89: @@
 ==Macro reference==
+===GetHumidityData===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureReal'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityData'''
 |-
-| colspan="2" | Return temperature reading as a float value in degrees C&nbsp;
+| colspan="2" | Returns the raw register pair value&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetHumidityInt===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureData'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityInt'''
 |-
-| colspan="2" | Returns the raw register pair value&nbsp;
+| colspan="2" | returns the relative Humidity reading as an integer value&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetHumidityReal===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureInt'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityReal'''
 |-
-| colspan="2" | Return temperature reading as an integer value in degrees C&nbsp;
+| colspan="2" | returns the Humidity reading as a float value&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetTemperatureData===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityInt'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureData'''
 |-
-| colspan="2" | returns the relative Humidity reading as an integer value&nbsp;
+| colspan="2" | Returns the raw register pair value&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetTemperatureInt===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityReal'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureInt'''
 |-
-| colspan="2" | returns the Humidity reading as a float value&nbsp;
+| colspan="2" | Return temperature reading as an integer value in degrees C&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetTemperatureReal===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityData'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureReal'''
 |-
-| colspan="2" | Returns the raw register pair value&nbsp;
+| colspan="2" | Return temperature reading as a float value in degrees C&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 168: / Line 185: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 189: / Line 204: @@
 |-
 | colspan="2" | Pin used for SDA (data signal)&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | SDA Remap Pin
+|-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
@@ Line 194: / Line 214: @@
 |-
 | colspan="2" | Pin used for SCL (clock signal)&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | SCL Remap Pin
+|-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-type-16-icon.png]]

Difference between revisions of "Component: Temp / Humidity (SHT21) (Environmental)"

Latest revision as of 10:26, 20 October 2023

Contents