Difference between revisions of "Component: Output CSV (DSP)"

From Flowcode Help
Jump to navigationJump to search
 
(4 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==Output CSV component==
 
==Output CSV component==
 
Allows the values from a buffer to be output directly into a .CSV format file.  Either a value at a time or as an array.
 
Allows the values from a buffer to be output directly into a .CSV format file.  Either a value at a time or as an array.
 +
 +
==Component Pack==
 +
 +
DSP
  
 
==Detailed description==
 
==Detailed description==
  
−
''No detailed description exists yet for this component''
 
  
−
==Examples==
 
  
  
−
''<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;" | '''WriteArray'''
 
−
|-
 
−
| colspan="2" | Writes a buffer of values from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro.&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;" | '''WriteValue'''
 
−
|-
 
−
| colspan="2" | Writes a single value from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro.&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;"
+
''No detailed description exists yet for this component''
−
|-
+
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+
==Examples==
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''QueueData'''
+
 
−
|-
 
−
| colspan="2" | Takes a single value from the buffer input and stores it, once there are enough values queued up it returns a 1.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:]] -
 
−
| width="90%" | ProcessWhenFull
 
−
|-
 
−
| colspan="2" | 0 = Do Nothing when Buffer is full, 1 = Auto call FFT macro when Buffer is full&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;" | '''IsPlaying'''
 
−
|-
 
−
| colspan="2" | Checks to see if the last played track is still playing&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;" | '''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="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;
 
−
|-
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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''
 
−
|}
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
{| 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''
 
−
|}
 
  
 +
==Downloadable macro reference==
  
 
{| 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;" | '''RemapCharacter'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CloseFile'''
−
|-
 
−
| 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
+
| colspan="2" | Closes a file&nbsp;
−
| 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="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 205: Line 67:
 
|-
 
|-
 
| 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;" | '''WriteArray'''
 
|-
 
|-
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising.&nbsp;
+
| colspan="2" | Writes a buffer of values from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 218: Line 80:
 
|-
 
|-
 
| 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;" | '''SetLEDState'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OpenFile'''
 
|-
 
|-
−
| colspan="2" | Sets the state of a single LED&nbsp;
+
| colspan="2" | Opens a file ready for writing. Returns 1 if file opened OK. Automatically called by the WriteValue/WriteArray macros with the default values set by the component properties if not already called by the program.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
−
| width="90%" | Port
+
| width="90%" | Filename
−
|-
 
−
| 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;
+
| colspan="2" | Filename, must be an 8.3 formatted filename in embedded.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
−
| width="90%" | State
+
| width="90%" | ExistingData
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | 0=KeepAndAppend, 1=Clear&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-bool-icon.png]] - BOOL
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 246: Line 103:
 
|-
 
|-
 
| 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;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteValue'''
 
|-
 
|-
−
| colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral. &nbsp;
+
| colspan="2" | Writes a single value from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 266: Line 123:
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Connect To
 
| width="90%" | Connect To
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | CSV File
 +
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
Line 279: Line 140:
 
| width="90%" | Filename
 
| width="90%" | Filename
 
|-
 
|-
−
| colspan="2" | Name of the file to write DSP data to.&nbsp;
+
| colspan="2" | Name of the file to write DSP data to. Requires an 8.3 file name for use with embedded file component.&nbsp;
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Line 290: Line 151:
 
|-
 
|-
 
| colspan="2" | Decides what to do when opening a file that already exists.&nbsp;
 
| colspan="2" | Decides what to do when opening a file that already exists.&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 Ltd
Version 1.2
Category DSP


Output CSV component

Allows the values from a buffer to be output directly into a .CSV format file. Either a value at a time or as an array.

Component Pack

DSP

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png CloseFile
Closes a file 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteArray
Writes a buffer of values from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png OpenFile
Opens a file ready for writing. Returns 1 if file opened OK. Automatically called by the WriteValue/WriteArray macros with the default values set by the component properties if not already called by the program. 
Fc9-string-icon.png - STRING Filename
Filename, must be an 8.3 formatted filename in embedded. 
Fc9-bool-icon.png - BOOL ExistingData
0=KeepAndAppend, 1=Clear 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png WriteValue
Writes a single value from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-conn-icon.png CSV File
Fc9-type-17-icon.png FAT Component
Points to the FAT filesystem component to allow access to file system and embedded SD card. 
Fc9-type-10-icon.png Filename
Name of the file to write DSP data to. Requires an 8.3 file name for use with embedded file component. 
Fc9-type-16-icon.png Layout
 
Fc9-type-16-icon.png Existing Data
Decides what to do when opening a file that already exists. 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Output_CSV_(DSP)&oldid=28530"