Libraries.System.SerialPort Documentation

This is an implementation of a Serial Port in Quorum. It provides for very basic querying of the port, like its system names, and allows us to open and close it. More information about Serial Ports can be found on Wikipedia: https://en.wikipedia.org/wiki/Serial_port

Inherits from: Libraries.Language.Object

Actions Documentation

AddListener(Libraries.System.SerialPortListener listener)

Parameters

Close()

Closes the port.

Return

boolean:

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetBaudRate()

Return

integer

GetDefaultTimeout()

Return

integer

GetDescription()

Returns a description of the port.

Return

text:

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetListenerIterator()

Return

Libraries.Containers.Iterator

GetName()

Returns the system's name for the port.

Return

text:

GetTimeoutNonBlocking()

Return

integer

GetTimeoutReadSemiBlocking()

Return

integer

GetTimeoutWriteBlocking()

Return

integer

InitializeListener()

Must be called for any added listeners to receive events. No manual read calls should be done after calling.

IsOpen()

Returns whether or not the port has accepted a connection.

Return

boolean:

Open()

Opens the port.

Return

boolean:

Read()

Reads from the port.

Return

text:

RemoveListener(Libraries.System.SerialPortListener listener)

Parameters

SendCloseEventToListeners()

SendReceievedEventToListeners(text data)

Parameters

  • text data

SetBaudRate(integer rate)

Parameters

  • integer rate

SetTimeouts(integer timeout, integer read, integer write)

Parameters

  • integer timeout
  • integer read
  • integer write

Write(integer value)

Parameters

  • integer value

Write(text value)

Writes to the port.

Parameters

  • text value