Skip to content

ModbusRtu

Methods

ModbusRtu.AddModbusRtuMaster

ADMIN

Add a new modbus RTU master with the given configuration. The timeout value is in milli seconds and the minimum value is 10 ms.

Parameters:

Field Type Notes
baudrate Uint
dataBits SerialPortDataBits
numberOfRetries Uint
parity SerialPortParity
serialPort String
stopBits SerialPortStopBits
timeout Uint

Returns:

Field Type Notes
modbusError ModbusRtuError
modbusUuid Uuid optional

ModbusRtu.GetModbusRtuMasters

ADMIN

Get the list of configured modbus RTU masters.

Parameters:

No parameters.

Returns:

Field Type Notes
modbusError ModbusRtuError
modbusRtuMasters ModbusRtuMaster[] optional

ModbusRtu.GetSerialPorts

ADMIN

Get the list of available serial ports from the host system.

Parameters:

No parameters.

Returns:

Field Type Notes
serialPorts SerialPorts

ModbusRtu.ReconfigureModbusRtuMaster

ADMIN

Reconfigure the modbus RTU master with the given UUID and configuration.

Parameters:

Field Type Notes
baudrate Uint
dataBits SerialPortDataBits
modbusUuid Uuid
numberOfRetries Uint
parity SerialPortParity
serialPort String
stopBits SerialPortStopBits
timeout Uint

Returns:

Field Type Notes
modbusError ModbusRtuError

ModbusRtu.RemoveModbusRtuMaster

ADMIN

Remove the modbus RTU master with the given modbus UUID.

Parameters:

Field Type Notes
modbusUuid Uuid

Returns:

Field Type Notes
modbusError ModbusRtuError

Notifications

ModbusRtu.ModbusRtuMasterAdded

Emitted whenever a new modbus RTU master has been added to the system.

Parameters:

Field Type Notes
modbusRtuMaster ModbusRtuMaster

ModbusRtu.ModbusRtuMasterChanged

Emitted whenever a modbus RTU master has been changed in the system.

Parameters:

Field Type Notes
modbusRtuMaster ModbusRtuMaster

ModbusRtu.ModbusRtuMasterRemoved

Emitted whenever a modbus RTU master has been removed from the system.

Parameters:

Field Type Notes
modbusUuid Uuid

ModbusRtu.SerialPortAdded

Emitted whenever a serial port has been added to the system.

Parameters:

Field Type Notes
serialPort SerialPort

ModbusRtu.SerialPortRemoved

Emitted whenever a serial port has been removed from the system.

Parameters:

Field Type Notes
serialPort SerialPort