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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
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]
+
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]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 40: Line 42:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| 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;" | '''RawSampleInt'''
 +
|-
 +
| 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-u16-icon.png]] - UINT
 +
| 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;" | '''RawAverageByte'''
 +
|-
 +
| colspan="2" | Background call to read the ADC as a byte average sample over time Call Enable() before this 
 +
|-
 +
|-
 +
| 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="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;" | '''GetSampleBits'''
 +
|-
 +
| colspan="2" | Gets the number of bits per sample 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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 and returns as a string 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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" | 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-u8-icon.png]] - BYTE
 +
| 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;" | '''RawAverageInt'''
 +
|-
 +
| 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-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-s16-icon.png]] - INT
 +
| 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;" | '''GetSpeedFilter'''
 +
|-
 +
| colspan="2" | Gets the Conversion speed filter string Use in Component.Property.SetFilter() 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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" | Function call to read the ADC as a full width 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="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;" | '''SetProperties'''
 +
|-
 +
| 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" | [[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''
 +
|}
 +
 +
 +
{| 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''
 +
|}
 +
 +
 +
{| 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;" | '''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. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''SetChannel'''
 +
|-
 +
| colspan="2" | Sets the channel ID for the component 
 +
|-
 +
|-
 +
| 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-void-icon.png]] - VOID
 +
| 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;" | '''RawSampleByte'''
 +
|-
 +
| colspan="2" | Background call to read the ADC as a byte Call Enable() before this 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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" | Blocking call to 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''
 +
|}
 +
 +
 +
{| 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;" | '''RawDisable'''
 +
|-
 +
| 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-void-icon.png]] - VOID
 +
| 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;" | '''GetByte'''
 +
|-
 +
| colspan="2" | Blocking call to 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''
 +
|}
 +
 +
 +
 +
 +
==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" 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 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:17, 20 January 2023

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.

Component Source Code

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

Detailed description

No detailed description exists yet for this component

Examples

Macro reference

Fc9-comp-macro.png RawSampleInt
Background call to read the ADC at full bit depth Call Enable() first 
Fc9-u16-icon.png - UINT Return


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


Fc9-comp-macro.png GetSampleBits
Gets the number of bits per sample 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetString
Reads the ADC as a direct voltage and returns as a string 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetAverageByte
Function call to read the ADC as a byte average sample over time  
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
Number of micro seconds in between taking each sample 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png RawAverageInt
Background call to read the ADC as a full width average sample over time Call Enable() before this 
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
 
Fc9-s16-icon.png - INT Return


Fc9-comp-macro.png GetSpeedFilter
Gets the Conversion speed filter string Use in Component.Property.SetFilter() 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetAverageInt
Function call to read the ADC as a full width average sample over time  
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
Number of micro seconds in between taking each sample 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png SetProperties
Set the VRef options and voltage, ConvSpeed and AcqTime for the ADC component. 
Fc9-s16-icon.png - INT VRef10Ms
Voltage Reference x10 mV - Default 500 = 5V 
Fc9-bool-icon.png - BOOL VRefOpt
External VRef 0=Disabled, 1=Enabled 
Fc9-s16-icon.png - INT ConvSpdOpt
Conversion Speed Setting - Refer to numbered list 
Fc9-s16-icon.png - INT Aquisitions
Aquisition time in micro seconds to precharge before sampling 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetChannel
Sets the channel ID for the component 
Fc9-s16-icon.png - INT ChannelId
Chaannel starting at 0, -1 is unconnected 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RawSampleByte
Background call to read the ADC as a byte Call Enable() before this 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetInt
Blocking call to read the ADC at full bit depth  
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png RawDisable
Disables the previously enabled ADC channel and converts back to digital mode. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetByte
Blocking call to read the ADC as a byte  
Fc9-u8-icon.png - BYTE 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 Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 

==Macro reference==

Fc9-comp-macro.png RawSampleInt
Background call to read the ADC at full bit depth Call Enable() first 
Fc9-u16-icon.png - UINT Return


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


Fc9-comp-macro.png GetSampleBits
Gets the number of bits per sample 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetString
Reads the ADC as a direct voltage and returns as a string 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetAverageByte
Function call to read the ADC as a byte average sample over time  
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
Number of micro seconds in between taking each sample 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png RawAverageInt
Background call to read the ADC as a full width average sample over time Call Enable() before this 
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
 
Fc9-s16-icon.png - INT Return


Fc9-comp-macro.png GetSpeedFilter
Gets the Conversion speed filter string Use in Component.Property.SetFilter() 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetAverageInt
Function call to read the ADC as a full width average sample over time  
Fc9-u8-icon.png - BYTE NumSamples
 
Fc9-u8-icon.png - BYTE DelayUs
Number of micro seconds in between taking each sample 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png SetProperties
Set the VRef options and voltage, ConvSpeed and AcqTime for the ADC component. 
Fc9-s16-icon.png - INT VRef10Ms
Voltage Reference x10 mV - Default 500 = 5V 
Fc9-bool-icon.png - BOOL VRefOpt
External VRef 0=Disabled, 1=Enabled 
Fc9-s16-icon.png - INT ConvSpdOpt
Conversion Speed Setting - Refer to numbered list 
Fc9-s16-icon.png - INT Aquisitions
Aquisition time in micro seconds to precharge before sampling 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetChannel
Sets the channel ID for the component 
Fc9-s16-icon.png - INT ChannelId
Chaannel starting at 0, -1 is unconnected 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RawSampleByte
Background call to read the ADC as a byte Call Enable() before this 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png GetInt
Blocking call to read the ADC at full bit depth  
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png RawDisable
Disables the previously enabled ADC channel and converts back to digital mode. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetByte
Blocking call to read the ADC as a byte  
Fc9-u8-icon.png - BYTE 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 Simulation
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_ADC_Template_2D_(Analog_Input)&oldid=33007"