Serial Port
uniflow.plugin.serialport •
Category: Generic Protocol •
Version: v1.0.2
Serial Port Plugin Reference Manual
1. Overview
Plugin Name: Serial Port
Type: Generic Protocol
Identifier: uniflow.plugin.serialport
Description
Receive data from external hardware via serial COM ports.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| COM Port | Numeric value specifying the com port. |
| Baud Rate | Specifies the baud rate. |
| Data Bits | Specifies the data bits. |
| Parity | Specifies the parity. |
| Stop Bits | Specifies the stop bits. |
| Handshake / Flow Control | Specifies the handshake / flow control. |
| Enable RTS | Toggle to enable or disable enable rts. |
| Enable DTR | Toggle to enable or disable enable dtr. |
3. Exposed Routes & Data Types
The following routes are available in the Uniflow catalog for this plugin:
| Display Name | Route ID | Kind | Category | Access | Data Type |
|---|---|---|---|---|---|
| ? | ? | ? | ? | Read | Variant |
| Data Received | DataReceivedItemId | Event | ? | Listen | Event Object |
| Last Received | LastReceivedItemId | Value | ? | Read | String |
| Connection Status | MetaConnectedItemId | Value | ? | Read | Bool |
| Send Data | SendDataItemId | Command | ? | Execute | Variant |
Route Parameters: Send Data
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|---|---|---|
message | Message | String | true |
WriteTypeParam | Write Type | String | true |
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from Serial Port, add the corresponding Input Node in the Rule Editor and select the desired property from the catalog. Link its output to any logical comparison or directly to an Action Node.
Scenario B: Triggering Actions
If the plugin supports writable properties or actions, use an Action Node in the Rule Editor. Configure the Target property to point to the Serial Port action, and supply any required parameters mapping from your rule's logic.