# EC-Monitor

> EC-Monitor documentation


2026-Oct-14, acontis technologies GmbH

## Pages

- [EC-Monitor](index.html.md): EC-Monitor user manual: passive EtherCAT network monitoring via an Ethernet TAP, architecture, integration guide, and the complete API reference.
- [Introduction](intro.html.md): EtherCAT® (Ethernet for Control Automation Technology) is a high-performance Ethernet Fieldbus techn...
- [Architecture](architecture.html.md): The EC-Monitor Software Development Kit (SDK) offers the possibility for Data Tracing / Listening / ...
- [Ethernet TAP](ethernet-tap.html.md): To capture the EtherCAT® traffic, EC-Monitor supports a variety of different Ethernet Test Access Po...
- [EtherCAT® MainDevices](ethercat-masters.html.md): In principle, all EtherCAT® MainDevices with ENI are supported. EtherCAT® MainDevices without ENI ar...
- [Getting Started](gettingstarted.html.md): To enable a quick and easy start, every EC-Monitor package comes with a pre-compiled EcMonitorDemo e...
- [Running EcMonitorDemo](gettingstarted_running-demo.html.md): To capture the EtherCAT® traffic insert a TAP device between the EtherCAT® adapter of the MainDevice...
- [Running EcMonitorDemoMqtt](gettingstarted_running-demo-mqtt.html.md): The EcMonitorDemoMqtt includes additional functionality to publish process data to an MQTT broker, f...
- [Compiling the EcMonitorDemo](gettingstarted_compiling.html.md): The following main rules can be used to generate the example applications for all operating systems.
- [Software Integration](integration.html.md): For the integration of the EC-Monitor, the EcMonitorDemo can be seen as an application framework, se...
- [Example application](integration_example.html.md): The example application will handle the following tasks:
- [Event notification](integration_notification.html.md): The EC-Monitor provides event notification for a great number of events. These events are for exampl...
- [Logging](integration_logging.html.md): The EC-Monitor offers a logging interface for a more detailed analysis of application errors, proble...
- [EtherCAT® Network Configuration ENI](integration_eni.html.md): The EtherCAT® configuration file ENI contains one or more Cyclic entries for reading new input data ...
- [Process Data Access](integration_processdata.html.md): The process data that is exchanged between an EtherCAT® MainDevice and the SubDevices in each cycle ...
- [Diagnosis](integration_diag.html.md): EtherCAT® offers comprehensive diagnostic capabilities at both hardware and software levels. Errors ...
- [MainDevice Variables](integration_mastervariables.html.md): MainDevice variables are an EC-Master extension that allows applications to trace data in real time ...
- [Operation without ENI](integration_genebi.html.md): The EC-Monitor can operate on a reduced feature set without an ENI file. This is particularly useful...
- [EC-Monitor Source Code](integration_src.html.md): In a source code delivery the EC-Monitor sources are divided into 4 parts:
- [Platform and Operating Systems (OS)](os.html.md): Setup and build instructions for the EC-Monitor demo application across all supported operating systems and platforms: Windows, Linux, VxWorks, and QNX.
- [Linux](os_linux.html.md): Linux itself is not real-time capable, so it is recommended to use it with the additional PREEMPT_RT...
- [QNX Neutrino](os_qnx.html.md): QNX Neutrino
- [Windriver VxWorks](os_vxworks.html.md): Windriver VxWorks
- [Microsoft Windows](os_windows.html.md): Microsoft Windows
- [Real-time Ethernet Driver](emll.html.md): This chapter describes how the EC-Monitor selects its Real-time Ethernet Driver module and lists the...
- [Real-time Ethernet Driver selection](emll_generic.html.md): The EC-Monitor currently supports a variety of different Real-time Ethernet Driver modules, each con...
- [Intel Pro/1000 - emllIntelGbe](emllintelgbe.html.md): The parameters to the Real-time Ethernet Driver Intel Pro/1000 are setup-specific.
- [Windows NDIS - emllNdis](emllndis.html.md): As default EC-Monitor for Windows contains `emllNdis.dll` to use a native Windows driver for EtherCA...
- [Windows WinPcap - emllPcap](emllpcap.html.md): An Ethernet Driver based on the WinPcap library is shipped with the EC-Monitor. This Ethernet Driver...
- [emllRemote](emllremote.html.md): The emllRemote is used to tunnel EtherCAT® frames within a TCP socket between EC-Master and EC-Simul...
- [VxWorks SNARF - emllSNARF](emllsnarf.html.md): Using the EC-Monitor stack’s SNARF Real-time Ethernet Driver it is possible to use any of the standa...
- [Linux SockRaw - emllSockRaw](emllsockraw.html.md): emllSockRaw is part of EC-Monitor for Linux. emllSockRaw uses the network interface of the native dr...
- [Windows TAP - emllTap](emlltap.html.md): The parameters to the Windows TAP Real-time Ethernet Driver are setup-specific. The function `Create...
- [Application programming interface, reference](api.html.md): Function prototypes, definitions etc. of the API can be found in the header file `EcMonitor.h` which...
- [General functions](api_general.html.md): Initialize EC-Monitor.
- [Packet Capture](api_pcap.html.md): Open packet capture file (PCAP).
- [Process Data functions](api_processdata.html.md): Blocking function to retrieve consistent process data from outside the JobTask context.
- [SubDevice status functions](api_slave.html.md): Returns the number of slaves which are configured in the ENI.
- [Diagnosis](api_diag.html.md): Gets the diagnosis image pointer.
- [Real-time Ethernet Driver Control Interface](api_linklayer.html.md): Determine whether the main link or redundancy link is connected.
- [EtherCAT® Mailbox Transfer](api_mbx.html.md): To be able to initiate a mailbox transfer the client has to create a mailbox transfer object first.
- [CAN application protocol over EtherCAT® (CoE)](api_mbx_coe.html.md): The EC-Monitor can forward CoE transfers to the application in real time via the notifications [emon...
- [File access over EtherCAT® (FoE)](api_mbx_foe.html.md): The EC-Monitor can record file transfers via the FoE protocol between an EtherCAT® MainDevice and a ...
- [Hot Connect](api_hotconnect.html.md): Get number of slaves belonging to a specific Hot-Connect group.
- [Configuration adjustments](api_superseteni.html.md): The Configuration adjustments allows to adapt the configuration without generating a new ENI file. T...
- [Generic notification interface](notification.html.md): One of the parameters the client has to set when registering with the EC-Monitor is a generic notifi...
- [Notification callback](notification_callback.html.md): Data structure filled with detailed information about the according notification.
- [emonNotifyApp](notification_emonnotifyapp.html.md): By calling this function the generic notification callback function setup by [`emonRegisterClient()`...
- [Enable/Disable notifications](notification_enable-disable.html.md): All notifications can be enabled or disabled. By default, all notifications are enabled except for:
- [Status notifications](notification_status.html.md): :members: -->
- [Error notifications](notification_error.html.md): For each error an error ID (error code) will be defined. This error ID will be used as the notificat...
- [RAS-Server for EC-Inspector and EC-Engineer](ras.html.md): The Remote Access Service (RAS) provides a socket-based uplink that lets diagnosis tools such as EC-...
- [Integration Requirements](ras_integration.html.md): To use the diagnosis tool EC-Inspector with a customer application, some modifications have to be ma...
- [Application programming interface](ras_api.html.md): Starts the RAS Server.
- [Error Codes](error-codes.html.md): |   **No.** | **Group**                                  | **Abbr.**   | **Description**            ...
- [Generic Error Codes](error-codes_generic.html.md): 0x00000000: No Error
- [DCM Error Codes](error-codes_dcm.html.md): 0x981201C0: Unspecific DCM Error
- [ADS over EtherCAT® (AoE) Error Codes](error-codes_aoe.html.md): 0x9813000D: AoE: No Rtime
- [CAN application protocol over EtherCAT® (CoE) SDO Error Codes](error-codes_coe.html.md): 0x98110040: SLV: SDO: Toggle bit not alternated (CoE abort code 0x05030000 of slave)
- [File Transfer over EtherCAT® (FoE) Error Codes](error-codes_foe.html.md): 0x98110060: SLV: ERROR FoE: not defined (FoE Error Code 0 (0x8000) of slave)
- [Servo Drive Profil over EtherCAT® (SoE) Error Codes](error-codes_soe.html.md): 0x98110078: ERROR SoE: Invalid access to element 0
- [Remote API Error Codes](error-codes_ras.html.md): 0x9811017D: RAS: Socket disconnected (e.g. IP connection terminated or lost)

---

For more comprehensive documentation, see [llms-full.txt](llms-full.txt)
