Component: Potentiometer (Analog Input)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix TSL |
| Version | 1.0 |
| Category | Analog Input |
Contents
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.
Macro reference
|
ReadAsInt |
| Read the ADC at full bit depth | |
 - INT
|
Return |
|
|
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 |
|
|
ReadAsByte |
| Read the ADC as a byte | |
 - BYTE
|
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 |
==Macro reference==
|
|
ReadAsInt |
| Read the ADC at full bit depth | |
| - INT
|
Return |
|
|
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 |
|
|
ReadAsByte |
| Read the ADC as a byte | |
| - BYTE
|
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 |
==Macro reference==
|
|
ReadAsInt |
| Read the ADC at full bit depth | |
| - INT
|
Return |
|
|
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 |
|
|
ReadAsByte |
| Read the ADC as a byte | |
| - BYTE
|
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 |
==Macro reference==
|
|
ReadAsInt |
| Read the ADC at full bit depth | |
| - INT
|
Return |
|
|
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 |
|
|
ReadAsByte |
| Read the ADC as a byte | |
| - BYTE
|
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 |
