Attention

You are viewing an older version of the documentation. The latest version is v3.3.

xenomai-poky

The following section is applicable to:

Important

Complete the pre-requisite section Setting up ECI Build before continuing further.

The ECI xenomai-poky Yocto target image provides a set of software utilities and the Xenomai3/i-pipe Cobalt preemptive & priority scheduling Linux OS runtime co-kernel to realize a real-time capable OS without a hypervisor.

1. Run the setup script:

   $ ./setup.sh
   

   

2. The setup script will present a list of pre-configured use cases. Select custom to start configuring a custom build.

   

3. The setup script will present a list of available build targets. Select xenomai-poky from the list.

   

4. On the following prompt, it is possible to modify the build configuration of the target image. Select/deselect features to be included in the image using the arrow keys to move the selection and spacebar to toggle the state. When complete, press the enter key to finalize the selection.

   

   The following table describes the various options available:

   Feature Option	Description
   SDK (build tools and dev pkgs)	Adds GCC and Make to the target image.
   SSH Server	Adds an SSH server to the target image.
   EC Protocol Bridge	Edge Control Protocol Bridge bridges various industrial protocols together, effectively providing a translation from one protocol to another.
   CODESYS Software PLC	CODESYS Software PLC provides a Linux runtime that allows control applications to execute on Linux-based systems. This feature requires a CODESYS .deb file to be added to the build environment.
   Kernel Debug*	Enables Kernel debug capabilities on the target.
   Graphical Windowing System*	Adds XFCE - a X11 based graphical window manager to the target image.
   Robot Operating System 2 (Foxy)	Provides core essentials of ROS2 software
   XDP & BPF	Allows packets to be reflected, filtered or redirected without traversing networking stack. Selecting this feature will add eBPF and XDP features to the target image.
   Kubernetes	Adds binaries required to join a Kubernetes cluster.
   Intel® Castle Lake Dependencies	Adds kernel modules and tools necessary to support an Intel® Castle Lake Client.
   Intel® In-Band Manageability	Intel® In-band Manageability enables an administrator to perform critical Device Management operations over-the-air remotely from the cloud. Selecting this feature will add Intel In-Band Manageability software to the target image.
   Intel® Functional Safety (EHL/Sbl)	Enables Intel® Elkhart Lake Functional Safety (FuSa) Software Package. Attention Functional Safety features are only supported on Intel Atom® x6000E Series processors.
   Intel® EII	Enables Intel® Edge Insights for Industrial features.
   *Experimental*	Enables experimental features.

   Important

   (*) For best real-time performance, it is recommended to not enable Graphical Windowing System or Kernel Debug features.

   Note

   The resulting OS will be headless (non-graphical) unless the Graphical Windowing System feature is selected.

5. The setup script will begin configuring the assets needed to build the target image. Depending on the feature options selected and state of the build environment, a few notifications may occur. Some of these notifications are described below.

   • Build directory already exists

     If the setup script is not building the target for the first time, the script will prompt: Build directory ecs-xenomai-<poky/deby> already exists. Do you want to clean the cached build? y/[n]

     

     Press n to retain the target build cache, or press y to delete target build cache.

     Note

     It is advised to delete the target build cache if the target source was modified or the previous build was incomplete. Retaining the target build cache will reduce the build time, but may promote build errors if the target source was modified or the previous build was incomplete. If build errors occur, rerun the setup script and choose y at this prompt.

   For all other notifications, refer to the section links below:

   • Setup Notifications
     • CODESYS Linux runtime package not found
     • Build directory already exists
     • Ensure Docker Engine is installed and running
     • Current user is not part of Docker group
     • Docker Daemon cannot reach the registry
     • Detected lock files for target
     • System memory below recommended minimum
     • Filename length test failed

6. After setting up the build target, the script will prompt: Do you want to run an automated build? y/[n].

   
   Automated BuildManual Build

   To perform an automated build, press y at the prompt.

   

---

The build typically takes a very long time. A Linux build system with the recommended specs may take about 1-2 hours to complete. A Linux build system with the minimum specs may take 6+ hours to complete. See section Linux Build System for recommended specs.

After the build completes, see section Installing ECI-X to create a bootable USB flash drive to install the ECI image.