Difference between revisions of "Component: ADC (MCP356X) (Analog Input)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| MatrixTSL
 
| MatrixTSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Analog Input
 
| Analog Input
 
|}
 
|}
  
  
 +
==ADC (MCP356X) component==
 +
An external ADC featuring 2, 4, or 8 channel 24-bit input. Capable of reading each channel independently or in differential mode. Communication using an SPI bus up to 20MHz.
  
−
==[[File:Component Icon 235fd689_bfd1_4c4a_a918_6c3c36e9a49f.png|Image]] ADC (MCP356X) component==
+
==Component Pack==
−
An external ADC featuring 2, 4, or 8 channel 24-bit input.
 
−
Capable of reading each channel independently or in differential mode.
 
−
Communication using an SPI bus up to 20MHz.
 
  
−
==Examples==
+
FREE
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>SampleADC</tt></u></span>===
 
−
Performs a single ADC sample and returns the result as a 24-bit value
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''PositiveChannel''
 
−
::0=CH0 - 7=CH7, 8=GND, 9=VDD, 11=REF+, 12=REF-, 13=TP, 14=TM, 15=VCM
 
  
−
:[[Variable Types|BYTE]] ''NegativeChannel''
+
''No detailed description exists yet for this component''
−
::0=CH0 - 7=CH7, 8=GND, 9=VDD, 11=REF+, 12=REF-, 13=TP, 14=TM, 15=VCM
 
  
 +
==Examples==
  
