Serial Communications Schema

From XAP Automation
Jump to: navigation, search

Serial Communications v1.2

This describes a xAP message schema for basic serial communications.

Unless otherwise stated a name/value pair is assumed to be mandatory.

Class=Serial.Comms

Serial.Setup
{
Port=(port number e.g. 2 for COM2)
-- mandatory
Baud=(bits per second e.g. 9600)
-- mandatory
Stop=(1 | 1.5 | 2)
-- mandatory
DataBits=(4 | 5 | 6 | 7 | 8)
-- mandatory
Parity=(none | even | odd | mark | space)
-- mandatory
Flow=(None | XOnXOff | Hardware)
-- mandatory
}


Serial.Received
{
Port=(port number e.g. 2 for COM2)
-- mandatory
Data=(Data received on the serial port)
-- mandatory
}


Serial.Send
{
Port=(port number e.g. 2 for COM2)
-- mandatory
Data=(Data to be sent on the serial port)
-- mandatory
}