Installers and libraries

SDKs include installers and libraries required to use the winIDEA SDK from other languages. Specific instructions are provided for each language below.

Note: To check the version of an installed module, print the string returned by iconnect::getModuleVersion(). See language-specific instructions for examples.

Documentation

API documentation with examples is accessible from the winIDEA menu Help | Contents.

The documentation is also included in the SDK zip file, downloadable from the TASKING web page. After extraction of the downloaded zip file, open directory documentation, and unzip the file isystem-connect-api-doc-<ver>.7z. Open index.html in a web browser. Bookmark this location for future reference.

Examples

Each programming language's zip file contains examples demonstrating winIDEA SDK usage. All examples use the winIDEA project in the targetProjects directory, which contains sources, a winIDEA workspace file (*.xjrf), and a prebuilt executable for the STM32F407 microcontroller. The sources allow changing the microcontroller type and compiling the project. Without a compiler or target, you can test scripts using the bundled prebuilt executable and QEMU.

Note: A flag USE_FLOAT_TYPE in projectDefs.h can be commented out if floating-point libraries are unavailable for your compiler.

Target example projects:

Workspace SampleSTM32.xjrf contains an STM32 project.
Workspace SampleSTM32-qemu.xjrf contains a project where winIDEA runs code in QEMU. The emulator does not support the analyzer (coverage and profiler).

Directory itest

This directory contains support files for the isystem.test API and testIDEA:

templates for Python script generation
XML stylesheets and CSS files for test reports
XML schema for test reports

Which language?

If you need help choosing a language for the winIDEA SDK, consider these important criteria:

Which language do you already know and use?

Many choose based on familiarity, enabling quick starts but potentially limiting long-term options. Consider learning new programming languages.

What do you want to implement?

For short testing and development scripts, scripting languages offer highest productivity. For full-featured IDEs built on the winIDEA SDK, compiled, statically typed languages are preferable.

We recommend Python for scripting. It integrates with winIDEA, has readable syntax, excellent libraries, and widespread popularity.

We recommend Java for compiled languages. Eclipse uses Java, as does our Eclipse Debug plugin. Most Java development tools are free with excellent libraries. Java libraries work with other JVM languages like Groovy (scripting) and Kotlin, and are usable in MATLAB.