Package com.smartgridready.driver.api.modbus

Interface GenDriverAPI4ModbusFactory

  • public interface GenDriverAPI4ModbusFactory
    Defines the interface for a Modbus interface driver factory.

    • Method Detail

      • createRtuTransport

        GenDriverAPI4Modbus createRtuTransport​(java.lang.String comPort)
        Creates a serial Modbus RTU transport.
        Parameters:
        comPort - the serial port name
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createRtuTransport

        GenDriverAPI4Modbus createRtuTransport​(java.lang.String comPort,
                                       int baudRate)
        Creates a serial Modbus RTU transport.
        Parameters:
        comPort - the serial port name
        baudRate - the serial port baud rate
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createRtuTransport

        GenDriverAPI4Modbus createRtuTransport​(java.lang.String comPort,
                                       int baudRate,
                                       Parity parity)
        Creates a serial Modbus RTU transport.
        Parameters:
        comPort - the serial port name
        baudRate - the serial port baud rate
        parity - the serial port parity
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createRtuTransport

        GenDriverAPI4Modbus createRtuTransport​(java.lang.String comPort,
                                       int baudRate,
                                       Parity parity,
                                       DataBits dataBits)
        Creates a serial Modbus RTU transport.
        Parameters:
        comPort - the serial port name
        baudRate - the serial port baud rate
        parity - the serial port parity
        dataBits - the serial port data bits
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createRtuTransport

        GenDriverAPI4Modbus createRtuTransport​(java.lang.String comPort,
                                       int baudRate,
                                       Parity parity,
                                       DataBits dataBits,
                                       StopBits stopBits)
        Creates a serial Modbus RTU transport.
        Parameters:
        comPort - the serial port name
        baudRate - the serial port baud rate
        parity - the serial port parity
        dataBits - the serial port data bits
        stopBits - the serial port stop bits
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createRtuTransport

        default GenDriverAPI4Modbus createRtuTransport​(java.lang.String comPort,
                                               int baudRate,
                                               Parity parity,
                                               DataBits dataBits,
                                               StopBits stopBits,
                                               boolean asciiEncoding)
        Creates a serial Modbus RTU transport.
        Parameters:
        comPort - the serial port name
        baudRate - the serial port baud rate
        parity - the serial port parity
        dataBits - the serial port data bits
        stopBits - the serial port stop bits
        asciiEncoding - use ASCII encoding if true, otherwise RTU encoding
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createTcpTransport

        GenDriverAPI4Modbus createTcpTransport​(java.lang.String ipAddress)
        Creates a Modbus TCP transport. Uses the default port 502.
        Parameters:
        ipAddress - the IP address or host name
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createTcpTransport

        GenDriverAPI4Modbus createTcpTransport​(java.lang.String ipAddress,
                                       int port)
        Creates a Modbus TCP transport.
        Parameters:
        ipAddress - the IP address or host name
        port - the TCP port
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createTcpTransport

        GenDriverAPI4Modbus createTcpTransport​(java.lang.String ipAddress,
                                       int port,
                                       int timeout)
        Creates a Modbus TCP transport.
        Parameters:
        ipAddress - the IP address or host name
        port - the TCP port
        timeout - the connection timeout in milliseconds
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createTcpTransport

        GenDriverAPI4Modbus createTcpTransport​(java.lang.String ipAddress,
                                       int port,
                                       int timeout,
                                       boolean rtuOverTcp)
        Creates a Modbus TCP transport.
        Parameters:
        ipAddress - the IP address or host name
        port - the TCP port
        timeout - the connection timeout in milliseconds
        rtuOverTcp - uses RTU over a TCP connection, e.g. for IP-to-serial gateways
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createUdpTransport

        GenDriverAPI4Modbus createUdpTransport​(java.lang.String ipAddress)
        Creates a Modbus UDP transport. Uses the default port 502.
        Parameters:
        ipAddress - the IP address or host name
        Returns:
        a new instance of GenDriverAPI4Modbus

      • createUdpTransport

        GenDriverAPI4Modbus createUdpTransport​(java.lang.String ipAddress,
                                       int port)
        Creates a Modbus UDP transport.
        Parameters:
        ipAddress - the IP address or host name
        port - the UDP port
        Returns:
        a new instance of GenDriverAPI4Modbus