−
'''Return value'''
 
  
−
:[[Variable Types|LONG]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
Confgures the SPI bus ready for communications and initialises the MCP356X device.
 
  
−
Returns true if device is responding to commands.
+
''<span style="color:red;">No additional examples</span>''
  
−
'''Parameters'''
+
==Downloadable macro reference==
  
−
:''This macro has no parameters''
+
{| 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;" | '''SetOffsetCalibration'''
 +
|-
 +
| colspan="2" | Allows the device offset to be entered allowing for accurate readings.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 +
| width="90%" | Offset
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
  
−
'''Return value'''
+
{| 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;" | '''SetGainCalibration'''
 +
|-
 +
| colspan="2" | Allows the device offset to be entered allowing for accurate readings.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Gain
 +
|-
 +
| colspan="2" | Default 800000 = Gain of 1X&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''
 +
|}
 +
 
  
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
+
{| 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;" | '''SampleADC'''
 +
|-
 +
| colspan="2" | Performs a single ADC sample and returns the result as a 24-bit value&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | PositiveChannel
 +
|-
 +
| colspan="2" | 0=CH0 - 7=CH7, 8=GND, 9=VDD, 11=REF+, 12=REF-, 13=TP, 14=TM, 15=VCM&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | NegativeChannel
 +
|-
 +
| colspan="2" | 0=CH0 - 7=CH7, 8=GND, 9=VDD, 11=REF+, 12=REF-, 13=TP, 14=TM, 15=VCM&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 +
| 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;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Confgures the SPI bus ready for communications and initialises the MCP356X device. Returns true if device is responding to commands.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Device Type</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DevType''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Device Address</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Device Configuration
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DevAddress''.
+
|-
−
 
+
|-
−
These bits are fixed from the manufacturer and by default are 01.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Device Type
−
Used as Bits 6 and 7 of the command byte.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
Alternative bits must be requested from the manufacturer.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Clock Selection</u></span>
+
| width="90%" | Device Address
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ClockSelection''.
+
| colspan="2" | These bits are fixed from the manufacturer and by default are 01. Used as Bits 6 and 7 of the command byte. Alternative bits must be requested from the manufacturer.&nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Clock Selection
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
<span style="font-weight: normal;"><u>Sensor Bias Current</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''BiasCurrent''.
+
| width="90%" | Sensor Bias Current
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | ADC Bias Current
−
<span style="font-weight: normal;"><u>ADC Bias Current</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ADCBiasCurrent''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | AMCLK Prescaler
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>AMCLK Prescaler</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Oversampling Ratio
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Prescaler''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | ADC Gain
−
 
+
|-
−
<span style="font-weight: normal;"><u>Oversampling Ratio</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OversamplingRatio''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | IRQ Mode
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>ADC Gain</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ADCGain''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Channel
−
 
+
|-
−
 
+
| colspan="2" | SPI Channel selector&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>IRQ Mode</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Prescale
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''IRQMode''.
+
|-
−
 
+
| colspan="2" | Prescale option selector&nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | MOSI
−
 
+
|-
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::CHANNEL''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | MOSI Remap Pin
−
SPI Channel selector
+
|-
−
 
+
| colspan="2" | Select which the target pin to assign the MOSI hardware pin functionality.&nbsp;
−
<span style="font-weight: normal;"><u>Prescale</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::PR_SCALE''.
+
| width="90%" | MISO
−
 
+
|-
−
Prescale option selector
+
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>MOSI</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | MISO Remap Pin
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MOSI''.
+
|-
−
 
+
| colspan="2" | Select which the target pin to assign the MISO hardware pin functionality.&nbsp;
−
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
<span style="font-weight: normal;"><u>MISO</u></span>
+
| width="90%" | CLK
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MISO''.
+
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
−
 
+
|-
−
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | CLK Remap Pin
−
<span style="font-weight: normal;"><u>CLK</u></span>
+
|-
−
 
+
| colspan="2" | Select which the target pin to assign the CLK hardware pin functionality.&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::CLK''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
+
| width="90%" | CS / SS
−
 
+
|-
−
<span style="font-weight: normal;"><u>CS / SS</u></span>
+
| colspan="2" | Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. &nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::SS''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Use IRQ
−
Chip Select / Slave Select Pin  
+
|-
−
 
+
| colspan="2" | No: Use polling of the status register to determine when an ADC sample is complete. Yes: Use the IRQ interrupt pin to determine when an ADC sample is complete.&nbsp;
−
Master Mode: General purpose output pin used to select the remote SPI device.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Slave Mode: Hardware chip select pin input used to select the SPI device.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
 
+
|-
−
<span style="font-weight: normal;"><u>Use IRQ</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''UseIRQ''.
+
| width="90%" | Simulate Comms
−
 
+
|-
−
No: Use polling of the status register to determine when an ADC sample is complete.
+
| colspan="2" | No: Simulation is done using panel sliders. Yes: Send SPI data via API interface and show real time data using panel sliders.&nbsp;
−
 
+
|}
−
Yes: Use the IRQ interrupt pin to determine when an ADC sample is complete.
 
−
 
 
−
<span style="font-weight: normal;"><u>IRQ Pin</u></span>
 
−
 
 
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''IRQPin''.
 
−
 
 
−
Connected to the IRQ pin of the device, goes low on an interrupt event such as sample complete.
 
−
 
 
−
<span style="font-weight: normal;"><u>Simulate Comms</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''SimComms''.
 
−
 
 
−
No: Simulation is done using panel sliders.
 
−
 
 
−
Yes: Send SPI data via API interface and show real time data using panel sliders.
 
−
 
 
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ScopeTraces''.
 
−
 
 
−
Selects if the scope traces are automatically generated or not
 
−
 
 
−
<span style="font-weight: normal;"><u>Console Data</u></span>
 
−
 
 
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ConsoleData''.
 
−
 
 
−
Selects if the console data is automatically generated or not
 
−
 
 
−
<span style="font-weight: normal;"><u>API</u></span>
 
−
 
 
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::Injector''.
 
−
 
 
−
Selects the API Slave to use to send and receive real world SPI data during simulation.
 

Latest revision as of 17:25, 9 November 2022

Author MatrixTSL
Version 1.0
Category Analog Input


ADC (MCP356X) component

An external ADC featuring 2, 4, or 8 channel 24-bit input. Capable of reading each channel independently or in differential mode. Communication using an SPI bus up to 20MHz.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png SetOffsetCalibration
Allows the device offset to be entered allowing for accurate readings. 
Fc9-s32-icon.png - LONG Offset
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetGainCalibration
Allows the device offset to be entered allowing for accurate readings. 
Fc9-u32-icon.png - ULONG Gain
Default 800000 = Gain of 1X 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SampleADC
Performs a single ADC sample and returns the result as a 24-bit value 
Fc9-u8-icon.png - BYTE PositiveChannel
0=CH0 - 7=CH7, 8=GND, 9=VDD, 11=REF+, 12=REF-, 13=TP, 14=TM, 15=VCM 
Fc9-u8-icon.png - BYTE NegativeChannel
0=CH0 - 7=CH7, 8=GND, 9=VDD, 11=REF+, 12=REF-, 13=TP, 14=TM, 15=VCM 
Fc9-s32-icon.png - LONG Return


Fc9-comp-macro.png Initialise
Confgures the SPI bus ready for communications and initialises the MCP356X device. Returns true if device is responding to commands. 
Fc9-bool-icon.png - BOOL Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Device Configuration
Fc9-type-16-icon.png Device Type
 
Fc9-type-16-icon.png Device Address
These bits are fixed from the manufacturer and by default are 01. Used as Bits 6 and 7 of the command byte. Alternative bits must be requested from the manufacturer. 
Fc9-type-16-icon.png Clock Selection
 
Fc9-type-16-icon.png Sensor Bias Current
 
Fc9-type-16-icon.png ADC Bias Current
 
Fc9-type-16-icon.png AMCLK Prescaler
 
Fc9-type-16-icon.png Oversampling Ratio
 
Fc9-type-16-icon.png ADC Gain
 
Fc9-type-16-icon.png IRQ Mode
 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-16-icon.png MOSI Remap Pin
Select which the target pin to assign the MOSI hardware pin functionality. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-16-icon.png MISO Remap Pin
Select which the target pin to assign the MISO hardware pin functionality. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-16-icon.png CLK Remap Pin
Select which the target pin to assign the CLK hardware pin functionality. 
Fc9-type-5-icon.png CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.  
Fc9-type-7-icon.png Use IRQ
No: Use polling of the status register to determine when an ADC sample is complete. Yes: Use the IRQ interrupt pin to determine when an ADC sample is complete. 
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulate Comms
No: Simulation is done using panel sliders. Yes: Send SPI data via API interface and show real time data using panel sliders. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_ADC_(MCP356X)_(Analog_Input)&oldid=28939"