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

From Flowcode Help
Jump to navigationJump to search
 
(15 intermediate revisions by the same user not shown)
Line 16: Line 16:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 24: Line 44:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 37: Line 77:
 
{{fcfile|PID_Control_Sim.fcfx|PID Control}}
 
{{fcfile|PID_Control_Sim.fcfx|PID Control}}
  
−
==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" |  
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Idx
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Val
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===Prv_GetConsole===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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_PutConsole'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetConsole'''
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 75: Line 105:
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
−
| width="90%" | Val
 
−
|-
 
−
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===Prv_GetPropStr===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''get'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 94: Line 120:
 
|-
 
|-
 
| 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:]] -  
+
| 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''
 
|}
 
|}
  
  
 +
===Prv_PutConsole===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''put'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutConsole'''
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 112: Line 139:
 
|-
 
|-
 
| 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" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
−
| width="90%" | val
+
| width="90%" | Val
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 126: Line 153:
  
  
 +
===Prv_PutPropStr===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''Prv_PutPropStr'''
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
Line 138: Line 166:
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
−
|-
 
−
| 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" |  
 
−
|-
 
 
|-
 
|-
 
| 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" |  
 
| 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 175: Line 177:
  
  
 +
===get===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''get'''
−
|-
 
−
| colspan="2" | Un-initialize the UART and release the resources 
 
−
|-
 
−
|-
 
−
| 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]]
+
| colspan="2" | Embedded - Get/Set uses Type Specified to maintain efficiency Sim - Reverts to long type so 8/16 bit will also fit 
−
| 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="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 
 
−
|-
 
−
| 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''
 
|}
 
|}
  
  
 +
===get_float===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''get_float'''
 
|-
 
|-
−
| colspan="2" | Receives a string of bytes and returns the number of bytes received. 
+
| 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-string-icon.png]] - STRING
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | StringData
+
| width="90%" | idx
 
|-
 
|-
 
| colspan="2" |  
 
| colspan="2" |  
 
|-
 
|-
−
| 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 
 
−
|-
 
−
| 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-u8-icon.png]] - BYTE
 
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===put===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''Start'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
 
|-
 
|-
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising. 
+
| 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" 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" |  
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState'''
 
 
|-
 
|-
−
| colspan="2" | Sets the state of a single LED 
+
| 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 
 
−
|-
 
−
| 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" |  
Line 285: Line 239:
  
  
 +
===put_float===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| 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;" | '''put_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" | [[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.  
 
 
|-
 
|-
 +
| 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-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 320:
 
|-
 
|-
 
| 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'''
 
−
|-
 
 
|}
 
|}
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DSP_Buff.fcfx FC_Comp_Source_DSP_Buff.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_Buff.fcfx FC_Comp_Source_DSP_Buff.fcfx]

Latest revision as of 08:58, 9 June 2025

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.

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







Macro reference

Prv_GetConsole

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


Prv_GetPropStr

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


Prv_PutConsole

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


Prv_PutPropStr

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


get

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


get_float

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


put

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


put_float

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


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
 

Component Source Code

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

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_DSPBuffer_(DSP)&oldid=41528"