fbarresi / softbeckhoff Goto Github PK

Virtual Beckhoff PLC for local testing with docker support

License: MIT License

C# 99.21% Dockerfile 0.79%

softbeckhoff's Introduction

SoftBeckhoff

This project was inspired by SoftPlc and aims to reach the same goal: a virtual PLC (a Beckhoff in this case) for testing usage.

Beckhoff PLCs communicates with the ADS Protocol. Since there are no opensouce ADS Servers I wrote a simple one with reverse engineering.

Please note that this software is still under development.

Features

✔️ Multiplatform + Docker Support (Windows, Linux, Mac OS)
✔️ Configurable with an Rest API (Swagger)
✔️ Works and act like a real Beckhoff!
✔️ All native types are supported
✔️ Route management on-board and over Rest API

Still under (heavy) development...

🌈 Support for custom compex types and arrays

How to use it?

A good tool for testing and writing symbols is TwincatAdsTool. This software was even tested with it.

run with docker

docker pull fbarresi/softbeckhoff:latest
docker run -p 8080:80 -p 48898:48898 --name softBeckhoff fbarresi/softbeckhoff:latest

Run it locally

todo basically with source code and dotnet run

Would you like to contribute?

Yes, please!

give a ⭐
make a fork
use and spread the software!

Other interesting related projects

TwincatAdsTool your swiss knife for twincat development.
BeckhoffHttpClient, an unofficial TwinCAT function for HTTP requests
BeckhoffS7Client, an unofficial TwinCAT function for S7 communication

Credits

Special thanks to JetBrains for supporting this open source project.

did you understand that you didn't understand?

Don't hesitate to write me or open an issue into this project!

softbeckhoff's People

Contributors

Stargazers

Watchers

Forkers

jforge bubdm leonard-lei bgjeorgiev goodmail126 519984307 3mul0r nerds-odd-e

softbeckhoff's Issues

is this a working XAR of TwinCAT?

Hi @fbarresi ,
Is this SoftBeckhoff a TwinCAT XAR?
I'm not sure what its functionality is for?
Best regards, Víctor.

GET undefined symbol results in 500 Server error

In the default server, calling GET: /symbols/test3 results in 500 Server error. I would have expected a 404.

System.ArgumentException: Symbol not found! at SoftBeckhoff.Services.BeckhoffServer.ReadSymbol(String name) in /app/Services/BeckhoffServer.cs:line 67 at SoftBeckhoff.Services.BeckhoffService.GetSymbol(String name) in /app/Services/BeckhoffService.cs:line 46 at lambda_method(Closure , Object , Object[] ) at Microsoft.Extensions.Internal.ObjectMethodExecutor.Execute(Object target, Object[] parameters) at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.SyncObjectResultExecutor.Execute(IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments) at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.InvokeActionMethodAsync() at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted) at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.InvokeNextActionFilterAsync()

Please add guidance on how to connect from TwinCAT XAE

I have started the docker container, and can connect to the swagger API using a web browser, but I don't know how to add a route to the softBeckhoff PLC.

Please add some guidance on what value to put into the routing, and/or if routes need to be set up on the softBeckhoff via the API.

how to test

How to test, how to use twincat client to read test data

Update ASP.NET docker container to new URI

https://hub.docker.com/_/microsoft-dotnet-aspnet

Microsoft have moved/renamed their docker containers as part of .NET Core 5,0 release.

You should be able to rename the ASP.NET docker container used to the LTS version without any other changes: mcr.microsoft.com/dotnet/aspnet:3.1

Can't read/write virtual plc when running it from Docker

Hello, I am trying your virtual-plc and I have an issue.
When I start the program on my machine everything works fine and I can read and write values in ADS.
But when I am starting it in Docker, I can't read and write values in my plc. I have an exception : TwinCAT.Ads.AdsErrorException : 'Target port could not be found. (AdsErrorCode: 6, 0x6)'

Here is the log of my container :

dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Application Directories
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
=======================
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
ApplicationPath: /app/SoftBeckhoff.dll
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
BaseDirectory: /app/
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
CurrentDirectory: /app
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Configuration
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
=============
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
ASPNETCORE_ENVIRONMENT: Production
Provider: ChainedConfigurationProvider
Provider: JsonConfigurationProvider
Provider: JsonConfigurationProvider
Provider: EnvironmentVariablesConfigurationProvider
Provider: CommandLineConfigurationProvider
Provider: JsonConfigurationProvider
Local System: SoftBeckhoff, 192.168.1.20.1.1, 172.17.0.5

Configured routes:
RemoteSystem1, 10.30.2.124.1.1, RemoteSystem1

dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Starting remote listeners ...
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Starting listening on 172.17.0.5:48898
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Waiting for Request to AmsTcpIpRouter (192.168.1.20.1.1)
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
[AmsTcpIpRouter] Start Listener
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Opening Loopback listener '127.0.0.1:48898'
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
[AmsTcpIpRouter] Start Listener
info: Microsoft.Hosting.Lifetime[0]
Now listening on: http://[::]:80
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Production
info: Microsoft.Hosting.Lifetime[0]
Content root path: /app
info: SoftBeckhoff.Services.BeckhoffService[0]
Initializing Beckhoff server...
info: SoftBeckhoff.Services.BeckhoffService[0]
Beckhoff server created
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Opening Loopback listener '127.0.0.1:48898'
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
[AmsTcpIpRouter] Start Listener
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
[AmsTcpIpRouter] TCP Connect Endpoint: 127.0.0.1:37776
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Port '852' occupied!
info: TwinCAT.Ads.AdsRouterService.RouterService[0]
AdsServer with AmsPort '192.168.1.20.1.1:65535' registered!
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Starting Receive AdsServer '192.168.1.20.1.1:65535 (Endpoint: 127.0.0.1:37776)' registered!
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
--> Sending Frame: TcpFrame Flags: PortConnect, DataSize: 8 (TcpFrameSize: 14)
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
--> Send TcpFrame: TcpFrame Flags: PortConnect, DataSize: 8 (TcpFrameSize: 14)
info: TwinCAT.Ads.AdsRouterService.RouterService[0]
AdsServer '192.168.1.20.1.1:852' connected! (2 loopback connections active)
info: SoftBeckhoff.Services.BeckhoffService[0]
Beckhoff server connected = True with result = 852
info: Microsoft.Hosting.Lifetime[0]
Application is shutting down...
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
A task was canceled.
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
[AmsTcpIpRouter] TCP Disconnect Endpoint: 127.0.0.1:37776
dbug: TwinCAT.Ads.AdsRouterService.RouterService[0]
Loopback listener '127.0.0.1:48898' closed!

Do you know what could cause that ?

Connect to docker via pyads

hey @fbarresi thanks for this amazing docker.

i want to connect to this docker via pyads.

the pyads' documentation provides a simple code example:

import pyads

 # Connection(ams_net_id: str | None = None, ams_net_port: int | None = None, ip_address: str | None = None)
plc = pyads.Connection('127.0.0.1.1.1', 851)
plc.open()
i = plc.read_by_name("GVL.int_val")
print(i)
plc.close()

what do i have to do to access the test1 variable from the docker? right now i'm always getting a connection timeout:

pyads.pyads_ex.ADSError: ADSError: timeout elapsed (1861).