Difference between revisions of "Component: DAC (MCP49x1) (Analog Output)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 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
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| 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 Output
 
| Analog Output
 
|}
 
|}
  
  
 +
==DAC component==
 +
Component to drive a digital to analogue converter (DAC) IC from Microchip via an SPI interface. Compatible with MCP4901 (8-Bit), MCP4911 (10-Bit) and MCP4921 (12-Bit) devices.
  
−
==[[File:Component Icon b6de5668_e0ae_4c1a_9c16_b16aa3f58024.png|Image]] DAC (MCP49x1) component==
+
==Component Pack==
−
Component to drive a digital to analogue converter (DAC) IC from Microchip via an SPI interface.
 
−
Compatible with MCP4901 (8-Bit), MCP4911 (10-Bit) and MCP4921 (12-Bit) devices.
 
  
−
==Examples==
+
COMMSA
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>SetOutput</tt></u></span>===
 
−
Sets the output voltage of the DAC
 
  
−
8-Bit: Range 0-255
 
  
−
10-Bit: Range 0-1023
 
  
−
12-Bit: Range 0-4095
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''DAC_Value''
 
−
::The value to output to the DAC
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
 +
''No detailed description exists yet for this component''
  
−
===<span style="font-weight: normal;"><u><tt>ControlPins</tt></u></span>===
+
==Examples==
−
Allows Shutdown (SHDN) and Latch (LDAC) pins to be controlled directly if enabled.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BOOL]] ''Shutdown''
 
−
::0 = Shutdown Device, 1 = Device Active
 
  
−
:[[Variable Types|BOOL]] ''Latch''
 
−
::0 = Data output driven from DAC register, 1 = Data output locked
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Disable</tt></u></span>===
 
−
Disables the DAC output.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
+
''<span style="color:red;">No additional examples</span>''
  
−
:''This call does not return a value''
 
  
 +
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>Enable</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Enables the DAC Output.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOutput'''
 +
|-
 +
| colspan="2" | Sets the output voltage of the DAC 8-Bit: Range 0-255 10-Bit: Range 0-1023 12-Bit: Range 0-4095&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | DAC_Value
 +
|-
 +
| colspan="2" | The value to output to the DAC&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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Channel''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::0=DAC Channel 0 , 1=DAC Channel 1
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ControlPins'''
 +
|-
 +
| colspan="2" | Allows Shutdown (SHDN) and Latch (LDAC) pins to be controlled directly if enabled.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Shutdown
 +
|-
 +
| colspan="2" | 0 = Shutdown Device, 1 = Device Active&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Latch
 +
|-
 +
| colspan="2" | 0 = Data output driven from DAC register, 1 = Data output locked&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;" | '''Disable'''
 +
|-
 +
| colspan="2" | Disables the DAC output.&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''
 +
|}
  
−
:''This call does not return a 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;" | '''Enable'''
 +
|-
 +
