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

using namespace std;

    33

    34

#include "CommandSoeRead.h"

    35

#include "MasterDevice.h"

    36

    37

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

    38

    39

CommandSoeRead::CommandSoeRead():

    40

    Command("soe_read", "Read an SoE IDN from a slave.")

    41

{

    42

}

    43

    44

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

    45

    46

string CommandSoeRead::helpString(const string &binaryBaseName) const

    47

{

    48

    stringstream str;

    49

    50

    str << binaryBaseName << " " << getName()

    51

        << " [OPTIONS] <IDN>" << endl

    52

        << binaryBaseName << " " << getName()

    53

        << " [OPTIONS] <DRIVE> <IDN>" << endl

    54

        << endl

    55

        << getBriefDescription() << endl

    56

        << endl

    57

        << "This command requires a single slave to be selected." << endl

    58

        << endl

    59

        << "Arguments:" << endl

    60

        << "  DRIVE    is the drive number (0 - 7). If omitted, 0 is assumed."

    61

        << endl

    62

        << "  IDN      is the IDN and must be either an unsigned" << endl

    63

        << "           16 bit number acc. to IEC 61800-7-204:" << endl

    64

        << "             Bit 15: (0) Standard data, (1) Product data" << endl

    65

        << "             Bit 14 - 12: Parameter set (0 - 7)" << endl

    66

        << "             Bit 11 - 0: Data block number" << endl

    67

        << "           or a string like 'P-0-150'." << endl

    68

        << endl

    69

        << "Data of the given IDN are read and displayed according to" << endl

    70

        << "the given datatype, or as raw hex bytes." << endl

    71

        << endl

    72

        << typeInfo()

    73

        << endl

    74

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

    75

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

    76

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

    77

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

    78

        << "  --type     -t <type>   Data type (see above)." << endl

    79

        << endl

    80

        << numericInfo();

    81

    82

    return str.str();

    83

}

    84

    85

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

    86

    87

void CommandSoeRead::execute(const StringVector &args)

    88

{

    89

    SlaveList slaves;

    90

    stringstream err;

    91

    const DataType *dataType = NULL;

    92

    ec_ioctl_slave_soe_read_t ioctl;

    93

    int driveArgIndex = -1, idnArgIndex = -1;

    94

    95

    if (args.size() == 1) {

    96

        idnArgIndex = 0;

    97

    } else if (args.size() == 2) {

    98

        driveArgIndex = 0;

    99

        idnArgIndex = 1;

   100

    } else {

   101

        err << "'" << getName() << "' takes eiter 1 or 2 arguments!";

   102

        throwInvalidUsageException(err);

   103

    }

   104

   105

    if (driveArgIndex >= 0) {

   106

        stringstream str;

   107

        unsigned int number;

   108

        str << args[driveArgIndex];

   109

        str

   110

            >> resetiosflags(ios::basefield) // guess base from prefix

   111

            >> number;

   112

        if (str.fail() || number > 7) {

   113

            err << "Invalid drive number '" << args[driveArgIndex] << "'!";

   114

            throwInvalidUsageException(err);

   115

        }

   116

        ioctl.drive_no = number;

   117

    } else {

   118

        ioctl.drive_no = 0;

   119

    }

   120

   121

    try {

   122

        ioctl.idn = parseIdn(args[idnArgIndex]);

   123

    } catch (runtime_error &e) {

   124

        err << "Invalid IDN '" << args[idnArgIndex] << "': " << e.what();

   125

        throwInvalidUsageException(err);

   126

    }

   127

   128

    MasterDevice m(getSingleMasterIndex());

   129

    m.open(MasterDevice::Read);

   130

    slaves = selectedSlaves(m);

   131

    if (slaves.size() != 1) {

   132

        throwSingleSlaveRequired(slaves.size());

   133

    }

   134

    ioctl.slave_position = slaves.front().position;

   135

   136

    if (getDataType().empty()) {

   137

        dataType = findDataType("raw"); // FIXME

   138

    } else { // no data type specified

   139

        if (!(dataType = findDataType(getDataType()))) {

   140

            err << "Invalid data type '" << getDataType() << "'!";

   141

            throwInvalidUsageException(err);

   142

        }

   143

    }

   144

   145

    if (dataType->byteSize) {

   146

        ioctl.mem_size = dataType->byteSize;

   147

    } else {

   148

        ioctl.mem_size = 1024;

   149

    }

   150

   151

    ioctl.data = new uint8_t[ioctl.mem_size + 1];

   152

   153

    try {

   154

        m.readSoe(&ioctl);

   155

    } catch (MasterDeviceSoeException &e) {

   156

        delete [] ioctl.data;

   157

        err << "SoE read command failed with code " << errorMsg(e.errorCode);

   158

        throwCommandException(err);

   159

    } catch (MasterDeviceException &e) {

   160

        delete [] ioctl.data;

   161

        throw e;

   162

    }

   163

   164

    m.close();

   165

   166

    try {

   167

        outputData(cout, dataType, ioctl.data, ioctl.data_size);

   168

    } catch (SizeException &e) {

   169

        delete [] ioctl.data;

   170

        throwCommandException(e.what());

   171

    }

   172

   173

    delete [] ioctl.data;

   174

}

   175

   176

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