Modbus Control (Background Operations)

number, bool ReadModbusRegister (string name)

Getting a Modbus-register value.

Options:

• string name – register name configured in Modbus Settings menu.

Return values:

• value - Modbus-register value. Returns the last successfully read value from the cache, refreshed at 100ms intervals (update frequency may vary depending on certain conditions). If the value has never been successfully read then returns 0.
• is_online - boolean value to determine if the last attempt to read Modbus-register value was successful.

number, bool ReadModbusRegisterUpdated (string name)

Getting a Modbus-register value without cache. Register value requested every time if command is called.

Options:

• string name – register name configured in Modbus Settings menu.

Return values:

• value - Modbus-register value;
• is_online - boolean value to determine if the last attempt to read Modbus-register value was successful.

bool WriteModbusRegister (string name, number value)

Setting the Modbus-register value.

Options:

• string name – register name configured in Modbus Settings menu;
• number value - register value to set (16-bit integer).

Return value:

• true - if Modbus-register value was successfully set.

number1, ... , numberN, bool ReadModbusMultipleRegistersUpdated (string name, number count)

Getting the values of multiple consecutive Modbus registers without cache.

Options:

• string name – register name configured in Modbus Settings menu;
• number count – number of requested registers.

Return values:

• value1, ... , valueN – Modbus-register values;
• is_online – boolean value to determine if the last attempt to read Modbus-register value was successful.

bool WriteModbusMultipleRegisters (string name, number count, number value1, ... , number valueN)

Setting the values of multiple consecutive Modbus registers.

Options:

• string name – register name configured in Modbus Settings menu;
• number count – number of registers to be written;
• number value1, ... , number valueN – register values to set (16-bit integer).

Return value:

• true - if Modbus-register values was successfully set.