Difference between revisions of "Component: Potentiometer (Analog Input)"

From Flowcode Help
Jump to navigationJump to search
Line 57: Line 57:
  
 
{{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}
 
{{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}
 +
 +
  
  
Line 70: Line 72:
 
==Macro reference==
 
==Macro reference==
  
−
===Ev_Start===
+
===GetAverageByte===
 
{| 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;" | '''Ev_Start'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAverageByte'''
 +
|-
 +
| colspan="2" | Read the ADC as a byte 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NumSamples
 
|-
 
|-
−
| colspan="2" | Broadcast to all components that simulation is starting 
+
| colspan="2" |  
 
|-
 
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | DelayUs
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+
| colspan="2" |  
 +
|-
 +
| 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''
 
|}
 
|}
  
  
−
===GetValue===
+
===GetAverageInt===
 
{| 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;" | '''GetValue'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAverageInt'''
 
|-
 
|-
−
| colspan="2" | Get the Float value, between lower and upper bounds. Used on App Developer 
+
| colspan="2" | Read the ADC at full bit depth 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
+
| width="90%" | NumSamples
−
|}
 
−
 
 
−
 
 
−
===ReadAsByte===
 
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+
| colspan="2" |  
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAsByte'''
 
 
|-
 
|-
−
| colspan="2" | Read the ADC as a byte 
+
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | DelayUs
 
|-
 
|-
 +
| colspan="2" |  
 
|-
 
|-
−
| 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-u16-icon.png]] - UINT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===ReadAsFloat===
+
===GetByte===
 
{| 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;" | '''ReadAsFloat'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
 
|-
 
|-
−
| colspan="2" | Reads the ADC as a direct voltage 
+
| colspan="2" | Read the ADC as a byte 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| 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''
 
|}
 
|}
  
  
−
===ReadAsInt===
+
===GetInt===
 
{| 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;" | '''ReadAsInt'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
 
|-
 
|-
 
| colspan="2" | Read the ADC at full bit depth 
 
| colspan="2" | Read the ADC at full bit depth 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===ReadAsVoltage===
+
===GetString===
 
{| 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;" | '''ReadAsVoltage'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
 
|-
 
|-
 
| colspan="2" | Reads the ADC as a direct voltage 
 
| colspan="2" | Reads the ADC as a direct voltage 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===SetValue===
+
===GetVoltage===
 
{| 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;" | '''SetValue'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVoltage'''
 
|-
 
|-
−
| colspan="2" | Sets the Float value, between lower and upper bounds. Used on App Developer 
+
| colspan="2" | Reads the ADC as a direct voltage 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
−
| width="90%" | Value
 
−
|-
 
−
| 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 218: Line 221:
 
|-
 
|-
 
| 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 
 
| 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 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Retain Value
 +
|-
 +
| colspan="2" |  
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
Line 228: Line 236:
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
| width="90%" | User Label Text
+
| width="90%" | LabelColour
−
|-
 
−
| colspan="2" | Text to display 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Scale Range
 
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 248: Line 251:
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+
| width="90%" | Colour Style
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
 +
| width="90%" | Fill
 
|-
 
|-
 +
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
| width="90%" | Colour Style
+
| width="90%" | Frame Outline
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
−
| width="90%" | Style
+
| width="90%" | Frame Fill
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
| width="90%" | Type
+
| width="90%" | Pointer Outline
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
−
| width="90%" | Scope Traces
+
| width="90%" | Pointer Fill
 
|-
 
|-
−
| colspan="2" | Selects if the scope traces are automatically generated or not 
+
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scale
+
| width="90%" | Text
 
|-
 
|-
 +
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
| width="90%" | Lower Bound
+
| width="90%" | Tick Mark Outline
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
−
| width="90%" | Upper Bound
+
| width="90%" | Tick Mark Fill
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
−
| width="90%" | Major Tick Step
+
| width="90%" | Cap Outline
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
−
| width="90%" | Minor Tick Step
+
| width="90%" | Cap Fill
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
−
| width="90%" | Label Format
+
| width="90%" | Main Image
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
−
| width="90%" | Closed
+
| width="90%" | Cap Image
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
| width="90%" | Start Angle
+
| width="90%" | Style
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
−
| width="90%" | End Angle
+
| width="90%" | Type
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 +
|-
 +
| 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%" | Scope Traces
 +
|-
 +
| colspan="2" | Selects if the scope traces are automatically generated or not 
 
|}
 
|}

Revision as of 11:17, 20 October 2023

Author Matrix TSL
Version 1.0
Category Analog Input


Potentiometer component

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

A simple example that shows how to use some common functions of the potentiometer in conjunction with an LCD.

FC6 Icon.png Potentiometer Example







Macro reference

GetAverageByte

Fc9-comp-macro.png GetAverageByte
Read the ADC as a byte 
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
 
Fc9-u8-icon.png - BYTE Return


GetAverageInt

Fc9-comp-macro.png GetAverageInt
Read the ADC at full bit depth 
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
 
Fc9-u16-icon.png - UINT Return


GetByte

Fc9-comp-macro.png GetByte
Read the ADC as a byte 
Fc9-u8-icon.png - BYTE Return


GetInt

Fc9-comp-macro.png GetInt
Read the ADC at full bit depth 
Fc9-u16-icon.png - UINT Return


GetString

Fc9-comp-macro.png GetString
Reads the ADC as a direct voltage 
Fc9-string-icon.png - STRING Return


GetVoltage

Fc9-comp-macro.png GetVoltage
Reads the ADC as a direct voltage 
Fc9-f32-icon.png - FLOAT Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-6-icon.png Channel
Analogue Input Channel - Which pin is the analogue input connected to? 
Fc9-conn-icon.png Settings
Fc9-type-14-icon.png 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  
Fc9-type-16-icon.png 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. 
Fc9-type-16-icon.png 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. 
Fc9-type-14-icon.png Acquisition cycles
Number of micro seconds to wait for the ADC input to charge before starting the analogue sample. 
Fc9-type-14-icon.png 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 
Fc9-type-7-icon.png Retain Value
 
Fc9-conn-icon.png Appearance
Fc9-type-16-icon.png Component Label
 
Fc9-type-2-icon.png LabelColour
 
Fc9-type-7-icon.png Show Connection Label
 
Fc9-type-7-icon.png Show Pin Value
 
Fc9-type-16-icon.png Colour Style
 
Fc9-type-23-icon.png Fill
 
Fc9-type-2-icon.png Frame Outline
 
Fc9-type-23-icon.png Frame Fill
 
Fc9-type-2-icon.png Pointer Outline
 
Fc9-type-23-icon.png Pointer Fill
 
Fc9-type-2-icon.png Text
 
Fc9-type-2-icon.png Tick Mark Outline
 
Fc9-type-23-icon.png Tick Mark Fill
 
Fc9-type-2-icon.png Cap Outline
 
Fc9-type-23-icon.png Cap Fill
 
Fc9-type-13-icon.png Main Image
 
Fc9-type-13-icon.png Cap Image
 
Fc9-type-12-icon.png Style
 
Fc9-type-12-icon.png Type
 
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Potentiometer_(Analog_Input)&oldid=39665"