Difference between revisions of "Component: Dual Potentiometer Trimmer (EBM006) (EBM Modules)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(5 intermediate revisions by the same user 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.1 (Release)
+
| 1.1
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| EBM Modules
 
| EBM Modules
 
|}
 
|}
  
  
 +
==Dual Potentiometer - Trimmer component==
 +
This board provides two rotary potentiometers.  This component directly interfaces with the EBM006 Dual Trimmers sensors board.
  
==[[File:Component Icon 245b0876_a350_4546_bb71_b427ff6ec9ef.png|Image]] Dual Potentiometer _ Trimmer (EBM006) component==
+
==Component Pack==
This board provides two rotary potentiometers.
 
This component directly interfaces with the EBM006 Dual Trimmers sensors board.
 
  
==Examples==
+
SENSORS
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
==Downloadable macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>ReadPotentiometer2</tt></u></span>===
 
Read Potentiometer 2 as a byte or integer.
 
  
'''Parameters'''
 
  
:[[Variable Types|BOOL]] ''Mode''
 
::0 = read as byte, 1 = read as int.
 
  
  
'''Return value'''
 
  
:[[Variable Types|INT]]
 
  
  
===<span style="font-weight: normal;"><u><tt>ReadPotentiometer1</tt></u></span>===
 
Read Potentiometer 1 as a byte or integer.
 
  
'''Parameters'''
 
  
:[[Variable Types|BOOL]] ''Mode''
+
''No detailed description exists yet for this component''
::0 = read as byte, 1 = read as int.
 
  
 +
==Examples==
  
'''Return value'''
 
  
:[[Variable Types|INT]]
 
  
  
  
==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''.
 
  
''<span style="color:red;">No additional information</span>''
 
  
  
 +
''<span style="color:red;">No additional examples</span>''
  
<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''.
+
==Downloadable macro 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;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadPotentiometer2'''
 +
|-
 +
| colspan="2" | Read Potentiometer 2 as a byte or integer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" | 0 = read as byte, 1 = read as int.&nbsp;
 +
|-
 +
| 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;" | '''ReadPotentiometer1'''
 +
|-
 +
| colspan="2" | Read Potentiometer 1 as a byte or integer.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" | 0 = read as byte, 1 = read as int.&nbsp;
 +
|-
 +
| 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''
 +
|}
  
<span style="font-weight: normal;"><u>VRef voltage</u></span>
 
  
This property is of type ''Signed integer'' and can be referenced with the variable name ''vrefvol''.
 
  
+Vref voltage x 10mV
 
  
Default 500 = 5V
+
==Property reference==
  
<span style="font-weight: normal;"><u>VRef option</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''vrefop''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
Defines what is used as the ADC Vref source.
+
|-
 
+
|-
<span style="font-weight: normal;"><u>Conversion speed</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
 
+
| width="90%" | Channel 1
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''convspd''.
+
|-
 
+
| colspan="2" | &nbsp;
Clock setting to set how fast the ADC peripheral is driven.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
<span style="font-weight: normal;"><u>Aquisition cycles</u></span>
+
| width="90%" | Channel 2
 
+
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''actime''.
+
| colspan="2" | &nbsp;
 
+
|-
Number of micro seconds to wait for the ACD input to charge before starting the analogue sample.
+
| 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" | +Vref voltage x 10mV Default 500 = 5V&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | VRef option
 +
|-
 +
| colspan="2" | Defines what is used as the ADC Vref source.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Conversion speed
 +
|-
 +
| colspan="2" | Clock setting to set how fast the ADC peripheral is driven.&nbsp;
 +
|-
 +
| 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.&nbsp;
 +
|}

Latest revision as of 17:23, 9 November 2022

Author Matrix TSL
Version 1.1
Category EBM Modules


Dual Potentiometer - Trimmer component

This board provides two rotary potentiometers. This component directly interfaces with the EBM006 Dual Trimmers sensors board.

Component Pack

SENSORS

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ReadPotentiometer2
Read Potentiometer 2 as a byte or integer. 
Fc9-bool-icon.png - BOOL Mode
0 = read as byte, 1 = read as int. 
Fc9-s16-icon.png - INT Return


Fc9-comp-macro.png ReadPotentiometer1
Read Potentiometer 1 as a byte or integer. 
Fc9-bool-icon.png - BOOL Mode
0 = read as byte, 1 = read as int. 
Fc9-s16-icon.png - INT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-6-icon.png Channel 1
 
Fc9-type-6-icon.png Channel 2
 
Fc9-conn-icon.png Settings
Fc9-type-14-icon.png VRef voltage
+Vref voltage x 10mV Default 500 = 5V 
Fc9-type-16-icon.png VRef option
Defines what is used as the ADC Vref source. 
Fc9-type-16-icon.png Conversion speed
Clock setting to set how fast the ADC peripheral is driven. 
Fc9-type-14-icon.png Aquisition cycles
Number of micro seconds to wait for the ACD input to charge before starting the analogue sample.