Difference between revisions of "Component: CSV Read/Write (File)"

Revision as of 10:25, 20 October 2023

Author	Matrix TSL
Version	1.0
Category	File

CSV Read/Write component

A component to simplify the task of creating and dumping data to a CSV file that can be loaded into Microcoft Excel or LibreOffice Math to create nice charts and graphs. Requires one of the File components to provide access to the file system.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_CSV_Writer.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

Simple example file to generate a two column CSV file that can be loaded into Microsoft Excel or LibreOffice Math.

The CSV Read/Write component is for simulation or App Developer.

For an embedded CSV read write see the File component

CSV Component used with App Developer -> File component: CSV Test AD

The component requires linking to a File component to provide access to the file system for simulation and runtime, this could be the File SD, File RPI or File AppDeveloper components.

Macro reference

AddNumber

	AddNumber
Adds a number to the CSV followed by a comma. This will form a single column of data in the CSV file.
- FLOAT	data

- VOID	Return

AddString

	AddString
Adds a string to the CSV followed by a comma. This will form a single column of data in the CSV file.
- STRING	data

- VOID	Return

CloseFile

	CloseFile
Closes the file and finishes off any pending writes ready for use in an external application.
- VOID	Return

NextRow

	NextRow
Move to the next row in the file
- VOID	Return

OpenFile

	OpenFile
Creates or opens a file ready for streaming data. If the file already exists then the contents will be deleted and the file started again from scratch. Returns 1 if file found and opened.
- STRING	Filename

- BOOL	Erase
0=Append existing data, 1=Reset file data
- BOOL	Return

ReadAsNumber

	ReadAsNumber
Reads the contents of a cell as a number.
- UINT	Column

- UINT	Row

- FLOAT	Return

ReadAsString

	ReadAsString
Reads the contents of a cell as a string
- UINT	Column

- UINT	Row

- STRING	Return

SequentialReadNumber

	SequentialReadNumber
Reads the contents of a cell as a number. Automatically moved to the next data cell after a read.
- FLOAT	Return

SequentialReadString

	SequentialReadString
Reads the contents of a cell as a string. Automatically moved to the next data cell after a read.
- STRING	Return

SetSequentialIndex

	SetSequentialIndex
Sets the index for sequential reads. Index is automatically reset to 0 after a file open.
- UINT	Index

- VOID	Return

Property reference

	Properties
	LinkTo

@@ Line 67: / Line 67: @@
 Simple example file to generate a two column CSV file that can be loaded into Microsoft Excel or LibreOffice Math.
-CSV Component used with Embedded -> File SD component: {{Fcfile|CSVTest.fcfx|CSV Test}}
+The CSV Read/Write component is for simulation or App Developer.
-CSV Component used with Embedded -> File RPI component: {{Fcfile|CSVTestRPI.fcfx|CSV Test RPI}}
+For an embedded CSV read write see the [[Component:_Embed_File_(File)|File component]]
 CSV Component used with App Developer -> File component: {{Fcfile|CSVTestAD.fcsx|CSV Test AD}}
@@ Line 80: / Line 80: @@
 ==Macro reference==
+===AddNumber===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddNumber'''
 |-
-| colspan="2" | Closes the file and finishes off any pending writes ready for use in an external application.&nbsp;
+| colspan="2" | Adds a number to the CSV followed by a comma. This will form a single column of data in the CSV file.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | data
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | &nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SequentialReadString'''
 |-
-| colspan="2" | Reads the contents of a cell as a string. Automatically moved to the next data cell after a read.&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-string-icon.png]] - STRING
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===AddString===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 124: / Line 118: @@
+===CloseFile===
 {| 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;" | '''ReadAsString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CloseFile'''
 |-
-| colspan="2" | Reads the contents of a cell as a string&nbsp;
+| colspan="2" | Closes the file and finishes off any pending writes ready for use in an external application.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Column
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Row
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===NextRow===
 {| 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;" | '''SequentialReadNumber'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''NextRow'''
 |-
-| colspan="2" | Reads the contents of a cell as a number. Automatically moved to the next data cell after a read.&nbsp;
+| colspan="2" | Move to the next row in the file&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| 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''
 |}
+===OpenFile===
 {| 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;" | '''AddNumber'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OpenFile'''
 |-
-| colspan="2" | Adds a number to the CSV followed by a comma. This will form a single column of data in the CSV file.&nbsp;
+| colspan="2" | Creates or opens a file ready for streaming data. If the file already exists then the contents will be deleted and the file started again from scratch. Returns 1 if file found and opened.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | data
+| width="90%" | Filename
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Erase
+|-
+| colspan="2" | 0=Append existing data, 1=Reset file data&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''
 |}
+===ReadAsNumber===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 201: / Line 194: @@
+===ReadAsString===
 {| 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;" | '''SetSequentialIndex'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAsString'''
+|-
+| colspan="2" | Reads the contents of a cell as a string&nbsp;
+|-
 |-
-| colspan="2" | Sets the index for sequential reads. Index is automatically reset to 0 after a file open.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Column
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Index
+| width="90%" | Row
 |-
 | colspan="2" | &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-string-icon.png]] - STRING
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===SequentialReadNumber===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SequentialReadNumber'''
 |-
-| colspan="2" | Creates or opens a file ready for streaming data. If the file already exists then the contents will be deleted and the file started again from scratch. Returns 1 if file found and opened.&nbsp;
+| colspan="2" | Reads the contents of a cell as a number. Automatically moved to the next data cell after a read.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" | Filename
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===SequentialReadString===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | &nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SequentialReadString'''
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| colspan="2" | Reads the contents of a cell as a string. Automatically moved to the next data cell after a read.&nbsp;
-| width="90%" | Erase
 |-
-| colspan="2" | 0=Append existing data, 1=Reset file data&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===SetSequentialIndex===
 {| 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;" | '''NextRow'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetSequentialIndex'''
+|-
+| colspan="2" | Sets the index for sequential reads. Index is automatically reset to 0 after a file open.&nbsp;
+|-
 |-
-| colspan="2" | Move to the next row in the file&nbsp;
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Index
 |-
+| colspan="2" | &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''
 |}