Prepare SDK-V-0302

CHANGELOG.md

@@ -0,0 +1,116 @@
+# Software Development Kit for ctrlX AUTOMATION
+
+## CHANGELOG
+
+### 3.2.0
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.6.4...3.2.0)
+
+### 2.6.4
+
+#### FIXED
+
++ Fix: Apps implementing a Datalayer provider using the Datalayer go API may crash randomly and unpredictable after a long period of running fine.
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.6.1...2.6.4)
+
+### 2.6.1
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.4.0...2.6.1)
+
+### 2.4.0
+
+#### FIXED
+
++ n/a
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.4...2.4.0)
+
+### 2.2.4 (SDK-V-0202.4)
+
+#### FIXED
+
++ Fix: [Release SDK-V-0202.3](https://github.com/boschrexroth/ctrlx-automation-sdk/releases/tag/2.2.3) contained a not released .NET Datalayer API (3.3.1), instead of version 3.0.3.
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.0...2.2.3)
+
+### 2.2.3 (SDK-V-0202.3)
+
+#### FIXED
+
++ Fix: [Direct call to the mddb compiler](https://github.com/boschrexroth/ctrlx-automation-sdk/pull/27)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/2.2.0...2.2.3)
+
+### 2.2.0 (SDK-V-0202)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.20.0...2.2.0)
++ Changed: Update package-assets.md
+
+### 1.20.0 (SDK-V-0120)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.18.0...1.20.0)
+
+### 1.18.0 (SDK-V-0118)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.16.0...1.18.0)
+
+### 1.16.0 (SDK-V-0116)
+
+#### FIXED
+
++ Fix: Removed broken links to source code and replaced by implementation description
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.14.0...1.16.0)
++ Changed: Updated versions of package dependencies
++ Changed: Use latest available dedicated package versions (removed caret)
+
+### 1.14.0 (SDK-V-0114)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.12.1...1.14.0)
+
+### 1.12.1 (SDK-V-0112.1)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.12.0...1.12.1)
+
+### 1.12.0 (SDK-V-0112)
+
+#### CHANGED
+
++ [Changes](https://github.com/boschrexroth/ctrlx-automation-sdk/compare/1.10.0...1.12.0)
+
+### 1.10.0 (SDK-V-0110)
+
+Initial SDK release

CONTRIBUTORS.md

@@ -4,4 +4,3 @@ in alphabetical order:
 * [Johannes Albrecht](https://github.com/albrecht-j), ![Repo Maintainer](https://badgen.net/badge/repo/maintainer/blue "Repo Maintainer")
 * [Matthias Stamm](https://github.com/DonCamillo72),
 * [Sebastian Krauskopf](https://github.com/krauskopf)
-

LICENSE

@@ -1,6 +1,9 @@
+This license applies only to the code in this repository. 
+Images, fonts and other assets are explicitly excluded.
+
 MIT License
 
-Copyright (c) 2023 Bosch Rexroth AG
+Copyright (c) 2024 Bosch Rexroth AG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,6 @@
 # Software Development Kit for ctrlX AUTOMATION
 
-This is the software development kit (SDK) for [ctrlX AUTOMATION](https://www.ctrlx-automation.com). It can be used to program Apps for ctrlX CORE. 
+This is the software development kit (SDK) for [ctrlX AUTOMATION](https://www.ctrlx-automation.com). It can be used to program Apps for ctrlX CORE.
 
 Browse through the manual via: [ctrlX AUTOMATION Software Development Kit](https://boschrexroth.github.io/ctrlx-automation-sdk)
 
@@ -29,41 +29,55 @@ If your ctrlX App Build Environment is running, you can log in and install the c
 
 ## Installation of the ctrlX AUTOMATION SDK
 
-The installation of the ctrlX AUTOMATION SDK takes place in three steps:
+__These installation steps are required on both an App Build Environment and an Ubuntu Server or Desktop System.__
+
+### Clone and Install the ctrlX AUTOMATION SDK
 
-1. Install required Debian packages.
-2. Install [snapcraft](https://snapcraft.io/snapcraft)
-3. Clone the ctrlX AUTOMATION SDK github repo and install the content of the ctrlX AUTOMATION SDK zip file
+Start a console session, change to your destination directory and enter:
 
-__These installation steps are required on both an App Build Environment and an Ubuntu Server or Desktop System.__
+	wget https://raw.githubusercontent.com/boschrexroth/ctrlx-automation-sdk/main/scripts/clone-install-sdk.sh && chmod a+x *.sh && ./clone-install-sdk.sh
+
+As a result, your local copy of the github repo is stored within the directory __ctrlx-automation-sdk/__
 
 ### Install required Debian packages
 
-Start a console session and enter these commands sequentially:
+Stay in the directory and enter:
 
-	wget https://raw.githubusercontent.com/boschrexroth/ctrlx-automation-sdk/main/scripts/install-required-packages.sh
-	chmod a+x *.sh
-	./install-required-packages.sh
+	ctrlx-automation-sdk/scripts/install-required-packages.sh
 
 ### Install snapcraft
 
-Start a console session and enter these commands sequentially:
+Stay in the directory and enter:
 
-	wget https://raw.githubusercontent.com/boschrexroth/ctrlx-automation-sdk/main/scripts/install-snapcraft.sh
-	chmod a+x *.sh
-	./install-snapcraft.sh
+	ctrlx-automation-sdk/scripts/install-snapcraft.sh
 
-### Clone and Install the ctrlX AUTOMATION SDK
+### Install ctrlx-datalayer Debian package
+
+Stay in the directory and enter:
+
+	ctrlx-automation-sdk/scripts/install-ctrlx-datalayer.sh ctrlx-automation-sdk/deb
+
+### Building Sample Projects
+
+Now you are able to build the C++ and Python sample projects.
+
+To build sample projects in other programming languages further installation steps are required.
+
+Change to the directory `ctrlx-automation-sdk/scripts` and start the according install script.
+
+For go samples:
+
+	install-go.sh
+
+For .NET samples:
 
-Start a console session, change to your destination directory and enter these commands sequentially:
+	install-dotnet-sdk.sh
 
-	wget https://raw.githubusercontent.com/boschrexroth/ctrlx-automation-sdk/main/scripts/clone-install-sdk.sh
-	chmod a+x *.sh
-	./clone-install-sdk.sh
+For nodejs samples:
 
-As a result, your local copy of the github repo is stored within the directory ctrlx-automation-sdk/
+	install-nodejs-npm.sh
 
-Now you are able to build the sample projects or develop Apps with own projects.
+Overview of all scripts: [Description of the scripts](scripts/README.md)
 
 ## License
 

doc/about.md

@@ -3,4 +3,3 @@ Copyright © 2020-2024 Bosch Rexroth AG. All rights reserved.
 Please note that any trademarks, logos and pictures contained or linked to in this Software are owned by or copyright © Bosch Rexroth AG 2023 and not licensed under the Software's license terms.
 
 <https://www.boschrexroth.com/en/dc/imprint/>
-

doc/app_builder_env_changes.md

@@ -4,7 +4,7 @@
 
 
 !!! important
-    The newest App Build Environment is always provided with ctrlX WORKS. 
+    The newest App Build Environment is always provided with ctrlX WORKS.
 
 Only the AMD64 version is supported because for every programming language supported by the ctrlX AUTOMATION SDK cross build capability is provided.
 
@@ -14,27 +14,27 @@ Only the AMD64 version is supported because for every programming language suppo
 * User boschrexroth is created in the last step of the setup workflow
 * Poweroff instead of reboot if setup is finished
 
-### Installation scripts
+#### Installation scripts
 
 * __install-dotnet-sdk.sh__: Install as Debian package
 * __install-nodejs-npm.sh__: Add proxy infos to ~/.npmrc
 * __install-sdk.sh__: Install Debian package ctrlx-datalayer-*.deb
 
-
-### Additionally installed packages
+#### Additionally installed packages
 
 * __ssh, curl__: Removed because they are installed in the base image.
 * __build-essential__: New
 
 ### Version 1.14.0 <small> March 15, 2022</small>
-### Installation scripts
+
+#### Installation scripts
 
 * __install-snapcraft.sh__: Improve robustness
 * __install-nodejs-npm.sh__: Install as snap
 * __install-go.sh__: Install as snap
 * __install-go.sh__: New
 
-### Additionally installed packages
+#### Additionally installed packages
 
 * __pkg-config__: New
 * __libzmq3-dev:amd64__: New