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

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.

On Off Control

PID Control

Macro reference

Prv_GetConsole

	Prv_GetConsole

- UINT	Idx

- LONG	Return

Prv_GetPropStr

	Prv_GetPropStr

- UINT	Idx

- UINT	Return

Prv_PutConsole

	Prv_PutConsole

- UINT	Idx

- LONG	Val

- VOID	Return

Prv_PutPropStr

	Prv_PutPropStr

- UINT	Idx

- UINT	Val

- 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
	Val

	Parent Name

	Buffer Size

	Buffer Type

	Data Recorder Trace

	Console

	Console Size

	Text

	Orientation

	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

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

Latest revision as of 08:58, 9 June 2025

Contents

DSPBuffer component

Detailed description

Examples

Macro reference

Prv_GetConsole

Prv_GetPropStr

Prv_PutConsole

Prv_PutPropStr

get

get_float

put

put_float

Property reference

Component Source Code

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 16: / Line 16: @@
 ==Detailed description==
@@ Line 22: / Line 44: @@
 ==Examples==
@@ Line 33: / Line 77: @@
 {{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" | &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''
-|}
+==Macro reference==
+===Prv_GetConsole===
 {| 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_PutConsole'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetConsole'''
 |-
 | colspan="2" | &nbsp;
@@ Line 71: / Line 105: @@
 | colspan="2" | &nbsp;
 |-
-| 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" | &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''
 |}
+===Prv_GetPropStr===
 {| 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;" | '''get'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
 |-
 | colspan="2" | &nbsp;
@@ Line 90: / Line 120: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | idx
+| width="90%" | Idx
 |-
 | 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''
 |}
+===Prv_PutConsole===
 {| 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;" | '''put'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutConsole'''
 |-
 | colspan="2" | &nbsp;
@@ Line 108: / Line 139: @@
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | idx
+| width="90%" | Idx
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:]] -
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| width="90%" | val
+| width="90%" | Val
 |-
 | colspan="2" | &nbsp;
@@ Line 122: / Line 153: @@
+===Prv_PutPropStr===
 {| 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_GetPropStr'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_PutPropStr'''
 |-
 | colspan="2" | &nbsp;
@@ Line 134: / Line 166: @@
 |-
 | 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="90%" | Idx
+| width="90%" | Val
 |-
 | 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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===get===
 {| 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;" | '''WhilePlaying'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
 |-
-| colspan="2" | Blocking function that waits for module to stop being busy. Returns true if the module is still busy and the timeout period has passed.&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-u16-icon.png]] - UINT
-| width="90%" | Timeout
+| width="90%" | idx
 |-
-| colspan="2" | Number of milliseconds to wait, 0=WaitForever&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-s32-icon.png]] - LONG
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===get_float===
 {| 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;" | '''IsPlaying'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get_float'''
 |-
-| colspan="2" | Checks to see if the last played track is still playing&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:]] -
+| 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;" | '''GetReplyByte'''
-|-
-| colspan="2" | Reads a single byte from the last reply. Each reply contains 4 bytes starting with the command code.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
-|-
-| colspan="2" | Range: 0-3 / 0=Command, 1=Feedback, 2=Data MSB, 3=Data LSB&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
+===put===
 {| 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;" | '''SkipTrack'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
-|-
-| colspan="2" | Jump to the next or previous track&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Direction
-|-
-| colspan="2" | 0=Next, 1=Previous&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;" | '''PlayTrack'''
-|-
-| colspan="2" | Plays track from the selected folder. MP3 & Advert folder track numbers should be 4 characters long e.g. 0001 any name.mp3, Other folder track numbers should be 3 characters long e.g. 001 Any name.mp3, Root the Track played in placement order.&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="90%" | Directory
-|-
-| colspan="2" | 0=Root, 1=Folder "01" - 99=Folder "99", 100=MP3, 101=Advert&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Track
+| width="90%" | idx
 |-
-| colspan="2" | Track number 1="001*.MP3" / "0001*.MP3", 100="100*.MP3" / "0100*.MP3"&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
-| 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" | Sets up the UART and does some housekeeping. Must be called before calling any of the other component macros.&nbsp;
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 261: / Line 239: @@
+===put_float===
 {| 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;" | '''ReadAnalogAsInt'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put_float'''
 |-
-| colspan="2" | Reads one of the analogue components as an Integer value&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%" | Channel
+| width="90%" | idx
 |-
-| colspan="2" | 0 = LDR, 1 = POT&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
+| 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;" | '''RemapCharacter'''
-|-
-| colspan="2" | Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters.  The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | RemapIdx
-|-
-| colspan="2" | Remap Index, Range: 0 to (Remap Characters - 1)&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SearchCharacter
-|-
-| colspan="2" | Character to look for a replace&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ReplacementCharacter
-|-
-| colspan="2" | New character value to use in place of the search character.&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;" | '''Start'''
-|-
-| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising.&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;" | '''SetLEDState'''
-|-
-| colspan="2" | Sets the state of a single LED&nbsp;
-|-
-|-
-| 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;
@@ Line 346: / Line 261: @@
 | 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. &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''
-|}
@@ Line 420: / Line 320: @@
 |-
 | colspan="2" | &nbsp;
-|-
-| 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]