EtherCAT Write Task
Learn how to send commands to EtherCAT devices with Synnax.
For the task lifecycle, see Task Basics.
Before creating a write task, configure your EtherCAT devices and identify the RxPDOs (output PDOs) to write to each one. State channels carry feedback read back from the device.
All channels in a task must use devices connected to the same network interface. Create separate tasks for devices on different EtherCAT networks.
Task Configuration Reference
Channel Configuration Modes
Automatic Mode (Recommended)
In automatic mode, you select a device and RxPDO name. The system automatically resolves the CoE index, subindex, and data type from the device’s ESI information.
Automatic Output Channel
Writes data to an RxPDO using the PDO name for automatic configuration.
When to use automatic mode:
- Device has complete ESI information
- PDO names are visible in the Console device properties
- Standard device configurations
Manual Mode
In manual mode, you specify the CoE index, subindex, and data type directly. Use this mode when the ESI file is incomplete or when working with non-standard PDO mappings.
Manual Output Channel
Writes data to an RxPDO using explicit CoE addressing.
When to use manual mode:
- ESI file is incomplete or missing PDO definitions
- Custom PDO mappings configured on the device
- Non-standard devices
- Accessing vendor-specific objects
Common servo drive RxPDO objects include control word (0x6040), target position
(0x607A), and target velocity (0x60FF).
Important Rules
- Network constraint -> All channels must use devices from the same network interface.
- State rate -> Higher state rates provide faster feedback but increase network load. Typically 10-50 Hz is sufficient.
- Execution rate -> Determines how frequently commands are sent to hardware. Higher rates provide more responsive control.
How-To
Console
Python
TypeScript
Configure and run task (Automatic Mode)
import synnax as sy
from synnax import ethercat
client = sy.Synnax()
# Retrieve EtherCAT device
dev = client.devices.retrieve(name="Servo Drive")
# Create command time index
cmd_time = client.channels.create(
name="ec_cmd_time",
is_index=True,
data_type=sy.DataType.TIMESTAMP,
retrieve_if_name_exists=True,
)
# Create command channels
control_cmd = client.channels.create(
name="control_word_cmd",
index=cmd_time.key,
data_type=sy.DataType.UINT16,
retrieve_if_name_exists=True,
)
target_pos_cmd = client.channels.create(
name="target_position_cmd",
index=cmd_time.key,
data_type=sy.DataType.INT32,
retrieve_if_name_exists=True,
)
# Create state time index
state_time = client.channels.create(
name="ec_state_time",
is_index=True,
data_type=sy.DataType.TIMESTAMP,
retrieve_if_name_exists=True,
)
# Create state channels
control_state = client.channels.create(
name="control_word_state",
index=state_time.key,
data_type=sy.DataType.UINT16,
retrieve_if_name_exists=True,
)
target_pos_state = client.channels.create(
name="target_position_state",
index=state_time.key,
data_type=sy.DataType.INT32,
retrieve_if_name_exists=True,
)
# Create and configure task using automatic mode
task = ethercat.WriteTask(
name="EtherCAT Write Task",
execution_rate=100, # Send commands at 100 Hz
state_rate=20, # Update state at 20 Hz
channels=[
ethercat.AutomaticWriteChannel(
device=dev.key,
pdo="control_word",
cmd_channel=control_cmd.key,
state_channel=control_state.key,
),
ethercat.AutomaticWriteChannel(
device=dev.key,
pdo="target_position",
cmd_channel=target_pos_cmd.key,
state_channel=target_pos_state.key,
),
],
)
client.tasks.configure(task)
# Start task and write commands
with task.run():
with client.open_writer(
start=sy.TimeStamp.now(),
channels=["control_word_cmd", "target_position_cmd"],
) as writer:
# Enable drive (control word 0x000F is common for CiA 402)
writer.write({
"control_word_cmd": 0x000F,
"target_position_cmd": 10000,
})
# Read back states
with client.open_streamer(["control_word_state", "target_position_state"]) as streamer:
frame = streamer.read()
print(f"Control State: {frame['control_word_state'][-1]}")
print(f"Target Position State: {frame['target_position_state'][-1]}") Configure and run task (Manual Mode)
import synnax as sy
from synnax import ethercat
client = sy.Synnax()
# Retrieve EtherCAT device
dev = client.devices.retrieve(name="Servo Drive")
# Create command time index
cmd_time = client.channels.create(
name="ec_cmd_time",
is_index=True,
data_type=sy.DataType.TIMESTAMP,
retrieve_if_name_exists=True,
)
# Create command channel
control_cmd = client.channels.create(
name="control_word_cmd",
index=cmd_time.key,
data_type=sy.DataType.UINT16,
retrieve_if_name_exists=True,
)
# Create state time index
state_time = client.channels.create(
name="ec_state_time",
is_index=True,
data_type=sy.DataType.TIMESTAMP,
retrieve_if_name_exists=True,
)
# Create state channel
control_state = client.channels.create(
name="control_word_state",
index=state_time.key,
data_type=sy.DataType.UINT16,
retrieve_if_name_exists=True,
)
# Create task using manual mode with CoE addressing
task = ethercat.WriteTask(
name="EtherCAT Manual Write",
execution_rate=100,
state_rate=20,
channels=[
ethercat.ManualWriteChannel(
device=dev.key,
index=0x6040, # Control word (CiA 402)
sub_index=0,
bit_length=16,
data_type="uint16",
cmd_channel=control_cmd.key,
state_channel=control_state.key,
),
],
)
client.tasks.configure(task)
# Start and write
with task.run():
with client.open_writer(
start=sy.TimeStamp.now(),
channels=["control_word_cmd"],
) as writer:
writer.write({"control_word_cmd": 0x000F}) Edit task configuration
import synnax as sy
from synnax import ethercat
client = sy.Synnax()
# Retrieve existing task and wrap with typed class
task = client.tasks.retrieve(name="EtherCAT Write Task")
task = ethercat.WriteTask(internal=task)
# Update task-level settings
task.config.execution_rate = 200 # Increase to 200 Hz
task.config.state_rate = 50 # Increase state rate
# Apply changes
client.tasks.configure(task) Configure and run task (Automatic Mode)
import { Synnax, TimeStamp } from "@synnaxlabs/client";
const client = new Synnax();
// Retrieve EtherCAT device
const [dev] = await client.devices.retrieve({ names: ["Servo Drive"] });
// Create command time index
const cmdTime = await client.channels.create(
{
name: "ec_cmd_time",
isIndex: true,
dataType: "timestamp",
},
{ retrieveIfNameExists: true },
);
// Create command channels
const controlCmd = await client.channels.create(
{
name: "control_word_cmd",
index: cmdTime.key,
dataType: "uint16",
},
{ retrieveIfNameExists: true },
);
const targetPosCmd = await client.channels.create(
{
name: "target_position_cmd",
index: cmdTime.key,
dataType: "int32",
},
{ retrieveIfNameExists: true },
);
// Create state time index
const stateTime = await client.channels.create(
{
name: "ec_state_time",
isIndex: true,
dataType: "timestamp",
},
{ retrieveIfNameExists: true },
);
// Create state channels
const controlState = await client.channels.create(
{
name: "control_word_state",
index: stateTime.key,
dataType: "uint16",
},
{ retrieveIfNameExists: true },
);
const targetPosState = await client.channels.create(
{
name: "target_position_state",
index: stateTime.key,
dataType: "int32",
},
{ retrieveIfNameExists: true },
);
// Create and configure task using automatic mode
const task = await client.tasks.create({
name: "EtherCAT Write Task",
rack: dev.rack,
type: "ethercat_write",
config: {
executionRate: 100, // Send commands at 100 Hz
stateRate: 20, // Update state at 20 Hz
channels: [
{
type: "automatic",
device: dev.key,
pdo: "control_word",
cmdChannel: controlCmd.key,
stateChannel: controlState.key,
},
{
type: "automatic",
device: dev.key,
pdo: "target_position",
cmdChannel: targetPosCmd.key,
stateChannel: targetPosState.key,
},
],
},
});
// Start task
await task.start();
// Write commands
const writer = await client.openWriter({
start: TimeStamp.now(),
channels: ["control_word_cmd", "target_position_cmd"],
});
// Enable drive (control word 0x000F is common for CiA 402)
await writer.write({
control_word_cmd: 0x000f,
target_position_cmd: 10000,
});
// Read back states
const streamer = await client.openStreamer([
"control_word_state",
"target_position_state",
]);
const frame = await streamer.read();
console.log(`Control State: ${frame.get("control_word_state").at(-1)}`);
console.log(`Target Position State: ${frame.get("target_position_state").at(-1)}`);
// Stop task
await task.stop();
await writer.close();
await streamer.close(); Configure and run task (Manual Mode)
import { Synnax, TimeStamp } from "@synnaxlabs/client";
const client = new Synnax();
// Retrieve EtherCAT device
const [dev] = await client.devices.retrieve({ names: ["Servo Drive"] });
// Create command time index
const cmdTime = await client.channels.create(
{
name: "ec_cmd_time",
isIndex: true,
dataType: "timestamp",
},
{ retrieveIfNameExists: true },
);
// Create command channel
const controlCmd = await client.channels.create(
{
name: "control_word_cmd",
index: cmdTime.key,
dataType: "uint16",
},
{ retrieveIfNameExists: true },
);
// Create state time index
const stateTime = await client.channels.create(
{
name: "ec_state_time",
isIndex: true,
dataType: "timestamp",
},
{ retrieveIfNameExists: true },
);
// Create state channel
const controlState = await client.channels.create(
{
name: "control_word_state",
index: stateTime.key,
dataType: "uint16",
},
{ retrieveIfNameExists: true },
);
// Create task using manual mode with CoE addressing
const task = await client.tasks.create({
name: "EtherCAT Manual Write",
rack: dev.rack,
type: "ethercat_write",
config: {
executionRate: 100,
stateRate: 20,
channels: [
{
type: "manual",
device: dev.key,
index: 0x6040, // Control word (CiA 402)
subIndex: 0,
bitLength: 16,
dataType: "uint16",
cmdChannel: controlCmd.key,
stateChannel: controlState.key,
},
],
},
});
// Start and write
await task.start();
const writer = await client.openWriter({
start: TimeStamp.now(),
channels: ["control_word_cmd"],
});
await writer.write({ control_word_cmd: 0x000f });
await task.stop();
await writer.close(); Edit task configuration
import { ethercat, Synnax } from "@synnaxlabs/client";
const client = new Synnax();
// Retrieve existing task
const task = await client.tasks.retrieve({ name: "EtherCAT Write Task" });
// Parse current configuration
const config = ethercat.writeConfigZ.parse(task.config);
// Update task-level settings
config.executionRate = 200; // Increase to 200 Hz
config.stateRate = 50; // Increase state rate
// Apply changes
await client.tasks.create({
key: task.key,
rack: task.rack,
name: task.name,
type: task.type,
config,
});