1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz

     5

#

     6

# Copyright (C) 2011-2014: Laurent BESSARD, Edouard TISSERANT

     7

#                          RTES Lab : CRKim, JBLee, youcu

     8

#                          Higen Motor : Donggu Kang

     9

#

    10

# See COPYING file for copyrights details.

    11

    12

import os

    13

    14

import wx

    15

    16

from PLCControler import LOCATION_CONFNODE, LOCATION_MODULE, LOCATION_GROUP, LOCATION_VAR_INPUT, LOCATION_VAR_OUTPUT, LOCATION_VAR_MEMORY

    17

    18

from MotionLibrary import Headers, AxisXSD

    19

from EthercatSlave import _EthercatSlaveCTN, _CommonSlave

    20

from ConfigEditor import CIA402NodeEditor

    21

    22

# Definition of node variables that have to be mapped in PDO

    23

# [(name, index, subindex, type,

    24

#   direction for master ('I': input, 'Q': output)),...]

    25

NODE_VARIABLES = [

    26

    ("ControlWord",             0x6040, 0x00, "UINT", "Q"),

    27

    ("TargetPosition",          0x607a, 0x00, "DINT", "Q"),

    28

    ("TargetVelocity",          0x60ff, 0x00, "DINT", "Q"),

    29

    ("TargetTorque",            0x6071, 0x00, "INT",  "Q"),

    30

    ("ModesOfOperation",        0x6060, 0x00, "SINT", "Q"),

    31

    ("StatusWord",              0x6041, 0x00, "UINT", "I"),

    32

    ("ModesOfOperationDisplay", 0x6061, 0x00, "SINT", "I"),

    33

    ("ActualPosition",          0x6064, 0x00, "DINT", "I"),

    34

    ("ActualVelocity",          0x606c, 0x00, "DINT", "I"),

    35

    ("ActualTorque",            0x6077, 0x00, "INT",  "I"),

    36

]

    37

    38

# Definition of optional node variables that can be added to PDO mapping.

    39

# A checkbox will be displayed for each section in node configuration panel to

    40

# enable them

    41

# [(section_name,

    42

#   [{'description', (name, index, subindex, type,

    43

#                     direction for master ('I': input, 'Q': output)),

    44

#     'retrieve', string_template_for_retrieve_variable (None: not retrieved,

    45

#                                 default string template if not defined),

    46

#     'publish', string_template_for_publish_variable (None: not published,

    47

#                                 default string template if not defined),

    48

#    },...]

    49

EXTRA_NODE_VARIABLES = [

    50

    ("ErrorCode", [

    51

        {"description": ("ErrorCode", 0x603F, 0x00, "UINT", "I"),

    52

         "publish": None}

    53

        ]),

    54

    ("DigitalInputs", [

    55

        {"description": ("DigitalInputs", 0x60FD, 0x00, "UDINT", "I"),

    56

         "publish": None}

    57

        ]),

    58

    ("DigitalOutputs", [

    59

        {"description": ("DigitalOutputs", 0x60FE, 0x00, "UDINT", "Q"),

    60

         "retrieve": None}

    61

        ]),

    62

    ("TouchProbe", [

    63

        {"description": ("TouchProbeFunction", 0x60B8, 0x00, "UINT", "Q"),

    64

         "retrieve": None},

    65

        {"description": ("TouchProbeStatus", 0x60B9, 0x00, "UINT", "I"),

    66

         "publish": None},

    67

        {"description": ("TouchProbePos1PosValue", 0x60BA, 0x00, "DINT", "I"),

    68

         "publish": None},

    69

        {"description": ("TouchProbePos1NegValue", 0x60BB, 0x00, "DINT", "I"),

    70

         "publish": None},

    71

        ]),

    72

]

    73

    74

# List of parameters name in no configuration panel for optional variable

    75

# sections

    76

EXTRA_NODE_VARIABLES_DICT = {

    77

    "Enable" + name: params

    78

    for name, params in EXTRA_NODE_VARIABLES}

    79

    80

# List of block to define to interface MCL to fieldbus for specific functions

    81

