Skip to content

Quick Start Guide

With the help of this guide you will be able to build your first snap with one of the example projects of the ctrlX AUTOMATION SDK in just a few steps.

Prerequisites

  • Install ctrlX WORKS >= 1.20 with function 'App Build Environment' on your Windows host computer

  • If your Windows host computer is behind a proxy server, install and run PX.exe.

Building a Snap

Building a snap from a SDK sample project can be done in a few steps:

  • From ctrlX WORKS create and start a new App Build Environment (QEMU VM) instance.

Wait until the VM is shutting down automatically after the initialization phase. Then restart your VM. For more information see ctrlX WORKS Feature App Build Environment.

  • When ctrlX WORKS enables the SSH link click this link to start a SSH session.

On password prompt enter boschrexroth

  • Install the latest ctrlX AUTOMATION SDK from github

Call this script:

~/scripts/install-sdk.sh

The script downloads ctrlx-automation-sdk.zip from github and unzips it to the folder /home/boschrexroth/ctrlx-automation-sdk/

  • Change to project folder /home/boschrexroth/ctrlx-automation-sdk/samples-cpp/datalayer.register.node

  • Build one or both snaps

To build a snap for a ctrlX COREvirtual enter:

./build-snap-amd64.sh

To build a snap for a ctrlX CORE enter:

./build-snap-arm64.sh

As a result a snap file sdk-cpp-registernode_...._amd64.snap respectively sdk-cpp-registernode_...._arm64.snap will be created.

To copy the snap(s) into your Windows file system start cmd.exe on your Windows host and enter this command:

scp -P 10022 boschrexroth@localhost:~/ctrlx-automation-sdk/samples-cpp/datalayer.register.node/*.snap .
  • Login into your ctrlX CORE and install the according snap

Don't forget to set option 'Allow installation from unknown source' under Apps --> Settings

  • Select Settings --> ctrlX Data Layer and check the nodes under path sdk-cpp-registernode/

There should appear several nodes created by the snap.

Important

To setup a complete tool set to develop own applications (snaps) see following chapters: