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

Latest revision as of 17:21, 9 November 2022

Author	Matrix TSL
Version	2.0
Category	Analog Output

DAC (Internal) component

Provides access to the onboard digital to analog converter (DAC) peripheral allowing for simple analogue output. Often the DAC output will be very low current and will need amplification using external circuitry to drive anything useful.

Component Pack

BASICIO

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
- UINT	DAC_Value
The value to output to the DAC
- VOID	Return

	GetValue
Gets the Name property value
- STRING	Name
The name of the property
- STRING	Return

	Disable
Disables the DAC output.
- VOID	Return

	Enable
Enables the DAC Output.
- VOID	Return

	SetValue
Sets the Value for the named property
- STRING	Name
Name of property to update
- STRING	Value
The new value for the property
- VOID	Return

	GetList

- STRING	Name

- STRING	Return

Property reference

	Properties
	Channel
DAC Channel number
	DAC Output Pin
DAC Output Pin
	Vref Option
Selects the maximum reference value for the DAC
	Vref Voltage
Reference Voltage, Used to calculate the Voltage resolution.
	Control Bits
Number of digital control bits
	Resolution
Maximum output resolution based on number of control bits.
	Voltage Resolution
Specifies the Resolution per digital bit in terms of Voltage.
	Simulation
	Scope Traces
Selects if the scope traces are automatically generated or not

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

Latest revision as of 17:21, 9 November 2022

Contents

DAC (Internal) component

Component Pack

Detailed description

Examples

Downloadable macro reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | Matrix TSL
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 2.0 (Release)
+| 2.0
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | Category
 | Analog Output
 |}
+==DAC (Internal) component==
+Provides access to the onboard digital to analog converter (DAC) peripheral allowing for simple analogue output. Often the DAC output will be very low current and will need amplification using external circuitry to drive anything useful.
-==[[File:Component Icon 09222494_fbef_455b_9651_9e9e46592eb5.png|Image]] DAC (Internal) component==
+==Component Pack==
-Provides access to the onboard digital to analog converter (DAC) peripheral allowing for simple analogue output.
-Often the DAC output will be very low current and will need amplification using external circuitry to drive anything useful.
-==Examples==
+BASICIO
-''<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
-'''Parameters'''
-:[[Variable Types|UINT]] ''DAC_Value''
-::The value to output to the DAC
-'''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''
+''No detailed description exists yet for this component''
+==Examples==
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>Enable</tt></u></span>===
-Enables the DAC Output.
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:''This call does not return a value''
-==Simulation macro reference==
+''<span style="color:red;">No additional examples</span>''
-===<span style="font-weight: normal;"><u><tt>GetValue</tt></u></span>===
-Gets the Name property value
-'''Parameters'''
+==Downloadable macro reference==
-:[[Variable Types|STRING]] ''Name''
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-::The name of the property
+|-
+| 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&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''
+|}
-'''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;" | '''GetValue'''
+|-
+| colspan="2" | Gets the Name property value&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Name
+|-
+| colspan="2" | The name of the property&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-:[[Variable Types|STRING]]
+{| 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''
+|}
-===<span style="font-weight: normal;"><u><tt>SetValue</tt></u></span>===
-Sets the Value for the named property
-'''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;" | '''Enable'''
+|-
+| colspan="2" | Enables 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''
+|}
-:[[Variable Types|STRING]] ''Name''
-::Name of property to update
-:[[Variable Types|STRING]] ''Value''
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-::The new value for the property
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
+|-
+| colspan="2" | Sets the Value for the named property&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Name
+|-
+| colspan="2" | Name of property to update&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Value
+|-
+| colspan="2" | The new value for the property&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;"
+|-
-:''This call does not return a value''
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
+|-
-===<span style="font-weight: normal;"><u><tt>GetList</tt></u></span>===
+| colspan="2" | &nbsp;
-''<span style="color:red;">No additional information</span>''
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Name
-'''Parameters'''
+|-
+| colspan="2" | &nbsp;
-:[[Variable Types|STRING]] ''Name''
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-'''Return value'''
+|}
-:[[Variable Types|STRING]]
@@ Line 116: / Line 157: @@
 ==Property reference==
-<span style="font-weight: normal;"><u>Channel</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''CHANNEL''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-DAC Channel number
+| 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>DAC Output Pin</u></span>
+|-
+|-
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''PORT''.
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Channel
-DAC Output Pin
+|-
+| colspan="2" | DAC Channel number&nbsp;
-<span style="font-weight: normal;"><u>Vref Option</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 ''VREFOP''.
+| width="90%" | DAC Output Pin
+|-
-Selects the maximum reference value for the DAC
+| colspan="2" | DAC Output Pin&nbsp;
+|-
-<span style="font-weight: normal;"><u>Vref Voltage</u></span>
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Vref Option
-This property is of type ''Floating point'' and can be referenced with the variable name ''VrefVol''.
+|-
+| colspan="2" | Selects the maximum reference value for the DAC&nbsp;
-Reference Voltage, Used to calculate the Voltage resolution.
+|-
+| 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-14-icon.png]]
+| width="90%" | Control Bits
-<span style="font-weight: normal;"><u>Resolution</u></span>
+|-
+| colspan="2" | Number of digital control bits&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-10-icon.png]]
-Maximum output resolution based on number of control bits.
+| width="90%" | Resolution
+|-
-<span style="font-weight: normal;"><u>Voltage Resolution</u></span>
+| colspan="2" | Maximum output resolution based on number of 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-15-icon.png]]
+| width="90%" | Voltage Resolution
-Specifies the Resolution per digital bit in terms of Voltage.
+|-
+| colspan="2" | Specifies the Resolution per digital bit in terms of Voltage.&nbsp;
-<span style="font-weight: normal;"><u>Scope Traces</u></span>
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-This property is of type ''True or false'' and can be referenced with the variable name ''ScopeTraces''.
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+|-
-Selects if the scope traces are automatically generated or not
+|-
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Scope Traces
+|-
+| colspan="2" | Selects if the scope traces are automatically generated or not&nbsp;
+|}