Component: Water Sensor (Grove 101020018) (101020018) (Environmental): Difference between revisions
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/ | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Grove_Water_Sensor.fcfx FC_Comp_Source_Grove_Water_Sensor.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Grove_Water_Sensor.fcfx FC_Comp_Source_Grove_Water_Sensor.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Grove_Water_Sensor.fcfx FC_Comp_Source_Grove_Water_Sensor.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| Line 44: | Line 46: | ||
==Examples== | ==Examples== | ||
| Line 68: | Line 72: | ||
==Macro reference== | ==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;" | '''GetIntValue''' | |||
|- | |||
| colspan="2" | Returns the analog 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'' | |||
|} | |||
{| 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;" | '''GetFloatValue''' | |||
|- | |||
| colspan="2" | Reads the analog value as a floating point value between 0 and 100 | |||
|- | |||
|- | |||
| 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'' | |||
|} | |||
==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" 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-1-icon.png]] | |||
| width="90%" | Tang Color | |||
|- | |||
| colspan="2" | Colour of the moving part of the slider. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |||
| width="90%" | Marker Color | |||
|- | |||
| colspan="2" | Colour of the marker line across the slider tang. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |||
| width="90%" | Scope Traces | |||
|- | |||
| colspan="2" | Selects if the scope traces are automatically generated or not | |||
|- | |||
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]] | |||
| width="90%" | Channel | |||
|- | |||
| colspan="2" | Analogue input channel - which pin is the analogue input conected to? | |||
|- | |||
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | |||
| width="90%" | VRef voltage | |||
|- | |||
| colspan="2" | Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | VRef option | |||
|- | |||
| colspan="2" | Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | Conversion speed | |||
|- | |||
| colspan="2" | Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | |||
| width="90%" | Aquisition cycles | |||
|- | |||
| colspan="2" | Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | |||
| width="90%" | Bit Depth | |||
|- | |||
| colspan="2" | Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095 | |||
|}==Macro reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:57, 27 January 2023
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Environmental |
Water Sensor (Grove 101020018) component
The water sensor uses a 1M ohm pull-up resistor. The resistor will pull the sensor trace value high until a drop of water shorts the sensor trace to the ground trace. You can use it with an analog input pin to detect the amount of water in contact between the grounded and sensor traces.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_Grove_Water_Sensor.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_Grove_Water_Sensor.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
GetIntValue |
| Returns the analog reading as an integer value. | |
 - INT
|
Return |
|
|
GetFloatValue |
| Reads the analog value as a floating point value between 0 and 100 | |
 - FLOAT
|
Return |
Property reference
|
Properties |
|
Simulation |
|
Tang Color |
| Colour of the moving part of the slider. | |
|
|
Marker Color |
| Colour of the marker line across the slider tang. | |
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
Connections |
|
Channel |
| Analogue input channel - which pin is the analogue input conected to? | |
|
|
Settings |
|
VRef voltage |
| Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V | |
|
VRef option |
| Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. | |
|
|
Conversion speed |
| Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. | |
|
|
Aquisition cycles |
| Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. | |
|
|
Bit Depth |
| Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095 | |
==Macro reference==
|
|
GetIntValue |
| Returns the analog reading as an integer value. | |
| - INT
|
Return |
|
|
GetFloatValue |
| Reads the analog value as a floating point value between 0 and 100 | |
| - FLOAT
|
Return |
Property reference
|
|
Properties |
|
|
Simulation |
|
|
Tang Color |
| Colour of the moving part of the slider. | |
|
|
Marker Color |
| Colour of the marker line across the slider tang. | |
|
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
Connections |
|
|
Channel |
| Analogue input channel - which pin is the analogue input conected to? | |
|
|
Settings |
|
|
VRef voltage |
| Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V | |
|
|
VRef option |
| Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. | |
|
|
Conversion speed |
| Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. | |
|
|
Aquisition cycles |
| Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. | |
|
|
Bit Depth |
| Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095 | |
==Macro reference==
|
|
GetIntValue |
| Returns the analog reading as an integer value. | |
| - INT
|
Return |
|
|
GetFloatValue |
| Reads the analog value as a floating point value between 0 and 100 | |
| - FLOAT
|
Return |
Property reference
|
|
Properties |
|
|
Simulation |
|
|
Tang Color |
| Colour of the moving part of the slider. | |
|
|
Marker Color |
| Colour of the marker line across the slider tang. | |
|
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
Connections |
|
|
Channel |
| Analogue input channel - which pin is the analogue input conected to? | |
|
|
Settings |
|
|
VRef voltage |
| Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V | |
|
|
VRef option |
| Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. | |
|
|
Conversion speed |
| Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. | |
|
|
Aquisition cycles |
| Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. | |
|
|
Bit Depth |
| Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095 | |
==Macro reference==
|
|
GetIntValue |
| Returns the analog reading as an integer value. | |
| - INT
|
Return |
|
|
GetFloatValue |
| Reads the analog value as a floating point value between 0 and 100 | |
| - FLOAT
|
Return |
Property reference
|
|
Properties |
|
|
Simulation |
|
|
Tang Color |
| Colour of the moving part of the slider. | |
|
|
Marker Color |
| Colour of the marker line across the slider tang. | |
|
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
Connections |
|
|
Channel |
| Analogue input channel - which pin is the analogue input conected to? | |
|
|
Settings |
|
|
VRef voltage |
| Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V | |
|
|
VRef option |
| Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage. | |
|
|
Conversion speed |
| Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. | |
|
|
Aquisition cycles |
| Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. | |
|
|
Bit Depth |
| Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095 | |