Using the NI 9144 and NI 9145 EtherCAT Slave Chassis with 3rd Party EtherCAT Master Tools

Updated Sep 28, 2022

Environment

Hardware

  • NI-9144
  • NI-9145

Driver

  • NI-Industrial Communications for EtherCAT

EtherCAT master software tools typically upload the configuration for connected slave devices by using the FoE (File over EtherCAT) protocol. How can I get the configuration for the slave if my tool doesn't support FoE?

It is possible to import the slave device XML configuration file or copy the XML file manually to a specific location where the master tool can read it. 

There are two ways for a master to work with EtherCAT Slave XML hardware description files.
  • The NI Slave XML creator tool, shown below, allows the user to create an XML hardware description file based on modules and FPGA bitfile used with the chassis.
Note: Always use the XML Creator Tool installed by the latest version of the NI-Industrial Communications for EtherCAT driver available from ni.com/support.
 


To use the tool, follow these instructions:
  1. Select the modules you are using per slot.
  2. Check the modules used in FPGA mode. In our example this applies to module 3 and 4.
  3. Specify the path to your FPGA bit file (in case you are running FPGA code on your chassis). This will allow you to import the UDVs (User defined Variables) from the bit file. Leave this path blank if you do not run additional FPGA code.
  4. Press the Create XML File button and save the XML file to a location of your choice.
  5. Start over to create another XML file or press the Stop button to close the tool.
Note:  If your bit file uses UDVs, they will always be assigned to Slot 1 of the chassis, so you can use only 7 modules in scan mode. That means Slot 1 must be either empty or the module in Slot 1 must be used in your FPGA code and the checkmark “Used with FPGA Mode” must be set.
  
  • If the 3rd party Master supports Modular Device Profile (MDP), you can easily discover the 9144 along with all installed modules and UDVs. This procedure assumes that you have installed the latest NI-Industrial Communications for EtherCAT driver.
  1. Copy the DD folder contents (NI-9144slots.xml and the Modules folder) from \\National Instruments\LabVIEW 201x\resource\Framework\Providers\indcomecat\DD to the third-party EtherCAT master's IO configuration folder. Find content attached to this KnowledgeBase article. 
  2. After you successfully download a possible bitfile to your FPGA target under the NI 9144, a XML file will be generated next to the bitfile. This XML file is the User-Defined Variables profile and will have the same filename as the FPGA bitfile. The generated FPGA XML file must be copied into the Modules Folder.
  3. Open NI-9144slots.xml with Notepad, add the generated XML file path at the end of <InfoReference> section and save the changes. (e.g <InfoReference>Modules\example_9144_FPGA.lvbitx.xml</InfoReference>)
  4. Restart the third-party EtherCAT master system service. Now you can use the third-party EtherCAT master to discover the NI 9144, all modules, and possible FPGA UDVs listed under the NI 9144 slave as an 'User Defined Variables Module'.