Component: Temp / Humidity (HTS221) (Environmental): Difference between revisions
Appearance
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Humidity_HTS221.fcfx FC_Comp_Source_Humidity_HTS221.fcfx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Humidity_HTS221.fcfx FC_Comp_Source_Humidity_HTS221.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Humidity_HTS221.fcfx FC_Comp_Source_Humidity_HTS221.fcfx] | ||
| Line 37: | Line 39: | ||
| Line 45: | Line 45: | ||
''No detailed description exists yet for this component'' | |||
==Examples== | |||
| Line 58: | Line 61: | ||
''<span style="color:red;">No additional examples</span>'' | |||
== | ==Macro reference== | ||
{| class="wikitable | ===ControlHeater=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ControlHeater''' | ||
|- | |- | ||
| colspan="2" | Controls the in-built heater element to speed up sensor recovery time in case of condensation. Humidity and temperature cannot be read while Heater is active. | |||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | |||
| width="90%" | Active | |||
|- | |- | ||
| | | colspan="2" | 0 = Off (Sensor Reading Available) / 1 = On (Sensor Reading Disabled) | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===DataAvailable=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''DataAvailable''' | ||
|- | |- | ||
| colspan="2" | Checks to see if new sensor data is available. Returns 0 if no new data is available. Returns 1 if new Temperature data is available. Returns 2 if new Humidity data is available. Returns 3 if new Temp and Humidity data is available. | | colspan="2" | Checks to see if new sensor data is available. Returns 0 if no new data is available. Returns 1 if new Temperature data is available. Returns 2 if new Humidity data is available. Returns 3 if new Temp and Humidity data is available. | ||
| Line 294: | Line 120: | ||
{| class="wikitable | ===Initialise=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Initialise''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Configures the I2C peripheral ready for communications. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===ReadHumidityInt=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadHumidityInt''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Samples the humidity from the sensor and returns the relative humidity reading as a integer byte from 0 to 100 | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===ReadHumidityReal=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadHumidityReal''' | ||
|- | |- | ||
| colspan="2" | Samples the humidity from the sensor and returns the relative humidity reading as a float from 0.0 to 100.0. | | colspan="2" | Samples the humidity from the sensor and returns the relative humidity reading as a float from 0.0 to 100.0. | ||
| Line 338: | Line 162: | ||
{| class="wikitable | ===ReadRegister=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadRegister''' | ||
|- | |- | ||
| colspan="2" | Reads an 8-bit value from one of the registers onboard the sensor IC. | | colspan="2" | Reads an 8-bit value from one of the registers onboard the sensor IC. | ||
| Line 356: | Line 181: | ||
{| class="wikitable" style="width | ===ReadTemperatureInt=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''ReadTemperatureInt''' | |||
|- | |||
| colspan="2" | Samples the temperature from the sensor and returns the reading in degrees C as an integer from -40 to 120. | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
===ReadTemperatureReal=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadTemperatureReal''' | ||
|- | |- | ||
| colspan="2" | Samples the temperature from the sensor and returns the reading in degrees C as a float from -40.0 to 120.0. | | colspan="2" | Samples the temperature from the sensor and returns the reading in degrees C as a float from -40.0 to 120.0. | ||
| Line 369: | Line 209: | ||
{| class="wikitable | ===WriteRegister=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''WriteRegister''' | ||
|- | |- | ||
| colspan="2" | Writes a value to a register on the sensor IC. | | colspan="2" | Writes a value to a register on the sensor IC. | ||
| Line 390: | Line 231: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Sensor Properties | ||
|- | |- | ||
|- | |- | ||
| Line 424: | Line 250: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | I2C Properties | ||
|- | |- | ||
|- | |- | ||
| Line 463: | Line 289: | ||
| colspan="2" | Baud rate to be used | | colspan="2" | Baud rate to be used | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:37, 13 July 2026
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Environmental |
Temp / Humidity (HTS221) component
A temperature and relative humidity sensor allowing the ambient temperature and relative humidity to be monitored digitally. Humidity Range = 0% - 100% +/- 3.5% Temperature Range = -40 - 120 Degrees C +/- 0.5 Degrees C
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Humidity_HTS221.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Humidity_HTS221.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
ControlHeater
DataAvailable
Initialise
| Initialise | |
| Configures the I2C peripheral ready for communications. | |
| Return | |
ReadHumidityInt
| ReadHumidityInt | |
| Samples the humidity from the sensor and returns the relative humidity reading as a integer byte from 0 to 100 | |
| Return | |
ReadHumidityReal
| ReadHumidityReal | |
| Samples the humidity from the sensor and returns the relative humidity reading as a float from 0.0 to 100.0. | |
| Return | |
ReadRegister
| ReadRegister | |
| Reads an 8-bit value from one of the registers onboard the sensor IC. | |
| Address | |
| Return | |
ReadTemperatureInt
| ReadTemperatureInt | |
| Samples the temperature from the sensor and returns the reading in degrees C as an integer from -40 to 120. | |
| Return | |
ReadTemperatureReal
| ReadTemperatureReal | |
| Samples the temperature from the sensor and returns the reading in degrees C as a float from -40.0 to 120.0. | |
| Return | |
WriteRegister
| WriteRegister | |
| Writes a value to a register on the sensor IC. | |
| Address | |
| Data | |
| Return | |