; --------------------------------------------------------------------------------
; @Title: Accessing TRACE32 from Python scripts via TRACE32 Remote API - README
; @Description: -
; @Keywords: python
; @Author: HLG
; @Copyright: (C) 1989-2015 Lauterbach GmbH, licensed for use with TRACE32(R) only
; --------------------------------------------------------------------------------
; $Id: readme.txt 116756 2020-01-27 07:42:44Z jvogl $


TRACE32 can be controlled with other applications via TRACE32 Remote API.
This enables you to control TRACE32 directly from your Python script.

This folder contains
- examples, which demonstrate, how to control TRACE32 via a Python script
- the required shared libraries for Windows and Linux (both 32- and 64-bit) and 64bit Mac OSX

Scripts:
  t32api.py            Very simple python example using the TRACE32 Remote API
  t32apicmd.py         TRACE32 Remote API that use T32_Cmd() and T32_GetMessage()
  t32rem.py            Python script, which sends a single command to TRACE32
  t32remotedo.py       Python script sending all commands of a PRACTICE script to TRACE32
  t32apimenu.py        Python example demonstrating various functions of the TRACE32 remote API
  t32remtest.py        Python example demonstrating various functions of the TRACE32 remote API
  t32_text_example.py  Python example showing how to perform unit testing of a function and reading,
                       writing variables and registers as well as displaying results. Tested
                       on windows 10, Ubuntu Linux 17.04 and Mac OSX High Sierra all with Python
                       3.6.3, all 64bit versions.
  t32_run_script.py    Simple Python example for connecting to TRACE32, browsing for a script
                       and executing.

  ./t32_multi_example  Directory containing two python files which give an example of controlling
                       multiple instances of TRACE32.
  +->t32_multi.py      Example of launching two instances of TRACE32 in an AMP multi core setup. The
                       python script shows to to control more than one instance of TRACE32 via the
                       API. Presents the user with a simple GUI that demonstrates how to set the
                       synchronisation options between TRACE32 instances. Requires the oshelper.py
                       module to function.
  +->oshelper.py       Module used by t32_multi.py. This module abstracts the underlying host
                       operating system and provides convenience functions for writing TRACE32
                       configuration files, loading API library files and launching TRACE32.

Libraries:
  t32api.dll       Shared library for a 32-bit version of Python running on MS Windows
  t32api64.dll     Shared library for a 64-bit version of Python running on MS Windows
  t32api.so        Shared library for a 32-bit version of Python running on Linux
  t32api64.so      Shared library for a 64-bit version of Python running on Linux
  libt32api64.so   Shared library for 64 bit version of Python running on Mac OSX.