edouard@2165: #!/usr/bin/env python
edouard@2165: # -*- coding: utf-8 -*-
edouard@2165:
edouard@2165: # This file is part of Beremiz
edouard@2165: #
edouard@2165: # Copyright (C) 2011-2014: Laurent BESSARD, Edouard TISSERANT
edouard@2165: # RTES Lab : CRKim, JBLee, youcu
edouard@2165: # Higen Motor : Donggu Kang
edouard@2165: #
edouard@2165: # See COPYING file for copyrights details.
edouard@2165:
Laurent@2111: import os
Laurent@2111:
Laurent@2111: import wx
Laurent@2111:
Laurent@2111: from PLCControler import LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY
Laurent@2111:
Laurent@2111: from MotionLibrary import Headers, AxisXSD
Edouard@2152: from EthercatSlave import _EthercatSlaveCTN, _CommonSlave
Laurent@2111: from ConfigEditor import CIA402NodeEditor
Laurent@2111:
Laurent@2153: # Definition of node variables that have to be mapped in PDO
Laurent@2153: # [(name, index, subindex, type,
Laurent@2153: # direction for master ('I': input, 'Q': output)),...]
Laurent@2111: NODE_VARIABLES = [
Laurent@2153: ("ControlWord", 0x6040, 0x00, "UINT", "Q"),
Laurent@2153: ("TargetPosition", 0x607a, 0x00, "DINT", "Q"),
Laurent@2153: ("TargetVelocity", 0x60ff, 0x00, "DINT", "Q"),
Laurent@2153: ("TargetTorque", 0x6071, 0x00, "INT", "Q"),
Laurent@2153: ("ModesOfOperation", 0x6060, 0x00, "SINT", "Q"),
Laurent@2153: ("StatusWord", 0x6041, 0x00, "UINT", "I"),
Laurent@2153: ("ModesOfOperationDisplay", 0x6061, 0x00, "SINT", "I"),
Laurent@2153: ("ActualPosition", 0x6064, 0x00, "DINT", "I"),
Laurent@2153: ("ActualVelocity", 0x606c, 0x00, "DINT", "I"),
Laurent@2153: ("ActualTorque", 0x6077, 0x00, "INT", "I"),
Laurent@2111: ]
Laurent@2111:
Laurent@2153: # Definition of optional node variables that can be added to PDO mapping.
Laurent@2153: # A checkbox will be displayed for each section in node configuration panel to
Laurent@2153: # enable them
Laurent@2153: # [(section_name,
Laurent@2153: # [{'description', (name, index, subindex, type,
Laurent@2153: # direction for master ('I': input, 'Q': output)),
Laurent@2153: # 'retrieve', string_template_for_retrieve_variable (None: not retrieved,
Laurent@2153: # default string template if not defined),
Laurent@2153: # 'publish', string_template_for_publish_variable (None: not published,
Laurent@2153: # default string template if not defined),
Laurent@2153: # },...]
Laurent@2111: EXTRA_NODE_VARIABLES = [
Laurent@2111: ("ErrorCode", [
Laurent@2111: {"description": ("ErrorCode", 0x603F, 0x00, "UINT", "I"),
Laurent@2111: "publish": None}
Laurent@2111: ]),
Laurent@2111: ("DigitalInputs", [
Laurent@2111: {"description": ("DigitalInputs", 0x60FD, 0x00, "UDINT", "I"),
Laurent@2111: "publish": None}
Laurent@2111: ]),
Laurent@2111: ("DigitalOutputs", [
Laurent@2111: {"description": ("DigitalOutputs", 0x60FE, 0x00, "UDINT", "Q"),
Laurent@2111: "retrieve": None}
Laurent@2146: ]),
Laurent@2146: ("TouchProbe", [
Laurent@2146: {"description": ("TouchProbeFunction", 0x60B8, 0x00, "UINT", "Q"),
Laurent@2146: "retrieve": None},
Laurent@2146: {"description": ("TouchProbeStatus", 0x60B9, 0x00, "UINT", "I"),
Laurent@2146: "publish": None},
Laurent@2146: {"description": ("TouchProbePos1PosValue", 0x60BA, 0x00, "DINT", "I"),
Laurent@2146: "publish": None},
Laurent@2146: {"description": ("TouchProbePos1NegValue", 0x60BB, 0x00, "DINT", "I"),
Laurent@2146: "publish": None},
Laurent@2146: ]),
Laurent@2111: ]
Laurent@2153:
Laurent@2153: # List of parameters name in no configuration panel for optional variable
Laurent@2153: # sections
Laurent@2153: EXTRA_NODE_VARIABLES_DICT = {
Laurent@2153: "Enable" + name: params
Laurent@2153: for name, params in EXTRA_NODE_VARIABLES}
Laurent@2153:
Laurent@2153: # List of block to define to interface MCL to fieldbus for specific functions
Laurent@2153: FIELDBUS_INTERFACE_GLOBAL_INSTANCES = [
Laurent@2111: {"blocktype": "GetTorqueLimit",
Laurent@2111: "inputs": [],
Laurent@2111: "outputs": [{"name": "TorqueLimitPos", "type": "UINT"},
Laurent@2111: {"name": "TorqueLimitNeg", "type": "UINT"}]},
Laurent@2111: {"blocktype": "SetTorqueLimit",
Laurent@2111: "inputs": [{"name": "TorqueLimitPos", "type": "UINT"},
Laurent@2111: {"name": "TorqueLimitNeg", "type": "UINT"}],
Laurent@2111: "outputs": []},
Laurent@2111: ]
Laurent@2111:
Laurent@2111: #--------------------------------------------------
Laurent@2111: # Ethercat CIA402 Node
Laurent@2111: #--------------------------------------------------
Laurent@2111:
Laurent@2111: class _EthercatCIA402SlaveCTN(_EthercatSlaveCTN):
Laurent@2111: XSD = """
Laurent@2111:
Laurent@2111:
Laurent@2111:
Laurent@2111: %s
Laurent@2111:
Laurent@2111:
Laurent@2111:
Laurent@2153: """ % ("\n".join(["""\
Laurent@2153: """ % category
Laurent@2153: for category, variables in EXTRA_NODE_VARIABLES]) + AxisXSD)
Laurent@2111:
Laurent@2111: NODE_PROFILE = 402
Laurent@2111: EditorType = CIA402NodeEditor
Laurent@2111:
Laurent@2111: ConfNodeMethods = [
Laurent@2111: {"bitmap" : "CIA402AxisRef",
Laurent@2111: "name" : _("Axis Ref"),
Laurent@2111: "tooltip" : _("Initiate Drag'n drop of Axis ref located variable"),
Laurent@2111: "method" : "_getCIA402AxisRef",
Laurent@2111: "push": True},
Laurent@2154: {"bitmap" : "CIA402NetPos",
Laurent@2154: "name" : _("Axis Pos"),
Laurent@2154: "tooltip" : _("Initiate Drag'n drop of Network position located variable"),
Laurent@2154: "method" : "_getCIA402NetworkPosition",
Laurent@2154: "push": True},
Laurent@2153: ]
Edouard@2152:
Edouard@2152: #--------------------------------------------------
Edouard@2152: # class code
Edouard@2152: #--------------------------------------------------
Edouard@2152:
Edouard@2152: def __init__(self):
Edouard@2152: # ----------- call ethercat mng. function --------------
Edouard@2152: self.CommonMethod = _CommonSlave(self)
Laurent@2111:
Laurent@2111: def GetIconName(self):
Laurent@2111: return "CIA402Slave"
Laurent@2111:
Laurent@2111: def SetParamsAttribute(self, path, value):
Laurent@2111: if path == "CIA402SlaveParams.Type":
Laurent@2111: path = "SlaveParams.Type"
Laurent@2111: elif path == "CIA402SlaveParams.Alias":
Laurent@2111: path = "SlaveParams.Alias"
Laurent@2111: return _EthercatSlaveCTN.SetParamsAttribute(self, path, value)
Laurent@2111:
Laurent@2111: def GetVariableLocationTree(self):
Laurent@2111: axis_name = self.CTNName()
Laurent@2111: current_location = self.GetCurrentLocation()
Laurent@2155: children = [{"name": name_frmt % (axis_name),
Laurent@2154: "type": LOCATION_VAR_INPUT,
Laurent@2154: "size": "W",
Laurent@2155: "IEC_type": iec_type,
Laurent@2155: "var_name": var_name_frmt % axis_name,
Laurent@2155: "location": location_frmt % (
Laurent@2155: ".".join(map(str, current_location))),
Laurent@2154: "description": "",
Laurent@2155: "children": []}
Laurent@2155: for name_frmt, iec_type, var_name_frmt, location_frmt in
Laurent@2155: [("%s Network Position", "UINT", "%s_pos", "%%IW%s"),
Laurent@2155: ("%s Axis Ref", "AXIS_REF", "%s", "%%IW%s.402")]]
Laurent@2155: children.extend(self.CTNParent.GetDeviceLocationTree(
Laurent@2155: self.GetSlavePos(), current_location, axis_name))
Laurent@2111: return {"name": axis_name,
Laurent@2111: "type": LOCATION_CONFNODE,
Laurent@2111: "location": self.GetFullIEC_Channel(),
Laurent@2111: "children": children,
Laurent@2111: }
Laurent@2111:
Laurent@2111: def CTNGlobalInstances(self):
Laurent@2111: current_location = self.GetCurrentLocation()
Laurent@2153: return [("%s_%s" % (block_infos["blocktype"],
Laurent@2153: "_".join(map(str, current_location))),
Laurent@2153: "EtherLab%s" % block_infos["blocktype"], "")
Laurent@2153: for block_infos in FIELDBUS_INTERFACE_GLOBAL_INSTANCES]
Laurent@2111:
Laurent@2154: def StartDragNDrop(self, data):
Laurent@2154: data_obj = wx.TextDataObject(str(data))
Laurent@2154: dragSource = wx.DropSource(self.GetCTRoot().AppFrame)
Laurent@2154: dragSource.SetData(data_obj)
Laurent@2154: dragSource.DoDragDrop()
Laurent@2154:
Laurent@2154: def _getCIA402NetworkPosition(self):
Laurent@2154: self.StartDragNDrop(
Laurent@2154: ("%%IW%s" % ".".join(map(str, self.GetCurrentLocation())),
Laurent@2154: "location", "UINT", self.CTNName() + "_Pos", ""))
Laurent@2154:
Laurent@2111: def _getCIA402AxisRef(self):
Laurent@2154: self.StartDragNDrop(
Laurent@2154: ("%%IW%s.402" % ".".join(map(str, self.GetCurrentLocation())),
Laurent@2154: "location", "AXIS_REF", self.CTNName(), ""))
Laurent@2154:
Laurent@2111: def CTNGenerate_C(self, buildpath, locations):
Laurent@2111: current_location = self.GetCurrentLocation()
Laurent@2111:
Laurent@2111: location_str = "_".join(map(lambda x:str(x), current_location))
Laurent@2153: slave_pos = self.GetSlavePos()
Laurent@2153: MCL_headers = Headers
Laurent@2153:
Laurent@2153: # Open CIA402 node code template file
Laurent@2153: plc_cia402node_filepath = os.path.join(os.path.split(__file__)[0],
Laurent@2153: "plc_cia402node.c")
Laurent@2111: plc_cia402node_file = open(plc_cia402node_filepath, 'r')
Laurent@2111: plc_cia402node_code = plc_cia402node_file.read()
Laurent@2111: plc_cia402node_file.close()
Laurent@2111:
Laurent@2153: # Init list of generated strings for each code template file section
Laurent@2153: fieldbus_interface_declaration = []
Laurent@2153: fieldbus_interface_definition = []
Laurent@2153: init_axis_params = []
Laurent@2153: extra_variables_retrieve = []
Laurent@2153: extra_variables_publish = []
Laurent@2153: extern_located_variables_declaration = []
Laurent@2153: entry_variables = []
Laurent@2153: init_entry_variables = []
Laurent@2153:
Laurent@2153: # Fieldbus interface code sections
Laurent@2153: for blocktype_infos in FIELDBUS_INTERFACE_GLOBAL_INSTANCES:
Laurent@2153: blocktype = blocktype_infos["blocktype"]
Laurent@2153: ucase_blocktype = blocktype.upper()
Laurent@2153: blockname = "_".join([ucase_blocktype, location_str])
Laurent@2153:
Laurent@2153: extract_inputs = "\n".join(["""\
Edouard@2164: __SET_VAR(%s->, %s,, %s);""" % (blockname, input_name, input_value)
Laurent@2153: for (input_name, input_value) in [
Laurent@2153: ("EXECUTE", "__GET_VAR(data__->EXECUTE)")] + [
Laurent@2153: (input["name"].upper(),
Laurent@2153: "__GET_VAR(data__->%s)" % input["name"].upper())
Laurent@2153: for input in blocktype_infos["inputs"]]
Laurent@2153: ])
Laurent@2153:
Laurent@2153:
Laurent@2153: return_outputs = "\n".join(["""\
Edouard@2164: __SET_VAR(data__->,%(output_name)s,,
Laurent@2153: __GET_VAR(%(blockname)s->%(output_name)s));""" % locals()
Laurent@2153: for output_name in ["DONE", "BUSY", "ERROR"] + [
Laurent@2153: output["name"].upper()
Laurent@2153: for output in blocktype_infos["outputs"]]
Laurent@2153: ])
Laurent@2153:
Laurent@2153: fieldbus_interface_declaration.append("""
Laurent@2153: extern void ETHERLAB%(ucase_blocktype)s_body__(ETHERLAB%(ucase_blocktype)s* data__);
Laurent@2153: void __%(blocktype)s_%(location_str)s(MC_%(ucase_blocktype)s *data__) {
Laurent@2153: __DECLARE_GLOBAL_PROTOTYPE(ETHERLAB%(ucase_blocktype)s, %(blockname)s);
Laurent@2153: ETHERLAB%(ucase_blocktype)s* %(blockname)s = __GET_GLOBAL_%(blockname)s();
Edouard@2164: __SET_VAR(%(blockname)s->, POS,, AxsPub.axis->NetworkPosition);
Laurent@2153: %(extract_inputs)s
Laurent@2153: ETHERLAB%(ucase_blocktype)s_body__(%(blockname)s);
Laurent@2153: %(return_outputs)s
Laurent@2153: }""" % locals())
Laurent@2153:
Laurent@2153: fieldbus_interface_definition.append("""\
Laurent@2153: AxsPub.axis->__mcl_func_MC_%(blocktype)s = __%(blocktype)s_%(location_str)s;\
Laurent@2153: """ % locals())
Laurent@2153:
Laurent@2153: # Get a copy list of default variables to map
Laurent@2111: variables = NODE_VARIABLES[:]
Laurent@2111:
Laurent@2153: # Set AxisRef public struct members value
Laurent@2153: node_params = self.CTNParams[1].getElementInfos(self.CTNParams[0])
Laurent@2153: for param in node_params["children"]:
Laurent@2153: param_name = param["name"]
Laurent@2153:
Laurent@2153: # Param is optional variables section enable flag
Laurent@2153: extra_node_variable_infos = EXTRA_NODE_VARIABLES_DICT.get(param_name)
Laurent@2153: if extra_node_variable_infos is not None:
Laurent@2156: param_name = param_name.replace("Enable", "") + "Enabled"
Laurent@2153:
Laurent@2153: if not param["value"]:
Laurent@2153: continue
Laurent@2153:
Laurent@2153: # Optional variables section is enabled
Laurent@2153: for variable_infos in extra_node_variable_infos:
Laurent@2153: var_name = variable_infos["description"][0]
Laurent@2153:
Laurent@2153: # Add each variables defined in section description to the
Laurent@2153: # list of variables to map
Laurent@2153: variables.append(variable_infos["description"])
Laurent@2153:
Laurent@2153: # Add code to publish or retrive variable
Laurent@2153: for var_exchange_dir, str_list, default_template in [
Laurent@2153: ("retrieve", extra_variables_retrieve,
Laurent@2153: " AxsPub.axis->%(var_name)s = *(AxsPub.%(var_name)s);"),
Laurent@2153: ("publish", extra_variables_publish,
Laurent@2153: " *(AxsPub.%(var_name)s) = AxsPub.axis->%(var_name)s;")]:
Laurent@2111:
Laurent@2153: template = variable_infos.get(var_exchange_dir,
Laurent@2153: default_template)
Laurent@2153: if template is not None:
Laurent@2153: extra_variables_publish.append(template % locals())
Laurent@2153:
Laurent@2153: # Set AxisRef public struct member value if defined
Laurent@2155: if param["value"] is not None:
Laurent@2153: param_value = ({True: "1", False: "0"}[param["value"]]
Laurent@2153: if param["type"] == "boolean"
Laurent@2153: else str(param["value"]))
Laurent@2153:
Laurent@2153: init_axis_params.append("""\
Laurent@2153: AxsPub.axis->%(param_name)s = %(param_value)s;""" % locals())
Laurent@2153:
Laurent@2153: # Add each variable in list of variables to map to master list of
Laurent@2153: # variables to add to network configuration
Laurent@2153: for name, index, subindex, var_type, dir in variables:
Laurent@2153: var_size = self.GetSizeOfType(var_type)
Laurent@2153: var_name = """\
Laurent@2153: __%(dir)s%(var_size)s%(location_str)s_%(index)d_%(subindex)d""" % locals()
Laurent@2153:
Laurent@2153: extern_located_variables_declaration.append(
Laurent@2153: "IEC_%(var_type)s *%(var_name)s;" % locals())
Laurent@2153: entry_variables.append(
Laurent@2153: " IEC_%(var_type)s *%(name)s;" % locals())
Laurent@2153: init_entry_variables.append(
Laurent@2153: " AxsPub.%(name)s = %(var_name)s;" % locals())
Laurent@2111:
Laurent@2111: self.CTNParent.FileGenerator.DeclareVariable(
Laurent@2153: slave_pos, index, subindex, var_type, dir, var_name)
Laurent@2153:
Laurent@2153: # Add newline between string in list of generated strings for sections
Laurent@2153: [fieldbus_interface_declaration, fieldbus_interface_definition,
Laurent@2153: init_axis_params, extra_variables_retrieve, extra_variables_publish,
Laurent@2153: extern_located_variables_declaration, entry_variables,
Laurent@2153: init_entry_variables] = map(lambda l: "\n".join(l), [
Laurent@2153: fieldbus_interface_declaration, fieldbus_interface_definition,
Laurent@2153: init_axis_params, extra_variables_retrieve, extra_variables_publish,
Laurent@2153: extern_located_variables_declaration, entry_variables,
Laurent@2153: init_entry_variables])
Laurent@2153:
Laurent@2153: # Write generated content to CIA402 node file
Laurent@2153: Gen_CIA402Nodefile_path = os.path.join(buildpath,
Laurent@2153: "cia402node_%s.c"%location_str)
Laurent@2111: cia402nodefile = open(Gen_CIA402Nodefile_path, 'w')
Laurent@2153: cia402nodefile.write(plc_cia402node_code % locals())
Laurent@2111: cia402nodefile.close()
Laurent@2111:
Laurent@2111: return [(Gen_CIA402Nodefile_path, '"-I%s"'%os.path.abspath(self.GetCTRoot().GetIECLibPath()))],"",True