TcOpen

Features

Application framework

• Messaging (alarms)

• Logging plc events and user action

• Plc Dialogs

• Sequenced coordination

Data framework

Data framework requires inxton framework.

• CreateReadUpdateDelete (CRUD) operations directly from the plc
• Generic interface for implementation of any repository
• TcOpen contains implementation for MongoDB, Json, InMemory

Inspectors

Advanced handling of signal inspections

Components

• TcoElements (basic components for discrete, analogue inputs, sensors, etc)
• TcoPneumatics (components for pneumatic components like cylinders, etc)
• TcoDrivesBeckhoff (components for drives base on NC task)

Other

• MQTT Sink for TcoLogging.
• MQTT Change observer

The full list of accessible features is kept up to date here.

State of the Project

The original open-source TcOpen project, developed by the TcOpenGroup organization, has been archived and is publicly available. It is now maintained exclusively for Inxton’s internal needs, with no plans for further extension or development.

Documentation

There is a separate documentation repository for this project here. At this moment we use docfx to generate documentation. The docfx uses IVF twin objects of PLC code to generate the API documentation. There is room for improvement in generated documentation; we do plan - in the course of the development of TcOpen - to improve that.

Working with TcOpen

If you just want to use TcOpen

If you want to use TcOpen in your application you may prefer using the libraries delivered as NuGet packages instead of this repository. Have a look at this video playlist where you can find more about the structure of the TcOpen application.

Contributing

We do not accept contributions at this point.

---

Prerequisites

1. Visual Studio 2019 (at least Community Edition) v16.8.3+ English version (other language mutation may not work properly).
2. TwinCAT 3.1 eXtended Automation Engineering (XAE) TwinCAT 3.1 4024.17+
3. .NET Framework 4.8 developer pack
4. .NET6 developer pack (6.0.5)
5. Inxton Vortex Builder extension

---

Clone this repository

git clone https://github.com/TcOpenGroup/TcOpen.git

Environment variables

You should set up Windows environment variable Tc3Target with the value of AMS ID of your testing target system.

Build project to restore necessary tooling and packages

BEFORE RUNNING THE SCRIPT MAKE SURE ALL INSTANCES OF VISUAL STUDIO ARE CLOSED. THE SCRIPT WILL OPEN VS TO COMPLETE THE BUILD OF THE PROJECT.

VS 2019 Community edition

cd your_tcopen_folder
.\pipelines\runbuild.ps1 -properties @{"buildConfig" = "Debug";
                                      "isTestingEnabled" = $false;
                                      "msbuildVerbosity" = "minimal";
                                      "publishNugets"= $false;
                                      "updateAssemblyInfo" = $false;
                                      "msbuild" = "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin\MSBuild.exe";
                                      "dotnet" = "C:\Program Files\dotnet\dotnet.exe";
                                      "devenv" = "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\devenv.com"}

VS 2019 Pro edition

cd your_tcopen_folder
.\pipelines\runbuild.ps1 -properties @{"buildConfig" = "Debug";
                                      "isTestingEnabled" = $false;
                                      "msbuildVerbosity" = "minimal";
                                      "publishNugets"= $false;
                                      "updateAssemblyInfo" = $false;
                                      "msbuild" = "C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\MSBuild\Current\Bin\MSBuild.exe";
                                      "dotnet" = "C:\Program Files\dotnet\dotnet.exe";
                                      "devenv" = "C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\Common7\IDE\devenv.com"}

In the initial part of the build, you may see some errors popping up due to missing g.cs files (untracked by git). You can ignore those messages as long as the build completes like this:

Open visual studio TcOpen.sln

Switch profile to Debug|TwinCAT RT (x64)

The build process might be susceptible to some issues due to configuration and environment differences. Should you encounter a problem, please report the issue here