
Percepio Detect Client for Windows
----------------------------------
Release 2025.2, Sept 20, 2025.

The "Client" provides the debugging tools in Percepio Detect,
including Tracealyzer and a core dump viewer. You need to start
the Client on your local computer before you can view payloads
from the Server dashboard.

The Client includes the following tools:

- Percepio Tracealyzer, for viewing TraceRecorder traces with integrated logging support.
- Core dump viewer, for viewing CrashCatcher core dumps, including function call stack.

Start by running the included demo, as described in 

  "Percepio Detect Demo Guide - Windows.pdf"

The Client is started by running percepio-client.bat. Check the terminal output to 
ensure it started correctly.

With the Client up an running, you may now click the payload links in the Detect dashboard
to view core dumps, traces and logs. If you have started the server as described
in the demo guide, it is found at http://127.0.0.1:8080.


Configuring the Client for your own project
-------------------------------------------

The Client is file-oriented. When a payload link is clicked in the Server dashboard, the 
Client receives an "alert key" that points to the requested alert payload file in the
Detect alert folder. By default, the Client is configured to use the bundled demo data.

To use Percepio Detect with your own project, the Client settings needs to be updated with
the right paths to the alert file directory, to the ELF image file and optionally to the
source code folder. The settings and documentation are found in project-settings.bat. 

Open project-settings.bat in a text editor and adjust the settings to match your project. 
For example:

set ALERTS_DIR=""

After saving your changes, restart the Client. 
 
Open the Server Dashboard click on a payload to ensure it loads correctly.

If core dumps can't be displayed, try using forward-slashed (/) in the paths.


Customization
-------------

In the default configuration, it is assumed that all data files are accessible via the file
system, either a local folder or a shared network folder. If the ELF file or source files
are not available locally, you may customize the client to download the required files.
See userhooks.py for details.

The core dump viewer requires at minimum the ELF image file (e.g. image.elf) from the build.
This must be the same version as programmed on the device that sent the alert. The core dump
viewer can also display a source code snippet around the fault locations, but that is optional.
Displaying the call stack, including function and variable names, requires only the ELF file.

Tracealyzer does not require .elf files or source code, but can leverage .elf files for
"compact logging" functions (e.g. xTracePrintCompactF) that allow more efficient tracing.

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

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