Component: Potentiometer (Analog Input)

From Flowcode Help
Revision as of 12:02, 3 February 2023 by Wiki bot (talk | contribs)
Jump to navigationJump to search
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.

FC6 Icon.png Potentiometer Example




Macro reference

Ev_Start

Fc9-comp-macro.png Ev_Start
Broadcast to all components that simulation is starting 
Fc9-u32-icon.png - ULONG Return


GetValue

Fc9-comp-macro.png GetValue
Get the Float value, between lower and upper bounds. Used on App Developer 
Fc9-f32-icon.png - FLOAT Return


ReadAsByte

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


ReadAsFloat

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


ReadAsInt

Fc9-comp-macro.png ReadAsInt
Read the ADC at full bit depth 
Fc9-s16-icon.png - INT Return


ReadAsVoltage

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


SetValue

Fc9-comp-macro.png SetValue
Sets the Float value, between lower and upper bounds. Used on App Developer 
Fc9-f32-icon.png - FLOAT Value
 
Fc9-void-icon.png - VOID 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-conn-icon.png Appearance
Fc9-type-16-icon.png Component Label
 
Fc9-type-11-icon.png User Label Text
Text to display 
Fc9-type-16-icon.png Scale Range
 
Fc9-type-7-icon.png Show Connection Label
 
Fc9-type-7-icon.png Show Pin Value
 
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Colour Style
 
Fc9-type-12-icon.png Style
 
Fc9-type-12-icon.png Type
 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-conn-icon.png Scale
Fc9-type-15-icon.png Lower Bound
 
Fc9-type-15-icon.png Upper Bound
 
Fc9-type-21-icon.png Major Tick Step
 
Fc9-type-15-icon.png Minor Tick Step
 
Fc9-type-10-icon.png Label Format
 
Fc9-type-7-icon.png Closed
 
Fc9-type-15-icon.png Start Angle
 
Fc9-type-15-icon.png End Angle