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

    35

#include "MasterDevice.h"

    36

    37

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

    38

    39

CommandUpload::CommandUpload():

    40

    SdoCommand("upload", "Read an SDO entry from a slave.")

    41

{

    42

}

    43

    44

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

    45

    46

string CommandUpload::helpString() const

    47

{

    48

    stringstream str;

    49

    50

    str << getName() << " [OPTIONS] <INDEX> <SUBINDEX>" << endl

    51

        << endl

    52

        << getBriefDescription() << endl

    53

        << endl

    54

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

    55

        << endl

    56

        << "The data type of the SDO entry is taken from the SDO" << endl

    57

        << "dictionary by default. It can be overridden with the" << endl

    58

        << "--type option. If the slave does not support the SDO" << endl

    59

        << "information service or the SDO is not in the dictionary," << endl

    60

        << "the --type option is mandatory."  << endl

    61

        << endl

    62

        << "These are the valid SDO entry data types:" << endl

    63

        << "  int8, int16, int32, uint8, uint16, uint32, string," << endl

    64

        << "  octet_string." << endl

    65

        << endl

    66

        << "Arguments:" << endl

    67

        << "  INDEX    is the SDO index and must be an unsigned" << endl

    68

        << "           16 bit number." << endl

    69

        << "  SUBINDEX is the SDO entry subindex and must be an" << endl

    70

        << "           unsigned 8 bit number." << endl

    71

        << endl

    72

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

    73

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

    74

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

    75

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

    76

        << "  --type     -t <type>   SDO entry data type (see above)." << endl

    77

        << endl

    78

        << numericInfo();

    79

    80

    return str.str();

    81

}

    82

    83

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

    84

    85

void CommandUpload::execute(const StringVector &args)

    86

{

    87

    SlaveList slaves;

    88

    stringstream err, strIndex, strSubIndex;

    89

    ec_ioctl_slave_sdo_upload_t data;

    90

    const DataType *dataType = NULL;

    91

    unsigned int uval;

    92

    93

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

    94

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

    95

        throwInvalidUsageException(err);

    96

    }

    97

    98

    strIndex << args[0];

    99

    strIndex

   100

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

   101

        >> data.sdo_index;

   102

    if (strIndex.fail()) {

   103

        err << "Invalid SDO index '" << args[0] << "'!";

   104

        throwInvalidUsageException(err);

   105

    }

   106

   107

    strSubIndex << args[1];

   108

    strSubIndex

   109

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

   110

        >> uval;

   111

    if (strSubIndex.fail() || uval > 0xff) {

   112

        err << "Invalid SDO subindex '" << args[1] << "'!";

   113

        throwInvalidUsageException(err);

   114

    }

   115

    data.sdo_entry_subindex = uval;

   116

   117

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

   118

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

   119

        throwInvalidUsageException(err);

   120

    }

   121

    MasterDevice m(getMasterIndices().front());

   122

    m.open(MasterDevice::Read);

   123

    slaves = selectedSlaves(m);

   124

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

   125

        throwSingleSlaveRequired(slaves.size());

   126

    }

   127

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

   128

   129

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

   130

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

   131

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

   132

            throwInvalidUsageException(err);

   133

        }

   134

    } else { // no data type specified: fetch from dictionary

   135

        ec_ioctl_slave_sdo_entry_t entry;

   136

   137

        try {

   138

            m.getSdoEntry(&entry, data.slave_position,

   139

                    data.sdo_index, data.sdo_entry_subindex);

   140

        } catch (MasterDeviceException &e) {

   141

            err << "Failed to determine SDO entry data type. "

   142

                << "Please specify --type.";

   143

            throwCommandException(err);

   144

        }

   145

        if (!(dataType = findDataType(entry.data_type))) {

   146

            err << "PDO entry has unknown data type 0x"

   147

                << hex << setfill('0') << setw(4) << entry.data_type << "!"

   148

                << " Please specify --type.";

   149

            throwCommandException(err);

   150

        }

   151

    }

   152

   153

    if (dataType->byteSize) {

   154

        data.target_size = dataType->byteSize;

   155

    } else {

   156

        data.target_size = DefaultBufferSize;

   157

    }

   158

   159

    data.target = new uint8_t[data.target_size + 1];

   160

   161

    try {

   162

        m.sdoUpload(&data);

   163

    } catch (MasterDeviceSdoAbortException &e) {

   164

        delete [] data.target;

   165

        err << "SDO transfer aborted with code 0x"

   166

            << setfill('0') << hex << setw(8) << e.abortCode

   167

            << ": " << abortText(e.abortCode);

   168

        throwCommandException(err);

   169

    } catch (MasterDeviceException &e) {

   170

        delete [] data.target;

   171

        throw e;

   172

    }

   173

   174

    m.close();

   175

   181

    }

   182

   183

    delete [] data.target;

   184

}

   185

   186

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