Jump to content

Component: ADC Template 2D (Analog Input): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(14 intermediate revisions by 2 users not shown)
Line 15: Line 15:
Base ADC component with no graphical interface. Contains all of the embedded side component calls to provide an ADC interface suitable for  wrapping with a new ADC style component.   
Base ADC component with no graphical interface. Contains all of the embedded side component calls to provide an ADC interface suitable for  wrapping with a new ADC style component.   


==Component Source Code==
==Detailed description==
 
 
 
 
 
 


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_adc_Base_2dgdi.fcfx FC_Comp_Source_adc_Base_2dgdi.fcfx]


==Detailed description==




Line 40: Line 44:


==Examples==
==Examples==




Line 45: Line 67:
==Macro reference==
==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetAverageByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RawSampleInt'''
| width="90%" class="mtx-class-macrohead" | '''GetAverageByte'''
|-
|-
| colspan="2" | Background call to read the ADC at full bit depth Call Enable() first 
| colspan="2" | Function call to read the ADC as a byte average sample over time  
|-
|-
| 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" | Number of micro seconds in between taking each sample 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetAverageInt===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RawAverageByte'''
| width="90%" class="mtx-class-macrohead" | '''GetAverageInt'''
|-
|-
| colspan="2" | Background call to read the ADC as a byte average sample over time Call Enable() before this 
| colspan="2" | Function call to read the ADC as a full width average sample over time  
|-
|-
|-
|-
Line 76: Line 110:
| colspan="2" | Number of micro seconds in between taking each sample 
| colspan="2" | Number of micro seconds in between taking each sample 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSampleBits'''
| width="90%" class="mtx-class-macrohead" | '''GetByte'''
|-
|-
| colspan="2" | Gets the number of bits per sample 
| colspan="2" | Blocking call to read the ADC as a byte  
|-
|-
|-
|-
Line 94: Line 129:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetInt===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetString'''
| width="90%" class="mtx-class-macrohead" | '''GetInt'''
|-
|-
| colspan="2" | Reads the ADC as a direct voltage and returns as a string 
| colspan="2" | Blocking call to read the ADC at full bit depth  
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetSampleBits===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAverageByte'''
| width="90%" class="mtx-class-macrohead" | '''GetSampleBits'''
|-
|-
| colspan="2" | Function call to read the ADC as a byte average sample over time  
| colspan="2" | Gets the number of bits per sample 
|-
|-
| 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" | Number of micro seconds in between taking each sample 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
Line 130: Line 157:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetSpeedFilter===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RawAverageInt'''
| width="90%" class="mtx-class-macrohead" | '''GetSpeedFilter'''
|-
|-
| colspan="2" | Background call to read the ADC as a full width average sample over time Call Enable() before this 
| colspan="2" | Gets the Conversion speed filter string Use in Component.Property.SetFilter() 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | NumSamples
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===GetString===
{| class="mtx-class-macrotable wikitable"
|-
|-
| colspan="2" |  
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetString'''
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| colspan="2" | Reads the ADC as a direct voltage and returns as a string 
| width="90%" | DelayUs
|-
|-
| colspan="2" |  
|-
|-
| 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-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetVoltage===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSpeedFilter'''
| width="90%" class="mtx-class-macrohead" | '''GetVoltage'''
|-
|-
| colspan="2" | Gets the Conversion speed filter string Use in Component.Property.SetFilter() 
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RawAverageByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAverageInt'''
| width="90%" class="mtx-class-macrohead" | '''RawAverageByte'''
|-
|-
| colspan="2" | Function call to read the ADC as a full width average sample over time  
| colspan="2" | Background call to read the ADC as a byte average sample over time Call Enable() before this 
|-
|-
|-
|-
Line 184: Line 218:
| colspan="2" | Number of micro seconds in between taking each sample 
| colspan="2" | Number of micro seconds in between taking each sample 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RawAverageInt===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetProperties'''
| width="90%" class="mtx-class-macrohead" | '''RawAverageInt'''
|-
|-
| colspan="2" | Set the VRef options and voltage, ConvSpeed and AcqTime for the ADC component. 
| colspan="2" | Background call to read the ADC as a full width average sample over time Call Enable() before this 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VRef10Ms
| width="90%" | NumSamples
|-
|-
| colspan="2" | Voltage Reference x10 mV - Default 500 = 5V 
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | VRefOpt
| width="90%" | DelayUs
|-
|-
| colspan="2" | External VRef 0=Disabled, 1=Enabled 
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | ConvSpdOpt
|-
| colspan="2" | Conversion Speed Setting - Refer to numbered list 
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Aquisitions
|-
| colspan="2" | Aquisition time in micro seconds to precharge before sampling 
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RawDisable===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVoltage'''
| width="90%" class="mtx-class-macrohead" | '''RawDisable'''
|-
|-
| colspan="2" | Reads the ADC as a direct voltage 
| colspan="2" | Disables the previously enabled ADC channel and converts back to digital mode. 
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RawEnable===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RawEnable'''
| width="90%" class="mtx-class-macrohead" | '''RawEnable'''
|-
|-
| colspan="2" | Enables and configures the ADC channel to be an analogue input. Only one ADC channel can be enabled at a time. Any RAW functions will reference the last enabled channel only. 
| colspan="2" | Enables and configures the ADC channel to be an analogue input. Only one ADC channel can be enabled at a time. Any RAW functions will reference the last enabled channel only. 
Line 248: Line 275:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RawSampleByte===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetChannel'''
| width="90%" class="mtx-class-macrohead" | '''RawSampleByte'''
|-
|-
| colspan="2" | Sets the channel ID for the component 
| colspan="2" | Background call to read the ADC as a byte Call Enable() before this 
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelId
|-
| colspan="2" | Chaannel starting at 0, -1 is unconnected 
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===RawSampleInt===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RawSampleByte'''
| width="90%" class="mtx-class-macrohead" | '''RawSampleInt'''
|-
|-
| colspan="2" | Background call to read the ADC as a byte Call Enable() before this 
| colspan="2" | Background call to read the ADC at full bit depth Call Enable() first 
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetChannel===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetChannel'''
|-
| colspan="2" | Sets the channel ID for the component 
|-
|-
| 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" | Blocking call to read the ADC at full bit depth  
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | ChannelId
|-
|-
| colspan="2" | Chaannel starting at 0, -1 is unconnected 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetProperties===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RawDisable'''
| width="90%" class="mtx-class-macrohead" | '''SetProperties'''
|-
|-
| colspan="2" | Disables the previously enabled ADC channel and converts back to digital mode. 
| colspan="2" | Set the VRef options and voltage, ConvSpeed and AcqTime for the ADC component. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | VRef10Ms
|-
| colspan="2" | Voltage Reference x10 mV - Default 500 = 5V 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | VRefOpt
|-
|-
| colspan="2" | External VRef 0=Disabled, 1=Enabled 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | ConvSpdOpt
|}
 
 
{| 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" | Conversion Speed Setting - Refer to numbered list 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
|-
|-
| colspan="2" | Blocking call to read the ADC as a byte  
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Aquisitions
|-
|-
| colspan="2" | Aquisition time in micro seconds to precharge before sampling 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
| width="90%" class="mtx-class-propfolder" | Connections
|-
|-
|-
|-
Line 337: Line 373:
| colspan="2" | Analogue Input Channel - Which pin is the analogue input connected to? 
| 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="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
| width="90%" class="mtx-class-propfolder" | Settings
|-
|-
|-
|-
Line 366: Line 402:
| 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 
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
| width="90%" class="mtx-class-propfolder" | Simulation
|-
|-
|-
|-
Line 375: Line 411:
| colspan="2" | Selects if the scope traces are automatically generated or not 
| colspan="2" | Selects if the scope traces are automatically generated or not 
|}
|}
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_adc_Base_2dgdi.fcfx FC_Comp_Source_adc_Base_2dgdi.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_adc_Base_2dgdi.fcfx FC_Comp_Source_adc_Base_2dgdi.fcfx]

