Command-line help in the docs.
/*****************************************************************************
*
* $Id$
*
****************************************************************************/
#include <iostream>
#include <iomanip>
using namespace std;
#include "globals.h"
#include "coe_datatypes.h"
/****************************************************************************/
const char *help_download =
"[OPTIONS] <INDEX> <SUBINDEX> <VALUE>\n"
"\n"
"Download an Sdo entry to a slave.\n"
"\n"
"The data type of the Sdo entry is taken from the Sdo dictionary by\n"
"default. It can be overridden with the --type option. If the slave\n"
"does not support the Sdo information service or the Sdo is not in the\n"
"dictionary, the --type option is mandatory.\n"
"\n"
"These are the valid Sdo entry data types:\n"
" int8, int16, int32, uint8, uint16, uint32, string.\n"
"\n"
"Arguments:\n"
" INDEX is the Sdo index and must be an unsigned 16 bit number.\n"
" SUBINDEX is the Sdo entry subindex and must be an unsigned 8 bit\n"
" number.\n"
" VALUE is the value to download and must correspond to the Sdo\n"
" entry datatype (see above).\n"
"\n"
"Command-specific options:\n"
" --slave -s <index> Positive numerical ring position (mandatory).\n"
" --type -t <type> Forced Sdo entry data type (see above).\n"
"\n"
"Numerical values can be specified either with decimal (no prefix),\n"
"octal (prefix '0') or hexadecimal (prefix '0x') base.\n";
/****************************************************************************/
void command_download(void)
{
stringstream strIndex, strSubIndex, strValue, err;
ec_ioctl_slave_sdo_download_t data;
unsigned int number;
const CoEDataType *dataType = NULL;
if (slavePosition < 0) {
err << "'" << commandName << "' requires a slave! "
<< "Please specify --slave.";
throw InvalidUsageException(err);
}
data.slave_position = slavePosition;
if (commandArgs.size() != 3) {
err << "'" << commandName << "' takes 3 arguments!";
throw InvalidUsageException(err);
}
strIndex << commandArgs[0];
strIndex
>> resetiosflags(ios::basefield) // guess base from prefix
>> data.sdo_index;
if (strIndex.fail()) {
err << "Invalid Sdo index '" << commandArgs[0] << "'!";
throw InvalidUsageException(err);
}
strSubIndex << commandArgs[1];
strSubIndex
>> resetiosflags(ios::basefield) // guess base from prefix
>> number;
if (strSubIndex.fail() || number > 0xff) {
err << "Invalid Sdo subindex '" << commandArgs[1] << "'!";
throw InvalidUsageException(err);
}
data.sdo_entry_subindex = number;
if (dataTypeStr != "") { // data type specified
if (!(dataType = findDataType(dataTypeStr))) {
err << "Invalid data type '" << dataTypeStr << "'!";
throw InvalidUsageException(err);
}
} else { // no data type specified: fetch from dictionary
ec_ioctl_slave_sdo_entry_t entry;
masterDev.open(MasterDevice::ReadWrite);
try {
masterDev.getSdoEntry(&entry, slavePosition,
data.sdo_index, data.sdo_entry_subindex);
} catch (MasterDeviceException &e) {
err << "Failed to determine Sdo entry data type. "
<< "Please specify --type.";
throw CommandException(err);
}
if (!(dataType = findDataType(entry.data_type))) {
err << "Pdo entry has unknown data type 0x"
<< hex << setfill('0') << setw(4) << entry.data_type << "!"
<< " Please specify --type.";
throw CommandException(err);
}
}
if (dataType->byteSize) {
data.data_size = dataType->byteSize;
} else {
data.data_size = DefaultBufferSize;
}
data.data = new uint8_t[data.data_size + 1];
strValue << commandArgs[2];
strValue >> resetiosflags(ios::basefield); // guess base from prefix
strValue.exceptions(ios::failbit);
try {
switch (dataType->coeCode) {
case 0x0002: // int8
{
int16_t val; // uint8_t is interpreted as char
strValue >> val;
if (val > 127 || val < -128)
throw ios::failure("Value out of range");
*data.data = val;
break;
}
case 0x0003: // int16
{
int16_t val;
strValue >> val;
*(int16_t *) data.data = cputole16(val);
break;
}
case 0x0004: // int32
{
int32_t val;
strValue >> val;
*(int32_t *) data.data = cputole32(val);
break;
}
case 0x0005: // uint8
{
uint16_t val; // uint8_t is interpreted as char
strValue >> val;
if (val > 0xff)
throw ios::failure("Value out of range");
*data.data = val;
break;
}
case 0x0006: // uint16
{
uint16_t val;
strValue >> val;
*(uint16_t *) data.data = cputole16(val);
break;
}
case 0x0007: // uint32
{
uint32_t val;
strValue >> val;
*(uint32_t *) data.data = cputole32(val);
break;
}
case 0x0009: // string
if (strValue.str().size() >= data.data_size) {
err << "String too large";
throw CommandException(err);
}
data.data_size = strValue.str().size();
strValue >> (char *) data.data;
break;
default:
delete [] data.data;
err << "Unknown data type 0x" << hex << dataType->coeCode;
throw CommandException(err);
}
} catch (ios::failure &e) {
delete [] data.data;
err << "Invalid value argument '" << commandArgs[2]
<< "' for type '" << dataType->name << "'!";
throw InvalidUsageException(err);
}
masterDev.open(MasterDevice::ReadWrite);
try {
masterDev.sdoDownload(&data);
} catch(MasterDeviceException &e) {
delete [] data.data;
throw e;
}
delete [] data.data;
}
/*****************************************************************************/