ReadFromSerialPortAction Class Reference

Reads from a serial port for incoming data. More...

Inherits ReadWriteSerialPortActionBase, and IYamlConvertibleExt.

Properties
StreamDataEvent	StopReadingWhen [get, set]
	Specifies the event that causes the action to stop reading. More...
ContentDataType	InputDataType [get, set]
	Specifies the input data type and how to process the data that is read. The following options are available: More...
bool	DataInSoapMessage [get, set]
	Specifies whether data is contained in a SOAP message. The default value is false. More...
string	DataContentVariable [get, set]
	Specifies the name of the variable to save input data to. 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

Reads from a serial port for incoming data.

For common action properties, see IntegrationAction. Example:

Actions:
- ReadFromSerialPortAction:
    StopReadingWhen.Idle:
      IdleUntilMilliSeconds: 1000
    InputDataType: XML
    DataInSoapMessage: false
    Port:
      PortName: COM3
      BaudRate: 19200
      DataBits: 8
      StopBits: One
    Encoding: USWesternEurope_1252
    Name: Read from Serial Port
    # And more common action properties
    ...

Property Documentation

StopReadingWhen

StreamDataEvent StopReadingWhen

getset

Specifies the event that causes the action to stop reading.

Example of the "Sequence of characters is received" event:

StopReadingWhen.CharacterSequence:
  CharacterSequence: _eom_
  IncludeInStreamData: false

Example of the "Number of characters is received" event:

StopReadingWhen.CharacterNumber:
  CharacterCount: 100

Example of the default "Port becomes idle" event:

StopReadingWhen.Idle:
  IdleUntilMilliSeconds: 200

InputDataType

ContentDataType InputDataType

getset

Specifies the input data type and how to process the data that is read. The following options are available:

• Unstructured (default)

XmlVariables

• JsonVariables
• XML
• BTXML
• TextCSV
• TextTabDelimited
• PrintCommandScript

DataInSoapMessage

bool DataInSoapMessage

getset

Specifies whether data is contained in a SOAP message. The default value is false.

DataContentVariable

string DataContentVariable

getset

Specifies the name of the variable to save input data to.

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:

• ReadFromSerialPortAction.Properties.cs