Difference between revisions of "Serialport"

From Lianjapedia
Jump to: navigation, search
(→‎Properties)
Line 25: Line 25:
 
|valign="top"|Logical
 
|valign="top"|Logical
 
|valign="top"|The breakenabled state.
 
|valign="top"|The breakenabled state.
 +
 +
-
 +
|valign="top"|count
 +
|valign="top"|R
 +
|valign="top"|Numeric
 +
|valign="top"|The number of available ports.
  
 
|-
 
|-

Revision as of 02:03, 14 May 2024


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
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.
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.

0x00 No line active.
0x01 TxD (Transmitted Data). This value is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.
0x02 RxD (Received Data). This value is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.
0x04 DTR (Data Terminal Ready).
0x08 DCD (Data Carrier Detect).
0x10 DSR (Data Set Ready).
0x20 RNG (Ring Indicator).
0x40 RTS (Request To Send). 0x80 CTS (Clear To Send).
0x100 STD (Secondary Transmitted Data).
0x200 SRD (Secondary Received Data).

error R Numeric The last error.

0 No error occurred.
1 An error occurred while attempting to open an non-existing device.
2 An error occurred while attempting to open an already opened device by another process or a user not having enough permission and credentials to open.
3 An error occurred while attempting to open an already opened device in this object.
13 This error occurs when an operation is executed that can only be successfully performed if the device is open.
4 Parity error detected by the hardware while reading data.
5 Framing error detected by the hardware while reading data.
6 Break condition detected by the hardware on the input line.
7 An I/O error occurred while writing the data.
8 An I/O error occurred while reading the data.
9 An I/O error occurred when a resource becomes unavailable, e.g. when the device is unexpectedly removed from the system.
10 The requested device operation is not supported or prohibited by the running operating system.
12 A timeout error occurred.
11 An unidentified 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
writeComplete Byteswritten as numeric Occurs write has completed
Retrieved from "https://www.lianja.com/doc/index.php?title=Serialport&oldid=27229"