Procedure within and outside TwinCAT with sci file

Note regarding availability (2021/01)

The SCI method is available from TwinCAT 3.1 build 4024.14.

The Slave Configuration Information (SCI) describes a specific complete configuration for an EtherCAT slave (terminal, box, drive...) based on the setting options of the device description file (ESI, EtherCAT Slave Information). That is, it includes PDO, CoE, synchronization.

Export:

  • select a single device via the menu (multiple selection is also possible):
    TwinCAT → EtherCAT Devices → Export SCI.
    Procedure within and outside TwinCAT with sci file 1:
  • If TwinCAT is offline (i.e. if there is no connection to an actual running controller) a warning message may appear, because after executing the function the system attempts to reload the EtherCAT segment. However, in this case this is not relevant for the result and can be acknowledged by clicking OK:
    Procedure within and outside TwinCAT with sci file 2:
  • A description may also be provided:
    Procedure within and outside TwinCAT with sci file 3:
  • Explanation of the dialog box:

Name

Name of the SCI, assigned by the user.

Description

Description of the slave configuration for the use case, assigned by the user.

Options

Keep modules

If a slave supports modules/slots, the user can decide whether these are to be exported or whether the module and device data are to be combined during export.

AoE | Set AmsNetId

The configured AmsNetId is exported. Usually this is network-dependent and cannot always be determined in advance.

EoE | Set MAC and IP

The configured virtual MAC and IP addresses are stored in the SCI. Usually these are network-dependent and cannot always be determined in advance.

CoE | Set cycle time(0x1C3x.2)

The configured cycle time is exported. Usually this is network-dependent and cannot always be determined in advance.

ESI

Reference to the original ESI file.

Export

Save SCI file.

  • A list view is available for multiple selections (Export multiple SCI files):
    Procedure within and outside TwinCAT with sci file 4:
  • Selection of the slaves to be exported:
    • All:
      All slaves are selected for export.
    • None:
      All slaves are deselected.
  • The sci file can be saved locally:
    Procedure within and outside TwinCAT with sci file 5:
  • The export takes place:
    Procedure within and outside TwinCAT with sci file 6:

Import

  • An sci description can be inserted manually into the TwinCAT configuration like any normal Beckhoff device description.
  • The sci file must be located in the TwinCAT ESI path, usually under:
    C:\TwinCAT\3.1\Config\Io\EtherCAT
    Procedure within and outside TwinCAT with sci file 7:
  • Open the selection dialog:
    Procedure within and outside TwinCAT with sci file 8:
  • Display SCI devices and select and insert the desired device:
    Procedure within and outside TwinCAT with sci file 9:

Additional Notes

  • Settings for the SCI function can be made via the general Options dialog (Tools → Options → TwinCAT → Export SCI):
    Procedure within and outside TwinCAT with sci file 10:
    Explanation of the settings:

Default export options

AoE | Set AmsNetId

Default setting whether the configured AmsNetId is exported.

CoE | Set cycle time(0x1C3x.2)

Default setting whether the configured cycle time is exported.

EoE | Set MAC and IP

Default setting whether the configured MAC and IP addresses are exported.

Keep modules

Default setting whether the modules persist.

Generic

Reload Devices

Setting whether the Reload Devices command is executed before the SCI export.
This is strongly recommended to ensure a consistent slave configuration.

SCI error messages are displayed in the TwinCAT logger output window if required:

Procedure within and outside TwinCAT with sci file 11: