Integration Requirements

7.1. Integration Requirements

To use the diagnosis tool EC-Lyser with a customer application, some modifications have to be done during integration of the EC-Master. The task is to integrate and start the Remote API Server system within the custom application, which provides a socket based uplink, which later on is connected by the EC-Lyser.

Remote Access Service (RAS) architecture showing a client application connecting over TCP/IP to a remote EC-Master server that controls an EtherCAT network

skinparam monochrome true
skinparam SequenceMessageAlign direction

node "EC-Lyser" {
    [RAS-Client]
}
node "EC-Master application" {
    [RAS-Server]
    [EC-Master core]
}

[RAS-Client] - [RAS-Server]
[RAS-Server] - [EC-Master core]

An example on how to integrate the Remote API Server within the application is given with the example application EcMasterDemo, which in case is pre-configured to listen for EC-Lyser on TCP Port 6000 when command line parameter EcMasterDemo -sp is given.

To clarify the steps which are needed within a custom application, a developer may use the following pseudo-code segment as a point of start. The Remote API Server library EcMasterRasServer.lib (or respectively EcMasterRasServer.a) must be linked.