13

Automation API / Extensions - Add timing markers, notes, or annotations


S
Saleae

I would like to get the possibility to add any text with drawing options like circles etc. to the captured data. This makes it easier for debugging or sharing data.

Additional Notes:

  • Allow the Automation API / Python extensions to read back the contents of existing notes from a previously saved capture file.
  • Allow the Automation API / Python extensions to place time marker(s) in places of interest (for example: place a time marker at the highest voltage). It could be coupled to the measurement extension, so if the measurement is deleted, the marker would also be deleted, if the measurement extent is moved the marker(s) are also moved.

A

Activity Newest / Oldest

Avatar

Tim

discuss.saleae.com/t/automation-api-timing-marker/3128/5
"I would like to add in real time a timing marker at specific time. I have a long capture to do and I want to add some markers to help me to find the data I want to analyze. I use python script for automation.
---
In my python script, if I can add many comments during the acquisition, it would be wonderful!!
---
when running hour of testing, I dont want to add a pause in my python script in order to insert a marker and continue the script. I prefer to have an automatic way (from your API) to set important labels and find potential issues."


Avatar

Tim

(#89453)
"Is there a way to put text into the notes saved with the automation interface save_capture() function?
Conversely, can the notes be read a program using the automation interface on a loaded capture?"


Avatar

Tim

(#88459)
"I have a script that orchestrates a sequence of events over 10~20 seconds. I would like to add "markers" in that script that show up as markers in the logic analyzer stream so that I can more easily drill down into the sequence of events.

More precisely, I would like my script to:
1. Setup things
2. Start ~20 second Capture on Logic Pro 16
3. Start bootloader over CAN - Takes ~ 1 second
4. Wait for bootloading to finish
5. Use Automation API to place a "marker" in the data stream.
6. Do other commands
7. Use Automation API to place a different marker
8. Send CAN command to re-enter bootloader
9. Put More markers with Automation API"


  • C
Avatar

Tim

(#83091)
"It would be really handy to be able to add notes to the screen. A little text box that I can drag around the screen."


Avatar

Peter Jaquiery

I'd forgotten about the original annotation thread my recent idea was merged with. The ideas are closely related and merging them makes sense. The point of difference is my recent idea annotates a region of activity - the system is in some state or processing a specific task, as opposed to a pint of interest - some interesting event happened at this point in time. Both are very useful and much of the work under the hood to support the two modes is likely to be common.


Avatar

Peter Jaquiery

I'd like to be able to add annotation text to a selected block so that I can quickly identify DUT system states as I work through debugging a system.

In the UI this would look like:
1/ Right click on a selection and choose "Annotate"
2/ Enter annotation text into a dialog
3/ the annotation remains even when the original selection is deleted and shows as a highlighted region.
4/ The annotation text overlays the signal when the mouse cursor is within the annotation region.

3/ and 4/ could change substantially as the feature design shakes out.


Avatar

Tim

Merged with: Annotate selections

Avatar

Tim

Thanks for sharing details on your preferred implementation. I'm going to merge this in with the idea below:
ideas.saleae.com/b/feature-requests/add-annotations-to-graph/


R

R

Or maybe also allow for pdf export of a certain range. You can select if it is separated by pages or just one giant pdf.


S

Saleae

Example: in the protocol analyzer, with a protocol like SPI the 1-byte labels can be shown in hex with a nice colored bar. But, I have a non-standard 3-wire protocol with no nice way to label the data. I would like to be able to select a data line across 8 clock edges and have a label showing the hex value of the data.


Avatar

Peter Jaquiery

This fits very well with Python filters and event detectors for marking points of interest - minimum or maximum pulse width in a train of pulses for example.


A

please add this feature.