Difference between revisions of "Component: Input (DSP)"
(XML import of component documentation) |
(XML import) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Author | | width="20%" style="color: gray;" | Author | ||
| − | | | + | | Matrix Ltd |
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
| − | | 1.2 | + | | 1.2 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
| Line 16: | Line 16: | ||
==[[File:Component Icon c73d493a_b6a0_4dbe_b4b5_79648f67d11e.png|Image]] Input component== | ==[[File:Component Icon c73d493a_b6a0_4dbe_b4b5_79648f67d11e.png|Image]] Input component== | ||
| − | + | Allows the values from a buffer to be assigned. Either a value at a time or from an array. | |
| + | The input signal would usually take the form of an ADC reading or raw data values. | ||
==Examples== | ==Examples== | ||
| − | + | Here is a basic example demonstrating how to pass a value into the DSP chain. | |
| − | + | {{Fcfile|Delay.fcfx|Delay}} | |
| + | The input value in the example uses an ADC reading but this can be taken from anything such as a reading from a CSV file on a SD card or a value passed by a sensor on a I2C bus etc. | ||
==Downloadable macro reference== | ==Downloadable macro reference== | ||
===<span style="font-weight: normal;"><u><tt>AddAsByteTick</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>AddAsByteTick</tt></u></span>=== | ||
| − | + | Adds a single byte value to the current location in the specified buffer and scales it appropriatley to suit the buffer. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 40: | Line 40: | ||
===<span style="font-weight: normal;"><u><tt>AddAsUINTTick</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>AddAsUINTTick</tt></u></span>=== | ||
| − | + | Adds a single unsigned int value to the current location in the specified buffer and scales it appropriatley to suit the buffer. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 54: | Line 52: | ||
| − | ===<span style="font-weight: normal;"><u><tt> | + | ===<span style="font-weight: normal;"><u><tt>AddToBuffer</tt></u></span>=== |
| − | + | Adds an array of byte values to the specified buffer and scales them appropriatley to suit the buffer. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types| | + | :[[Variable Types|<- STRING]] ''Data'' |
| + | ::''This parameter may be returned back to the caller'' | ||
| Line 69: | Line 66: | ||
| − | ===<span style="font-weight: normal;"><u><tt> | + | ===<span style="font-weight: normal;"><u><tt>AddAsSINTTick</tt></u></span>=== |
| − | + | Adds a single signed integer value to the current location in the specified buffer and scales it appropriatley to suit the buffer. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types| | + | :[[Variable Types|INT]] ''Data'' |
| Line 84: | Line 79: | ||
| − | + | ===<span style="font-weight: normal;"><u><tt>AddRawTick</tt></u></span>=== | |
| − | + | Adds a value to the current location in the specified buffer as is and without scaling. | |
| − | |||
| − | ===<span style="font-weight: normal;"><u><tt> | ||
| − | |||
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types| | + | :[[Variable Types|UINT]] ''Data'' |
| − | |||
| Line 103: | Line 92: | ||
| + | |||
| + | ==Simulation macro reference== | ||
| + | |||
| + | ''This component does not contain any simulation macros'' | ||
| Line 110: | Line 103: | ||
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''. | ||
| − | + | Reference to DSP system buffer manager component. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Input</u></span> | <span style="font-weight: normal;"><u>Input</u></span> | ||
| Line 118: | Line 109: | ||
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''. | ||
| − | + | Buffer assigned to input channel | |
Latest revision as of 11:25, 13 February 2015
| Author | Matrix Ltd |
| Version | 1.2 (Release) |
| Category | DSP |
Contents
Input component
Allows the values from a buffer to be assigned. Either a value at a time or from an array. The input signal would usually take the form of an ADC reading or raw data values.
Examples
Here is a basic example demonstrating how to pass a value into the DSP chain.
Delay
The input value in the example uses an ADC reading but this can be taken from anything such as a reading from a CSV file on a SD card or a value passed by a sensor on a I2C bus etc.
Downloadable macro reference
AddAsByteTick
Adds a single byte value to the current location in the specified buffer and scales it appropriatley to suit the buffer.
Parameters
- BYTE Data
Return value
- This call does not return a value
AddAsUINTTick
Adds a single unsigned int value to the current location in the specified buffer and scales it appropriatley to suit the buffer.
Parameters
- UINT Data
Return value
- This call does not return a value
AddToBuffer
Adds an array of byte values to the specified buffer and scales them appropriatley to suit the buffer.
Parameters
- <- STRING Data
- This parameter may be returned back to the caller
Return value
- This call does not return a value
AddAsSINTTick
Adds a single signed integer value to the current location in the specified buffer and scales it appropriatley to suit the buffer.
Parameters
- INT Data
Return value
- This call does not return a value
AddRawTick
Adds a value to the current location in the specified buffer as is and without scaling.
Parameters
- UINT Data
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.
Reference to DSP system buffer manager component.
Input
This property is of type Fixed list of ints and can be referenced with the variable name input_a.
Buffer assigned to input channel
