Actions YAML Reference
Properties | List of all members
SendToSerialPortAction Class Reference

Writes information to a serial port. More...

Inherits ReadWriteSerialPortActionBase.

Properties

DataTarget Message [get, set]
 Specifies the source of the message that is sent to the serial port.
Example in which the source is a variable: More...
 
SerialInterfacePort Port [get, set]
 Specifies a serial COM port and its settings, as follows:
More...
 
ActionTextEncoding Encoding [get, set]
 Specifies the text encoding scheme of the input or output message. For more information, see ActionTextEncoding. The default value is UnicodeUTF8. More...
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...
 

Detailed Description

Writes information to a serial port.

For common action properties, see IntegrationAction.
Example:

Actions:
- SendToSerialPortAction:
Message: '%EventData%'
Port:
PortName: COM1
BaudRate: 9600
DataBits: 8
StopBits: One
Name: Send to Serial Port
# And more common action properties
...
DataTarget Message
Specifies the source of the message that is sent to the serial port. Example in which the source is a...
Definition: WriteSerialPortAction.Properties.cs:91
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87

Property Documentation

◆ Message

DataTarget Message
getset

Specifies the source of the message that is sent to the serial port.
Example in which the source is a variable:

Message: '%EventData%'

Example in which the source is a template with variables:

Message: 'Today is %CurrentDate%. Time now: %CurrentTime%'

Example in which the source is a file from the temporary storage:

File: data.txt

Example in which the source is a file from the computer or network or from Librarian:

File: lib://MySecretFolder/data.txt

Example in which the source is a cloud file:

File:
Path: dropbox://Dropbox/
FileSystem.Dropbox:
AccountName: Dropbox
UrlAccountName: Dropbox

◆ Port

SerialInterfacePort Port
getsetinherited

Specifies a serial COM port and its settings, as follows:

  • PortName (the default value is COM1)
  • BaudRate (the default value is 9600)
  • DataBits (the default value is 8)
  • Parity
    • None (default)
    • Odd
    • Even
    • Mark
    • Space
  • StopBits
    • None
    • One (default)
    • Two
    • OnePointFive
  • FlowControl
    • None (default)
    • XOnXOff
    • RequestToSend
    • RequestToSendXOnXOff

Example:

Port:
PortName: COM3
BaudRate: 19200
DataBits: 8
StopBits: One
FlowControl: XonXoff

◆ Encoding

ActionTextEncoding Encoding
getsetinherited

Specifies the text encoding scheme of the input or output message. For more information, see ActionTextEncoding. The default value is UnicodeUTF8.

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.


The documentation for this class was generated from the following file: