Serial
Serial - Close
Close a serial port
IN
| Name | Type | Description |
|---|---|---|
| InSerial | SerialPort | The serial port to close. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Serial - CountAvailable
Counts the number of bytes that are available to be read from serial port
IN
| Name | Type | Description |
|---|---|---|
| InSerial | SerialPort | The serial port instance. |
| OutCount | Int | The the count of available bytes. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Serial - Open
Open a serial port
IN
| Name | Type | Description |
|---|---|---|
| InPortName | DynamicEnum | The serial port name. |
| InBaudRate | Int | The BaudRate value. |
| InParity | Enum < Parity > | The Parity value. |
| InDataBits | Int | The DataBits value. |
| InStopBits | Enum < StopBits > | The StopBits value. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutSerial | SerialPort | The serial port instance. |
| Error | ErrorState | Gets the execution error message |
Serial - ReadBytes
Reads an array of bytes from serial port
IN
| Name | Type | Description |
|---|---|---|
| InSerial | SerialPort | The serial port instance. |
| InTerminationString | String | The termination value for string.Any char can be used, including \r,\t,\n,\0.Type : string |
| InTimeout | Int | The timeout,in milliseconds,to wait for string.If <0, waits forever.Type : int |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutBytes | ByteArray | The read bytes. |
| Error | ErrorState | Gets the execution error message |
Serial - ReadString
Reads string value from serial
IN
| Name | Type | Description |
|---|---|---|
| InSerial | SerialPort | The serial port instance. |
| InEncoding | Enum < EncodingText > | The encoding value for string. |
| InTerminationString | String | The termination value for string.Any char can be used, including \r,\t,\n,\0. |
| InTimeout | Int | The timeout,in milliseconds,to wait for string.If <0, waits forever. |
| InReadTerminationChar | Bool | Sets if termination char has to be read. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| OutText | String | The read string.Type : string |
| Error | ErrorState | Gets the execution error message |
Serial - WriteBytes
Writes an array of bytes to serial port
IN
| Name | Type | Description |
|---|---|---|
| InSerial | SerialPort | The serial port instance. |
| InBytes | ByteArray | The bytes to write. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |
Serial - WriteString
Writes string value to serial
IN
| Name | Type | Description |
|---|---|---|
| InSerial | SerialPort | The serial port instance. |
| InEncoding | Enum | The encoding value for string. |
| InTerminationString | String | The termination value to append to string. |
| InText | String | The string to write. |
| Name | String | Set the tool's name |
| Enable | Bool | Sets if current tool is enabled or not |
OUT
| Name | Type | Description |
|---|---|---|
| Error | ErrorState | Gets the execution error message |