EtherCAT Async SSC/SoE Upload
Read data asynchronously from subordinate device represented by service data object
Simulink Real-Time / EtherCAT
The EtherCAT Async SSC/SoE Upload block provides asynchronous SERCOS interface (SErial Real time COmmunication Specification) over EtherCAT® (SoE) upload. The block selects an IDN in the specified subordinate device and sends an upload (read) request. After sending the request, the block immediately returns whatever value was returned from the device on an earlier call to the block.
Enable — Enables block to upload data
0 disables uploads. A value greater than or
1 enables the block to upload data.
Data — Data received from subordinate
Returns data received from the EtherCAT subordinate device. The data signal has the type specified in Data Type and a vector dimension given by Dimension.
Status — Status of data transfer
Status of asynchronous data transfer:
0— Mailbox transfer object idle, transfer not running
1— Mailbox transfer object running, transfer not complete
2— Transfer successfully executed
3— Error occurred during transfer request
Error — Report an EtherCAT network error
0 | integer
If no error occurs, this port transmits
0. Otherwise, it transmits a
nonzero value. For list of error codes, see EtherCAT Error Codes.
IDN — Identification Number
The documentation for your EtherCAT device specifies the IDN
values. You can select the IDN as a character vector that
represents a 16-bit integer (according to IEC 61800 -7 -204), such as
First field (bit 15):
Sfor Standard data,
Pfor product-specific data
Second field (bit 14 - 12):
0..7for parameter set
Third field (bit 11 - 0):
0..4095for data-block number
Drive Number — Index number of the drive
Specify the decimal index of the drive.
SoE blocks apply to only motor controllers. A single subordinate device can support one or more drive or motor channels. The drive number is the zero-based index of the drive or motor channel on this subordinate device at which this block is aimed. In SoE terminology, the drive is the logic that sends control signals to the motor. Typically, this logic is a small processor inside the subordinate device.
Data Type — Data type of the IDN
double (default) |
To identify the data type for the IDN, refer to the subordinate device documentation for the description of the IDN and the data type it uses. From the list, select the data type of the IDN.
If you select a data type that does not match the type of the entry, the block returns
a nonzero value through the
Dimension — Dimension of data for this IDN
Specify the row dimension of data for this IDN.
To identify the dimension of data (vector size) for the IDN, refer to the subordinate device documentation for the description of the IDN and the number of data type values (the dimension) it uses. Enter the vector length as found in the SoE description for the subordinate device in its manual.
SubDevice Name — Name of device that contains the IDN
From the list, select the name of the device that contains the IDN.
The block populates this drop-down list with the contents of the configuration file.
Timeout — Time to wait for response from subordinate device
Enter the maximum number of milliseconds to wait for a response from the EtherCAT subordinate device.
C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.
Introduced in R2020b