Difference between revisions of "Component: DAC (MCP49x1) (Analog Output)"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| Line 1: | Line 1: | ||
| − | + | {| style="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 | + | | 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. | ||
| + | |||
| + | ==Detailed description== | ||
| − | + | ''No detailed description exists yet for this component'' | |
| − | |||
| − | |||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| Line 25: | Line 27: | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
| − | === | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
| − | Sets the output voltage of the DAC | + | |- |
| + | | 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 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | DAC_Value | ||
| + | |- | ||
| + | | colspan="2" | The value to output to the DAC | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | 10- | + | {| 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;" | '''ControlPins''' | ||
| + | |- | ||
| + | | colspan="2" | Allows Shutdown (SHDN) and Latch (LDAC) pins to be controlled directly if enabled. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:]] - | ||
| + | | width="90%" | Shutdown | ||
| + | |- | ||
| + | | colspan="2" | 0 = Shutdown Device, 1 = Device Active | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:]] - | ||
| + | | width="90%" | Latch | ||
| + | |- | ||
| + | | colspan="2" | 0 = Data output driven from DAC register, 1 = Data output locked | ||
| + | |- | ||
| + | | 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;" | '''Disable''' | ||
| + | |- | ||
| + | | colspan="2" | Disables the DAC output. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''Enable''' | ||
| + | |- | ||
| + | | colspan="2" | Enables the DAC Output. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | 0=DAC Channel 0 , 1=DAC Channel 1 | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | '''WriteLEDs''' | ||
| + | |- | ||
| + | | colspan="2" | Allows control of all 8-LEDs on the front of the Formula Flowcode. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | LED_Byte | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Starts up the formula flowcode PWM for motor control and performs the wait for button press | ||
| + | |- | ||
| + | |- | ||
| + | | 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== | ==Property reference== | ||
| − | |||
| − | + | {| 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''' | |
| − | + | |- | |
| − | + | |- | |
| − | + | | 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. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Gain Option | |
| − | + | |- | |
| − | Reference Voltage, Used to calculate the Voltage resolution. | + | | colspan="2" | Selects the maximum reference value for the DAC |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
| − | + | | width="90%" | Vref Pin Voltage | |
| − | + | |- | |
| − | + | | colspan="2" | The reference voltage applied to the VREF pin. | |
| − | Number of discrete output states available from the DAC. | + | |- |
| − | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
| − | + | | width="90%" | Vref Voltage | |
| − | + | |- | |
| − | + | | colspan="2" | Reference Voltage, Used to calculate the Voltage resolution. | |
| − | + | |- | |
| − | Number of digital control bits | + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] |
| − | + | | width="90%" | Steps | |
| − | + | |- | |
| − | + | | colspan="2" | Number of discrete output states available from the DAC. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | |
| − | Maximum output resolution based on number of control bits. | + | | width="90%" | Control Bits |
| − | + | |- | |
| − | + | | colspan="2" | Number of digital control bits | |
| − | + | |- | |
| − | + | | 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. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
| − | + | | width="90%" | Voltage Resolution | |
| − | + | |- | |
| − | SPI Channel selector | + | | colspan="2" | Specifies the Resolution per digital bit in terms of Voltage. |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Channel | |
| − | + | |- | |
| − | + | | colspan="2" | SPI Channel selector | |
| − | Prescale option selector | + | |- |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | Prescale | |
| − | + | |- | |
| − | + | | colspan="2" | Prescale option selector | |
| − | + | |- | |
| − | 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]] |
| − | + | | width="90%" | MOSI | |
| − | + | |- | |
| − | + | | colspan="2" | 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]] | |
| − | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | + | | width="90%" | MISO |
| − | + | |- | |
| − | + | | colspan="2" | 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-5-icon.png]] | |
| − | + | | width="90%" | CLK | |
| − | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | + | |- |
| − | + | | colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | |
| − | + | | width="90%" | CS / SS | |
| − | + | |- | |
| − | Chip Select / Slave Select Pin | + | | 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. |
| − | + | |- | |
| − | Master Mode: General purpose output pin used to select the remote SPI device. | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] |
| − | + | | width="90%" | Use SHDN Pin | |
| − | Slave Mode: Hardware chip select pin input used to select the SPI device. | + | |- |
| − | + | | 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. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
| − | + | | width="90%" | Use LDAC Pin | |
| − | + | |- | |
| − | Allows the SHDN pin to be driven from an output pin on the microcontroller. | + | | 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. |
| − | + | |- | |
| − | If not used then tie the SHDN pin to VCC to allow the DAC to function. | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections''' | |
| − | + | |- | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations''' | |
| − | 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. | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] |
| − | + | | width="90%" | Simulate Comms | |
| − | + | |- | |
| − | + | | colspan="2" | | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
| − | Selects if the scope traces are automatically generated or not | + | | width="90%" | DAC Output Scope Traces |
| − | + | |- | |
| − | + | | colspan="2" | Selects if the scope traces are automatically generated or not | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
| − | + | | width="90%" | SPI Scope Traces | |
| − | Selects if the scope traces are automatically generated or not | + | |- |
| − | + | | colspan="2" | Selects if the scope traces are automatically generated or not | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |
| − | + | | width="90%" | SPI Console Data | |
| − | + | |- | |
| − | Selects if the console data is automatically generated or not | + | | colspan="2" | Selects if the console data is automatically generated or not |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | + | | width="90%" | API | |
| − | + | |- | |
| − | + | | colspan="2" | | |
| − | + | |} | |
Revision as of 21:05, 16 November 2021
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Analog Output |
Contents
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.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
| SetOutput | |
| Sets the output voltage of the DAC 8-Bit: Range 0-255 10-Bit: Range 0-1023 12-Bit: Range 0-4095 | |
| DAC_Value | |
| The value to output to the DAC | |
| Return | |
| Disable | |
| Disables the DAC output. | |
| Return | |
| Enable | |
| Enables the DAC Output. | |
| Channel | |
| 0=DAC Channel 0 , 1=DAC Channel 1 | |
| Return | |
| 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. | |
| Return | |
| 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. | |
| Return | |
| WriteLEDs | |
| Allows control of all 8-LEDs on the front of the Formula Flowcode. | |
| LED_Byte | |
| Return | |
| Initialise | |
| Starts up the formula flowcode PWM for motor control and performs the wait for button press | |
| Return | |