Serialport
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Available in Lianja 9.7.
Properties
This class supports the following properties:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
baudrate. | RW | Numeric | The baudrate 1200 1200 baud. |
breakenabled | RW | Logical | The breakenabled state. |
count | R | Numeric | The number of available ports. |
databits | RW | Numeric | The number of databits. Valid values; 5, 6, 7 or 8 |
stopbits | RW | Numeric | The number of stopbits. Valid values; 1, 2 or 3 (1.5 on windows) |
parity | RW | Numeric | The parity bits.
0 No parity bit it sent. This is the most common parity setting. Error detection is handled by the communication protocol. |
flowcontrol | RW | Numeric | The flowcontrol. 0 No flow control. |
portname | RW | character | The portname e.g com3 |
dataterminalready | RW | Logical | The DTR state. |
requesttosend | RW | Logical | The RTS state |
pinoutsignals | R | Numeric | The pinoutsignals. 0x00 No line active. |
error | R | Numeric | The last error. 0 No error occurred. |
Methods
This class supports the following methods:
Method | Args | Description |
---|---|---|
availablePorts | extended as logical (optional) | Returns a comma separated list of ports available |
readData | length as numeric. (optional) | Reads data. Returns as a character string. |
writeData | Character | Writes the specified character string |
flush | None | Writes as much as possible from the internal write buffer to the underlying serial port without blocking. If any data was written, this function returns true; otherwise returns false. |
writeData | Character | Writes the specified character string |
open | None | Open the serial port specified in portname. NOTE: set all port settings AFTER opening the port. |
close | None | Closes the serial port |
clear | None | Discards all characters from the output and input buffer. This includes clearing the internal class buffers and the UART (driver) buffers. Also terminate pending read or write operations. If successful, returns true; otherwise returns false. |
clearError | None | Clears the internal error indicator. |
Events
This class supports the the following events:
Event | Args | Description |
---|---|---|
readyRead | bytesavailable as numeric | Occurs when data is available to read |
writeCompleted | Byteswritten as numeric | Occurs write has completed |