Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "BaSyx / Download / .NET Setup"

(Created page with "= How to build the BaSyx .NET Core SDK = The BaSyx .NET Core SDK can be build via dotnet CLI as wells as Microsoft Visual Studio. It uses NuGet for dependency management. Thi...")
 
Line 7: Line 7:
 
The BaSyx .NET Core SDK requires the following dependencies to successfully build:
 
The BaSyx .NET Core SDK requires the following dependencies to successfully build:
 
* .NET Core SDK 2.2 [https://dotnet.microsoft.com/download/dotnet-core/2.2 Download]
 
* .NET Core SDK 2.2 [https://dotnet.microsoft.com/download/dotnet-core/2.2 Download]
 +
* Microsoft Visual Studio >=2017 Community Edition [https://visualstudio.microsoft.com/de/vs/community/ Download]
  
 
== Getting started ==
 
== Getting started ==
The following Eclipse Projects can to be imported to Eclipse:
+
0. Create a custom directory somewhere on your drive and navigate there by terminal
* basys.sdk
+
1. git clone https://git.eclipse.org/r/basyx/basyx
* basys.components
+
2. Navigate to directory sdks/csnet/
* basys.examples
+
3. Open BaSyx.SDK.sln in Visual Studio
 +
4. Build -> Rebuild Solution
 +
5. Done!
  
In order to start developing on the project, the first thing you need to do is
+
== Hello World Example ==
 
+
To get your first Asset Administation Shell up and running, do the following;
# Make sure that each project has a JDK selected as JRE System Library
+
1. In Solution Explorer expand "Examples" folder
# Right-click “basys.sdk” >> Select “Run As” >> Select “Maven Install”
+
2. Right-click on HelloAssetAdministationShell-Project
 
+
3. Select "Set as StartUp Project"
 
+
4. Press Play!
Maven will download all required sources, run the unit and integration tests and export a jar of the SDK to the .components and .examples project. The mentioned projects are depending on each other in the following sense:
+
[[File:BaSyx_Java_Dependencies.PNG]]
+
 
+
That means the basys.sdk project is required as a .jar file in each of the local maven repositories of basys.examples and basys.components. If you want to make changes to the basys.sdk project, you need to make a maven install in order to see the changes reflect in the other projects.
+
 
+
Before you get started, the second task you need to do is to update the .sdk project to align with the maven configuration. For this what you need to do is
+
* Right-click “basys.sdk” >> Select “Maven” >> Select “Update Project…” (ignore errors)
+
 
+
Finally, the last step is to run a Maven clean compile to make sure that the changes you do during coding are directly reflected when you execute single unit tests manually.
+
* Right-click “basys.sdk” >> Select “Run As” >> Select “Build…” >> Type “clean compile” and hit Enter
+
 
+
 
+
'''!! Note: Make sure to clean compile after each install! Otherwise, your changes in the code will not be reflected in manual unit testing. !!
+
'''
+

Revision as of 14:06, 22 June 2019

How to build the BaSyx .NET Core SDK

The BaSyx .NET Core SDK can be build via dotnet CLI as wells as Microsoft Visual Studio. It uses NuGet for dependency management. This article will detail on how to build the .NET Core SDK from a fresh checkout.

Requirements

The BaSyx .NET Core SDK requires the following dependencies to successfully build:

  • .NET Core SDK 2.2 Download
  • Microsoft Visual Studio >=2017 Community Edition Download

Getting started

0. Create a custom directory somewhere on your drive and navigate there by terminal 1. git clone https://git.eclipse.org/r/basyx/basyx 2. Navigate to directory sdks/csnet/ 3. Open BaSyx.SDK.sln in Visual Studio 4. Build -> Rebuild Solution 5. Done!

Hello World Example

To get your first Asset Administation Shell up and running, do the following; 1. In Solution Explorer expand "Examples" folder 2. Right-click on HelloAssetAdministationShell-Project 3. Select "Set as StartUp Project" 4. Press Play!

Back to the top