View source for Component: Potentiometer (Analog Input)

From Flowcode Help

← Component: Potentiometer (Analog Input)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;" | Category | Analog Input |} ==Potentiometer component== ==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 view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Potentiometer.fcfx 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. {{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}} ===Filtering ADC Inputs=== Simple example which uses a filtering technique to provide a digital low pass filter on the ADC readings. The output of the filter is 50% the ADC reading and 50% the previous reading. {{Fcfile|LPFilter_2D.fcfx|LPFilter}} In this example the output of the filter is 25% the ADC reading and 75% the previous reading. {{Fcfile|LPFilter2_2D.fcfx|LPFilter2}} ===Analogue Inputs Window=== The [[Analog_Window|Analogue inputs window]] available from the View ribbon, allows you to see the values for all of the analogue inputs which are active in your program. They can also be manually altered by dragging the mouse along one of the sliders. ===Data Recorder=== An ADC based component will automatically add a trace to the [[Using_the_Data_Recorder|data recorder]] window allowing you to get a view of the analogue data over time during simulation. [[File:Data_Recorder1.png]] ==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;" | '''GetAverageByte''' |- | colspan="2" | Read the ADC as a byte  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | NumSamples |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | DelayUs |- | colspan="2" |   |- | 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;" | '''GetAverageInt''' |- | colspan="2" | Read the ADC at full bit depth  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | NumSamples |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | DelayUs |- | colspan="2" |   |- | 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;" | '''GetByte''' |- | colspan="2" | Read the ADC as a byte  |- |- | 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'' |} ===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;" | '''GetInt''' |- | colspan="2" | Read the ADC at full bit depth  |- |- | 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;" | '''GetString''' |- | colspan="2" | Reads the ADC as a direct voltage  |- |- | 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;" | '''GetVoltage''' |- | colspan="2" | Reads the ADC as a direct voltage  |- |- | 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'' |} ==Property reference== {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |- | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' |- |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections |- |- | width="10%" align="center" | [[File:Fc9-type-6-icon.png]] | width="90%" | Channel |- | colspan="2" | Analogue Input Channel - Which pin is the analogue input connected to?  |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings |- |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | VRef voltage |- | colspan="2" | 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   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | VRef option |- | colspan="2" | 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.  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Conversion speed |- | colspan="2" | 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.  |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Acquisition cycles |- | colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample.  |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Bit Depth |- | 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  |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Retain Value |- | colspan="2" |   |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Component Label |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | LabelColour |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Connection Label |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | width="90%" | Show Pin Value |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Colour Style |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-23-icon.png]] | width="90%" | Fill |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Frame Outline |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-23-icon.png]] | width="90%" | Frame Fill |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Pointer Outline |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-23-icon.png]] | width="90%" | Pointer Fill |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Text |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Tick Mark Outline |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-23-icon.png]] | width="90%" | Tick Mark Fill |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-2-icon.png]] | width="90%" | Cap Outline |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-23-icon.png]] | width="90%" | Cap Fill |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | Main Image |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-13-icon.png]] | width="90%" | Cap Image |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-12-icon.png]] | width="90%" | Style |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-12-icon.png]] | width="90%" | Type |- | colspan="2" |   |- | 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  |}

Return to Component: Potentiometer (Analog Input).