Difference between revisions of "Component: DSPBuffer (DSP)"

From Flowcode Help
Jump to navigationJump to search
 
(3 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==DSPBuffer component==
 
==DSPBuffer component==
 
Creates a DSP buffer to be embedded into a DSP component to hold any output values.
 
Creates a DSP buffer to be embedded into a DSP component to hold any output values.
 +
 +
==Component Pack==
 +
 +
FREE
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 24: Line 36:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 75: Line 95:
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 
| width="90%" | Val
 
| width="90%" | Val
 
|-
 
|-
Line 90: Line 110:
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
 
|-
 
|-
−
| colspan="2" |  
+
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
 
|-
 
|-
 
|-
 
|-
Line 98: Line 118:
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 108: Line 128:
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
 
|-
 
|-
−
| colspan="2" |  
+
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
 
|-
 
|-
 
|-
 
|-
Line 116: Line 136:
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 
| width="90%" | val
 
| width="90%" | val
 
|-
 
|-
Line 129: Line 149:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put_float'''
 
|-
 
|-
−
| colspan="2" |  
+
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
 
|-
 
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Idx
+
| width="90%" | idx
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
+
| width="90%" | val
−
|}
 
−
 
 
−
 
 
−
{| 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;" | '''Prv_GetConsole'''
 
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Idx
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 
−
| 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;" | '''Init'''
 
−
|-
 
−
| colspan="2" | Initialize the component with the specified properties 
 
−
|-
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 178: Line 172:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
 
|-
 
|-
−
| colspan="2" | Un-initialize the UART and release the resources 
+
| 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;" | '''ReceiveByteArray'''
 
−
|-
 
−
| colspan="2" | Receives an array of bytes and returns the number of bytes received. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Data
 
 
|-
 
|-
−
| colspan="2" | A byte array variable to hold the received data 
 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | NumBytes
+
| width="90%" | Idx
 
|-
 
|-
−
| colspan="2" | Maximum number of bytes to try and receive 
+
| colspan="2" |  
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Timeout
 
−
|-
 
−
| colspan="2" | Max amount of time in ms to wait between bytes 
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
Line 219: Line 190:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetConsole'''
−
|-
 
−
| colspan="2" | Receives a string of bytes and returns the number of bytes received. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | StringData
 
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | NumBytes
 
−
|-
 
−
| colspan="2" | Maximum number of bytes to try and receive 
 
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Timeout
+
| width="90%" | Idx
−
|-
 
−
| colspan="2" | Max amount of time in ms to wait between bytes 
 
−
|-
 
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| 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;" | '''Start'''
 
−
|-
 
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising. 
 
−
|-
 
−
|-
 
−
| 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;" | '''SetLEDState'''
 
−
|-
 
−
| colspan="2" | Sets the state of a single LED 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Port
 
−
|-
 
−
| colspan="2" | 0 = PortA, 1 = PortB 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | LED
 
−
|-
 
−
| colspan="2" | 0 = LED0, 7 = LED7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | State
 
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 288: Line 208:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get_float'''
 
|-
 
|-
−
| colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs. 
+
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Buffer
+
| width="90%" | idx
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
−
| 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" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral.  
 
−
|-
 
−
|-
 
−
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 375: Line 282:
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
−
|-
 
−
| 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'''
 
−
|-
 
 
|}
 
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix TSL
Version 1.0
Category DSP


DSPBuffer component

Creates a DSP buffer to be embedded into a DSP component to hold any output values.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

Some examples containing the Input ADC component.

FC6 Icon.png On Off Control

FC6 Icon.png PID Control

Downloadable macro reference

Fc9-comp-macro.png Prv_PutPropStr
 
Fc9-u16-icon.png - UINT Idx
 
Fc9-u16-icon.png - UINT Val
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Prv_PutConsole
 
Fc9-u16-icon.png - UINT Idx
 
Fc9-s32-icon.png - LONG Val
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png get
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
Fc9-u16-icon.png - UINT idx
 
Fc9-s32-icon.png - LONG Return


Fc9-comp-macro.png put
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
Fc9-u16-icon.png - UINT idx
 
Fc9-s32-icon.png - LONG val
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png put_float
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
Fc9-u16-icon.png - UINT idx
 
Fc9-f32-icon.png - FLOAT val
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Prv_GetPropStr
 
Fc9-u16-icon.png - UINT Idx
 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png Prv_GetConsole
 
Fc9-u16-icon.png - UINT Idx
 
Fc9-s32-icon.png - LONG Return


Fc9-comp-macro.png get_float
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
Fc9-u16-icon.png - UINT idx
 
Fc9-f32-icon.png - FLOAT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-10-icon.png Val
 
Fc9-type-10-icon.png Parent Name
 
Fc9-type-21-icon.png Buffer Size
 
Fc9-type-16-icon.png Buffer Type
 
Fc9-type-7-icon.png Data Recorder Trace
 
Fc9-type-21-icon.png Console
 
Fc9-type-21-icon.png Console Size
 
Fc9-type-10-icon.png Text
 
Fc9-type-16-icon.png Orientation
 
Fc9-type-7-icon.png Enabled
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_DSPBuffer_(DSP)&oldid=28522"