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

Revision as of 12:02, 3 February 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_temp/Potentiometer.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/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

Ev_Start

	Ev_Start
Broadcast to all components that simulation is starting
- ULONG	Return

GetValue

	GetValue
Get the Float value, between lower and upper bounds. Used on App Developer
- FLOAT	Return

ReadAsByte

	ReadAsByte
Read the ADC as a byte
- BYTE	Return

ReadAsFloat

	ReadAsFloat
Reads the ADC as a direct voltage
- FLOAT	Return

ReadAsInt

	ReadAsInt
Read the ADC at full bit depth
- INT	Return

ReadAsVoltage

	ReadAsVoltage
Reads the ADC as a direct voltage
- FLOAT	Return

SetValue

	SetValue
Sets the Float value, between lower and upper bounds. Used on App Developer
- FLOAT	Value

- VOID	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
	Appearance
	Component Label

	User Label Text
Text to display
	Scale Range

	Show Connection Label

	Show Pin Value

	Simulation
	Colour Style

	Style

	Type

	Scope Traces
Selects if the scope traces are automatically generated or not
	Scale
	Lower Bound

	Upper Bound

	Major Tick Step

	Minor Tick Step

	Label Format

	Closed

	Start Angle

	End Angle

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Potentiometer.fcfx FC_Comp_Source_Potentiometer.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Potentiometer.fcfx FC_Comp_Source_temp/Potentiometer.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Potentiometer.fcfx FC_Comp_Source_Potentiometer.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Potentiometer.fcfx FC_Comp_Source_temp/Potentiometer.fcfx]
 ==Detailed description==
@@ Line 57: / Line 57: @@
 {{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}
@@ Line 64: / Line 66: @@
 ==Macro reference==
-===ReadAsInt===
+===Ev_Start===
 {| 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;" | '''Ev_Start'''
 |-
-| colspan="2" | Read the ADC at full bit depth&nbsp;
+| colspan="2" | Broadcast to all components that simulation is starting&nbsp;
 |-
 |-
-| 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-u32-icon.png]] - ULONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 88: / Line 90: @@
 |-
 | 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''
+|}
+===ReadAsByte===
+{| 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'''
+|-
+| colspan="2" | Read the ADC as a byte&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''
 |}
@@ Line 106: / Line 122: @@
-===SetValue===
+===ReadAsInt===
 {| 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;" | '''ReadAsInt'''
 |-
-| colspan="2" | Sets 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" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
-| 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''
 |}
@@ Line 139: / Line 150: @@
-===Ev_Start===
+===SetValue===
 {| 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;" | '''SetValue'''
 |-
-| colspan="2" | Broadcast to all components that simulation is starting&nbsp;
+| colspan="2" | Sets the Float value, between lower and upper bounds. Used on App Developer&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Value
-|}
-===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" | &nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAsByte'''
 |-
-| colspan="2" | Read the ADC as a byte&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-|-
-|-
-| 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''
 |}

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

Revision as of 12:02, 3 February 2023

Contents