👁 Image
SiLA2.Core 10.2.4

Introduction

.NET 10 Implementation of the SiLA2 Standard

• Platform-independent
• SiLA2.Server even runs on embedded Linux Host as recommended AspNetCore-Process
• Feature-To-Proto-Generation by XSLT
  • SiLA2 Core Features included in SiLA2.dll
  • Additional Features should be part of Feature-Implementation Assemblies (just add your features and protos in MSBuild Targets ProtoPreparation & ProtoGeneration like it is done in Assemblies TemperatureController.Features.csproj or ShakerController.Features.csproj)
• Extensible InProcess Server Web Frontend included (based on Blazor (https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor) which supports "server push" functionality by SignalR)

👁 image

• Optional Workflow Orchestration Module based on Nuget Package Stateless (https://github.com/dotnet-state-machine/stateless)
• Optional InProcess-Database-Module (based on SQLite) with basic User Management which can be easily extended.
• Optional InProcess-Document-Database-Module (based on LiteDB) named SiLA2.Database.NoSQL which can be used as AnIML data storage...
• Optional Inter Process Communication Module (SiLA2.IPC.NetMQ) for Socket Communication...compatible with ZeroMQ (https://zeromq.org/)
• Optional AnIML Module offering the AnIML Domain Model as C# classes generated from official AnIML schemas (https://github.com/AnIML/schemas)
• Optional Serial Port Managment Module for USB/RS-232/UART Communication
• Optional Component to manage Encryption and Certifcates

There´s also a Web Application SiLA2.UniversalClient.Net to control your running SiLA2.Servers in your local network.

If you want to see all the Modules and Components you should start SiLA2.Temperature.Server.App and afterwards SiLA2.Temperature.Server.App.Webfrontend. Running the Server the first time, you´ll have to add an exception to your browser once due to the self-signed certificate which was created by the Server if there´s none.

Platform Support

The following core NuGet packages multi-target both net10.0 and netstandard2.0 for broader compatibility:

• SiLA2.Core - Core server implementation
• SiLA2.Client - Client-side gRPC communication
• SiLA2.Client.Dynamic - Runtime dynamic client generation
• SiLA2.Communication - Dynamic protobuf marshalling
• SiLA2.Utils - Network utilities, mDNS, certificates
• SiLA2.StateMachine - Service Orchestration

This allows SiLA2 client applications to be built targeting .NET Framework 4.6.1+ or other .NET Standard 2.0 compatible platforms.

Prerequisites

• Linux / macOS
  • You´ll need the .NET 10 SDK >> https://dotnet.microsoft.com/en-us/download/dotnet/10.0
  • It´s not necessary to build applications with a GUI but if you do so an IDE like Visual Studio Code ( >> https://code.visualstudio.com/ ) would be convenient especially with Extension C# Dev Kit ( >> https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit ). Another alternative IDE is JetBrains Rider ( >> https://www.jetbrains.com/rider/ )
• Windows
  • Download free IDE Visual Studio 2026 Community ( >> https://visualstudio.microsoft.com/de/vs/community/ ), use commercial Visual Studio 2026 Version, Visual Studio Code or Rider (free for non-commercial use)
  • .NET 10 SDK is included in Visual Studio 2026...if you want to use Visual Studio Code or other IDEs you´ll have to download it on your own (see link above)

Getting Started

• Clone Repo
  • Please be sure fetching sila_base submodule by
    • checking out the Repository with git-submodules recursively
      • git clone --recurse-submodules https://gitlab.com/SiLA2/sila_csharp.git
    • or check out the Repository and run following commands
      • git submodule init
      • git submodule update
• Run SiLA2.Temperature.Server.App (SiLA2 Server)
• Run SiLA2.Temperature.Client.App connecting automatically to SiLA2 Server or
• Run SiLA2.Temperature.Server.App.Webfrontend (in Debug-Mode https://localhost:5011)
  • In the SiLA2 Server WebFrontend you´ll find Information and NavigationLinks of SiLA2 Temperature Server. There´s also an example of how Server-Push-Feature can be used...just click on NavigationLink "Temperature" and hit button "Change Temperature"...the values you produced can be saved as AnIML data by pushing the according button...

Build your own Project based on official Nuget-Packages

• Create ASP.NET Core Application as SiLA2.Server Project
• Search for & reference SiLA2.* packages found at Nuget.org in Visual Studio or https://www.nuget.org/ ...use at least SiLA2.Core (v10.2.3+)...
• Create *.sila.xml-Feature-File and include it like it was done in Example Project SiLA2.Referencing.Nuget.Features.csproj
• Add MSBuild Targets ProtoPreparation & ProtoGeneration in your FeatureAssembly.csproj:

Recommended Approach (SiLA2.Core v10.2.3+)

The SiLA2.Core NuGet package automatically provides $(SiLA2XsltPath) and $(SiLA2ProtoPath) via MSBuild props:

 <Target Name="ProtoPreparation" BeforeTargets="PrepareForBuild">
 
 <Error Condition="'$(SiLA2XsltPath)' == ''" Text="SiLA2XsltPath is not set. Ensure SiLA2.Core NuGet package v10.2.3+ is referenced." />

 <Message Text="Copying Base Protos..." Importance="high" />
 <Copy SourceFiles="$(SiLA2ProtoPath)SiLAFramework.proto" DestinationFolder="Protos/" />

 <Message Text="Started XmlTransformation TemperatureController-v1_0.sila.xml -&gt; TemperatureController.proto" Importance="high" />
 <XslTransformation XslInputPath="$(SiLA2XsltPath)fdl2proto.xsl" XmlInputPaths="$(MSBuildProjectDirectory)/Features/TemperatureController-v1_0.sila.xml" OutputPaths="Protos/TemperatureController.proto" />
 <Message Text="Finished XmlTransformation" Importance="high" />
 </Target>

 <Target Name="ProtoGeneration" DependsOnTargets="ProtoPreparation" AfterTargets="ProtoPreparation">
 <Message Text="Compiling Protos..." Importance="high" />
 <ItemGroup>
 <Protobuf Include="Protos\TemperatureController.proto" ProtoRoot="Protos\" GrpcServices="Both" OutputDir="Services\" />
 <Protobuf Update="Protos\SiLAFramework.proto" ProtoRoot="Protos\" CompileOutputs="false" />
 </ItemGroup>
 <Message Text="Finished Compiling Protos..." Importance="high" />
 </Target>

<details> <summary><b>Legacy Support (SiLA2.Core < 10.2.3)</b></summary>

For older versions of SiLA2.Core that don't include the MSBuild props, add this fallback target to download the required files:

 
 <Target Name="DownloadContentFiles" BeforeTargets="ProtoPreparation" Condition="'$(SiLA2XsltPath)' == ''">
 <DownloadFile SourceUrl="https://gitlab.com/SiLA2/sila_base/-/raw/master/xslt/fdl2proto.xsl" DestinationFolder="$(MSBuildProjectDirectory)/Features" DestinationFileName="fdl2proto.xsl" />
 <DownloadFile SourceUrl="https://gitlab.com/SiLA2/sila_base/-/raw/master/xslt/fdl2proto-messages.xsl" DestinationFolder="$(MSBuildProjectDirectory)/Features" DestinationFileName="fdl2proto-messages.xsl" />
 <DownloadFile SourceUrl="https://gitlab.com/SiLA2/sila_base/-/raw/master/xslt/fdl2proto-service.xsl" DestinationFolder="$(MSBuildProjectDirectory)/Features" DestinationFileName="fdl2proto-service.xsl" />
 <DownloadFile SourceUrl="https://gitlab.com/SiLA2/sila_base/-/raw/master/xslt/fdl-validation.xsl" DestinationFolder="$(MSBuildProjectDirectory)/Features" DestinationFileName="fdl-validation.xsl" />
 <DownloadFile SourceUrl="https://gitlab.com/SiLA2/sila_base/-/raw/master/protobuf/SiLAFramework.proto" DestinationFolder="$(MSBuildProjectDirectory)/Protos" DestinationFileName="SiLAFramework.proto" />
 </Target>

 <Target Name="ProtoPreparation" BeforeTargets="PrepareForBuild">
 <PropertyGroup>
 <_XsltPath Condition="'$(SiLA2XsltPath)' != ''">$(SiLA2XsltPath)</_XsltPath>
 <_XsltPath Condition="'$(SiLA2XsltPath)' == ''">$(MSBuildProjectDirectory)/Features/</_XsltPath>
 <_ProtoPath Condition="'$(SiLA2ProtoPath)' != ''">$(SiLA2ProtoPath)</_ProtoPath>
 <_ProtoPath Condition="'$(SiLA2ProtoPath)' == ''">$(MSBuildProjectDirectory)/Protos/</_ProtoPath>
 </PropertyGroup>

 <Message Text="Copying Base Protos..." Importance="high" />
 <Copy SourceFiles="$(_ProtoPath)SiLAFramework.proto" DestinationFolder="Protos/" Condition="'$(SiLA2ProtoPath)' != ''" />

 <XslTransformation XslInputPath="$(_XsltPath)fdl2proto.xsl" XmlInputPaths="$(MSBuildProjectDirectory)/Features/TemperatureController-v1_0.sila.xml" OutputPaths="Protos/TemperatureController.proto" />
 </Target>

 <Target Name="ProtoGeneration" DependsOnTargets="ProtoPreparation" AfterTargets="ProtoPreparation">
 <ItemGroup>
 <Protobuf Include="Protos\TemperatureController.proto" ProtoRoot="Protos\" GrpcServices="Both" OutputDir="Services\" />
 <Protobuf Update="Protos\SiLAFramework.proto" ProtoRoot="Protos\" CompileOutputs="false" />
 </ItemGroup>
 </Target>

</details>

• Build Feature-Assembly
• Implement the features you´ve defined in your *.sila.xml-Feature-File in your Feature-Assembly
• Reference your Feature-Assenbly in your SiLA2.Server Project
• Create SilA2-Clients communicating with the SiLA2.Server...in this case you might want to use Nuget-Package SiLA2.Client or SiLA2.Client.Dynamic

Build and Test

• Just build your Solution as described in "# Getting Started"
• Run your SilA2.Server.App
• Call Server from a Client, use the SiLA Universal Client (https://gitlab.com/SiLA2/universal-sila-client/sila_universal_client or use SiLA2.UniversalClient.Net ( >> https://gitlab.com/SiLA2/sila_csharp/-/tree/master/src/SiLA2.UniversalClient.Net )
• If you have problems building the solution you might clean your Nuget-Cache by 'dotnet nuget locals all --clear' once...

For more Information

Visit the SiLA2 C# Wiki

For open Issues

Visit https://gitlab.com/SiLA2/sila_csharp/-/issues

Contribution

It´s Open Source (License >> MIT)...feel free to use or contribute...