Tc3_Event: Event Logging Framework for TwinCAT 3

Tc3_Event is a lightweight, high-performance event logging framework designed for TwinCAT 3 automation projects. It provides structured, standardized logging for diagnostics, simplifies development, and integrates seamlessly with HMIs and SCADA systems.

---

📚 Table of Contents

• Overview
• Key Features
• Getting Started
• Advanced Usage
• Exports
• Screenshots
• Roadmap
• Contributing
• License
• Dual Licensing Model

---

🔍 Overview

Tc3_Event accelerates your development cycle by 30--50% by eliminating manual steps and implementing standardized, traceable logging from day one.
Built with Structured Text (ST) and reusable Function Blocks, it ensures clarity, consistency, and operational transparency.

---

🛠️ Key Features & Developer Benefits

---

Feature Description Benefit

---

Structured Logging Reusable Function Easy adoption & Blocks in ST maintainability

Automated ID Generation PowerShell script for Faster development, unique IDs fewer errors

Dynamic Parameters Embed variables in logs Context-rich diagnostics

HMI Ready Real-time display on Operational clarity HMIs

Multi-Level Log levels: Verbose, Efficient debugging Traceability Info, Warning,
Error, Critical

Functional Logger Dedicated component for Rapid commissioning testing

---

⚡ Getting Started

1. Clone the Repository

git clone https://github.com/PeterZerlauth/Tc3_Event.git

2. Import into TwinCAT 3

Add the library to your TwinCAT 3 project.

3. Initialize Loggers

PROGRAM MAIN
VAR
    fbLogger:       Tc3_Event.FB_LoggerManager;
    fbHmiLogger:    Tc3_Event.FB_HmiLogger;
    fbFileLogger:   Tc3_Event.FB_FileLogger;
    fbTcLogger:     Tc3_Event.FB_TcLogger;
END_VAR

fbLogger.M_Add(fbHmiLogger);
fbLogger.M_Add(fbFileLogger);
fbLogger.M_Add(fbTcLogger);

---

🔍 Advanced Usage

PROGRAM MAIN
VAR
    fbEvent: FB_Event;
END_VAR

fbEvent();
fbEvent.P_Logger := fbLogger;

fbEvent.M_Verbose('Verbose');

fbEvent.M_Info(2276475569, 'System initialized');

fbEvent.M_AddREAL(33.1345321, 3);
fbEvent.M_Warning(1791326186, 'High temperature detected < %s °C');

fbEvent.M_Error(2621541999, 'Motor communication failed');

fbEvent.M_Critical(2626343866, 'Emergency stop activated');

---

📤 JSON Export

.\export.ps1 -Languages @("en", "de", "es")

{
    "locale":  [ "en", "de", "es" ],
    "Events":  [
                   {
                       "id":  "849363082",
                       "key":  "Input %s is simulated"
                       "source":  [ "FB_Test1000", "FB_TestSlow" ]
                   }
  ]
}

---

📤 XML Export

<EventClass>
  <EventId>
    <Name Id="828536003">Tc3_Event_828536003</Name>
    <DisplayName TxtId=""><![CDATA[I message {0} {1}]]></DisplayName>
  </EventId>
</EventClass>

---

📸 Screenshots

---

---

🚀 Roadmap

• Structured Logging\
• HMI Integration\
• File Logging\
• TwinCAT Eventlogger Integration (in development)

---

🤝 Contributing

Pull requests are welcome. For major changes, open an issue first.

---

📝 Dual Licensing Model

Tc3_Event is distributed under a Dual License Model to support both open-source usage and commercial adoption.

1. Open Source License (GPLv3)

• Free for individuals, academia, and non-commercial use
• Permits commercial use only if derivative works remain open-source under GPLv3\
• Requires full source disclosure of modifications and derivative products

2. Commercial License

A commercial license is required for companies that:

• Integrate Tc3_Event into proprietary, closed-source products
• Cannot release their entire application under GPLv3
• Need warranty, professional support, or long-term maintenance
• Require customized licensing or integration rights

The commercial license removes GPLv3 copyleft obligations.

Contact for Commercial Licensing

For licensing inquiries, contact: [email protected]