Difference between revisions of "Component: Output CSV (DSP)"
From Flowcode Help
Jump to navigationJump to search| (2 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== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 24: | Line 34: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 34: | Line 50: | ||
==Downloadable macro reference== | ==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;" | '''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;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| Line 44: | Line 73: | ||
|- | |- | ||
| 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 | ||
| + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| Line 71: | Line 123: | ||
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9-type- | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| width="90%" | Connect To | | width="90%" | Connect To | ||
|- | |- | ||
| − | | colspan="2" | | + | | 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-17-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | ||
| Line 84: | Line 140: | ||
| width="90%" | Filename | | width="90%" | Filename | ||
|- | |- | ||
| − | | colspan="2" | Name of the file to write DSP data to. | + | | colspan="2" | Name of the file to write DSP data to. Requires an 8.3 file name for use with embedded file component. |
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| Line 95: | Line 151: | ||
|- | |- | ||
| colspan="2" | Decides what to do when opening a file that already exists. | | colspan="2" | Decides what to do when opening a file that already exists. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
Latest revision as of 17:19, 9 November 2022
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | DSP |
Contents
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
|
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 |
| DSP component with output buffer to collect our data from. | |
|
CSV File |
|
FAT Component |
| Points to the FAT filesystem component to allow access to file system and embedded SD card. | |
|
Filename |
| Name of the file to write DSP data to. Requires an 8.3 file name for use with embedded file component. | |
|
|
Layout |
|
|
Existing Data |
| Decides what to do when opening a file that already exists. | |
