Package org.openhab.core.io.transport.modbus

Interface ModbusManager

@NonNullByDefault
public interface ModbusManager

ModbusManager is the main interface for interacting with Modbus slaves

Author:

Sami Salonen - Initial contribution

Method Summary

Modifier and Type	Method	Description
EndpointPoolConfiguration	getEndpointPoolConfiguration(ModbusSlaveEndpoint endpoint)	Get general configuration settings applied to a given endpoint Note that default configuration settings are returned in case the endpoint has not been configured.
ModbusCommunicationInterface	newModbusCommunicationInterface(ModbusSlaveEndpoint endpoint, @Nullable EndpointPoolConfiguration configuration)	Open communication interface to endpoint

Method Details

newModbusCommunicationInterface

ModbusCommunicationInterface newModbusCommunicationInterface(ModbusSlaveEndpoint endpoint,
 @Nullable EndpointPoolConfiguration configuration)
                                                      throws IllegalArgumentException

Open communication interface to endpoint

Parameters:

endpoint - endpoint pointing to modbus slave

configuration - configuration for the endpoint. Use null to use default pool configuration

Returns:

Communication interface for interacting with the slave

Throws:

IllegalArgumentException - if there is already open communication interface with same endpoint but differing configuration

getEndpointPoolConfiguration

EndpointPoolConfiguration getEndpointPoolConfiguration(ModbusSlaveEndpoint endpoint)

Get general configuration settings applied to a given endpoint Note that default configuration settings are returned in case the endpoint has not been configured.

Parameters:

endpoint - endpoint to query

Returns:

general connection settings of the given endpoint