APIs, concepts, guides, and more
PDO vs. SDO

Understand the difference between real-time data exchange with PDOs and periodic service channel messages with SDOs in EtherCAT, and learn how to read, write, and configure these using RapidSetup and the RapidCode API.

In EtherCAT, values are sent and received from most drives using CANopen PDOโ€™s and SDOโ€™s. In most applications, RapidCode API users need not be aware of these low-level features.

  • PDO (Process Data Object) โ†’ Real-time data sent to/from the MotionController to each drive/node for every sample period.
  • SDO (Service Data Object) โ†’ Service Channel messages which are not exchanged every cycle.

๐Ÿ”น What are PDOs?

PDOs or Process Data Objects are the values exchanged cyclically with every real-time sample of the MotionController (1kHz by default). For servo drives, these are values such as control/status information and position demand/feedback.

Warning
Multi-Threading Note
Writing to the same PDO values is not Multi-Threading safe.
Writing to different PDO values is Multi-Threading safe.

๐Ÿ”น PDO - Reading & Writing

Using RapidSetup

Open the RapidSetup tool then go to Tools > Network Data

Here you can see which PDOโ€™s are being exchanged between our controller and your device/node(s).

Network Data Page - RapidSetup v8.1.5

Using RapidCode API

Reading Inputs

public void NetworkInputs()
{
int inputCount = controller.NetworkInputCountGet();
for (int i = 0; i < inputCount; i++)
{
int size = controller.NetworkInputBitSizeGet(i);
int offset = controller.NetworkInputBitOffsetGet(i);
string name = controller.NetworkInputNameGet(i);
UInt64 value = controller.NetworkInputValueGet(i);
}
}
int32_t NetworkInputBitOffsetGet(int32_t index)
uint64_t NetworkInputValueGet(int32_t index)
int32_t NetworkInputCountGet()
Get the number of PDO inputs found on the network.
int32_t NetworkInputBitSizeGet(int32_t index)
Get the size (in bits) of a network input.
const char *const NetworkInputNameGet(int32_t index)
Get the name of a PDO network input.

Reading and Writing to Outputs

public void NetworkOutputs()
{
int outputCount = controller.NetworkOutputCountGet();
for (int i = 0; i < outputCount; i++)
{
int size = controller.NetworkOutputBitSizeGet(i);
int offset = controller.NetworkOutputBitOffsetGet(i);
string name = controller.NetworkOutputNameGet(i);
UInt64 value = controller.NetworkOutputValueGet(i);
//If you intend to write outputs, you only need to do this once.
controller.NetworkOutputOverrideSet(i, true);
//Anytime you want to write a specific output value.
controller.NetworkOutputOverrideValueSet(i, value); //โ†Write to a PDO output.
}
}
uint64_t NetworkOutputValueGet(int32_t index)
Gets the value sent out over EtherCAT.
void NetworkOutputOverrideValueSet(int32_t index, uint64_t outputValue)
Sets a PDO output directly.
void NetworkOutputOverrideSet(int32_t index, bool outputOverride)
Set NetworkOutputValue to override RMP cyclic value.
const char *const NetworkOutputNameGet(int32_t index)
Get the name of a PDO output.
int32_t NetworkOutputBitSizeGet(int32_t index)
Get the size (in bits) of a PDO output.
int32_t NetworkOutputBitOffsetGet(int32_t index)
Get the raw PDO offset for an output.
Note
Be sure you know what you are doing if you choose to Override an Output. Any automated process which was writing to it, will no longer have control and will not be aware that someone else is in charge.

๐Ÿ”น PDO - Injection

You can inject exchanged information (changing defaults) by creating the CustomNodeInfo.xml.

Let's say we want to read/write from the latch status, control, and positions SDOโ€™s because communicating directly with the SDO takes too much time.

Follow the Example below for a solution.

PDO Injection Using CustomNodeInfo.xml File

In the default NodeInfo.xml file Yaskawa (for example) by default has the following PDOโ€™s configuration:

<PDOs>
<PDOAssignment Index="0x1601" IsOutput="True" Include="False" />
<PDOAssignment Index="0x1a01" IsOutput="False" Include="False" />
<PDOAssignment Index="0x1600" IsOutput="True" Include="True" RemoveContent="0x6060 0x6072" />
<PDOAssignment Index="0x1a00" IsOutput="False" Include="True" />
</PDOs>

Take a look at the Yaskawa-SGD7S.xml ESI file, located in the ESI folder inside the RMP folder:

