String Communication Write

## String Communication Write

![](/media/202601/485e1223-8205-479c-bfc4-c4284cf3741c_1768530644.png)

## Module Principle
The module converts the connected image processed data of various data types into a string of a specified format according to the set protocol header, protocol tail, separator symbol, and other information, adds the protocol header and tail to splice into a string, and finally writes it out to the specified ordinary serial port, TCP client, or server communication port.

## Usage Scenarios
Commonly used to convert the image processed data connected to the module into a string of a specified format according to the set protocol header, protocol tail, separator symbol, and other information, and output the converted string through the specified communication port.

## Usage Method
Prerequisite: Configure a communication port such as ordinary serial port, TCP client, or server in the VG3 project, and establish an image processing flow.
1. Function Addition Tree &rArr; Auxiliary Tools &rArr; Hardware Control &rArr; String Communication Output Module, drag or double-click to add to the specified position in the flow.
2. Select the communication port to be output. When the communication port is a server, fill in the specified client IP according to the specific situation. Generally, it is not necessary to fill in.
3. Add split header/tail characters, decimal processing, connection port invalid processing, etc., according to specific usage conditions. Generally, it is not necessary to fill in.

## Parameter Configuration Description
![](/media/202601/522e189c-811f-4cd6-821d-4b56b0bf90aa_1768532694.png)
1. Communication Port Selection: Select the communication port to be read. Gray light indicates the communication port is unused; red light indicates communication port connection failed; green light indicates communication port connected normally. If the communication port type is incorrect, display the communication port type. If the communication port type is server, display the client IP and fill in the client IP to be output.
2. Client IP: When the communication port is a server, if multiple clients are connected but you only want to output values to a specified IP, you need to add it, otherwise you do not need to fill it in.
3. Protocol Header: The string added to the head of the string after value conversion.
4. Protocol Tail: The string added to the tail of the string after value conversion.
5. Separator: The separator between connected input ports; the separator symbol between connected data, such as: pose (1, 2, 3), point array ((1, 2), (2, 3)), when the separator is ==,==, it is converted to "==1,2,3==", "==1,2,2,3==".
6. Decimal Processing: When converting data types containing decimals such as floating-point numbers and points to strings, decimal processing: do not process, only keep integers, keep decimals of specified bit length.
7. Data Invalid Processing: Used when the data of the output port connected to the digital input port is invalid. Processing method: pad with special characters output, default string, do not output.
Pad with special characters output: When the data of the output port connected to the digital input port in the module is invalid, the data to be output is padded with 0.
Default string: When the data of the output port connected to any digital input port in the module is invalid, the module outputs the specified string.
Do not output: When the data of the output port connected to any digital input port in the module is invalid, the module does not output.
8. Error String: Used for padding values and outputting when padding with special characters output and default string.

![](/media/202601/fefee50d-6cf0-4536-b5ed-d81b21e159fa_1768550116.png)
Name Column in Table: Double-click to modify the name of the selected input port.
Data Source in Table: Only after the Whether Subscribe column is checked, click to select the output port of the module above the module.
Pin Information in Table: Display the data type of the input port cannot be modified.
Whether Subscribe in Table: After checking, you can connect to the output port of the external module. If not checked, convert the input port data type to a string, and you can set the value of the input port by double-clicking.
Current Value in Table: Only after the Whether Subscribe column is not checked, double-click to set the value of the input port.
Table operations include the following:
1. Plus sign: Click to add the input port to be output.
2. Minus sign: Click to delete the selected input port.
3. Clear: Click to clear all added input ports.
4. Move Up: Click to move up the selected input port.
5. Move Down: Click to move down the selected input port.

## Output Description
![](/media/202601/12d5f2dd-88bd-4376-970b-bf5ee701cd82_1768532708.png)
1. Run Result: If the specified communication port data type is incorrect or writing fails when not connected, it is false; when the specified communication port type is correct and writing succeeds when connected, it is true.
2. Write String: Convert the image processed data connected to the module into a string of a specified format according to the set protocol header, protocol tail, separator symbol, and other information.

---

Click here to jump to the corresponding Chinese manual page: [String Communication Write](/doc/251)