Package com.smartgridready.communicator.modbus.helper

Class ModbusUtil

  • public class ModbusUtil
extends java.lang.Object
    Utility methods for Modbus.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getModbusGatewayIdentifier​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
      Gets the unique gateway identifier of a Modbus device.
      static short getModbusSlaveId​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
      Gets the Modbus device slave ID.
      static ModbusType getModbusType​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
      Gets the Modbus interface type.
      static int getSerialBaudrate​(java.lang.String baudRate)
      Gets the serial baud rate.
      static com.smartgridready.driver.api.modbus.DataBits getSerialDataBits​(java.lang.String dataBits)
      Gets the data bits configuration.
      static com.smartgridready.driver.api.modbus.Parity getSerialParity​(java.lang.String parity)
      Gets the parity configuration.
      static com.smartgridready.driver.api.modbus.StopBits getSerialStopBits​(java.lang.String stopBits)
      Gets the stop bits configuration.
      static boolean interfaceParametersMatch​(com.smartgridready.ns.v0.ModbusInterfaceDescription interface1, com.smartgridready.ns.v0.ModbusInterfaceDescription interface2)
      Tells if interface specifications of two devices match.
      static boolean isSerial​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
      Tells if the interface uses a serial connection.
      static boolean isTcp​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
      Tells if the interface uses a TCP/IP connection.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEFAULT_MODBUS_TCP_PORT

        public static final int DEFAULT_MODBUS_TCP_PORT
        Default TCP port.
        See Also:
        Constant Field Values

      • DEFAULT_MODBUS_TCP_TIMEOUT

        public static final int DEFAULT_MODBUS_TCP_TIMEOUT
        Default connection timeout in milliseconds.
        See Also:
        Constant Field Values

      • DEFAULT_BAUDRATE

        public static final int DEFAULT_BAUDRATE
        Default baud rate.
        See Also:
        Constant Field Values

      • DEFAULT_PARITY

        public static final com.smartgridready.driver.api.modbus.Parity DEFAULT_PARITY
        Default parity.

      • DEFAULT_DATABITS

        public static final com.smartgridready.driver.api.modbus.DataBits DEFAULT_DATABITS
        Default data bits.

      • DEFAULT_STOPBITS

        public static final com.smartgridready.driver.api.modbus.StopBits DEFAULT_STOPBITS
        Default stop bits.

      • DEFAULT_SLAVE_ID

        public static final short DEFAULT_SLAVE_ID
        Default slave ID.
        See Also:
        Constant Field Values

    • Method Detail

      • isSerial

        public static boolean isSerial​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
        Tells if the interface uses a serial connection.
        Parameters:
        interfaceDescription - the interface specification
        Returns:
        a boolean

      • isTcp

        public static boolean isTcp​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
        Tells if the interface uses a TCP/IP connection.
        Parameters:
        interfaceDescription - the interface specification
        Returns:
        a boolean

      • getModbusSlaveId

        public static short getModbusSlaveId​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
        Gets the Modbus device slave ID.
        Parameters:
        interfaceDescription - the interface specification
        Returns:
        a short

      • getModbusGatewayIdentifier

        public static java.lang.String getModbusGatewayIdentifier​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
                                                   throws com.smartgridready.driver.api.common.GenDriverException
        Gets the unique gateway identifier of a Modbus device. Is the serial port name or a combination of IP address and port.
        Parameters:
        interfaceDescription - the interface specification
        Returns:
        a string
        Throws:
        com.smartgridready.driver.api.common.GenDriverException - when the interface type could not be correctly detected

      • getSerialDataBits

        public static com.smartgridready.driver.api.modbus.DataBits getSerialDataBits​(java.lang.String dataBits)
        Gets the data bits configuration.
        Parameters:
        dataBits - the data bits as string
        Returns:
        an instance of DataBits

      • getSerialStopBits

        public static com.smartgridready.driver.api.modbus.StopBits getSerialStopBits​(java.lang.String stopBits)
        Gets the stop bits configuration.
        Parameters:
        stopBits - the stop bits as string
        Returns:
        an instance of StopBits

      • getSerialParity

        public static com.smartgridready.driver.api.modbus.Parity getSerialParity​(java.lang.String parity)
        Gets the parity configuration.
        Parameters:
        parity - the parity as string
        Returns:
        an instance of Parity

      • getSerialBaudrate

        public static int getSerialBaudrate​(java.lang.String baudRate)
        Gets the serial baud rate.
        Parameters:
        baudRate - the baud rate as string
        Returns:
        an int

      • interfaceParametersMatch

        public static boolean interfaceParametersMatch​(com.smartgridready.ns.v0.ModbusInterfaceDescription interface1,
                                               com.smartgridready.ns.v0.ModbusInterfaceDescription interface2)
        Tells if interface specifications of two devices match.
        Parameters:
        interface1 - the interface specification of device 1
        interface2 - the interface specification of device 2
        Returns:
        a boolean

      • getModbusType

        public static ModbusType getModbusType​(com.smartgridready.ns.v0.ModbusInterfaceDescription interfaceDescription)
        Gets the Modbus interface type.
        Parameters:
        interfaceDescription - the interface specification
        Returns:
        an instance of ModbusType