Difference between revisions of "Component: Input ADC (DSP Inputs)"

From Flowcode Help
Jump to navigationJump to search
 
(8 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_ADCInput.fcfx FC_Comp_Source_DSP_ADCInput.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_ADCInput.fcfx FC_Comp_Source_DSP_ADCInput.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_ADCInput.fcfx FC_Comp_Source_DSP_ADCInput.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 34: Line 42:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
  
  
Line 46: Line 60:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
==Macro reference==
 
==Macro reference==
  
 +
===AddSample===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 62: Line 91:
  
  
 +
===AddSampleArray===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 78: Line 108:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  
Line 113: Line 141:
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
| width="90%" | Auto Adjust Scale
+
| width="90%" | Bit Depth
 
|-
 
|-
−
| colspan="2" | Yes: Automatically convert ADC samples to match the full bit depth of the DSP buffer. No: Leave the ADC samples at the native bit depth.&nbsp;
+
| colspan="2" | Maximum number of bits for each ADC sample.&nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Line 133: Line 161:
 
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample.&nbsp;
 
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
| width="90%" | Bit Depth
+
| width="90%" | Remap Values
 
|-
 
|-
−
| colspan="2" | Maximum number of bits for each ADC sample.&nbsp;
+
| colspan="2" | Map the analog input range to a selected output range. &nbsp;
−
|}==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="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddSample'''
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Mapping
 
|-
 
|-
−
| colspan="2" | Adds a single ADC sample to the current location in the specified buffer. If Auto Scale is enabled then the sample will be scaled to correctly fit inside the buffer. Auto increments current location.&nbsp;
 
 
|-
 
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Input Full Range
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| colspan="2" | Selects if the entire range of the ADC is mapped. Yes: Use the full ADC range No: Use a custom ADC range&nbsp;
−
| 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="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddSampleArray'''
+
| width="90%" | Input Min
−
|-
 
−
| colspan="2" | Adds a single ADC sample to the current location in the specified buffer. If Auto Scale is enabled then the sample will be scaled to correctly fit inside the buffer. Auto increments current location.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | SampleDelay
 
−
|-
 
−
| colspan="2" | Number of us in between each sample.&nbsp;
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
 
−
 
 
−
 
 
−
 
 
−
==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'''
 
 
|-
 
|-
 +
| colspan="2" | Min value provided by the ADC input&nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
| width="90%" | Buffer Size
+
| width="90%" | Input Max
 
|-
 
|-
−
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
+
| colspan="2" | Max value provided by the ADC input&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
| width="90%" | Buffer Type
+
| width="90%" | Output Min
 
|-
 
|-
−
| colspan="2" | Sets the buffer data type, data is automatically scaled to fit and make full use of the data type.&nbsp;
+
| colspan="2" | Min value to output&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+
| width="90%" | Output Max
 
|-
 
|-
−
|-
+
| colspan="2" | Max value to output&nbsp;
−
| 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?&nbsp;
 
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation Slider
 
|-
 
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
| width="90%" | Auto Adjust Scale
+
| width="90%" | Show Slider
 
|-
 
|-
−
| colspan="2" | Yes: Automatically convert ADC samples to match the full bit depth of the DSP buffer. No: Leave the ADC samples at the native bit depth.&nbsp;
+
| colspan="2" | Allows the ADC input to be driven from a slider.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
| width="90%" | VRef option
+
| width="90%" | Major Tick Step
 
|-
 
|-
−
| 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.&nbsp;
+
| colspan="2" | The number of minor tick marks to show a major tick mark value.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
| width="90%" | Conversion speed
+
| width="90%" | Minor Tick Step
 
|-
 
|-
−
| 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.&nbsp;
+
| colspan="2" | The scale value between consecutive minor tick marks.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
| width="90%" | Acquisition cycles
+
| width="90%" | Label Format
 
|-
 
|-
−
| colspan="2" | Number of micro seconds to wait for the ADC input to charge before starting the analogue sample.&nbsp;
+
| colspan="2" | &nbsp;
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Bit Depth
 
−
|-
 
−
| colspan="2" | Maximum number of bits for each ADC sample.&nbsp;
 
 
|}
 
|}

Latest revision as of 16:34, 17 May 2023

Author Matrix Ltd
Version 1.2
Category DSP Inputs


Input ADC component

Allows the values from a buffer to be assigned driectly from an analog enabled pin. Either a single sample at a time or a number of samples. Auto scales the digital value to fill the entire range of the specified buffer type.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples








Macro reference

AddSample

Fc9-comp-macro.png AddSample
Adds a single ADC sample to the current location in the specified buffer. If Auto Scale is enabled then the sample will be scaled to correctly fit inside the buffer. Auto increments current location. 
Fc9-void-icon.png - VOID Return


AddSampleArray

Fc9-comp-macro.png AddSampleArray
Adds a single ADC sample to the current location in the specified buffer. If Auto Scale is enabled then the sample will be scaled to correctly fit inside the buffer. Auto increments current location. 
Fc9-u16-icon.png - UINT SampleDelay
Number of us in between each sample. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type, data is automatically scaled to fit and make full use of the data type. 
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-21-icon.png Bit Depth
Maximum number of bits for each ADC sample. 
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-7-icon.png Remap Values
Map the analog input range to a selected output range.  
Fc9-conn-icon.png Mapping
Fc9-type-7-icon.png Input Full Range
Selects if the entire range of the ADC is mapped. Yes: Use the full ADC range No: Use a custom ADC range 
Fc9-type-21-icon.png Input Min
Min value provided by the ADC input 
Fc9-type-21-icon.png Input Max
Max value provided by the ADC input 
Fc9-type-14-icon.png Output Min
Min value to output 
Fc9-type-14-icon.png Output Max
Max value to output 
Fc9-conn-icon.png Simulation Slider
Fc9-type-7-icon.png Show Slider
Allows the ADC input to be driven from a slider. 
Fc9-type-21-icon.png Major Tick Step
The number of minor tick marks to show a major tick mark value. 
Fc9-type-15-icon.png Minor Tick Step
The scale value between consecutive minor tick marks. 
Fc9-type-10-icon.png Label Format
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Input_ADC_(DSP_Inputs)&oldid=39055"