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

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray...")
 
 
(4 intermediate revisions by the same user 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 Pack==
 +
 +
FREE
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
''No detailed description exists yet for this component''
 
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
Line 76: Line 100:
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get'''
 
|-
 
|-
−
| colspan="2" | &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;
 
|-
 
|-
 
|-
 
|-
Line 84: Line 108:
 
| 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-s32-icon.png]] - LONG
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 94: Line 118:
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''put'''
 
|-
 
|-
−
| colspan="2" | &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;
 
|-
 
|-
 
|-
 
|-
Line 102: Line 126:
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 
| width="90%" | Val
 
| width="90%" | Val
 
|-
 
|-
Line 115: Line 139:
 
|-
 
|-
 
| 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" | &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;
 
|-
 
|-
 
|-
 
|-
Line 125: Line 149:
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
 
|-
 
|-
−
| 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%" | 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''
 
|}
 
|}
Line 133: Line 162:
 
|-
 
|-
 
| 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_GetConsole'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetPropStr'''
 
|-
 
|-
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
Line 143: Line 172:
 
| 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-u16-icon.png]] - UINT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 151: Line 180:
 
|-
 
|-
 
| 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;" | '''SetHandle'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Prv_GetConsole'''
 
|-
 
|-
 
| colspan="2" | &nbsp;
 
| colspan="2" | &nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | Handle
+
| width="90%" | Idx
 
|-
 
|-
 
| colspan="2" | &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-u32-icon.png]] - ULONG
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 169: Line 198:
 
|-
 
|-
 
| 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;" | '''IsPlaying'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetHandle'''
 
|-
 
|-
−
| colspan="2" | Checks to see if the last played track is still playing&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
| width="90%" style="border-top: 2px solid #000;" | ''Return''
+
| width="90%" | Handle
−
|}
 
−
 
 
−
 
 
−
{| 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="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;" | '''SkipTrack'''
 
−
|-
 
−
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 218: Line 216:
 
|-
 
|-
 
| 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;" | '''PlayTrack'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''get_float'''
 
|-
 
|-
−
| 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="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;
 
−
|-
 
−
| 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;" | '''Initialise'''
 
−
|-
 
−
| colspan="2" | Sets up the UART and does some housekeeping. Must be called before calling any of the other component macros.&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;" | '''ReadAnalogAsInt'''
 
−
|-
 
−
| colspan="2" | Reads one of the analogue components as an Integer value&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Channel
 
−
|-
 
−
| colspan="2" | 0 = LDR, 1 = POT&nbsp;
 
−
|-
 
−
| 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;" | '''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;
 
| 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-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. &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''
 
|}
 
|}
Line 361: Line 241:
 
|-
 
|-
 
|-
 
|-
−
| 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 410: Line 290:
 
|-
 
|-
 
| colspan="2" | &nbsp;
 
| 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'''
 
−
|-
 
 
|}
 
|}

Latest revision as of 17:19, 9 November 2022

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 Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

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-u32-icon.png - ULONG 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-u32-icon.png - ULONG Return


Fc9-comp-macro.png SetHandle
 
Fc9-h32-icon.png - HANDLE Handle
 
Fc9-void-icon.png - VOID 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-16-icon.png Link To
DSP component with output buffer to collect our data from. 
Fc9-type-10-icon.png Subname
 
Fc9-type-21-icon.png Subhandle
 
Fc9-type-21-icon.png Buffer Size
 
Fc9-type-21-icon.png Buffer Type
 
Fc9-type-21-icon.png Console Handle
 
Fc9-type-2-icon.png Color
 
Fc9-type-2-icon.png Outline
 
Fc9-type-10-icon.png Text
 
Fc9-type-16-icon.png Orientation
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_DSPBufferRef_(DSP)&oldid=28523"