Jump to content

Component: DSPBuffer (DSP)

From Flowcode Help
Revision as of 16:53, 16 November 2021 by Wiki bot (talk | contribs) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

Downloadable macro reference

Prv_PutPropStr
 
- UINT Idx
 
- UINT Val
 
- VOID Return


Prv_PutConsole
 
- UINT Idx
 
[[File:]] - Val
 
- VOID Return


get
 
- UINT idx
 
[[File:]] - Return


put
 
- UINT idx
 
[[File:]] - val
 
- VOID Return


Prv_GetPropStr
 
- UINT Idx
 
- UINT Return


Prv_GetConsole
 
- UINT Idx
 
[[File:]] - Return


WhilePlaying
Blocking function that waits for module to stop being busy. Returns true if the module is still busy and the timeout period has passed. 
- UINT Timeout
Number of milliseconds to wait, 0=WaitForever 
[[File:]] - Return


IsPlaying
Checks to see if the last played track is still playing 
[[File:]] - Return


GetReplyByte
Reads a single byte from the last reply. Each reply contains 4 bytes starting with the command code. 
- BYTE Index
Range: 0-3 / 0=Command, 1=Feedback, 2=Data MSB, 3=Data LSB 
- BYTE Return


SkipTrack
Jump to the next or previous track 
[[File:]] - Direction
0=Next, 1=Previous 
- VOID Return


PlayTrack
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. 
- BYTE Directory
0=Root, 1=Folder "01" - 99=Folder "99", 100=MP3, 101=Advert 
- UINT Track
Track number 1="001*.MP3" / "0001*.MP3", 100="100*.MP3" / "0100*.MP3" 
- VOID Return


Initialise
Sets up the UART and does some housekeeping. Must be called before calling any of the other component macros. 
- VOID Return


ReadAnalogAsInt
Reads one of the analogue components as an Integer value 
- BYTE Channel
0 = LDR, 1 = POT 
[[File:]] - Return


RemapCharacter
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. 
- BYTE RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1) 
- BYTE SearchCharacter
Character to look for a replace 
- BYTE ReplacementCharacter
New character value to use in place of the search character. 
- VOID Return


Start
Startup routine required by the hardware device. Automatically clears the display after initialising. 
- VOID Return


SetLEDState
Sets the state of a single LED 
- BYTE Port
0 = PortA, 1 = PortB 
- BYTE LED
0 = LED0, 7 = LED7 
- BYTE State
 
- VOID Return


Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.  
- VOID Return



Property reference

Properties
Val
 
Parent Name
 
Buffer Size
 
Buffer Type
 
Data Recorder Trace
 
Console
 
Console Size
 
Text
 
Orientation
 
Enabled
 
Connections
Simulations