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...")
 
m (Updates sdk location)
 
(4 intermediate revisions by 2 users not shown)
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]
 +
* (Optional but really helpful) 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:
+
:# Create a folder somewhere on your drive and open CommandLine/PowerShell/Terminal in it
−
* basys.sdk
+
:# Clone BaSyx Repository: git clone https://git.eclipse.org/r/basyx/basyx
−
* basys.components
+
:# Navigate to folder {your-folder}/sdks/dotnet/
−
* basys.examples
+
:# Open BaSyx.SDK.sln in Visual Studio
 +
:# Build -> Rebuild Solution
 +
:# Done!
  
−
In order to start developing on the project, the first thing you need to do is
+
Note: Having built the project, in the respective build folder (bin) of each project NuGet Packages have been generated. This is the recommended way of using BaSys libraries within other projects. It is highly recommended to put all Nuget Packages into one folder and consider it as Local repository. To add a Local Repository, in Visual Studio go:
 +
:# Tools -> Options -> NuGet Package Manager -> Package Sources
 +
:# Press green "+" to add your local repository, give it a name and choose location by pressing "..."
 +
:# Press "Update" and "OK"
 +
:# Now you can select your local repository as NuGet Package source when adding new libraries to your project via NuGet Package Manager
  
−
# Make sure that each project has a JDK selected as JRE System Library
+
== Hello World Example ==
−
# Right-click “basys.sdk” >> Select “Run As” >> Select “Maven Install”
+
To get your first Asset Administation Shell up and running, do the following;
−
 
+
:# In Solution Explorer expand "Examples" folder
−
 
+
:# Right-click on HelloAssetAdministationShell-Project
−
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:
+
:# Select "Set as StartUp Project"
−
[[File:BaSyx_Java_Dependencies.PNG]]
+
:# Press Play!
−
 
+
:# Open your favorite browser and enter: "http://localhost:5080/ui"
−
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.
+
:# Now you should see a graphical user interface of the HelloAssetAdministrationShell
−
 
+
−
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. !!
+
−
'''
+

Latest revision as of 09:35, 18 June 2020

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
  • (Optional but really helpful) Microsoft Visual Studio >=2017 Community Edition Download

Getting started

  1. Create a folder somewhere on your drive and open CommandLine/PowerShell/Terminal in it
  2. Clone BaSyx Repository: git clone https://git.eclipse.org/r/basyx/basyx
  3. Navigate to folder {your-folder}/sdks/dotnet/
  4. Open BaSyx.SDK.sln in Visual Studio
  5. Build -> Rebuild Solution
  6. Done!

Note: Having built the project, in the respective build folder (bin) of each project NuGet Packages have been generated. This is the recommended way of using BaSys libraries within other projects. It is highly recommended to put all Nuget Packages into one folder and consider it as Local repository. To add a Local Repository, in Visual Studio go:

  1. Tools -> Options -> NuGet Package Manager -> Package Sources
  2. Press green "+" to add your local repository, give it a name and choose location by pressing "..."
  3. Press "Update" and "OK"
  4. Now you can select your local repository as NuGet Package source when adding new libraries to your project via NuGet Package Manager

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!
  5. Open your favorite browser and enter: "http://localhost:5080/ui"
  6. Now you should see a graphical user interface of the HelloAssetAdministrationShell
Retrieved from "https://wiki.eclipse.org/index.php?title=BaSyx_/_Download_/_.NET_Setup&oldid=439626"

This page was last modified 09:35, 18 June 2020 by Frank Schnicke. Based on work by Daniel Espen and Constantin Ziesche.

Back to the top