Developer Guide

  • 2022.1
  • 09/08/2022
  • Public
Contents

Command-Line Options

Usage: tcc_rt_communication_demo --profile <profile name> --interface <interface name> [--mode <mode name>] [--no-best-effort] [--config-path <directory with profiles configuration>] [--output-file <output file>] [--exec-path <path to binary executables>] [--target <target>] [--base-time <UTC base time>] [--remote-address <remote-target-address>] [--remote-interface <remote interface name>] [--remote-config-path <remote directory with profiles configuration>] [--remote-exec-path <remote path to binary executables>] [--verbose]
Option
Description
-p, --profile <profile name>
Required. Defines the profile name to be executed. The following profiles are supported (‘a’ for Board A and ‘b’ for Board B):
  1. Basic, with and without optimizations:
    • basic-a-opt
    • basic-a-noopt
    • basic-b-opt
    • basic-b-noopt
  2. SISO, with and without optimizations:
    • siso-single-a-opt
    • siso-single-a-noopt
    • siso-single-b-opt
    • siso-single-b-noopt
-i, --interface <interface name>
Required. Defines the network interface name to be used for TSN-based data transmission. For example: enp1s0.
-m, --mode <mode name>
Optional. Defines the operation mode to customize demo behavior. The following modes are supported by the demo application:
  • all (default): Run all modes/stages: TSN configuration, clock synchronization, and the demo application.
  • setup: Similar to the
    all
    mode, except that it does not start the demo application: (re-)configure the network interfaces, traffic control, and (re-)start ptp4l and phc2sys clock syncronization.
  • clock: (Re-)start ptp4l and phc2sys clock synchronization.
  • tsn: Configure the network interface and the traffic control for TSN.
  • run: Only run the demo application; TSN and clock should already be configured.
-n, --no-best-effort
Optional. Do not use best-effort traffic (iperf3) together with other components of the demo application.
-t, --target <target>
Optional. Defines the type of target board to select configuration files for execution. Available types are:
  • AUTO (default): autodetect the target
  • EHL: use configuration for Intel Atom® x6000E Series Processors
  • TGL-U: use configuration for 11th Generation Intel® Core™ Processors
  • TGL-H: use configuration for Intel® Xeon® W-11000E Series Processors
-c, --config-path <directory with profiles configuration>
Optional. Defines the directory with the profiles’ configuration files. ‘./cfg/’ is used by default. The directory should contain two sub-directories:
  • basic
    for the Basic profiles’ configuration files
  • siso-single
    for the SISO profiles’ configuration files
-o, --output-file <output file>
Optional. Defines the filename for storing the output statistics.
  • ./tcc_rt_communication_demo_output/log_e2e.log
    is used by default for the Basic profiles
  • ./tcc_rt_communication_demo_output/log-roundtrip.log
    is used by default for the SISO profiles
-e, --exec-path <directory with binary executables>
Optional. Defines the directory with binary executables and shared libraries such as opcua_server and libtcc_rtcdatamgr.so. The demo uses binary executables from the default general system directory so the binary executables are available by searching through the PATH environment. This directory is used before the directories from the PATH environment variable.
-v, --verbose
Optional. Enable the verbose mode.
-h, --help
Optional. Print command-line help.
-a, --remote-address <remote target IP>
Required for the remote launch mode. If provided, this switches the sample to the remote launch mode, making it possible to launch the sample from board A. Defines the IP address for the second remote target. This parameter can only be combined with
basic-a-opt/noopt
or
siso-single-a-opt/noopt
profiles.
-g, --remote-config-path <remote config path>
Required for the remote launch mode. Defines the directory on the remote side that contains the profiles configuration files. This directory should contain two subdirectories: ‘basic/’ for basic-<…> profiles configuration files, and ‘siso-single/’ for siso-single-<…> profiles configuration files.
-u, --remote-exec-path <remote directory with binary executables>
Optional. Defines the directory on the remote side with binary executables such as opcua_server and libtcc_rtcdatamgr.so. Use this option if the sample executables are located in directories that do not appear in the PATH environment variable. This option prepends the provided directory to the PATH variable on the remote target.
-r, --remote-interface <remote interface name>
Optional. Defines the name of the network interface on the remote side to be used for TSN-based data transmission in the remote launch mode. If not specified, the local interface name will be used in the remote launch mode for the remote interface.
-b, --base-time <the base time in UTC to start network communications>
Optional. Define the base time for TSN communications. Other times defined in the configuration files are calculated with respect to this base time. If the base time is not provided, it is selected automatically. Also, this argument is used internally in the remote launch mode to select the same launch time for both boards. The base time must be selected in such a way that it is between 2 and 20 seconds from the launch time of the opcua_server.
Example
tcc_rt_communication_demo -p basic-a-opt -i enp1s0 -m run -n

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.