Comment on page
CSV Export

Node_Csv_Export Documentation
The Node_Csv_Export node in AugeLab Studio is used to export data as a CSV file based on input conditions. This documentation will provide an overview of the node's functionality and how to use it effectively.
Node Overview
The Node_Csv_Export node allows you to define the folder path, file name, and export conditions for exporting data as a CSV file. It collects data from connected input sockets and saves it in a CSV file when the export condition is met.
Node Properties
Node Title: CSV Export
Node ID: OP_NODE_CSV_EXPORT
Tooltip: Connect data to export as a CSV file depending on input conditions.
Inputs
The node has the following input sockets:
Folder Path: The folder path where the CSV file will be saved. If not connected, the current working directory will be used.
File Name: The name of the CSV file to be created. If not connected, a default name will be generated based on the current date and time.
Start Logging: A boolean value that determines whether to start collecting data for export. If not connected, logging will not start.
Export File: A boolean value that triggers the export of the collected data as a CSV file. If not connected, the data will not be exported.
In addition to these four input sockets, there can be up to ten additional input sockets labeled "Data_1" to "Data_10". These sockets allow you to connect data that will be logged and exported.
Node Widgets
The Node_Csv_Export node has the following widgets:
Data Headers: This section allows you to set the headers for the data to be logged and exported. Each header corresponds to the connected data input socket. If no header is provided, the default header will be used (e.g., "Data_1" for the first input socket).
Text Edits: There are up to ten text input fields where you can enter custom headers for the connected data input sockets. Leaving a text field empty will use the default header for that socket.
Widget Configurations
The behavior of the Node_Csv_Export node can be affected by the following widget configurations:
Data Headers:
By default, the node will use the default headers for the connected data input sockets (e.g., "Data_1", "Data_2", etc.).
To set custom headers, enter the desired header text in the corresponding text input field. This allows you to provide more descriptive headers for your data.
Usage
1.Drag and drop the Node_Csv_Export node from the node library onto the canvas in AugeLab Studio.
2.Connect the desired inputs to the input sockets of the node:
Connect a folder path to the "Folder Path" input socket (optional). If not connected, the current working directory will be used.
Connect a file name to the "File Name" input socket (optional). If not connected, a default name will be generated based on the current date and time.
Connect a boolean value to the "Start Logging" input socket (optional). When this value is True, the node will start collecting data for export.
Connect a boolean value to the "Export File" input socket (optional). When this value is True, the collected data will be exported as a CSV file.
Connect the desired data inputs to the "Data_X" input sockets (optional). You can connect up to ten data inputs, labeled "Data_1" to "Data_10".
3.Set the data headers (optional):
By default, the node will use the default headers for the connected data input sockets (e.g., "Data_1", "Data_2", etc.).
To set custom headers, enter the desired header text in the corresponding text input field under the "Data Headers" section. Leave a field empty to use the default header for that socket.
4.Configure the export conditions:
When the "Start Logging" input value is True, the node will start collecting data based on the connected input sockets.
When the "Export File" input value is True, the collected data will be exported as a CSV file.
5.If the "Export File" condition is met and the node has not exported the data before, the data will be saved as a CSV file:
The file will be created in the specified folder path (or the current working directory if not provided).
The file name will be the specified name (or a default name based on the current date and time if not provided).
The headers for the data columns will be included in the CSV file.
Each row of the CSV file will contain the logged data for each connected input socket.
6.The node can be used repeatedly to log and export data as needed.
Notes
If the "Folder Path" input is not connected, the current working directory will be used as the default folder path.
If the "File Name" input is not connected, a default name will be generated based on the current date and time.
The node supports up to ten data input sockets (labeled "Data_1" to "Data_10") for logging and exporting.
Custom headers can be set for the data input sockets to provide more descriptive column names in the exported CSV file.
That concludes the documentation for the Node_Csv_Export node in AugeLab Studio. This node provides a flexible way to log and export data as a CSV file based on input conditions.
Function Blocks - Inputs - Previous
Video
Next - Function Blocks - Outputs
Cycle Timer
Last modified 4mo ago