Component: Output CSV (DSP Outputs): Difference between revisions
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here | 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
|
CloseFile |
| Closes a file | |
 - VOID
|
Return |
|
|
WriteArray |
| Writes a buffer of values from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro. | |
| - VOID
|
Return |
|
|
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. | |
 - STRING
|
Filename |
| Filename, must be an 8.3 formatted filename in embedded. | |
 - BOOL
|
ExistingData |
| 0=KeepAndAppend, 1=Clear | |
| - BOOL
|
Return |
|
|
WriteValue |
| Writes a single value from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Connect To 0 |
| DSP component with output buffer to collect our data from. | |
|
CSV File |
|
|
LinkTo |
|
|
Number of Inputs |
| The number of inputs the multiplexer can switch between. | |
|
Filename |
| Name of the file to write DSP data to. | |
|
|
Existing Data |
| Decides what to do when opening a file that already exists. | |
==Macro reference==
|
|
CloseFile |
| Closes a file | |
| - VOID
|
Return |
|
|
WriteArray |
| Writes a buffer of values from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro. | |
| - VOID
|
Return |
|
|
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. | |
| - STRING
|
Filename |
| Filename, must be an 8.3 formatted filename in embedded. | |
| - BOOL
|
ExistingData |
| 0=KeepAndAppend, 1=Clear | |
| - BOOL
|
Return |
|
|
WriteValue |
| Writes a single value from the selected DSP buffer to the CSV file. FAT component must be initialised before calling this macro. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Connect To 0 |
| DSP component with output buffer to collect our data from. | |
|
|
CSV File |
|
|
LinkTo |
|
|
Number of Inputs |
| The number of inputs the multiplexer can switch between. | |
|
|
Filename |
| Name of the file to write DSP data to. | |
|
|
Existing Data |
| Decides what to do when opening a file that already exists. | |