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

{

    74

    SlaveList slaves;

    75

    SlaveList::const_iterator si;

    76

    77

    if (args.size()) {

    78

        stringstream err;

    79

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

    80

        throwInvalidUsageException(err);

    81

    }

    82

    83

    MasterDevice m(getSingleMasterIndex());

    84

    m.open(MasterDevice::Read);

    85

    slaves = selectedSlaves(m);

    86

    87

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

    88

    if (slaves.size() > 1) {

    89

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

    90

    }

    91

    92

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

    93

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

    94

    }

    95

    96

    if (slaves.size() > 1) {

    97

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

    98

    }

    99

}

   100

   101

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

   102

   103

void CommandXml::generateSlaveXml(

   104

        MasterDevice &m,

   105

        const ec_ioctl_slave_t &slave,

   106

        unsigned int indent

   107

        )

   108

{

   109

    ec_ioctl_slave_sync_t sync;

   110

    ec_ioctl_slave_sync_pdo_t pdo;

   111

    string pdoType, in;

   112

    ec_ioctl_slave_sync_pdo_entry_t entry;

   113

    unsigned int i, j, k;

   114

   115

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

   116

        in += "  ";

   117

    }

   118

   119

    cout

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

   134

    if (strlen(slave.name)) {

   135

        cout

   136

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

   137

            << slave.name

   138

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

   139

    }

   140

   141

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

   142

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

   143

   144

        cout

   145

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

   146

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

   147

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

   148

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

   149

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

   150

    }

   151

   152

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

   153

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

   154

   155

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

   156

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

   157

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

   158

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

   159

   160

            cout

   161

                << in << "        <" << pdoType

   162

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

   163

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

   164

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

   165

                << "</Index>" << endl

   166

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

   167

   168

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

   169

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

   170

   171

                cout

   172

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

   173

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

   174

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

   175

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

   176

                if (entry.index)

   177

                    cout

   178

                        << in << "            <SubIndex>"

   179

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

   180

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

   181

   182

                cout

   183

                    << in << "            <BitLen>"

   184

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

   185

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

   186

   187

                if (entry.index) {

   188

                    cout

   189

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

   190

                        << "</Name>" << endl

   191

                        << in << "            <DataType>";

   192

   193

                    if (entry.bit_length == 1) {

   194

                        cout << "BOOL";

   195

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

   196

                        if (entry.bit_length <= 64) {

   197

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

   198

                        } else {

   199

                            cout << "STRING("

   200

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

   201

                                << ")";

   202

                        }

   203

                    } else {

   204

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

   205

                    }

   206

   207

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

   208

                }

   209

   210

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

   211

            }

   212

   213

            cout

   214

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

   215

        }

   216

    }

   217

   218

    cout

   219

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

   220

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

   221

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

   222

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

   223

}

   224

   225

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