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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_DSP_FileOutput.fcfx FC_Comp_Source_DSP_FileOutput.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DSP_FileOutput.fcfx FC_Comp_Source_DSP_FileOutput.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 38: Line 40:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 58: Line 62:
  
 
==Macro reference==
 
==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;" | '''CloseFile'''
 +
|-
 +
| colspan="2" | Closes a 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| 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;" | '''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. 
 +
|-
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | ExistingData
 +
|-
 +
| colspan="2" | 0=KeepAndAppend, 1=Clear 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Connect To 0
 +
|-
 +
| colspan="2" | DSP component with output buffer to collect our data from. 
 +
|-
 +
| 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-16-icon.png]]
 +
| width="90%" | LinkTo
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Number of Inputs
 +
|-
 +
| colspan="2" | The number of inputs the multiplexer can switch between. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Filename
 +
|-
 +
| colspan="2" | Name of the file to write DSP data to. 
 +
|-
 +
| 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. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:13, 20 January 2023

Author Matrix Ltd
Version 1.2
Category DSP Outputs


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 Source Code

Please click here to view the component source code (Beta): FC_Comp_Source_DSP_FileOutput.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


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 0
DSP component with output buffer to collect our data from. 
Fc9-conn-icon.png CSV File
Fc9-type-16-icon.png LinkTo
 
Fc9-type-16-icon.png Number of Inputs
The number of inputs the multiplexer can switch between. 
Fc9-type-10-icon.png Filename
Name of the file to write DSP data to. 
Fc9-type-16-icon.png Existing Data
Decides what to do when opening a file that already exists. 

==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 0
DSP component with output buffer to collect our data from. 
Fc9-conn-icon.png CSV File
Fc9-type-16-icon.png LinkTo
 
Fc9-type-16-icon.png Number of Inputs
The number of inputs the multiplexer can switch between. 
Fc9-type-10-icon.png Filename
Name of the file to write DSP data to. 
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/wiki/index.php?title=Component:_Output_CSV_(DSP_Outputs)&oldid=32458"