| colspan="2" | Enables the DAC Output.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | 0=DAC Channel 0 , 1=DAC Channel 1&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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
Configures the SPI peripheral ready for communications and initialises the internal variables. DAC needs to be enabled before any output voltage can be generated.
 
  
−
'''Parameters'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:''This macro has no parameters''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
−
 
+
|-
−
'''Return value'''
+
| colspan="2" | Configures the SPI peripheral ready for communications and initialises the internal variables. DAC needs to be enabled before any output voltage can be generated.&nbsp;
−
 
+
|-
−
:''This call does not return a value''
+
|-
 +
| 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''
 +
|}
  
  
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>DAC IC</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DAC_IC''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Selects which DAC IC is connected and therefore the bit depth available.
+
| 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>Gain Option</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''GainOP''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | DAC IC
−
Selects the maximum reference value for the DAC
+
|-
−
 
+
| colspan="2" | Selects which DAC IC is connected and therefore the bit depth available.&nbsp;
−
<span style="font-weight: normal;"><u>Vref Voltage</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''VrefVol''.
+
| width="90%" | Gain Option
−
 
+
|-
−
Reference Voltage, Used to calculate the Voltage resolution.
+
| colspan="2" | Selects the maximum reference value for the DAC&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Steps</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Vref Pin Voltage
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Steps''.
+
|-
−
 
+
| colspan="2" | The reference voltage applied to the VREF pin.&nbsp;
−
Number of discrete output states available from the DAC.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
<span style="font-weight: normal;"><u>Control Bits</u></span>
+
| width="90%" | Vref Voltage
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''BITS''.
+
| colspan="2" | Reference Voltage, Used to calculate the Voltage resolution.&nbsp;
−
 
+
|-
−
Number of digital control bits
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Steps
−
<span style="font-weight: normal;"><u>Resolution</u></span>
+
|-
−
 
+
| colspan="2" | Number of discrete output states available from the DAC.&nbsp;
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Res''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Maximum output resolution based on number of control bits.
+
| width="90%" | Control Bits
−
 
+
|-
−
<span style="font-weight: normal;"><u>Voltage Resolution</u></span>
+
| colspan="2" | Number of digital control bits&nbsp;
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''VoltRes''.
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Resolution
−
Specifies the Resolution per digital bit in terms of Voltage.
+
|-
−
 
+
| colspan="2" | Maximum output resolution based on number of control bits.&nbsp;
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::CHANNEL''.
+
| width="90%" | Voltage Resolution
−
 
+
|-
−
SPI Channel selector
+
| colspan="2" | Specifies the Resolution per digital bit in terms of Voltage.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Prescale</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Connections
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::PR_SCALE''.
+
|-
−
 
+
|-
−
Prescale option selector
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Channel
−
<span style="font-weight: normal;"><u>MOSI</u></span>
+
|-
−
 
+
| colspan="2" | SPI Channel selector&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MOSI''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
+
| width="90%" | Prescale
−
 
+
|-
−
<span style="font-weight: normal;"><u>MISO</u></span>
+
| colspan="2" | Prescale option selector&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MISO''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | MOSI
−
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
+
|-
−
 
+
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
−
<span style="font-weight: normal;"><u>CLK</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::CLK''.
+
| width="90%" | MOSI Remap Pin
−
 
+
|-
−
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
+
| colspan="2" | Select which the target pin to assign the MOSI hardware pin functionality.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>CS / SS</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | MISO
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::SS''.
+
|-
−
 
+
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
−
Chip Select / Slave Select Pin  
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Master Mode: General purpose output pin used to select the remote SPI device.
+
| width="90%" | MISO Remap Pin
−
 
+
|-
−
Slave Mode: Hardware chip select pin input used to select the SPI device.
+
| colspan="2" | Select which the target pin to assign the MISO hardware pin functionality.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Use SHDN Pin</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | CLK
−
This property is of type ''True or false'' and can be referenced with the variable name ''UseSHDN''.
+
|-
−
 
+
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
−
Allows the SHDN pin to be driven from an output pin on the microcontroller.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
If not used then tie the SHDN pin to VCC to allow the DAC to function.
+
| width="90%" | CLK Remap Pin
−
 
+
|-
−
<span style="font-weight: normal;"><u>Use LDAC Pin</u></span>
+
| colspan="2" | Select which the target pin to assign the CLK hardware pin functionality.&nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''UseLDAC''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | CS / SS
−
Allows the LDAC pin to be driven from an output pin on the microcontroller.
+
|-
−
 
+
| 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;
−
If not used then tie the LDAC pin to GND to allow the DAC to function.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>DAC Output Scope Traces</u></span>
+
| width="90%" | Use SHDN Pin
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''ScopeTraces''.
+
| colspan="2" | Allows the SHDN pin to be driven from an output pin on the microcontroller. If not used then tie the SHDN pin to VCC to allow the DAC to function.&nbsp;
−
 
+
|-
−
Selects if the scope traces are automatically generated or not
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Use LDAC Pin
−
<span style="font-weight: normal;"><u>SPI Scope Traces</u></span>
+
|-
−
 
+
| colspan="2" | Allows the LDAC pin to be driven from an output pin on the microcontroller. If not used then tie the LDAC pin to GND to allow the DAC to function.&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ScopeTraces''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Selects if the scope traces are automatically generated or not
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
 
+
|-
−
<span style="font-weight: normal;"><u>SPI Console Data</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 ''cal_spi1::ConsoleData''.
+
| width="90%" | Simulate Comms
−
 
+
|-
−
Selects if the console data is automatically generated or not
+
| colspan="2" | &nbsp;
−
 
+
|}
−
<span style="font-weight: normal;"><u>Injector</u></span>
 
−
 
 
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::Injector''.
 
−
 
 
−
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 17:27, 9 November 2022

Author Matrix TSL
Version 1.0
Category Analog Output


DAC component

Component to drive a digital to analogue converter (DAC) IC from Microchip via an SPI interface. Compatible with MCP4901 (8-Bit), MCP4911 (10-Bit) and MCP4921 (12-Bit) devices.

Component Pack

COMMSA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png SetOutput
Sets the output voltage of the DAC 8-Bit: Range 0-255 10-Bit: Range 0-1023 12-Bit: Range 0-4095 
Fc9-u16-icon.png - UINT DAC_Value
The value to output to the DAC 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ControlPins
Allows Shutdown (SHDN) and Latch (LDAC) pins to be controlled directly if enabled. 
Fc9-bool-icon.png - BOOL Shutdown
0 = Shutdown Device, 1 = Device Active 
Fc9-bool-icon.png - BOOL Latch
0 = Data output driven from DAC register, 1 = Data output locked 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disables the DAC output. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Enables the DAC Output. 
Fc9-u8-icon.png - BYTE Channel
0=DAC Channel 0 , 1=DAC Channel 1 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Configures the SPI peripheral ready for communications and initialises the internal variables. DAC needs to be enabled before any output voltage can be generated. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png DAC IC
Selects which DAC IC is connected and therefore the bit depth available. 
Fc9-type-16-icon.png Gain Option
Selects the maximum reference value for the DAC 
Fc9-type-15-icon.png Vref Pin Voltage
The reference voltage applied to the VREF pin. 
Fc9-type-15-icon.png Vref Voltage
Reference Voltage, Used to calculate the Voltage resolution. 
Fc9-type-21-icon.png Steps
Number of discrete output states available from the DAC. 
Fc9-type-14-icon.png Control Bits
Number of digital control bits 
Fc9-type-10-icon.png Resolution
Maximum output resolution based on number of control bits. 
Fc9-type-15-icon.png Voltage Resolution
Specifies the Resolution per digital bit in terms of Voltage. 
Fc9-conn-icon.png SPI 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 SHDN Pin
Allows the SHDN pin to be driven from an output pin on the microcontroller. If not used then tie the SHDN pin to VCC to allow the DAC to function. 
Fc9-type-7-icon.png Use LDAC Pin
Allows the LDAC pin to be driven from an output pin on the microcontroller. If not used then tie the LDAC pin to GND to allow the DAC to function. 
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulate Comms
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_DAC_(MCP49x1)_(Analog_Output)&oldid=29068"