beremiz: comparison modbus/modbus.py

equal deleted inserted replaced

-:09bac1f52b1e
+:cca3e5d7d6f3
 # Return the number of (modbus library) nodes this specific TCP client will need
 #   return type: (tcp nodes, rtu nodes, ascii nodes)
 def GetNodeCount(self):
 return (1, 0, 0)
+def GetConfigName(self):
+""" Return the node's Configuration_Name """
+return self.ModbusTCPclient.getConfiguration_Name()
 def CTNGenerate_C(self, buildpath, locations):
 """
 Generate C code
 @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)
 @param locations: List of complete variables locations \
 # Return the number of (modbus library) nodes this specific TCP server will need
 #   return type: (tcp nodes, rtu nodes, ascii nodes)
 def GetNodeCount(self):
 return (1, 0, 0)
-# Return a list with a single tuple conatining the (location, port number)
+# Return a list with a single tuple conatining the (location, IP address, port number)
-#     location: location of this node in the configuration tree
+#     location   : location of this node in the configuration tree
 #     port number: IP port used by this Modbus/IP server
+#     IP address : IP address of the network interface on which the server will be listening
+#                  ("", "*", or "#ANY#" => listening on all interfaces!)
 def GetIPServerPortNumbers(self):
-port = self.GetParamsAttributes()[0]["children"][1]["value"]
+port = self.ModbusServerNode.getLocal_Port_Number()
-return [(self.GetCurrentLocation(), port)]
+addr = self.ModbusServerNode.getLocal_IP_Address()
+return [(self.GetCurrentLocation(), addr, port)]
+def GetConfigName(self):
+""" Return the node's Configuration_Name """
+return self.ModbusServerNode.getConfiguration_Name()
 def CTNGenerate_C(self, buildpath, locations):
 """
 Generate C code
 @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)
 # Return the number of (modbus library) nodes this specific RTU client will need
 #   return type: (tcp nodes, rtu nodes, ascii nodes)
 def GetNodeCount(self):
 return (0, 1, 0)
+def GetConfigName(self):
+""" Return the node's Configuration_Name """
+return self.ModbusRTUclient.getConfiguration_Name()
 def CTNGenerate_C(self, buildpath, locations):
 """
 Generate C code
 @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)
 @param locations: List of complete variables locations \
 # Return the number of (modbus library) nodes this specific RTU slave will need
 #   return type: (tcp nodes, rtu nodes, ascii nodes)
 def GetNodeCount(self):
 return (0, 1, 0)
+def GetConfigName(self):
+""" Return the node's Configuration_Name """
+return self.ModbusRTUslave.getConfiguration_Name()
 def CTNGenerate_C(self, buildpath, locations):
 """
 Generate C code
 @param current_location: Tupple containing plugin IEC location : %I0.0.4.5 => (0,0,4,5)
 @param locations: List of complete variables locations \
 # ask each child how many nodes it needs, and add them all up.
 total_node_count = tuple(
 x1 + x2 for x1, x2 in zip(total_node_count, child.GetNodeCount()))
 return total_node_count
-# Return a list with tuples of the (location, port numbers) used by all
+# Return a list with tuples of the (location, port numbers) used by all the Modbus/IP servers
-# the Modbus/IP servers
 def GetIPServerPortNumbers(self):
 IPServer_port_numbers = []
 for child in self.IECSortedChildren():
 if child.CTNType == "ModbusTCPserver":
 IPServer_port_numbers.extend(child.GetIPServerPortNumbers())
 return IPServer_port_numbers
+# Return a list with tuples of the (location, configuration_name) used by all the Modbus nodes (tcp/rtu, clients/servers)
+def GetConfigNames(self):
+Node_Configuration_Names = []
+for child in self.IECSortedChildren():
+Node_Configuration_Names.extend([(child.GetCurrentLocation(), child.GetConfigName())])
+return Node_Configuration_Names
 def CTNGenerate_C(self, buildpath, locations):
 # print "#############"
 # print self.__class__
 # print type(self)
 loc_dict = {"locstr": "_".join(map(str, self.GetCurrentLocation()))}
 # Determine the number of (modbus library) nodes ALL instances of the modbus plugin will need
 #   total_node_count: (tcp nodes, rtu nodes, ascii nodes)
-# Also get a list with tuples of (location, IP port numbers) used by all the Modbus/IP server nodes
+#
+# Also get a list with tuples of (location, IP address, port number) used by all the Modbus/IP server nodes
 #   This list is later used to search for duplicates in port numbers!
-#   IPServer_port_numbers = [(location ,IPserver_port_number), ...]
+#   IPServer_port_numbers = [(location, IP address, port number), ...]
-#       location: tuple similar to (0, 3, 1) representing the location in the configuration tree "0.3.1.x"
+#       location            : tuple similar to (0, 3, 1) representing the location in the configuration tree "0.3.1.x"
-# IPserver_port_number: a number (i.e. port number used by the
+#       IPserver_port_number: a number (i.e. port number used by the Modbus/IP server)
-# Modbus/IP server)
+#       IP address          : IP address of the network interface on which the server will be listening
+#                             ("", "*", or "#ANY#" => listening on all interfaces!)
+#
+# Also get a list with tuples of (location, Configuration_Name) used by all the Modbus nodes
+#   This list is later used to search for duplicates in Configuration Names!
+#   Node_Configuration_Names = [(location, Configuration_Name), ...]
+#       location          : tuple similar to (0, 3, 1) representing the location in the configuration tree "0.3.1.x"
+#       Configuration_Name: the "Configuration_Name" string
 total_node_count = (0, 0, 0)
-IPServer_port_numbers = []
+IPServer_port_numbers    = []
+Node_Configuration_Names = []
 for CTNInstance in self.GetCTRoot().IterChildren():
 if CTNInstance.CTNType == "modbus":
-# ask each modbus plugin instance how many nodes it needs, and
+# ask each modbus plugin instance how many nodes it needs, and add them all up.
-# add them all up.
+total_node_count = tuple(x1 + x2 for x1, x2 in zip(total_node_count, CTNInstance.GetNodeCount()))
-total_node_count = tuple(x1 + x2 for x1, x2 in zip(
+IPServer_port_numbers.   extend(CTNInstance.GetIPServerPortNumbers())
-total_node_count, CTNInstance.GetNodeCount()))
+Node_Configuration_Names.extend(CTNInstance.GetConfigNames        ())
-IPServer_port_numbers.extend(
-CTNInstance.GetIPServerPortNumbers())
+# Search for use of duplicate Configuration_Names by Modbus nodes
+# Configuration Names are used by the web server running on the PLC
+# (more precisely, run by Beremiz_service.py) to identify and allow
+# changing the Modbus parameters after the program has been downloaded
+# to the PLC (but before it is started)
+# With clashes in the configuration names, the Modbus nodes will not be
+# distinguasheble on the web interface!
+for i in range(0, len(Node_Configuration_Names) - 1):
+for j in range(i + 1, len(Node_Configuration_Names)):
+if Node_Configuration_Names[i][1] == Node_Configuration_Names[j][1]:
+error_message = _("Error: Modbus plugin nodes %{a1}.x and %{a2}.x use the same Configuration_Name \"{a3}\".\n").format(
+a1=_lt_to_str(Node_Configuration_Names[i][0]),
+a2=_lt_to_str(Node_Configuration_Names[j][0]),
+a3=Node_Configuration_Names[j][1])
+self.FatalError(error_message)
 # Search for use of duplicate port numbers by Modbus/IP servers
-# print IPServer_port_numbers
+# Note: We only consider duplicate port numbers if using the same network interface!
-# ..but first define a lambda function to convert a tuple with the config tree location to a nice looking string
+i = 0
-#   for e.g., convert the tuple (0, 3, 4) to "0.3.4"
+for loc1, addr1, port1 in IPServer_port_numbers[:-1]:
+i = i + 1
-for i in range(0, len(IPServer_port_numbers) - 1):
+for loc2, addr2, port2 in IPServer_port_numbers[i:]:
-for j in range(i + 1, len(IPServer_port_numbers)):
+if (port1 == port2) and (
-if IPServer_port_numbers[i][1] == IPServer_port_numbers[j][1]:
+(addr1 == addr2)   # on the same network interface
-error_message = _("Error: Modbus/IP Servers %{a1}.x and %{a2}.x use the same port number {a3}.\n").format(
+or (addr1 == "") or (addr1 == "*") or (addr1 == "#ANY#") # or one (or both) of the servers
-a1=_lt_to_str(IPServer_port_numbers[i][0]),
+or (addr2 == "") or (addr2 == "*") or (addr2 == "#ANY#") # use all available network interfaces
-a2=_lt_to_str(IPServer_port_numbers[j][0]),
+):
-a3=IPServer_port_numbers[j][1])
+error_message = _("Error: Modbus plugin nodes %{a1}.x and %{a2}.x use same port number \"{a3}\" " +
+"on the same (or overlapping) network interfaces \"{a4}\" and \"{a5}\".\n").format(
+a1=_lt_to_str(loc1), a2=_lt_to_str(loc2), a3=port1, a4=addr1, a5=addr2)
 self.FatalError(error_message)
-#self.GetCTRoot().logger.write_warning(error_message)
-#raise Exception
 # Determine the current location in Beremiz's project configuration
 # tree
 current_location = self.GetCurrentLocation()

changeset 2668	cca3e5d7d6f3
parent 2663	54f5b8e5c8d2
child 2669	be233279d179
child 2713	680ea4684209