View source for Component: Temp / Humidity (Grove 101020212) (101020212) (Environmental)

From Flowcode Help

← Component: Temp / Humidity (Grove 101020212) (101020212) (Environmental)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 2.0 |- | width="20%" style="color:gray;" | Category | Environmental |} ==Temp / Humidity (Grove 101020212) 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, {{Fcfile|SHT31_example_floats.fcfx|Grove 101020212 (SHT31) Example}} ==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;" | '''GetHumidityData''' |- | colspan="2" | Returns the raw register pair value  |- |- | 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;" | '''GetHumidityInt''' |- | colspan="2" | returns the relative Humidity reading as an integer value  |- |- | 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;" | '''GetHumidityReal''' |- | colspan="2" | returns the Humidity reading as a float value  |- |- | 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;" | '''GetTemperatureData''' |- | colspan="2" | Returns the raw register pair value  |- |- | 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;" | '''GetTemperatureInt''' |- | colspan="2" | Return temperature reading as an integer value in degrees C  |- |- | 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;" | '''GetTemperatureReal''' |- | colspan="2" | Return temperature reading as a float value in degrees C  |- |- | 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;" |- | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' |- | colspan="2" | 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.  |- |- | 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'' |} ==Property reference== {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |- | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Address |- | colspan="2" | Selects the correct device address based on the ADDR pin connection to VDD or VSS.  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Channel |- | colspan="2" | Channel selection  |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | SDA |- | colspan="2" | Pin used for SDA (data signal)  |- | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | width="90%" | SCL |- | colspan="2" | Pin used for SCL (clock signal)  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Baud Select |- | colspan="2" | Baud rate option selector  |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Baud Rate |- | colspan="2" | Baud rate to be used  |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Stop Delay |- | colspan="2" | 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.   |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation |- |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Simulation Comms |- | 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_Grove.fcfx FC_Comp_Source_Humidity_SHT31_Grove.fcfx] Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Humidity_SHT31_Grove.fcfx FC_Comp_Source_Humidity_SHT31_Grove.fcfx]

Return to Component: Temp / Humidity (Grove 101020212) (101020212) (Environmental).