Difference between revisions of "Component: Touch Pads (EBM013) (EBM Modules)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| EBM Modules
 
| EBM Modules
 
|}
 
|}
 +
 +
 +
==Touch Pads component==
 +
This board provides two touch areas for use with capacitive sensing. Hence two digital touch switches can  be implemented. This component directly interfaces with the EBM013 Sensors board.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM013v5.fcfx FC_Comp_Source_EBM013v5.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM013v5.fcfx FC_Comp_Source_EBM013v5.fcfx]
 +
 +
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
−
==[[File:Component Icon 8a853d8e_967b_4317_85d2_070167d41396.png|Image]] Touch Pads (EBM013) component==
 
−
This board provides two touch areas for use with capacitive sensing. Hence two digital touch switches can
 
−
be implemented. This component directly interfaces with the EBM013 Sensors board.
 
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>GetTouchValue</tt></u></span>===
+
''No detailed description exists yet for this component''
−
Samples the touch sensor ADC value and returns it
+
 
 +
==Examples==
  
−
Always samples both channels, but only returns the chosen channel
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''Switch''
 
−
::Select Switch. Switch 1 = 0, Switch 2 = 1
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|UINT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetTouchPressed</tt></u></span>===
 
−
Returns non-zero if touch detected
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''Switch''
 
−
::Switch 1 = 0, Switch 2 = 1
 
  
−
:[[Variable Types|UINT]] ''OffValue''
 
  
−
:[[Variable Types|BYTE]] ''Threshold''
 
−
::Provide the threshold value for the pad to be considered touched
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Channel 1</u></span>
 
  
−
This property is of type ''Single analog pin'' and can be referenced with the variable name ''CHANNEL1''.
 
  
−
ADC Channel number
 
  
−
<span style="font-weight: normal;"><u>Channel 2</u></span>
 
  
−
This property is of type ''Single analog pin'' and can be referenced with the variable name ''CHANNEL2''.
+
Sample program using the EBM013 - Touch Pads sensor.
  
−
''<span style="color:red;">No additional information</span>''
+
Sensors are first calibrated and then can be read as digital switches
  
 +
{{Fcfile|EBM013 - Test Program.fcfx|EBM013 Example}}
  
  
−
<span style="font-weight: normal;"><u>On Value</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''OnVal1''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>Off Value</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''OffVal1''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>On Value</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''OnVal2''.
+
==Macro reference==
  
−
''<span style="color:red;">No additional information</span>''
+
===GetTouchPressed===
 +
{| 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;" | '''GetTouchPressed'''
 +
|-
 +
| colspan="2" | Returns non-zero if touch detected&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Switch
 +
|-
 +
| colspan="2" | Switch 1 = 0, Switch 2 = 1&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | OffValue
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Threshold
 +
|-
 +
| colspan="2" | Provide the threshold value for the pad to be considered touched&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
 +
===GetTouchValue===
 +
{| 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;" | '''GetTouchValue'''
 +
|-
 +
| colspan="2" | Samples the touch sensor ADC value and returns it Always samples both channels, but only returns the chosen channel&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Switch
 +
|-
 +
| colspan="2" | Select Switch. Switch 1 = 0, Switch 2 = 1&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Off Value</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''OffVal2''.
+
==Property reference==
  
−
''<span style="color:red;">No additional information</span>''
+
{| 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-6-icon.png]]
 +
| width="90%" | Channel 1
 +
|-
 +
| colspan="2" | ADC Channel number&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
 +
| width="90%" | Channel 2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation Properties
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Switch 1
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | On Value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Off Value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Switch 2
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | On Value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Off Value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:09, 7 February 2023

Author Matrix TSL
Version 1.0
Category EBM Modules


Touch Pads component

This board provides two touch areas for use with capacitive sensing. Hence two digital touch switches can be implemented. This component directly interfaces with the EBM013 Sensors board.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_EBM013v5.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_EBM013v5.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Sample program using the EBM013 - Touch Pads sensor.

Sensors are first calibrated and then can be read as digital switches

FC6 Icon.png EBM013 Example







Macro reference

GetTouchPressed

Fc9-comp-macro.png GetTouchPressed
Returns non-zero if touch detected 
Fc9-bool-icon.png - BOOL Switch
Switch 1 = 0, Switch 2 = 1 
Fc9-u16-icon.png - UINT OffValue
 
Fc9-u8-icon.png - BYTE Threshold
Provide the threshold value for the pad to be considered touched 
Fc9-bool-icon.png - BOOL Return


GetTouchValue

Fc9-comp-macro.png GetTouchValue
Samples the touch sensor ADC value and returns it Always samples both channels, but only returns the chosen channel 
Fc9-bool-icon.png - BOOL Switch
Select Switch. Switch 1 = 0, Switch 2 = 1 
Fc9-u16-icon.png - UINT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-6-icon.png Channel 1
ADC Channel number 
Fc9-type-6-icon.png Channel 2
 
Fc9-conn-icon.png Simulation Properties
Fc9-conn-icon.png Switch 1
Fc9-type-21-icon.png On Value
 
Fc9-type-21-icon.png Off Value
 
Fc9-conn-icon.png Switch 2
Fc9-type-21-icon.png On Value
 
Fc9-type-21-icon.png Off Value
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Touch_Pads_(EBM013)_(EBM_Modules)&oldid=37939"