Difference between revisions of "Serialport"

Revision as of 22:07, 13 May 2024

Under development

Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.

Available in Lianja 9.7.

This class supports the following properties:

Property	Access (R/RW)	Value	Description
baudrate	RW	Numeric	The baudrate
breakenabled	RW	Logical	The breakenabled state.
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. 2 The number of 1 bits in each character, including the parity bit, is always even. 3 The number of 1 bits in each character, including the parity bit, is always odd. It ensures that at least one state transition occurs in each character. 4 Space parity. The parity bit is sent in the space signal condition. It does not provide error detection information. 5 Mark parity. The parity bit is always set to the mark signal condition (logical 1). It does not provide error detection information.
flowcontrol	RW	Numeric	The flowcontrol. 0 No flow control. 1 Hardware flow control (RTS/CTS). 2 Software flow control (XON/XOFF).
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.

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
open	None	Open the serial port specified in portname. NOTE: set all port settings AFTER opening the port.
close	None	Closes the serial port

This class supports the the following events:

Event	Args	Description
readyRead	bytesavailable as numeric	Occurs when data is available to read
writeComplete	Byteswritten as numeric	Occurs write has completed

@@ Line 129: / Line 129: @@
 |-
 |readyRead
-|None
+|bytesavailable as numeric
-|Occurs when data is available
+|Occurs when data is available to read
 |-
 |-