Percepio Detect Client for Linux
--------------------------------

The Detect Client is an integrated set of developer tools for viewing debugging data provided with alerts.
This runs on each user’s computer. When clicking on payload links in the Dashboard, the Client is notified 
and loads the selected data in the right tool.

There are two versions of the Client, for Linux and Windows hosts. They have the same functionality but
differ in some details. This document described the Linux version.

The Linux version of the Detect Client is provided as a Docker image and includes the following tools:

- Tracealyzer for viewing TraceRecorder traces. This may include RTOS events and custom logging.

- Core dump viewer for Arm Cortex-M devices, using the CrashCatcher core dump format.

- Curl and wget tools for accessing build artifact repositories, such as Sonatype Nexus or JFrog Artifactory.

Note that the Core Dump Viewer needs access to the ELF image files, matching the device that produced
the core dump. This is also the case for Tracealyzer, if certain TraceRecorder features are used.


Setup

1. Follow the Demo guide and verify the Client shows the provided demo data.

2. To integrate Percepio Detect in your development environment:
   - Open percepio-client.sh in a text editor and read the documentation.
   - Add your own settings in percepio-client.sh to match your setup, including:
      - ALERTS_DIR
      - ELF_DIR
      - ELF_REL_PATH
      - SRC_DIR
      - SRV_REL_PATH


Using the Percepio Client

1. Start the Client by running the percepio-client.sh script.
   You may need to make it executable first by running chmod +x percepio-client.sh.

   The script will download and start the Client docker container.
      
   When it is ready, you should see the following text:
   "Ready to display payloads. Click the links in the server dashboard."
   
2. Open the Server Dashboard (http://<server address>:8080) in your web browser.

3. When you click on a payload link, the Client will open a separate window with
   the appropriate tool displaying the payload data.


Notes:

* Tracealyzer requires a separate license key, as described in the Demo guide.

* The Client can be closed by typing Ctrl-C in the terminal window.

* This Docker-based packaging of Tracealyzer is only intended for use with Percepio Detect. 
  For other uses, please install Tracealyzer natively on the host machine instead.

* When running Tracealyzer using this Client the Tracealyzer User Manual can't be opened
  from the Tracealyzer user interface in the normal way. 
  The Tracealyzer User Manual can instead be accessed at http://localhost:8085/tz-user-manual/. 
  This assuming that the Client is running and that the Tracealyzer license has been installed.

 
For questions and assistance, please contact Percepio at 
 
     https://percepio.com/contact-us/

Copyright (c), Percepio AB, 2025
https://percepio.com


    
