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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| DSP
 
| 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.
  
−
==[[File:Component Icon 5142bd81_abad_444b_b6db_36a87dce5835.png|Image]] Output CSV component==
+
==Component Pack==
−
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.
 
  
−
==Examples==
+
DSP
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>WriteArray</tt></u></span>===
 
−
Writes a buffer of values from the selected DSP buffer to the CSV file.
 
  
−
FAT component must be initialised before calling this macro.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>WriteValue</tt></u></span>===
 
−
Writes a single value from the selected DSP buffer to the CSV file.
 
  
−
FAT component must be initialised before calling this macro.
+
''No detailed description exists yet for this component''
  
−
'''Parameters'''
+
==Examples==
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Connect To</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''ConnectTo''.
 
  
−
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''
  
  
 +
==Downloadable macro reference==
  
−
<span style="font-weight: normal;"><u>FAT Component</u></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;" | '''CloseFile'''
 +
|-
 +
| colspan="2" | Closes a file&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''
 +
|}
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''FATComponent''.
 
  
−
Points to the FAT filesystem component to allow access to file system and embedded SD card.
+
{| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Filename</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''Filename''.
+
{| 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;" | '''OpenFile'''
 +
|-
 +
| 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-string-icon.png]] - STRING
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | Filename, must be an 8.3 formatted filename in embedded.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | ExistingData
 +
|-
 +
| colspan="2" | 0=KeepAndAppend, 1=Clear&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
Name of the file to write DSP data to.
 
  
−
<span style="font-weight: normal;"><u>Layout</u></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;" | '''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''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Layout''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
 +
==Property reference==
  
−
<span style="font-weight: normal;"><u>Existing Data</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ExtData''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Decides what to do when opening a file that already exists.
+
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Connect To
 +
|-
 +
| 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="90%" | FAT Component
 +
|-
 +
| colspan="2" | Points to the FAT filesystem component to allow access to file system and embedded SD card.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Filename
 +
|-
 +
| 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="90%" | Layout
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Existing Data
 +
|-
 +
| colspan="2" | Decides what to do when opening a file that already exists.&nbsp;
 +
|}

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"