Difference between revisions of "Component: Control (DSP)"
(XML import of component documentation) |
(XML import of components for release) |
||
| Line 16: | Line 16: | ||
==[[File:Component Icon e6dd1315_4acf_4fb5_abd9_5743d3715cbe.png|Image]] Control component== | ==[[File:Component Icon e6dd1315_4acf_4fb5_abd9_5743d3715cbe.png|Image]] Control component== | ||
| − | + | Allows for several types of control operations to be performed on a buffer | |
==Examples== | ==Examples== | ||
| Line 25: | Line 25: | ||
===<span style="font-weight: normal;"><u><tt>Process</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>Process</tt></u></span>=== | ||
| − | + | Processes an entire buffer, either by performing the control operation to every value in the buffer or just the last value. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
:[[Variable Types|INT]] ''Setpoint'' | :[[Variable Types|INT]] ''Setpoint'' | ||
| + | ::Value to specify the required control setpoint | ||
| Line 40: | Line 39: | ||
===<span style="font-weight: normal;"><u><tt>ProcessTick</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>ProcessTick</tt></u></span>=== | ||
| − | + | Processes the current value from a buffer. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
:[[Variable Types|INT]] ''Setpoint'' | :[[Variable Types|INT]] ''Setpoint'' | ||
| + | ::Value to specify the required control setpoint | ||
| Line 65: | Line 63: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''. | ||
| − | + | DSP buffer manager to get the buffers from | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Feedback</u></span> | <span style="font-weight: normal;"><u>Feedback</u></span> | ||
| Line 73: | Line 69: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | ||
| − | + | Feedback buffer - used to pass the feedback reading into the control algorythm. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Output</u></span> | <span style="font-weight: normal;"><u>Output</u></span> | ||
| Line 81: | Line 75: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''output_c''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''output_c''. | ||
| − | + | Output buffer - used to pass the control output values from the control algorythm. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Process</u></span> | <span style="font-weight: normal;"><u>Process</u></span> | ||
| Line 89: | Line 81: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''style''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''style''. | ||
| − | + | Selects whether to process the entire buffer or just a single value when calling the Process macro | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Method</u></span> | <span style="font-weight: normal;"><u>Method</u></span> | ||
| Line 97: | Line 87: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''method''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''method''. | ||
| − | + | Specifies which control method will be used to process the buffer data | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Proportional</u></span> | <span style="font-weight: normal;"><u>Proportional</u></span> | ||
| Line 105: | Line 93: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''proportional''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''proportional''. | ||
| − | + | P coefficient used to perform the Proportional calculation | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Integral</u></span> | <span style="font-weight: normal;"><u>Integral</u></span> | ||
| Line 113: | Line 99: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''integral''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''integral''. | ||
| − | + | I coefficient used to perform the Integral calculation | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Derivative</u></span> | <span style="font-weight: normal;"><u>Derivative</u></span> | ||
| Line 121: | Line 105: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''derivative''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''derivative''. | ||
| − | + | D coefficient used to perform the Derivative calculation | |
Revision as of 13:34, 2 September 2013
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | DSP |
Contents
Control component
Allows for several types of control operations to be performed on a buffer
Examples
No additional examples
Downloadable macro reference
Process
Processes an entire buffer, either by performing the control operation to every value in the buffer or just the last value.
Parameters
- INT Setpoint
- Value to specify the required control setpoint
Return value
- This call does not return a value
ProcessTick
Processes the current value from a buffer.
Parameters
- INT Setpoint
- Value to specify the required control setpoint
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Buffer Manager
This property is of type Fixed list of ints and can be referenced with the variable name buffer_manager.
DSP buffer manager to get the buffers from
Feedback
This property is of type Fixed list of ints and can be referenced with the variable name input_a.
Feedback buffer - used to pass the feedback reading into the control algorythm.
Output
This property is of type Fixed list of ints and can be referenced with the variable name output_c.
Output buffer - used to pass the control output values from the control algorythm.
Process
This property is of type Fixed list of ints and can be referenced with the variable name style.
Selects whether to process the entire buffer or just a single value when calling the Process macro
Method
This property is of type Fixed list of ints and can be referenced with the variable name method.
Specifies which control method will be used to process the buffer data
Proportional
This property is of type Signed integer and can be referenced with the variable name proportional.
P coefficient used to perform the Proportional calculation
Integral
This property is of type Signed integer and can be referenced with the variable name integral.
I coefficient used to perform the Integral calculation
Derivative
This property is of type Signed integer and can be referenced with the variable name derivative.
D coefficient used to perform the Derivative calculation
