LuaPLC

• Index

Contents

• Functions
• Fields

Modules

• BinArray
• Bit
• CAN
• ExtendedPulseTimer
• GPIO
• IEC60870_5_104_Master
• IEC60870_5_104_Slave
• IOCards
• LuaSQLiteApplication
• ModbusMaster
• ModbusSlave
• MqttApplication
• OffDelayTimer
• OnDelayTimer
• PulseTimer
• Queue
• SerialPort
• Snap7Client
• Stopwatch
• Tag
• Thread
• Timer

Module SerialPort

The class that's used to create and manage Serial port connections.

Info:

• Copyright: Debaru Kft. 2017
• Release:
• License: GNU
• Author: Debaru Kft

Functions

SerialPort ()	Creates a SerialPort instance.
open ()	Opens the SerialPort communication.
close ()	Closes the SerialPort communication.
close ()	Returns true if the SerialPort is open.
available ()	Returns an integer value indicating whether the SerialPort is available.
read (size)	Reads the specified amount of data from the SerialPort.
write (data, size)	Writes the specified amount of data to the SerialPort.
flush ()	Clears the receive buffer.
dabug_as (name)	Logs the read and written information with name.
disable_debug ()	Disables debug.

Fields

port	Represents the Serial port number.
baud	Represents the SerialPort speed.
data_bits	Represents the SerialPort data bits settings.
parity	Represents the SerialPort parity settings.
stop_bits	Represents the SerialPort stop bits settings.
flow_control	Represents the SerialPort flow control settings.
inter_byte_timeout	Represents the SerialPort inter byte timeout settings.
read_timeout	Represents the SerialPort read timeout settings.

Functions

SerialPort ()

Creates a SerialPort instance.

open ()

Opens the SerialPort communication.

close ()

Closes the SerialPort communication.

close ()

Returns true if the SerialPort is open.

Returns:

bool

available ()

Returns an integer value indicating whether the SerialPort is available.

Returns:

int

read (size)

Reads the specified amount of data from the SerialPort.

Parameters:

• size int

Returns:

BinArray

write (data, size)

Writes the specified amount of data to the SerialPort.

Parameters:

• data BinArray
• size int

flush ()

Clears the receive buffer.

dabug_as (name)

Logs the read and written information with name.

Parameters:

• name string

disable_debug ()

Disables debug.

Fields

port

Represents the Serial port number.

• type int (default: 0)

baud

Represents the SerialPort speed.

• type int (default: 0)

data_bits

Represents the SerialPort data bits settings.

• type int (default: 0)

parity

Represents the SerialPort parity settings.

• type int (default: 0)

stop_bits

Represents the SerialPort stop bits settings.

• type int (default: 0)

flow_control

Represents the SerialPort flow control settings.

• type int (default: 0)

inter_byte_timeout

Represents the SerialPort inter byte timeout settings.

• type int (default: 0)

read_timeout

Represents the SerialPort read timeout settings.

• type int (default: 0)