Jamie Balfour

Welcome to my personal website.

Find out more about me, my personal projects, reviews, courses and much more here.

Official ZPE/YASS documentationzpe.lib.serial

The Serial plugin (libSerial) provides access to serial ports using the jSerialComm library. It allows you to list available ports, open a port, check its status, and write data.

Functions

list_serial_ports () ⇒ list
Returns a list of available serial ports on the system.

Each item in the list is a ZPESerialPort object that can be used to open the port, check its status, or write data.

Objects

ZPESerialPort

get_name () ⇒ string
Returns the descriptive name of the serial port.
is_open () ⇒ boolean
Returns true if the port is currently open.
open () ⇒ boolean
Opens the serial port. Returns true on success, otherwise false.
write () ⇒ null
Writes a byte to the serial port using the current built-in configuration: baud rate 19200, scanner timeout mode, then closes the port.

Note: This method currently takes no parameters and always writes the same single byte. It returns null.
Comments

There are no comments on this page.

New comment

Comments are welcome and encouraged, including disagreement and critique. However, this is not a space for abuse. Disagreement is welcome; personal attacks, harassment, or hate will be removed instantly. This site reflects personal opinions, not universal truths. If you can’t distinguish between the two, this probably isn’t the place for you. The system temporarily stores IP addresses and browser user agents for the purposes of spam prevention, moderation, and safeguarding. This data is automatically removed after fourteen days. Your email address is stored so that replies can be sent to your email address.

Comments powered by BalfComment

Feedback 👍
Comments are sent via email to me.