_{Official ZPE/YASS documentation}SerialPort

SerialPort provides cross-platform serial communication and replaces the former lib.serial plugin. Use SerialPort::list_ports() to discover ports or construct one from its system name.

Availability: SerialPort was added to ZPE in version 1.14.11. Its methods require permission level 3.

Public properties

• system_name

  The read-only operating-system port name.

• name

  The read-only descriptive port name.

• baud_rate

  The current baud rate; this property can be changed before opening the port.

Static functions

These functions are called on the object type itself and do not require a serial port instance.

• list_ports [1.14.11+]

  Returns the serial ports currently available on the system.

Instance functions

• _construct [1.14.11+]

  Initialises a serial port from its system name.

• bytes_available [1.14.11+]

  Returns the number of bytes currently available to read.

• close [1.14.11+]

  Closes the serial port.

• get_name [1.14.11+]

  Returns the descriptive name of the serial port.

• is_open [1.14.11+]

  Returns whether the serial port is open.

• open [1.14.11+]

  Opens the serial port.

• read [1.14.11+]

  Reads available UTF-8 data from the serial port.

• write [1.14.11+]

  Writes UTF-8 text to the serial port.

Example

$ports = SerialPort::list_ports()
$port = $ports[0]
$port->open()
$port->write("Hello")