Beckhoff.TwinCAT.TcEventLoggerAdsProxy.Net 2.9.2

Description

The package 'Beckhoff.TwinCAT.EventloggerAdsProxy' contains a client for interacting with the TwinCAT 3 Eventlogger. It includes everything to develop own .NET Core applications (e.g. HMI, Datalogger) to communicate with TwinCAT devices.

Requirements

• Operating System: TwinCAT/BSD, Windows 10, Windows 11

Documention

The actual version of the documentation is available in the Beckhoff Infosys. Beckhoff Information System

Getting Started

using TcEventLoggerAdsProxyLib;
using System.Globalization;

var logger = new TcEventLogger();

logger.MessageSent += (TcMessage message) => Console.WriteLine("Received Message: " + message.GetText(CultureInfo.CurrentCulture.LCID));
logger.AlarmRaised += (TcAlarm alarm) => Console.WriteLine("Alarm Raised: " + alarm.GetText(CultureInfo.CurrentCulture.LCID));
logger.AlarmCleared += (TcAlarm alarm, bool bRemove) => Console.WriteLine((bRemove ? "Alarm Cleared and was Confirmed: " : "Alarm Cleared: ") + alarm.GetText(CultureInfo.CurrentCulture.LCID));
logger.AlarmConfirmed += (TcAlarm alarm, bool bRemove) => Console.WriteLine((bRemove ? "Alarm Confirmed and was Cleared: " : "Alarm Confirmed: ") + alarm.GetText(CultureInfo.CurrentCulture.LCID));

logger.Connect(); //connect to localhost

Console.Write("Press 'x' or CTRL+C to quit");
while (true)
{
    if (Console.ReadKey(true).Key == ConsoleKey.X) break;
}

Send Message

using TcEventLoggerAdsProxyLib;

var logger = new TcEventLogger();
logger.Connect(); //connect to localhost

var cls = Guid.Parse("{E0777B97-0929-4CC3-8996-A3555C4C663B}");
var id = 123u;
var severity = SeverityLevelEnum.Error;

var source = new TcSourceInfo
{
    Name = "SendTcMessageSample",
    Guid = Guid.Parse("{E0858882-E4F2-4B42-8729-1753BCC26FD0}"),
    Id = 999
};

var event_args = new TcArguments
{
    "X_Axis",
    123
};

Console.Write("Press 's' to send and 'x' or CTRL+C to quit");

while (true)
{
    var input = Console.ReadKey(true);
    if (input.Key == ConsoleKey.S)
        logger.SendTcMessage(cls, id, severity, "{ axis : { name : 'X-Axis', index : 2 }", source, event_args);
    else if (input.Key == ConsoleKey.X) break;
}

Localized Source Name

To access localized source names, cast Message, Alarm or LoggedEvent to ITcSourceInfoLocalization. Use either the As<type> method or (from .NET 5.0) the direct as cast operator. Returns null if the function is not supported by the runtime.

var localizedSource = message.As<ITcSourceInfoLocalization>();
var localizedName = localizedSource?.GetLocalizedSourceName(CultureInfo.CurrentCulture.LCID);

// .NET 5.0+ alternative:
var localizedName2 = (message as ITcSourceInfoLocalization)?.GetLocalizedSourceName(CultureInfo.CurrentCulture.LCID);