Difference between revisions of "Component: Humidity (EBM016) (EBM Modules)"

From Flowcode Help
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==Humidity component==
 
==Humidity component==
 
Humidity and temperature sensor using an SHT21 IC connected via I2C - as used by the Matrix e-block module EBM016. 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 SHT21 IC connected via I2C - as used by the Matrix e-block module EBM016. On screen GUI allows temperature and humidity values to be simulated, and will show all I2C communication in a console window.
 +
 +
==Component Pack==
 +
 +
SENSORS
  
 
==Detailed description==
 
==Detailed description==
  
−
''No detailed description exists yet for this component''
 
  
−
==Examples==
 
  
  
  
−
This example reads the temperature and humidity levels from the sensor and displays the readings on the LCD.
 
  
−
{{Fcfile|EBM016 - Test Program.fcfx|EBM016 Example}}
 
  
−
==Downloadable macro reference==
 
  
−
{| 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:]] -
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| 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''
 
−
|}
 
  
 +
''No detailed description exists yet for this component''
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
==Examples==
−
|-
 
−
| 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:]] -
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| 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:]] -
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| 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:]] -
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| 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''
 
−
|}
 
  
  
−
{| 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" | Initialises the component ready for I2C communications 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
  
−
{| 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" | Sets up up the communication bus and initialises the accelerometer module.  Returns 0 for success and > 0 for fail. 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
−
{| 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;" | '''SimSetGyro'''
 
−
|-
 
−
| colspan="2" | Allows the XYZ slider values to be set via the simulation 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | X
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | Y
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | Z
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
  
 +
This example reads the temperature and humidity levels from the sensor and displays the readings on the LCD.
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
{{Fcfile|EBM016 - Test Program.fcfx|EBM016 Example}}
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UpdateAccelerometerData'''
 
−
|-
 
−
| colspan="2" | Reads from the accelerometer and updates the local XYZ variables. Returns 1 for new data and 0 for no new data 
 
−
|-
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
==Downloadable macro reference==
  
 
{| 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;" | '''SimSetCompass'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureReal'''
 
|-
 
|-
−
| colspan="2" | Allows the XYZ slider values to be set via the simulation 
+
| colspan="2" | Return temperature reading as a float value in degrees C 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
−
| width="90%" | X
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | Y
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | Z
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 205: Line 69:
 
|-
 
|-
 
| 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;" | '''Read_Bearing'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureData'''
 
|-
 
|-
−
| colspan="2" | Reads the current sensor compass bearing based on degrees CW from magnetic north. Returns 0-359 where 0 = North, 90 = East, 180 = South, 270 = West Requires the ArcTan floating point function to be available to work correctly. Supported on AVR, 16-bit  
+
| colspan="2" | Returns the raw register pair value 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | NumSamples
 
 
|-
 
|-
−
| colspan="2" | The number of readings to base the bearing on 
 
 
|-
 
|-
 
| 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-u16-icon.png]] - UINT
Line 223: Line 82:
 
|-
 
|-
 
| 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;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTemperatureInt'''
 
|-
 
|-
−
| colspan="2" | Sets up up the communication bus and initialises the accelerometer module.  Returns 0 for success and > 0 for fail. 
+
| colspan="2" | Return temperature reading as an integer value in degrees C 
 
|-
 
|-
 
|-
 
|-
−
| 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-s16-icon.png]] - INT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 236: Line 95:
 
|-
 
|-
 
| 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;" | '''IOSetOutputPin'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityInt'''
 
|-
 
|-
−
| colspan="2" | Sets the selected digital pin to an output and assigns the output state. 
+
| colspan="2" | returns the relative Humidity reading as an integer value 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
−
| width="90%" | Pin
 
−
|-
 
−
| colspan="2" | Range: 0-29 
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | State
 
−
|-
 
−
| colspan="2" | Range: 0-1 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 259: Line 108:
 
|-
 
|-
 
| 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;" | '''UARTReceive'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityReal'''
 
|-
 
|-
−
| colspan="2" | Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available. 
+
| colspan="2" | returns the Humidity reading as a float value 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
 
|-
 
|-
−
| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1 
 
 
|-
 
|-
−
| 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-f32-icon.png]] - FLOAT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 277: Line 121:
 
|-
 
|-
 
| 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;" | '''ADCSampleAverage10'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHumidityData'''
 
|-
 
|-
−
| colspan="2" | Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples 
+
| colspan="2" | Returns the raw register pair value 
 
