Use IDE Scripting

MPLAB X IDE provides scripting capabilities to control the IDE behavior programmatically. Allow developed for use with Microchip MPU projects, scripts may be used with MCU projects as well.

About the Scripts

The scripts are written in Jython. The scripts have access to an API that allows you to:

• Control the debugging session state (run, halt, etc.).
• Access memory in the device while debugging.
• Set breakpoints with callbacks to functions that determine if a halt should happen or not. This allows implementation of conditional breakpoints.
• Place actions in the Projects window which, when clicked, will run methods in a script.
• Provide hooks for debug events: a function will be called when a given event happens.

Using the Scripts

To gain access to the scripting features, follow the steps below.

1. 1.Close the project that will use the scripts.
2. 2.Create a file named autoload.py. A self-documenting autoload.py that explains the APIs is available under <MPLAB X IDE Install folder>\docs\example_code.
3. 3.Copy the file into your project directory. Edit the file here as necessary.
4. 4.Re-open the project and you will see a “Script Files” folder in the project tree. The file autoload.py will be under this folder.
5. 5.Run the scripts under “Tests” as needed.