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 "CommandSoeWrite.h"

    35

#include "MasterDevice.h"

    36

    37

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

    38

    39

CommandSoeWrite::CommandSoeWrite():

    40

    Command("soe_write", "Write an SoE IDN to a slave.")

    41

{

    42

}

    43

    44

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

    45

    46

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

    47

{

    48

    stringstream str;

    49

    50

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

    51

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

    52

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

    53

        << " [OPTIONS] <DRIVE> <IDN> <VALUE>" << 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

        << "  VALUE    is the value to write (see below)." << endl

    69

		<< endl

    70

        << "The VALUE argument is interpreted as the given data type" << endl

    71

		<< "(--type is mandatory) and written to the selected slave." << endl

    72

        << endl

    73

		<< typeInfo()

    74

        << endl

    75

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

    76

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

    77

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

    78

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

    79

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

    80

        << endl

    81

        << numericInfo();

    82

    83

    return str.str();

    84

}

    85

    86

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

    87

    88

void CommandSoeWrite::execute(const StringVector &args)

    89

{

    90

    stringstream err;

    91

    const DataType *dataType = NULL;

    92

    ec_ioctl_slave_soe_write_t ioctl;

    93

    SlaveList slaves;

    94

    size_t memSize;

    95

    int driveArgIndex = -1, idnArgIndex = -1, valueArgIndex = -1;

    96

    97

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

    98

        idnArgIndex = 0;

    99

        valueArgIndex = 1;

   100

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

   101

        driveArgIndex = 0;

   102

        idnArgIndex = 1;

   103

        valueArgIndex = 2;

   104

    } else {

   105

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

   106

        throwInvalidUsageException(err);

   107

    }

   108

   109

    if (driveArgIndex >= 0) {

   110

        stringstream str;

   111

        unsigned int number;

   112

        str << args[driveArgIndex];

   113

        str

   114

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

   115

            >> number;

   116

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

   117

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

   118

            throwInvalidUsageException(err);

   119

        }

   120

        ioctl.drive_no = number;

   121

    } else {

   122

        ioctl.drive_no = 0;

   123

    }

   124

   125

    try {

   126

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

   127

    } catch (runtime_error &e) {

   128

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

   129

        throwInvalidUsageException(err);

   130

    }

   131

   132

    MasterDevice m(getSingleMasterIndex());

   133

    m.open(MasterDevice::ReadWrite);

   134

    slaves = selectedSlaves(m);

   135

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

   136

        throwSingleSlaveRequired(slaves.size());

   137

    }

   138

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

   139

   140

    if (!getDataType().empty()) { // data type specified

   141

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

   142

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

   143

            throwInvalidUsageException(err);

   144

        }

   145

    } else { // no data type specified

   146

        err << "Please specify a data type.";

   147

        throwInvalidUsageException(err); // FIXME read from stream

   148

    }

   149

   150

    if (dataType->byteSize) {

   151

        memSize = dataType->byteSize;

   152

    } else {

   153

        // guess string type size

   154

        memSize = args[valueArgIndex].size() + 1;

   155

        if (!memSize) {

   156

            err << "Empty argument not allowed.";

   157

            throwInvalidUsageException(err);

   158

        }

   159

    }

   160

   161

    ioctl.data = new uint8_t[memSize];

   162

   163

    try {

   164

        ioctl.data_size = interpretAsType(

   165

                dataType, args[valueArgIndex], ioctl.data, memSize);

   166

    } catch (SizeException &e) {

   167

        delete [] ioctl.data;

   168

        throwCommandException(e.what());

   169

    } catch (ios::failure &e) {

   170

        delete [] ioctl.data;

   171

        err << "Invalid value argument '" << args[valueArgIndex]

   172

            << "' for type '" << dataType->name << "'!";

   173

        throwInvalidUsageException(err);

   174

    }

   175

   176

    try {

   177

        m.writeSoe(&ioctl);

   178

    } catch (MasterDeviceSoeException &e) {

   179

        delete [] ioctl.data;

   180

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

   181

        throwCommandException(err);

   182

    } catch (MasterDeviceException &e) {

   183

        delete [] ioctl.data;

   184

        throw e;

   185

    }

   186

   187

    delete [] ioctl.data;

   188

}

   189

   190

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