Difference between revisions of "Component: Temp / Humidity (SHT31) (Environmental)"
From Flowcode Help
Jump to navigationJump to search| Line 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 24: | Line 26: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 43: | Line 47: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 69: | Line 73: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 82: | Line 86: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 95: | Line 99: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
Revision as of 13:30, 17 November 2021
| Author | Matrix TSL |
| Version | 2.0 |
| Category | Environmental |
Contents
Temp / Humidity 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
No additional examples
Downloadable macro reference
|
GetTemperatureReal |
| Return temperature reading as a float value in degrees C | |
 - FLOAT
|
Return |
|
|
GetTemperatureData |
| Returns the raw register pair value | |
 - UINT
|
Return |
|
|
GetTemperatureInt |
| Return temperature reading as an integer value in degrees C | |
 - INT
|
Return |
|
|
GetHumidityInt |
| returns the relative Humidity reading as an integer value | |
| - INT
|
Return |
|
|
GetHumidityReal |
| returns the Humidity reading as a float value | |
| - FLOAT
|
Return |
|
|
GetHumidityData |
| Returns the raw register pair value | |
| - UINT
|
Return |
|
|
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. | |
|
|
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 |
|
Connections |
|
|
Simulations |
|
|
Simulation Comms |