<Object>
<Index>#x60B8</Index>
<Name>Touch probe function</Name>
<Type>UINT</Type>
<BitSize>16</BitSize>
<Flags>
<Access>rw</Access>
<PdoMapping>RT</PdoMapping>
</Flags>
</Object>
<Object>
<Index>#x60B9</Index>
<Name>Touch probe status</Name>
<Type>UINT</Type>
<BitSize>16</BitSize>
<Flags>
<Access>ro</Access>
<PdoMapping>T</PdoMapping>
</Flags>
</Object>
<Object>
<Index>#x60BA</Index>
<Name>Touch probe 1 position value</Name>
<Type>DINT</Type>
<BitSize>32</BitSize>
<Flags>
<Access>ro</Access>
<PdoMapping>T</PdoMapping>
</Flags>
</Object>
<Object>
<Index>#x60BC</Index>
<Name>Touch probe 2 position value</Name>
<Type>DINT</Type>
<BitSize>32</BitSize>
<Flags>
<Access>ro</Access>
<PdoMapping>T</PdoMapping>
</Flags>
</Object>

You can add multiple AddEntry by copying the relevant Vendor from NodeInfo.xml and pasting it to CustomNodeInfo.xml and making the following changes:

<PDOs>
<PDOAssignment Index="0x1601" IsOutput="True" Include="False" />
<PDOAssignment Index="0x1a01" IsOutput="False" Include="False" />
<PDOAssignment Index="0x1600" IsOutput="True" Include="True" RemoveContent="0x6060" />
<PDOAssignment Index="0x1a00" IsOutput="False" Include="True" />
<AddEntry Name="Touch probe 1 position value" Index="0x60BA" SubIndex="0" BitLen="32" DataType="DINT" />
<AddEntry Name="Touch probe status" Index="0x60B9" SubIndex="0" BitLen="16" DataType="UINT" />
<AddEntry Name="Touch probe 2 position value" Index="0x60BC" SubIndex="0" BitLen="32" DataType="DINT" />
</PDOAssignment>
</PDOs>

This works well for Inputs:

<Access>**ro**</Access>

like Touch probe values and status. But it does not work currently for Outputs:

<Access>**rw**</Access>

such as the Touch probe function (0x60B8). Right now if you add an output in, RMP will write 0 into it every cycle. Unless you Override the sent value (see next section).

๐Ÿ”น PDO - Output Value Override

Using RapidSetup

Set the value under the OVERRIDE VALUE column and then check the checkbox under the OVERRIDE column. (See image below)

Network Data Page - RapidSetup v8.1.5

Using RapidCode API

Enabling Override Feature

motionController.NetworkOutputOverrideSet(index, outputOverride);
Note
Where:
index โ†’ the PDO Network Output index to read from. outputOverride โ†’ boolean that will enable or disable the override feature for specific PDO index. See NetworkOutputOverrideSet()

Setting Override Value

motionController.NetworkOutputOverrideValueSet(index, value);
Note
Where:
index โ†’ the index of the PDO Network Output to Override.
outputOverride โ†’ Your desired value (must be an unsigned 64-bit value, you may need to use a union) See NetworkOutputOverrideValueSet()

๐Ÿ”น What are SDOs?

SDOs or Service Data Object are messages in a confirmed service with a kind of handshake. They are used for the access to entries of the object dictionary. Especially the configuration for the requested behavior of the drive adapted to the various possible applications is done by these objects.

Note
– SDOโ€™s are not exchanged during every cycle, they are done periodically.
– Not as fast as PDOโ€™s since they must wait for network response

๐Ÿ”น SDO - Reading & Writing

Using RapidSetup

The easiest way to read a SDO or write to an SDO is by using our RapidSetup utility then click on your drive node. (see images below)

Node Page - RapidSetup v8.1.5

Using RapidCode API

SDO Writing

axis.NetworkNode.ServiceChannelWrite(index, subIndex, byteCount, value);
Note
Where:
index โ†’ the memory address to write to.
subIndex โ†’ the sub index to write to.
byteCount โ†’ the number of bytes to write.
value โ†’ the numeric value to write.
See ServiceChannelWrite()

SDO Reading

axis.NetworkNode.ServiceChannelRead(index, subIndex, byteCount);
Note
Where:
index โ†’ the memory address to read from.
subIndex โ†’ the sub index to read from.
byteCount โ†’ the number of bytes to read.
See ServiceChannelRead()

๐Ÿ“œ Sample Code