Studio Trace

This article was written for version 2.3.1 of Core. Click here for the most recent version of the help center.

The trace plugin in Studio is a powerful tool for debugging and viewing messages on the bus. Trace allows you to select a message type, view the contents of incoming messages, and then finally select certain message parameters to print to a CSV file.

1. Opening trace and selecting a message type

To open trace, first open up PolySync Core Studio.

$ polysync-core-studio

Then, click on trace in the “Launch Plugin” right-hand sidebar. Trace should open up as shown below. The drop down list in the left-hand sidebar contains all of the message types that have been seen on the bus. It will update dynamically. Select a name for the trace window in the text box above the drop down list. Once a message type and name for the trace is selected hit “Start Trace.”

Studio Trace

2. Selecting parameters to display

The window should now look something like the image below. Header timestamp and timestamp should be selected, and data should be displayed for these fields in the center window. If there is nothing being displayed in the center window after a few seconds, then most likely there are no longer messages of this type on the bus. The check boxes in the left-hand sidebar allow you to select what parameters of each message type are displayed.

Try selecting and deselecting some of these, the center window should update accordingly. If it is necessary to change the trace name or the message type being displayed, click on the settings button and it will bring you back to the previous window. Another feature of trace is that incoming messages can be sorted by a particular column. To do this click on the heading of the column in question. Trace will then begin sorting by rows with the greatest value in that column.

Studio Trace

Recording to CSV

Trace also includes the functionality to record whatever is in the center window to CSV. To do this click on the “Record to CSV” box in the bottom left-hand corner. Then select “browse” and choose a folder to record to. In order to begin hit “Start Record.” In order to stop recording hit “Stop Record.” The output will be a CSV file with the UTC time stamp at the time the recording was started.