doc_logo.png

Getting started

This chapter will break down the use of the ADTF Device Toolbox 3. After reading this guide, you will know:


Connect ADTF Device Toolbox with ADTF

There are some ways to connect the new Device Toolbox with an existing ADTF delivery.

Using ADTF addons folder

Like in ADTF 2.x it is possible to extract the ADTF Device Toolbox in the ADTF addons directory. Due that there is no installer anymore, the archive has to be extracted manually.

Extract wherever you want

You can extract the ADTF Device Toolbox wherever you want (maybe you are using conan or any other package manager) it will work fine, but you have to set the paths to your plugindescriptions in ADTF Configuration Editor.

This will be stored for your user settings.

A symbolic link can combine both worlds - extracting anywhere but using the ADTF addons structure. The ADTF Device Toolbox folder has to be linked symbolically into the ADTF addons directory.

Where do I find the delivered example sessions?

We provide an example project in order to show the use cases of several filters provided in this toolbox. The project contains several ADTF sessions for different use cases. For an overview please have a look here If you have extracted the ADTF Device Toolbox within the addons folder of your used ADTF 3.x delivery and set the root folder name to devicetoolbox, you can find the necessary ADTF project here:

Within the ADTF Configuration Editor you can now choose one of the above listed ADTF sessions. For further information, like how the filters are working, you have to check the documentation of the individual components at the filter overview.


How can I start these sessions and what is the purpose of them?

Each session describes an specific use case, example or feature within Device Toolbox - feel free to adapt them for your use case. In general, the sessions can be started in different ways. Have a look at in ADTF3 Guides especially Best Practise Tooling which launch option fulfills your needs.


Building the examples

Using the supplied batch file (Windows only)

  1. make sure that the path to your CMake executable is in your PATH variable.
  2. open the Visual Studio Command Prompt from your start menu (under "Microsoft Visual Studio <Version>/Visual Studio Tools")
  3. from the Visual Studio Command Prompt launch the build_examples.bat file in the root directory of the toolbox
  4. follow the instructions

Manually
  1. Launch cmake-gui
  2. Set the source directory to the root directory of the devicetoolbox (e.g <ADTF_DIR>/addons/devicetoolbox).
  3. Set the build/binary directory to a NEW and different directory (e.g. C:/Work/device-build)
  4. Press .
  5. Click when CMake asks to create the build directory.
  6. Select your compiler in the dialog that appears now and press .
  7. You will now get red values in the list, red does not mean wrong but new!
  8. Make sure that ADTF_DIR is correctly set (path to your ADTF delivery)
  9. Press again.
  10. The ADTF_DEVICE_TOOLBOX_DIR variable should point to the ADTF Device Toolbox delivery.
  11. Set CMAKE_INSTALL_PREFIX to the root directory of the ADTF Device Toolbox (e.g <ADTF_DIR>/addons/devicetoolbox). You can choose any directory you like, but keep in mind that you have to add it to the plugins directories of ADTF later on.
  12. Press again.
  13. You should now have everything ready and no red values.
  14. Press .
  15. Now go to the build directory:
    • On Windows open the adtf_device_examples.sln with Visual Studio and build it. Don't forget to build the INSTALL project after everything has been built.
    • On Linux type make install in the build directory.
  16. done

Using the ADTF Device Toolbox configuration for your own projects

To use the ADTF Device Toolbox CMake configuration in your own projects you need to include it in your main CMakeLists.txt file with the following command: Within this version the basic usage of the ADTF Device Toolbox for your own projects is based on packages (equivalent to ADTF). The main header for the sdk is adtf_devicetb_sdk.h. That is used for extending functionality of the ADTF Device Toolbox, e.g. for Custom Bus-Database Parser SDK, with your own implementations. The ADTF Device Toolbox ships with predefined CMake functions that help to build and deploy custom extensions. A reference of these functions can be found in the ADTF Documentation .