1

/*****************************************************************************

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

 ****************************************************************************/

    29

    30

#include <iostream>

    31

#include <iomanip>

    32

#include <string.h>

    33

using namespace std;

    34

    35

#include "CommandXml.h"

    36

#include "MasterDevice.h"

    37

    38

/*****************************************************************************/

    39

    40

CommandXml::CommandXml():

    41

    Command("xml", "Generate slave information XML.")

    42

{

    43

}

    44

    45

/*****************************************************************************/

    46

    47

string CommandXml::helpString() const

    48

{

    49

    stringstream str;

    50

    51

    str << getName() << " [OPTIONS]" << endl

    52

        << endl

    53

        << getBriefDescription() << endl

    54

        << endl

    55

        << "Note that the PDO information can either originate" << endl

    56

        << "from the SII or from the CoE communication area. For" << endl

    57

        << "slaves, that support configuring PDO assignment and" << endl

    58

        << "mapping, the output depends on the last configuration." << endl

    59

        << endl

    60

        << "Command-specific options:" << endl

    61

        << "  --alias    -a <alias>" << endl

    62

        << "  --position -p <pos>    Slave selection. See the help of" << endl

    63

        << "                         the 'slaves' command." << endl

    64

        << endl

    65

        << numericInfo();

    66

    67

    return str.str();

    68

}

    69

    70

/****************************************************************************/

    71

    72

void CommandXml::execute(const StringVector &args)

    73

{

    75

    SlaveList slaves;

    76

    SlaveList::const_iterator si;

    77

    78

    if (args.size()) {

    79

        stringstream err;

    80

        err << "'" << getName() << "' takes no arguments!";

    81

        throwInvalidUsageException(err);

    82

    }

    83

    86

        stringstream err;

    87

        err << getName() << " requires to select a single master!";

    88

        throwInvalidUsageException(err);

    89

    }

    91

    m.open(MasterDevice::Read);

    92

    slaves = selectedSlaves(m);

    93

    94

    cout << "<?xml version=\"1.0\" ?>" << endl;

    95

    if (slaves.size() > 1) {

    96

        cout << "<EtherCATInfoList>" << endl;

    97

    }

    98

    99

    for (si = slaves.begin(); si != slaves.end(); si++) {

   100

        generateSlaveXml(m, *si, slaves.size() > 1 ? 1 : 0);

   101

    }

   102

   103

    if (slaves.size() > 1) {

   104

        cout << "</EtherCATInfoList>" << endl;

   105

    }

   106

}

   107

   108

/****************************************************************************/

   109

   110

void CommandXml::generateSlaveXml(

   111

        MasterDevice &m,

   112

        const ec_ioctl_slave_t &slave,

   113

        unsigned int indent

   114

        )

   115

{

   116

    ec_ioctl_slave_sync_t sync;

   117

    ec_ioctl_slave_sync_pdo_t pdo;

   118

    string pdoType, in;

   119

    ec_ioctl_slave_sync_pdo_entry_t entry;

   120

    unsigned int i, j, k;

   121

   122

    for (i = 0; i < indent; i++) {

   123

        in += "  ";

   124

    }

   125

   126

    cout

   127

        << in << "<EtherCATInfo>" << endl

   128

        << in << "  <!-- Slave " << slave.position << " -->" << endl

   129

        << in << "  <Vendor>" << endl

   130

        << in << "    <Id>" << slave.vendor_id << "</Id>" << endl

   131

        << in << "  </Vendor>" << endl

   132

        << in << "  <Descriptions>" << endl

   133

        << in << "    <Devices>" << endl

   134

        << in << "      <Device>" << endl

   135

        << in << "        <Type ProductCode=\"#x"

   136

        << hex << setfill('0') << setw(8) << slave.product_code

   137

        << "\" RevisionNo=\"#x"

   138

        << hex << setfill('0') << setw(8) << slave.revision_number

   139

        << "\">" << slave.order << "</Type>" << endl;

   140

   141

    if (strlen(slave.name)) {

   142

        cout

   143

            << in << "        <Name><![CDATA["

   144

            << slave.name

   145

            << "]]></Name>" << endl;

   146

    }

   147

   148

    for (i = 0; i < slave.sync_count; i++) {

   149

        m.getSync(&sync, slave.position, i);

   150

   151

        cout

   152

            << in << "        <Sm Enable=\"" << dec << (unsigned int) sync.enable

   153

            << "\" StartAddress=\"" << sync.physical_start_address

   154

            << "\" ControlByte=\"" << (unsigned int) sync.control_register

   155

            << "\" DefaultSize=\"" << sync.default_size

   156

            << "\" />" << endl;

   157

    }

   158

   159

    for (i = 0; i < slave.sync_count; i++) {

   160

        m.getSync(&sync, slave.position, i);

   161

   162

        for (j = 0; j < sync.pdo_count; j++) {

   163

            m.getPdo(&pdo, slave.position, i, j);

   164

            pdoType = (sync.control_register & 0x04 ? "R" : "T");

   165

            pdoType += "xPdo"; // last 2 letters lowercase in XML!

   166

   167

            cout

   168

                << in << "        <" << pdoType

   169

                << " Sm=\"" << i << "\" Fixed=\"1\" Mandatory=\"1\">" << endl

   170

                << in << "          <Index>#x"

   171

                << hex << setfill('0') << setw(4) << pdo.index

   172

                << "</Index>" << endl

   173

                << in << "          <Name>" << pdo.name << "</Name>" << endl;

   174

   175

            for (k = 0; k < pdo.entry_count; k++) {

   176

                m.getPdoEntry(&entry, slave.position, i, j, k);

   177

   178

                cout

   179

                    << in << "          <Entry>" << endl

   180

                    << in << "            <Index>#x"

   181

                    << hex << setfill('0') << setw(4) << entry.index

   182

                    << "</Index>" << endl;

   183

                if (entry.index)

   184

                    cout

   185

                        << in << "            <SubIndex>"

   186

                        << dec << (unsigned int) entry.subindex

   187

                        << "</SubIndex>" << endl;

   188

   189

                cout

   190

                    << in << "            <BitLen>"

   191

                    << dec << (unsigned int) entry.bit_length

   192

                    << "</BitLen>" << endl;

   193

   194

                if (entry.index) {

   195

                    cout

   196

                        << in << "            <Name>" << entry.name

   197

                        << "</Name>" << endl

   198

                        << in << "            <DataType>";

   199

   200

                    if (entry.bit_length == 1) {

   201

                        cout << "BOOL";

   202

                    } else if (!(entry.bit_length % 8)) {

   203

                        if (entry.bit_length <= 64) {

   204

                            cout << "UINT" << (unsigned int) entry.bit_length;

   205

                        } else {

   206

                            cout << "STRING("

   207

                                << (unsigned int) (entry.bit_length / 8)

   208

                                << ")";

   209

                        }

   210

                    } else {

   211

                        cout << "BIT" << (unsigned int) entry.bit_length;

   212

                    }

   213

   214

                    cout << "</DataType>" << endl;

   215

                }

   216

   217

                cout << in << "          </Entry>" << endl;

   218

            }

   219

   220

            cout

   221

                << in << "        </" << pdoType << ">" << endl;

   222

        }

   223

    }

   224

   225

    cout

   226

        << in << "      </Device>" << endl

   227

        << in << "    </Devices>" << endl

   228

        << in << "  </Descriptions>" << endl

   229

        << in << "</EtherCATInfo>" << endl;

   230

}

   231

   232

/*****************************************************************************/