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

Revision as of 14:42, 16 January 2023

Please click here for the component source code: FC_Comp_Source_Potentiometer.fcfx

No detailed description exists yet for this component

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

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

	ReadAsFloat
Reads the ADC as a direct voltage
- FLOAT	Return

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

- VOID	Return

	ReadAsVoltage
Reads the ADC as a direct voltage
- FLOAT	Return

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

	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 20: / Line 20: @@
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
@@ Line 100: / Line 104: @@
 |-
 | 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''
+|}
+{| 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'''
+|-
+| colspan="2" | Broadcast to all components that simulation is starting&nbsp;
+|-
+|-
+| 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''
 |}