AasCore.Aas3.Package
2.0.0
Prefix Reserved
dotnet add package AasCore.Aas3.Package --version 2.0.0
NuGet\Install-Package AasCore.Aas3.Package -Version 2.0.0
<PackageReference Include="AasCore.Aas3.Package" Version="2.0.0" />
<PackageVersion Include="AasCore.Aas3.Package" Version="2.0.0" />
<PackageReference Include="AasCore.Aas3.Package" />
paket add AasCore.Aas3.Package --version 2.0.0
#r "nuget: AasCore.Aas3.Package, 2.0.0"
#:package AasCore.Aas3.Package@2.0.0
#addin nuget:?package=AasCore.Aas3.Package&version=2.0.0
#tool nuget:?package=AasCore.Aas3.Package&version=2.0.0
aas-package3-csharp
Aas-package3-csharp is a library for reading and writing packaged file format of an Asset Administration Shell (AAS) in C#.
Status
The library is thoroughly tested and meant to be used in production.
.NET 10, .NET Framework 4.6.2 and later, as well as .NET Standard 2.0 and 2.1 are supported. Version 2 dropped the dedicated builds for .NET 8 and 9, which reached their end of support in November 2026.
Documentation
The documentation is available at https://eclipse-aascw.github.io/aas-package3-csharp/doc.
Teaser
Here is are short snippets to demonstrate how you can use the library.
To create and write to a package:
// General packaging handler to be shared accross the program
var packaging = new AasCore.Aas3.Package.Packaging();
// Create a package
{
byte[] specContent = ...;
byte[] thumbnailContent = ...;
byte[] supplementaryContent = ...;
using var pkg = packaging.Create("/path/to/some/file");
var spec = pkg.MakeSpec(
pkg.PutPart(
new Uri(
"/aasx/some-company/data.json",
UriKind.Relative),
"text/json",
specContent);
pkg.MakeThumbnail(
pkg.PutPart(
new Uri(
"/some-thumbnail.png",
UriKind.Relative),
"image/png",
thumbnailContent));
pkg.RelateSupplementaryToSpec(
pkg.PutPart(
new Uri(
"/aasx-suppl/some-company/some-manual.pdf",
UriKind.Relative),
"application/pdf",
supplementaryContent),
spec);
pkg.Flush();
}
To read from the package:
// General packaging handler to be shared accross the program
var packaging = new AasCore.Aas3.Package.Packaging();
// Read from the package
byte[] specContent;
byte[] thumbnailContent;
byte[] supplementaryContent;
{
using var pkgOrErr = packaging.OpenRead(
"/path/to/some/file");
var pkg = pkgOrErr.Must();
// Read the specs
var specsByContentType = pkg.SpecsByContentType();
if (!specsByContentType.ContainsKey("text/json"))
{
throw new ArgumentException("No json specs");
}
var spec = specsByContentType["text/json"].First();
specContent = spec.ReadAllBytes();
// Read the thumbnail
var thumbnail = pkg.Thumbnail();
if(thumbnail != null)
{
thumbnailContent = pkg.Thumbnail().ReadAllBytes();
// Do something with the thumbnail content
}
// Read the supplementary file
supplementaryContent = pkg
.MustPart(
new Uri(
"/aasx-suppl/some-company/some-manual.pdf",
UriKind.Relative))
.ReadAllBytes();
}
Please see the full documentation at [https://eclipse-aascw.github.io/aas-package3-csharp/doc] for more details.
Installation
The library is available on NuGet at: https://www.nuget.org/packages/AasCore.Aas3.Package/
Versioning
The name of the library indicates the supported version of the Asset Administration Shell (AAS).
In case of aas-package3-csharp, this means that the Version 3 of the Asset Administration Shell (AAS) is supported.
We follow Semantic Versioning to version the library. The version X.Y.Z indicates:
- X is the major version (backward-incompatible),
- Y is the minor version (backward-compatible), and
- Z is the patch version (backward-compatible bug fix).
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.2
- System.IO.Packaging (>= 10.0.15)
-
.NETStandard 2.0
- System.IO.Packaging (>= 10.0.15)
-
.NETStandard 2.1
- System.IO.Packaging (>= 10.0.15)
-
net10.0
- System.IO.Packaging (>= 10.0.15)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on AasCore.Aas3.Package:
| Package | Downloads |
|---|---|
|
twinsphere.TypedAasMetamodels
This library provides types for various standardized submodels, simplifying the creation of submodel instances with first-level language support. It abstracts the complexities of the meta model, facilitating the creation of accurate submodel instances. Additional features include validation rules derived from submodel templates and conversion logic for transforming submodels to and from the original AAS metamodel representations. |
|
|
FluentAAS.IO
JSON and AASX serialization/export utilities for Asset Administration Shell (AAS) models in FluentAAS. |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on AasCore.Aas3.Package:
| Repository | Stars |
|---|---|
|
admin-shell-io/aasx-package-explorer
C# based viewer / editor for the Asset Administration Shell
|
|
|
eclipse-aaspe/package-explorer
AASX Package Explorer
|
| Version | Downloads | Last Updated |
|---|---|---|
| 2.0.0 | 115 | 11/12/2026 |
| 1.0.6 | 93 | 11/12/2026 |
| 1.0.5 | 93 | 11/12/2026 |
| 1.0.4 | 16,165 | 4/30/2026 |
| 1.0.3 | 1,353 | 2/27/2026 |
| 1.0.2 | 14,662 | 6/4/2025 |
| 1.0.1 | 15,549 | 3/13/2024 |
| 1.0.0 | 1,988 | 2/15/2024 |
| 1.0.0-pre9 | 4,648 | 7/23/2022 |
| 1.0.0-pre8 | 552 | 7/2/2021 |
| 1.0.0-pre7 | 4,852 | 7/2/2021 |
| 1.0.0-pre6 | 573 | 6/30/2021 |
| 1.0.0-pre5 | 437 | 6/4/2021 |
| 1.0.0-pre4 | 494 | 6/4/2021 |
| 1.0.0-pre3 | 446 | 6/4/2021 |
| 1.0.0-pre2 | 648 | 5/22/2021 |
| 1.0.0-pre1 | 501 | 5/21/2021 |