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"

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]
+
* (Optional but really helpful) Microsoft Visual Studio >=2017 Community Edition [https://visualstudio.microsoft.com/de/vs/community/ Download]
  
 
== Getting started ==
 
== Getting started ==
:# Create a custom directory somewhere on your drive and navigate there by terminal
+
:# Create a folder somewhere on your drive and open CommandLine/PowerShell/Terminal in it
:# git clone https://git.eclipse.org/r/basyx/basyx
+
:# Clone BaSyx Repository: git clone https://git.eclipse.org/r/basyx/basyx
:# Navigate to directory sdks/csnet/
+
:# Navigate to folder {your-folder}/sdks/csnet/
:# Open BaSyx.SDK.sln in Visual Studio
+
:# Open BaSyx.SDK.sln in Visual Studio  
 
:# Build -> Rebuild Solution
 
:# Build -> Rebuild Solution
 
:# Done!
 
:# 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:
 +
:# 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
  
 
== Hello World Example ==
 
== Hello World Example ==
Line 23: Line 29:
 
:# Select "Set as StartUp Project"
 
:# Select "Set as StartUp Project"
 
:# Press Play!
 
:# Press Play!
 +
:# Open your favorite browser and enter: "http://localhost:5080/ui"
 +
:# Now you should see a graphical user interface of the HelloAssetAdministrationShell

Revision as of 14:21, 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
  • (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/csnet/
  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

Back to the top