|-
 
|-
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | ADCChannel
 
−
|-
 
−
| colspan="2" | Range: 0, 3-7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | SampleCount
 
−
|-
 
−
| colspan="2" | Range: 1- 100 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | SampleDelay
 
−
|-
 
−
| colspan="2" | Delay in us between each sample 
 
 
|-
 
|-
 
| 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-u16-icon.png]] - UINT
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''OneWireScanBus'''
 
−
|-
 
−
| colspan="2" | Scans the one wire bus to detect all connected devices. Returns the number of one wire devices found. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1 
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''SPIInitialise'''
 
−
|-
 
−
| colspan="2" | Initialsie the SPI module ready for communications 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''OneWireReceiveByte'''
 
−
|-
 
−
| colspan="2" | Receives a byte from the one wire bus a bit at a time 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1 
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''I2CSend'''
 
−
|-
 
−
| colspan="2" | Transmit a byte using the I2C bus 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DataOut
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''UARTSend'''
 
−
|-
 
−
| colspan="2" | Send a byte via the UART module 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Data
 
−
|-
 
−
| colspan="2" | Data Byte to send. Range: 0-255 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''OneWireGetDeviceCount'''
 
−
|-
 
−
| colspan="2" | Returns the number of devices found by the last ScanBus operation. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1 
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''PWMSetPrescaler'''
 
−
|-
 
−
| colspan="2" | Sets the prescaler for the PWM output 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Range: 0 - 11 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Prescaler
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Period
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''PWMEnable'''
 
−
|-
 
−
| colspan="2" | Enable a PWM output 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | Range: 0-11 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''ADCSampleArray10'''
 
−
|-
 
−
| colspan="2" | Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | ADCChannel
 
−
|-
 
−
| colspan="2" | Range: 0, 3-7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | SampleCount
 
−
|-
 
−
| colspan="2" | Range: 1- 32 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | SampleDelay
 
−
|-
 
−
| colspan="2" | Delay in us between each sample 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Samples
 
−
|-
 
−
| colspan="2" | 10-bit samples returned from the function 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
−
{| 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;" | '''ADCSampleAverage8'''
 
−
|-
 
−
| colspan="2" | Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | ADCChannel
 
−
|-
 
−
| colspan="2" | Range: 0, 3-7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | SampleCount
 
−
|-
 
−
| colspan="2" | Range: 1- 100 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | SampleDelay
 
−
|-
 
−
| colspan="2" | Delay in us between each sample 
 
−
|-
 
−
| 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''
 
|}
 
|}
Line 532: Line 136:
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 
|-
 
|-
−
| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent. 
+
| colspan="2" | Initialises the component ready for I2C communications 
 
|-
 
|-
 
|-
 
|-
Line 580: Line 184:
 
| 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.  
 
| 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" | [[File:Fc9-type-7-icon.png]]
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" | Scope Traces
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
|-
 
−
| colspan="2" | 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. 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
−
| width="90%" | Console Data
 
−
|-
 
−
| colspan="2" | Selects if the console data is automatically generated or not 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | API
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 
 
|-
 
|-
 
|-
 
|-

Latest revision as of 17:23, 9 November 2022

Author Matrix TSL
Version 2.0
Category EBM Modules


Humidity component

Humidity and temperature sensor using an SHT21 IC connected via I2C - as used by the Matrix e-block module EBM016. On screen GUI allows temperature and humidity values to be simulated, and will show all I2C communication in a console window.

Component Pack

SENSORS

Detailed description

No detailed description exists yet for this component

Examples

This example reads the temperature and humidity levels from the sensor and displays the readings on the LCD.

FC6 Icon.png EBM016 Example

Downloadable macro reference

Fc9-comp-macro.png GetTemperatureReal
Return temperature reading as a float value in degrees C 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png GetTemperatureData
Returns the raw register pair value 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png GetTemperatureInt
Return temperature reading as an integer value in degrees C 
Fc9-s16-icon.png - INT Return


Fc9-comp-macro.png GetHumidityInt
returns the relative Humidity reading as an integer value 
Fc9-s16-icon.png - INT Return


Fc9-comp-macro.png GetHumidityReal
returns the Humidity reading as a float value 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png GetHumidityData
Returns the raw register pair value 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png Initialise
Initialises the component ready for I2C communications 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-7-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulation Comms
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Humidity_(EBM016)_(EBM_Modules)&oldid=28784"