Difference between revisions of "Component: Temp / Humidity (SHT31) (Environmental)"
From Flowcode Help
Jump to navigationJump to search| (8 intermediate revisions by 2 users not shown) | |||
| Line 14: | Line 14: | ||
==Temp / Humidity (SHT31) component== | ==Temp / Humidity (SHT31) component== | ||
Humidity and temperature sensor using an SHT31 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. | Humidity and temperature sensor using an SHT31 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
==Detailed description== | ==Detailed description== | ||
| Line 31: | Line 27: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| Line 52: | Line 39: | ||
| + | ''No detailed description exists yet for this component'' | ||
| + | ==Examples== | ||
| Line 58: | Line 47: | ||
| − | + | An example displaying real temperatures and humidity using floats, | |
| + | {{Fcfile|SHT31_example_floats.fcfx|SHT31 Example}} | ||
==Macro reference== | ==Macro reference== | ||
| + | ===GetHumidityData=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityData''' |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| colspan="2" | Returns the raw register pair value | | colspan="2" | Returns the raw register pair value | ||
| Line 89: | Line 67: | ||
| − | + | ===GetHumidityInt=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 115: | Line 81: | ||
| + | ===GetHumidityReal=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 128: | Line 95: | ||
| − | + | ===GetTemperatureData=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 235: | Line 109: | ||
| + | ===GetTemperatureInt=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 248: | Line 123: | ||
| + | ===GetTemperatureReal=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureReal''' |
| − | |||
| − | |||
|- | |- | ||
| − | + | | colspan="2" | Return temperature reading as a float value in degrees C | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | colspan="2" | | ||
|- | |- | ||
|- | |- | ||
| Line 274: | Line 137: | ||
| − | + | ===Initialise=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 298: | Line 149: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | |||
| − | |||
| Line 354: | Line 203: | ||
| colspan="2" | | | colspan="2" | | ||
|} | |} | ||
| + | |||
| + | ==Component Source Code== | ||
| + | |||
| + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Humidity_SHT31.fcfx FC_Comp_Source_Humidity_SHT31.fcfx] | ||
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Humidity_SHT31.fcfx FC_Comp_Source_Humidity_SHT31.fcfx] | ||
Latest revision as of 11:42, 26 November 2024
| Author | Matrix TSL |
| Version | 2.0 |
| Category | Environmental |
Contents
Temp / Humidity (SHT31) component
Humidity and temperature sensor using an SHT31 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.
Detailed description
No detailed description exists yet for this component
Examples
An example displaying real temperatures and humidity using floats,
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 |
| Configures the I2C peripheral and puts the sensor into one shot mode ready to be sampled. Must be called before calling any of the other component macros. Returns 1 if the sensor has been intialised correctly, else returns 0. | |
 - BYTE
|
Return |
Property reference
|
Properties |
|
Address |
| Selects the correct device address based on the ADDR pin connection to VDD or VSS. | |
|
|
Channel |
| Channel selection | |
|
SDA |
| Pin used for SDA (data signal) | |
|
|
SCL |
| Pin used for SCL (clock signal) | |
|
|
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 |
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Humidity_SHT31.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Humidity_SHT31.fcfx