FIELDBUS_INTERFACE_GLOBAL_INSTANCES = [

    82

    {"blocktype": "GetTorqueLimit",

    83

     "inputs": [],

    84

     "outputs": [{"name": "TorqueLimitPos", "type": "UINT"},

    85

                 {"name": "TorqueLimitNeg", "type": "UINT"}]},

    86

    {"blocktype": "SetTorqueLimit",

    87

     "inputs": [{"name": "TorqueLimitPos", "type": "UINT"},

    88

                {"name": "TorqueLimitNeg", "type": "UINT"}],

    89

     "outputs": []},

    90

]

    91

    92

# --------------------------------------------------

    93

#                 Ethercat CIA402 Node

    94

# --------------------------------------------------

    95

    96

    97

class _EthercatCIA402SlaveCTN(_EthercatSlaveCTN):

    98

    XSD = """<?xml version="1.0" encoding="ISO-8859-1" ?>

    99

    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

   100

      <xsd:element name="CIA402SlaveParams">

   101

        <xsd:complexType>

   102

          %s

   103

        </xsd:complexType>

   104

      </xsd:element>

   105

    </xsd:schema>

   106

    """ % ("\n".join(["""\

   107

          <xsd:attribute name="Enable%s" type="xsd:boolean"

   108

                         use="optional" default="false"/>""" % category

   109

                for category, variables in EXTRA_NODE_VARIABLES]) + AxisXSD)

   110

   111

    NODE_PROFILE = 402

   112

    EditorType = CIA402NodeEditor

   113

   114

    ConfNodeMethods = [

   115

        {"bitmap" : "CIA402AxisRef",

   116

         "name" : _("Axis Ref"),

   117

         "tooltip" : _("Initiate Drag'n drop of Axis ref located variable"),

   118

         "method" : "_getCIA402AxisRef",

   119

         "push": True},

   120

        {"bitmap" : "CIA402NetPos",

   121

         "name" : _("Axis Pos"),

   122

         "tooltip" : _("Initiate Drag'n drop of Network position located variable"),

   123

         "method" : "_getCIA402NetworkPosition",

   124

         "push": True},

   125

    ]

   126

   127

# --------------------------------------------------

   128

#    class code

   129