Latest revision as of 14:36, 13 July 2026

Author Matrix Ltd
Version 1.3
Category Analog Input


ADC Template 2D component

Base ADC component with no graphical interface. Contains all of the embedded side component calls to provide an ADC interface suitable for wrapping with a new ADC style component.

Detailed description

No detailed description exists yet for this component

Examples

Macro reference

GetAverageByte

GetAverageByte
Function call to read the ADC as a byte average sample over time  
- BYTE NumSamples
 
- BYTE DelayUs
Number of micro seconds in between taking each sample 
- BYTE Return


GetAverageInt

GetAverageInt
Function call to read the ADC as a full width average sample over time  
- BYTE NumSamples
 
- BYTE DelayUs
Number of micro seconds in between taking each sample 
- UINT Return


GetByte

GetByte
Blocking call to read the ADC as a byte  
- BYTE Return


GetInt

GetInt
Blocking call to read the ADC at full bit depth  
- UINT Return


GetSampleBits

GetSampleBits
Gets the number of bits per sample 
- BYTE Return


GetSpeedFilter

GetSpeedFilter
Gets the Conversion speed filter string Use in Component.Property.SetFilter() 
- STRING Return


GetString

GetString
Reads the ADC as a direct voltage and returns as a string 
- STRING Return


GetVoltage

GetVoltage
Reads the ADC as a direct voltage 
- FLOAT Return


RawAverageByte

RawAverageByte
Background call to read the ADC as a byte average sample over time Call Enable() before this 
- BYTE NumSamples
 
- BYTE DelayUs
Number of micro seconds in between taking each sample 
- BYTE Return


RawAverageInt

RawAverageInt
Background call to read the ADC as a full width average sample over time Call Enable() before this 
- BYTE NumSamples
 
- BYTE DelayUs
 
- INT Return


RawDisable

RawDisable
Disables the previously enabled ADC channel and converts back to digital mode. 
- VOID Return


RawEnable

RawEnable
Enables and configures the ADC channel to be an analogue input. Only one ADC channel can be enabled at a time. Any RAW functions will reference the last enabled channel only. 
- VOID Return


RawSampleByte

RawSampleByte
Background call to read the ADC as a byte Call Enable() before this 
- BYTE Return


RawSampleInt

RawSampleInt
Background call to read the ADC at full bit depth Call Enable() first 
- UINT Return


SetChannel

SetChannel
Sets the channel ID for the component 
- INT ChannelId
Chaannel starting at 0, -1 is unconnected 
- VOID Return


SetProperties

SetProperties
Set the VRef options and voltage, ConvSpeed and AcqTime for the ADC component. 
- INT VRef10Ms
Voltage Reference x10 mV - Default 500 = 5V 
- BOOL VRefOpt
External VRef 0=Disabled, 1=Enabled 
- INT ConvSpdOpt
Conversion Speed Setting - Refer to numbered list 
- INT Aquisitions
Aquisition time in micro seconds to precharge before sampling 
- 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 
Simulation
Scope Traces
Selects if the scope traces are automatically generated or not 

Component Source Code

Please click here to download the component source project: FC_Comp_Source_adc_Base_2dgdi.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_adc_Base_2dgdi.fcfx

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_ADC_Template_2D_(Analog_Input)&oldid=47742"