Jump to content

Component: DSPBufferRef (DSP): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,393 edits
No edit summary
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(19 intermediate revisions by 2 users not shown)
Line 14: Line 14:
==DSPBufferRef component==
==DSPBufferRef component==
Reference and access to a specific DSP buffer inside another DSP component. Used for a DSP component input buffer.
Reference and access to a specific DSP buffer inside another DSP component. Used for a DSP component input buffer.
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Buff_Ref.fcfx FC_Comp_Source_DSP_Buff_Ref.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Buff_Ref.fcfx FC_Comp_Source_DSP_Buff_Ref.fcfx]


==Detailed description==
==Detailed description==




Line 22: Line 48:


==Examples==
==Examples==




Line 27: Line 73:
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


==Downloadable macro reference==


{| 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_PutPropStr'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Idx
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Val
|-
| colspan="2" | &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''
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===Prv_GetConsole===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutConsole'''
| width="90%" class="mtx-class-macrohead" | '''Prv_GetConsole'''
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 65: Line 103:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Val
|-
| colspan="2" | &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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Prv_GetPropStr===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
| width="90%" class="mtx-class-macrohead" | '''Prv_GetPropStr'''
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 88: Line 122:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Prv_PutConsole===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
| width="90%" class="mtx-class-macrohead" | '''Prv_PutConsole'''
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 106: Line 141:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -  
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Val
| width="90%" | Val
|-
|-
Line 116: Line 151:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Prv_PutPropStr===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
| width="90%" class="mtx-class-macrohead" | '''Prv_PutPropStr'''
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 128: Line 164:
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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;" | '''Prv_GetConsole'''
|-
| colspan="2" | &nbsp;
|-
|-
|-
| 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%" | Val
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| 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-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetHandle===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetHandle'''
| width="90%" class="mtx-class-macrohead" | '''SetHandle'''
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:]] -  
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Handle
| width="90%" | Handle
|-
|-
Line 170: Line 194:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===get===
|-
{| class="mtx-class-macrotable wikitable"
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
|-
| colspan="2" | Un-initialize the UART and release the resources&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''
|}
 
 
{| 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.&nbsp;
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''get'''
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
| width="90%" | Data
|-
|-
| colspan="2" | A byte array variable to hold the received data&nbsp;
|-
|-
| 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&nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Timeout
|-
| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===get_float===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
| width="90%" class="mtx-class-macrohead" | '''get_float'''
|-
|-
| colspan="2" | Receives a string of bytes and returns the number of bytes received.&nbsp;
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | StringData
| width="90%" | Idx
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | NumBytes
|-
| colspan="2" | Maximum number of bytes to try and receive&nbsp;
|-
| 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&nbsp;
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===put===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
| width="90%" class="mtx-class-macrohead" | '''put'''
|-
|-
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising.&nbsp;
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
|-
|-
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | Idx
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | &nbsp;
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState'''
|-
|-
| colspan="2" | Sets the state of a single LED&nbsp;
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
|-
| width="90%" | Val
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Port
|-
| colspan="2" | 0 = PortA, 1 = PortB&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LED
|-
| colspan="2" | 0 = LED0, 7 = LED7&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | State
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
Line 280: Line 256:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===put_float===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
| width="90%" class="mtx-class-macrohead" | '''put_float'''
|-
|-
| colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs.&nbsp;
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit&nbsp;
|-
|-
|-
|-
| 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" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
| 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;" | '''Initialise'''
|-
| colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral. &nbsp;
|-
|-
| colspan="2" | &nbsp;
|-
|-
| 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
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Link To
| width="90%" | Link To
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Line 351: Line 318:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Color
| width="90%" | Text
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Outline
| width="90%" | Orientation
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Text
| width="90%" | Style
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Outline line style&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Orientation
| width="90%" | Thickness
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Thickness of the line&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
| width="90%" | Colour
|-
|-
| colspan="2" | Colour of the line&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
| width="90%" | TimerRetryCount
|-
|-
| colspan="2" | &nbsp;
|}
|}

Latest revision as of 14:23, 13 July 2026

Author Matrix TSL
Version 1.0
Category DSP


DSPBufferRef component

Reference and access to a specific DSP buffer inside another DSP component. Used for a DSP component input buffer.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DSP_Buff_Ref.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_Buff_Ref.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples








Macro reference

Prv_GetConsole

Prv_GetConsole
 
- UINT Idx
 
- ULONG Return


Prv_GetPropStr

Prv_GetPropStr
 
- UINT Idx
 
- UINT Return


Prv_PutConsole

Prv_PutConsole
 
- UINT Idx
 
- ULONG Val
 
- VOID Return


Prv_PutPropStr

Prv_PutPropStr
 
- UINT Idx
 
- UINT Val
 
- VOID Return


SetHandle

SetHandle
 
- HANDLE Handle
 
- VOID Return


get

get
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
- UINT Idx
 
- LONG Return


get_float

get_float
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
- UINT Idx
 
- FLOAT Return


put

put
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
- UINT Idx
 
- LONG Val
 
- VOID Return


put_float

put_float
Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
- UINT Idx
 
- FLOAT Val
 
- VOID Return


Property reference

Properties
Link To
DSP component with output buffer to collect our data from. 
Subname
 
Subhandle
 
Buffer Size
 
Buffer Type
 
Console Handle
 
Text
 
Orientation
 
Style
Outline line style 
Thickness
Thickness of the line 
Colour
Colour of the line 
TimerRetryCount
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_DSPBufferRef_(DSP)&oldid=46599"