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

Latest 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.

Potentiometer Example

Macro reference

GetAverageByte

	GetAverageByte
Read the ADC as a byte
- BYTE	NumSamples

- BYTE	DelayUs

- BYTE	Return

GetAverageInt

	GetAverageInt
Read the ADC at full bit depth
- BYTE	NumSamples

- BYTE	DelayUs

- UINT	Return

GetByte

	GetByte
Read the ADC as a byte
- BYTE	Return

GetInt

	GetInt
Read the ADC at full bit depth
- UINT	Return

GetString

	GetString
Reads the ADC as a direct voltage
- STRING	Return

GetVoltage

	GetVoltage
Reads the ADC as a direct voltage
- FLOAT	Return

Property reference

	Properties
	Connections
	Channel
Analogue Input Channel - Which pin is the analogue input connected 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.
	Acquisition cycles
Number of micro seconds to wait for the ADC 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
	Retain Value

	Appearance
	Component Label

	LabelColour

	Show Connection Label

	Show Pin Value

	Colour Style

	Fill

	Frame Outline

	Frame Fill

	Pointer Outline

	Pointer Fill

	Text

	Tick Mark Outline

	Tick Mark Fill

	Cap Outline

	Cap Fill

	Main Image

	Cap Image

	Style

	Type

	Simulation
	Scope Traces
Selects if the scope traces are automatically generated or not

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

Latest revision as of 11:17, 20 October 2023

Contents

Potentiometer component

Component Source Code

Detailed description

Examples

Macro reference

GetAverageByte

GetAverageInt

GetByte

GetInt

GetString

GetVoltage

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 57: / Line 57: @@
 {{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}
@@ Line 62: / Line 72: @@
 ==Macro reference==
+===GetAverageByte===
 {| 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;" | '''ReadAsInt'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAverageByte'''
+|-
+| colspan="2" | Read the ADC as a byte&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | NumSamples
 |-
-| colspan="2" | Read the ADC at full bit depth&nbsp;
+| colspan="2" | &nbsp;
 |-
+| 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-s16-icon.png]] - INT
+| colspan="2" | &nbsp;
+|-
+| 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''
 |}
+===GetAverageInt===
 {| 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;" | '''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&nbsp;
+| colspan="2" | Read the ADC at full bit depth&nbsp;
 |-
 |-
-| 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
-|}
-{| 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" | &nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAsFloat'''
 |-
-| colspan="2" | Reads the ADC as a direct voltage&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | DelayUs
 |-
+| colspan="2" | &nbsp;
 |-
-| 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-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetByte===
 {| 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;" | '''SetValue'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
 |-
-| colspan="2" | Sets the Float value, between lower and upper bounds. Used on App Developer&nbsp;
+| colspan="2" | Read the ADC as a byte&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Value
-|-
-| colspan="2" | &nbsp;
-|-
-| 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''
 |}
+===GetInt===
 {| 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;" | '''ReadAsVoltage'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
 |-
-| colspan="2" | Reads the ADC as a direct voltage&nbsp;
+| colspan="2" | Read the ADC at full bit depth&nbsp;
 |-
 |-
-| 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-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetString===
 {| 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;" | '''Ev_Start'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
 |-
-| colspan="2" | Broadcast to all components that simulation is starting&nbsp;
+| colspan="2" | Reads the ADC as a direct voltage&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| 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''
 |}
+===GetVoltage===
 {| 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;" | '''ReadAsByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVoltage'''
 |-
-| colspan="2" | Read the ADC as a byte&nbsp;
+| colspan="2" | Reads the ADC as a direct voltage&nbsp;
 |-
 |-
-| 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''
 |}
@@ Line 205: / 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Retain Value
+|-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
@@ Line 215: / Line 236: @@
 | colspan="2" | &nbsp;
 |-
-| 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&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-| width="90%" | Scale Range
 |-
 | colspan="2" | &nbsp;
@@ Line 235: / Line 251: @@
 | colspan="2" | &nbsp;
 |-
-| 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" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-23-icon.png]]
+| width="90%" | Fill
 |-
+| colspan="2" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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&nbsp;
+| colspan="2" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
 |-
-| 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" | &nbsp;
+|-
+| 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&nbsp;
 |}