# --------------------------------------------------

   130

   131

    def __init__(self):

   132

        # ----------- call ethercat mng. function --------------

   133

        self.CommonMethod = _CommonSlave(self)

   134

   135

    def GetIconName(self):

   136

        return "CIA402Slave"

   137

   138

    def SetParamsAttribute(self, path, value):

   139

        if path == "CIA402SlaveParams.Type":

   140

            path = "SlaveParams.Type"

   141

        elif path == "CIA402SlaveParams.Alias":

   142

            path = "SlaveParams.Alias"

   143

        return _EthercatSlaveCTN.SetParamsAttribute(self, path, value)

   144

   145

    def GetVariableLocationTree(self):

   146

        axis_name = self.CTNName()

   147

        current_location = self.GetCurrentLocation()

   148

        children = [{"name": name_frmt % (axis_name),

   149

                     "type": LOCATION_VAR_INPUT,

   150

                     "size": "W",

   151

                     "IEC_type": iec_type,

   152

                     "var_name": var_name_frmt % axis_name,

   153

                     "location": location_frmt % (

   154

                            ".".join(map(str, current_location))),

   155

                     "description": "",

   156

                     "children": []}

   157

                    for name_frmt, iec_type, var_name_frmt, location_frmt in

   158

                        [("%s Network Position", "UINT", "%s_pos", "%%IW%s"),

   159

                         ("%s Axis Ref", "AXIS_REF", "%s", "%%IW%s.402")]]

   160

        children.extend(self.CTNParent.GetDeviceLocationTree(

   161

                            self.GetSlavePos(), current_location, axis_name))

   162

        return {

   163

            "name": axis_name,

   164

            "type": LOCATION_CONFNODE,

   165

            "location": self.GetFullIEC_Channel(),

   166

            "children": children,

   167

        }

   168

   169

    def CTNGlobalInstances(self):

   170

        current_location = self.GetCurrentLocation()

   171

        return [("%s_%s" % (block_infos["blocktype"],

   172

                            "_".join(map(str, current_location))),

   173

                 "EtherLab%s" % block_infos["blocktype"], "")

   174

                for block_infos in FIELDBUS_INTERFACE_GLOBAL_INSTANCES]

   175

   176

    def StartDragNDrop(self, data):

   177

        data_obj = wx.TextDataObject(str(data))

   178

        dragSource = wx.DropSource(self.GetCTRoot().AppFrame)

   179

        dragSource.SetData(data_obj)

   180

        dragSource.DoDragDrop()

   181

   182

    def _getCIA402NetworkPosition(self):

   183

        self.StartDragNDrop(

   184

            ("%%IW%s" % ".".join(map(str, self.GetCurrentLocation())),

   185

             "location", "UINT", self.CTNName() + "_Pos", ""))

   186

   187

    def _getCIA402AxisRef(self):

   188

        self.StartDragNDrop(

   189

            ("%%IW%s.402" % ".".join(map(str, self.GetCurrentLocation())),

   190

             "location", "AXIS_REF", self.CTNName(), ""))

   191

   192

    def CTNGenerate_C(self, buildpath, locations):

   193

        current_location = self.GetCurrentLocation()

   194

   196

        slave_pos = self.GetSlavePos()

   197

        MCL_headers = Headers

   198

   199

        # Open CIA402 node code template file

   200

        plc_cia402node_filepath = os.path.join(os.path.split(__file__)[0],

   201

                                               "plc_cia402node.c")

   202

        plc_cia402node_file = open(plc_cia402node_filepath, 'r')

   203

        plc_cia402node_code = plc_cia402node_file.read()

   204

        plc_cia402node_file.close()

   205

   206

        # Init list of generated strings for each code template file section

   207

        fieldbus_interface_declaration = []

   208

        fieldbus_interface_definition = []

   209

        init_axis_params = []

   210

        extra_variables_retrieve = []

   211

        extra_variables_publish = []

   212

        extern_located_variables_declaration = []

   213

        entry_variables = []

   214

        init_entry_variables = []

   215

   216

        # Fieldbus interface code sections

   217

        for blocktype_infos in FIELDBUS_INTERFACE_GLOBAL_INSTANCES:

   218

            blocktype = blocktype_infos["blocktype"]

   219

            ucase_blocktype = blocktype.upper()

   220

            blockname = "_".join([ucase_blocktype, location_str])

   221

   222

            extract_inputs = "\n".join(["""\

   223

    __SET_VAR(%s->, %s,, %s);""" % (blockname, input_name, input_value)

   224

                for (input_name, input_value) in [

   225

                    ("EXECUTE", "__GET_VAR(data__->EXECUTE)")] + [

   226

                    (input["name"].upper(),

   227

                     "__GET_VAR(data__->%s)" % input["name"].upper())

   228

                    for input in blocktype_infos["inputs"]]

   229

                ])

   230

   231

   232

            return_outputs = "\n".join(["""\

   233

    __SET_VAR(data__->,%(output_name)s,,

   234

              __GET_VAR(%(blockname)s->%(output_name)s));""" % locals()

   235

                    for output_name in ["DONE", "BUSY", "ERROR"] + [

   236

                        output["name"].upper()

   237

                        for output in blocktype_infos["outputs"]]

   238

                ])

   239

   240

            fieldbus_interface_declaration.append("""

   241

extern void ETHERLAB%(ucase_blocktype)s_body__(ETHERLAB%(ucase_blocktype)s* data__);

   242

void __%(blocktype)s_%(location_str)s(MC_%(ucase_blocktype)s *data__) {

   243

__DECLARE_GLOBAL_PROTOTYPE(ETHERLAB%(ucase_blocktype)s, %(blockname)s);

   244

ETHERLAB%(ucase_blocktype)s* %(blockname)s = __GET_GLOBAL_%(blockname)s();

   245

__SET_VAR(%(blockname)s->, POS,, AxsPub.axis->NetworkPosition);

   246

%(extract_inputs)s

   247

ETHERLAB%(ucase_blocktype)s_body__(%(blockname)s);

   248

%(return_outputs)s

   249

}""" % locals())

   250

   251

            fieldbus_interface_definition.append("""\

   252

        AxsPub.axis->__mcl_func_MC_%(blocktype)s = __%(blocktype)s_%(location_str)s;\

   253

""" % locals())

   254

   255

        # Get a copy list of default variables to map

   256

        variables = NODE_VARIABLES[:]

   257

   258

        # Set AxisRef public struct members value

   259

        node_params = self.CTNParams[1].getElementInfos(self.CTNParams[0])

   260

        for param in node_params["children"]:

   261

            param_name = param["name"]

   262

   263

            # Param is optional variables section enable flag

   264

            extra_node_variable_infos = EXTRA_NODE_VARIABLES_DICT.get(param_name)

   265

            if extra_node_variable_infos is not None:

   266

                param_name = param_name.replace("Enable", "") + "Enabled"

   267

   268

                if not param["value"]:

   269

                    continue

   270

   271

                # Optional variables section is enabled

   272

                for variable_infos in extra_node_variable_infos:

   273

                    var_name = variable_infos["description"][0]

   274

   275

                    # Add each variables defined in section description to the

   276

                    # list of variables to map

   277

                    variables.append(variable_infos["description"])

   278

   279

                    # Add code to publish or retrive variable

   280

                    for var_exchange_dir, str_list, default_template in [

   281

                         ("retrieve", extra_variables_retrieve,

   282

                          "    AxsPub.axis->%(var_name)s = *(AxsPub.%(var_name)s);"),

   283

                         ("publish", extra_variables_publish,

   284

                          "    *(AxsPub.%(var_name)s) = AxsPub.axis->%(var_name)s;")]:

   285

   286

                        template = variable_infos.get(var_exchange_dir,

   287

                                                      default_template)

   288

                        if template is not None:

   289

                            extra_variables_publish.append(template % locals())

   290

   291

            # Set AxisRef public struct member value if defined

   292

            if param["value"] is not None:

   293

                param_value = ({True: "1", False: "0"}[param["value"]]

   294

                               if param["type"] == "boolean"

   295

                               else str(param["value"]))

   296

   297

                init_axis_params.append("""\

   298

        AxsPub.axis->%(param_name)s = %(param_value)s;""" % locals())

   299

   300

        # Add each variable in list of variables to map to master list of

   301

        # variables to add to network configuration

   302

        for name, index, subindex, var_type, dir in variables:

   303

            var_size = self.GetSizeOfType(var_type)

   304

            var_name = """\

   305

__%(dir)s%(var_size)s%(location_str)s_%(index)d_%(subindex)d""" % locals()

   306

   307

            extern_located_variables_declaration.append(

   308

                    "IEC_%(var_type)s *%(var_name)s;" % locals())

   309

            entry_variables.append(

   310

                    "    IEC_%(var_type)s *%(name)s;" % locals())

   311

            init_entry_variables.append(

   312

                    "    AxsPub.%(name)s = %(var_name)s;" % locals())

   313

   314

            self.CTNParent.FileGenerator.DeclareVariable(

   315

                    slave_pos, index, subindex, var_type, dir, var_name)

   316

   317

        # Add newline between string in list of generated strings for sections

   318

        [fieldbus_interface_declaration, fieldbus_interface_definition,

   319

         init_axis_params, extra_variables_retrieve, extra_variables_publish,

   320

         extern_located_variables_declaration, entry_variables,

   321

         init_entry_variables] = map(lambda l: "\n".join(l), [

   322

            fieldbus_interface_declaration, fieldbus_interface_definition,

   323

            init_axis_params, extra_variables_retrieve, extra_variables_publish,

   324

            extern_located_variables_declaration, entry_variables,

   325

            init_entry_variables])

   326

   327

        # Write generated content to CIA402 node file

   328

        Gen_CIA402Nodefile_path = os.path.join(buildpath,

   329

                                "cia402node_%s.c" % location_str)

   330

        cia402nodefile = open(Gen_CIA402Nodefile_path, 'w')

   331

        cia402nodefile.write(plc_cia402node_code % locals())

   332

        cia402nodefile.close()

   333