Component: ADC Template 2D (Analog Input)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 1.3 |
| Category | Analog Input |
Contents
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 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
Detailed description
No detailed description exists yet for this component
Examples
Macro reference
|
RawSampleInt |
| Background call to read the ADC at full bit depth Call Enable() first | |
 - UINT
|
Return |
|
|
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 |
|
|
GetSampleBits |
| Gets the number of bits per sample | |
| - BYTE
|
Return |
|
|
GetString |
| Reads the ADC as a direct voltage and returns as a string | |
 - STRING
|
Return |
|
|
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 |
|
|
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 |
|
|
GetSpeedFilter |
| Gets the Conversion speed filter string Use in Component.Property.SetFilter() | |
| - STRING
|
Return |
|
|
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 |
|
|
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 |
|
|
GetVoltage |
| Reads the ADC as a direct voltage | |
 - FLOAT
|
Return |
|
|
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 |
|
|
SetChannel |
| Sets the channel ID for the component | |
| - INT
|
ChannelId |
| Chaannel starting at 0, -1 is unconnected | |
| - VOID
|
Return |
|
|
RawSampleByte |
| Background call to read the ADC as a byte Call Enable() before this | |
| - BYTE
|
Return |
|
|
GetInt |
| Blocking call to read the ADC at full bit depth | |
| - UINT
|
Return |
|
|
RawDisable |
| Disables the previously enabled ADC channel and converts back to digital mode. | |
| - VOID
|
Return |
|
|
GetByte |
| Blocking call to 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 | |
|
|
Simulation |
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
==Macro reference==
|
|
RawSampleInt |
| Background call to read the ADC at full bit depth Call Enable() first | |
| - UINT
|
Return |
|
|
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 |
|
|
GetSampleBits |
| Gets the number of bits per sample | |
| - BYTE
|
Return |
|
|
GetString |
| Reads the ADC as a direct voltage and returns as a string | |
| - STRING
|
Return |
|
|
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 |
|
|
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 |
|
|
GetSpeedFilter |
| Gets the Conversion speed filter string Use in Component.Property.SetFilter() | |
| - STRING
|
Return |
|
|
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 |
|
|
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 |
|
|
GetVoltage |
| Reads the ADC as a direct voltage | |
| - FLOAT
|
Return |
|
|
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 |
|
|
SetChannel |
| Sets the channel ID for the component | |
| - INT
|
ChannelId |
| Chaannel starting at 0, -1 is unconnected | |
| - VOID
|
Return |
|
|
RawSampleByte |
| Background call to read the ADC as a byte Call Enable() before this | |
| - BYTE
|
Return |
|
|
GetInt |
| Blocking call to read the ADC at full bit depth | |
| - UINT
|
Return |
|
|
RawDisable |
| Disables the previously enabled ADC channel and converts back to digital mode. | |
| - VOID
|
Return |
|
|
GetByte |
| Blocking call to 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 | |
|
|
Simulation |
|
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
==Macro reference==
|
|
RawSampleInt |
| Background call to read the ADC at full bit depth Call Enable() first | |
| - UINT
|
Return |
|
|
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 |
|
|
GetSampleBits |
| Gets the number of bits per sample | |
| - BYTE
|
Return |
|
|
GetString |
| Reads the ADC as a direct voltage and returns as a string | |
| - STRING
|
Return |
|
|
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 |
|
|
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 |
|
|
GetSpeedFilter |
| Gets the Conversion speed filter string Use in Component.Property.SetFilter() | |
| - STRING
|
Return |
|
|
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 |
|
|
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 |
|
|
GetVoltage |
| Reads the ADC as a direct voltage | |
| - FLOAT
|
Return |
|
|
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 |
|
|
SetChannel |
| Sets the channel ID for the component | |
| - INT
|
ChannelId |
| Chaannel starting at 0, -1 is unconnected | |
| - VOID
|
Return |
|
|
RawSampleByte |
| Background call to read the ADC as a byte Call Enable() before this | |
| - BYTE
|
Return |
|
|
GetInt |
| Blocking call to read the ADC at full bit depth | |
| - UINT
|
Return |
|
|
RawDisable |
| Disables the previously enabled ADC channel and converts back to digital mode. | |
| - VOID
|
Return |
|
|
GetByte |
| Blocking call to 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 | |
|
|
Simulation |
|
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
