serial

`serial` opens a serial port, writes data, reads data, and can monitor incoming data asynchronously.

Read operations return `bytes` objects. Write operations accept a `bytes` object, string, or single byte number.

`serial` is not cloneable because it owns an operating-system serial port handle and optional monitor thread state.

Creates a closed serial port object.

Example:

port = serial();
print(port.is_open());       // false

`serial` has no object-specific properties.

Use methods such as `is_open()`, `is_monitoring()`, and `last_error()` to inspect serial state.

`clone()` is not supported for `serial`.

Opens a serial port using the default baud rate `115200`.

Returns: boolean-style number.

If the port cannot be opened, returns `false` and stores the error text.

Example:

port = serial();
ok = port.open('COM1');

Opens a serial port using the specified baud rate.

Returns: boolean-style number.

Example:

port = serial();
ok = port.open('COM1', 9600);

Stops monitoring if needed, then closes the serial port.

Returns `true` when the port was closed or was already closed. If closing fails, returns `false` and stores the error text.

Example:

port.close();

Returns true when the serial port is open.

Example:

if (port.is_open())
{
    print('serial ready');
}

Writes data to the serial port.

Returns: number of bytes written. If writing fails, returns `none()` and stores the error text.

Example:

port.write('G0 X0 Y0\n');
port.write(13);

Reads up to 256 bytes from the serial port.

A timeout returns an empty `bytes` object. Other read errors return `none()` and store the error text.

Example:

data = port.read();
print(data.size());

Reads up to `maxBytes` bytes from the serial port.

Returns: bytes object, or none.

Example:

data = port.read(64);

Starts asynchronous reading.

Returns: boolean-style number.

The callback receives one argument: a `bytes` object containing the received bytes.

Example:

function OnSerialData(data)
{
    print('bytes: ', data.size());
}
 
port = serial();
if (port.open('COM1', 115200))
{
    port.monitor(OnSerialData);
}

Stops asynchronous monitoring.

Returns `true` if monitoring was active, otherwise returns `false`.

Example:

port.stop_monitor();

Returns true while asynchronous monitoring is active.

Example:

if (port.is_monitoring())
{
    print('serial monitor active');
}

Returns the last serial error message.

Returns an empty string when no error is stored.

Example:

if (!port.open('COM1'))
{
    print(port.last_error());
}

Clears the stored error message.

Example:

port.clear_error();

Returns a short text summary of serial methods.

Previous: Comm

Next: Dialogs