Programmer Plugin API

The programmer device API defines the interfaces to use when implementing programmer device plugins.
The API is only relevant for software developers implementing a plugin for a specific programmer device type.

This section will not describe all the details of the API, but will describe the purpose and usage of the defined interfaces, methods, properties and events. Please refer to the Programmer Tool assembly for the latest build-in documentation.

IProgrammerPlugin interface

This defines the interface of a programmer plugin. The interface has only a few methods.

Methods

ListSetupParameters

This must return the list of additional plugin specific parameters for the Setup method of the programmer tool. The parameters specified by this method will be passed to the Setup method of the programmer device object.

CreateDeviceInstance

This method is used to create a programmer device object (implements the IProgramerDevice interface) to be used by the programmer tool instance to perform all programming actions.

IProgrammerDevice Interface

Programmer device objects must implement the IProgrammerDevice interface defined by the Programmer Tool assembly. The interface defines the methods, properties and events the Programmer Tool will use to perform the programming actions.

Methods

Setup

This method is called by the Setup method of the Programmer Tool instance to initialize and setup the programmer device. After this method has been called, the device should at least be ready for the Erase and Blank Check operations.

The Programmer tool instance will pass the arguments (values) of the parameters that were specified by the IProgrammerPlugin.ListSetupParameters method.

LoadFile

This method is used to transfer the memory image file to the programmer device or the programmer device object.

After this method has been called, the programmer device should be ready for Program and Verify commands.

Erase

This method is used to perform an Erase operation with the programmer device.

BlankCheck

This method is used to perform a Blank Check operation with the programmer device.

Program

This method is used to perform a Program operation with the programmer device.

Verify

This method is used to perform a Verify operation with the programmer device.

CreateDevicePanelControl

This method creates a UI control for user interaction with the programmer device. The functionality and look of the control is specific for each programmer plugin.

Properties

CommunicationSync

This read-only property returns an object to be used for locking (reserving) the programmer device object while performing one or more operations.

State

This is a read-only property returning a textual single line description of the state of the programmer device.

Events

StateChanged

This event notifies when the State property text has changed.