Tutorial: How to install GNU MCU Eclipse?

Overview

For more flexibility and upgradeability, GNU MCU Eclipse is not packed as a all-inclusive suite to be installed in a single step. However, the separate steps are relatively easy to perform, and installing the plug-ins and the tools can be successfully completed even by non-experienced users.

为了获得更灵活、可升级的特性，GUN MCU Eclipse 没有在单步安装中集成所有内容的套件。然而，独立步骤也是相对简单的，并且安装插件与工具甚至对于没有经验的用户来说也是可以成功完成的。

Note for beginners: If performed for the first time, it is recommended to follow the steps by the book and avoid poetic licenses, since they might lead to tricky situations and subtle functional problems.

初学者请注意：如果是第一次操作，建议根据 "by the book"步骤，并避免poetic licenses（因为它们可能会导致棘手和微妙的问题）

建议的操作顺序如下所示:

The recommended sequence is described below.

xpm - the xPack Manager

xpm 是一个新的工具，目前还在发展中，意在管理软件包（xPacks），其中包括了安装二进制发行版。

xpm is a new tool, currently under development, intended to manage software packages (xPacks), including to install binary distributions. It is built on top of Node.js and is highly portable; the install steps are described in the xpm install page.

对于 GNU/Linux 用户 : 你的发行版系统中可能已经装有一个node，如果它的版本小于8，那么xpm会停止并弹出警告。总之，我们强烈建议你避免使用发行版的node，并至少安装Node.js的长期支持包。

Warning for GNU/Linux users: your distribution may already have a node binary installed; if it is not >= 8.x, xpm will complain and do not start; anyway, we strongly recommend to avoid the distribution binary and install at least the LTS package from Node.js.

Ubuntu中安装最新NodeJS和NPM

Warning for Windows users: binary packages are .zip files containing .exe files; some aggressive antivirus programs may quarantine those files, or even modify the content of the archives, thus changing the checksum and thus preventing the packages to be installed; either configure or temporarily disable the antivirus if necessary.

目前，xpm不是强制安装的，但它是一个有用的附加部分，因为它提供了便捷的方式来安装以及更新 ARM 与 RISC-V 工具链，PopenOCD，QEMU和 Windows构建工具。

Currently xpm is not mandatory, but it is a useful addition since it provides a convenient way to install and later upgrade the ARM and RISC-V toolchains, OpenOCD, QEMU and the Windows Build Tools.

$ sudo npm install --global xpm@latest

[sudo] password for schips:

/usr/local/bin/xpm -> /usr/local/lib/node_modules/xpm/bin/xpm.js

+ xpm@0.5.0

added 260 packages from 146 contributors in 15.142s

xPack Dev Tools

在2019年中，主要的工具从GNU MCU Eclipse 项目移到了 xPack 项目，而且所有新发布版本都可以通过@xpack-dev-tools获得

In mid-2019, the main binary tools were moved from the GNU MCU Eclipse project to xPack project, and all new releases are available via the @xpack-dev-tools scope.

所有先前的发布版本仍然存在于@gnu-mcu-eclipse中，但这些是过时的版本，不推荐在新项目中使用。

All previous releases are still available in the @gnu-mcu-eclipse scope, but were deprecated and are not recommended for new projects.

Toolchain(s)

通常这一步是强制性的，因为大多数平台在默认情况下都没有嵌入GCC工具链（ARM或RISC-V）。

This is generally mandatory, since most platforms do not come by default with an embedded GCC toolchain (ARM or RISC-V).

Please follow the steps in the ARM Toolchain install or RISC-V Toolchain install page.

For ARM, the easy install method is:

$ xpm install --global @xpack-dev-tools/arm-none-eabi-gcc@latest

For RISC-V, the easy install method is:

$ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@latest

Windows Build Tools

This step is Windows specific, and it is highly recommended to use the GNU MCU Eclipse Windows Build Tools, and avoid other make.exe programs, even if they apparently work, since subtle differences in path processing exists between different versions of make.

Please follow the steps in the How to install the Windows Build Tools page.

The easy install method is:

$ xpm install --global @gnu-mcu-eclipse/windows-build-tools

POSIX platforms generally include make in the system distribution, or might require to install some developer packages (for example on macOS you need to install the Xcode Command Line Tools).

SEGGER J-Link

SEGGER J-Link is the recommended debugger and, if available, please follow the steps in the How to install the SEGGER J-Link page.

OpenOCD

For the unfortunate developers who do not have a J-Link available, the alternative is to follow the steps in the How to install the OpenOCD binaries page.

The easy install method is:

$ xpm install --global @xpack-dev-tools/openocd@latest

OpenOCD might be needed when using development boards with integrated debuggers, like STM32F4-DISCOVERY boards, although the recommended solution is to prepare a custom cable and connect them to J-Link.

OpenOCD is also needed when using RISC-V boards with integrated debuggers.

QEMU

QEMU is a hardware emulator that can be successfully used to run simple blinky applications, and the default tutorial requires QEMU, so it is highly recommended to install it.

The easy install method is:

$ xpm install --global @xpack-dev-tools/qemu-arm@latest

For more details, please follow the steps in the How to install the QEMU binaries page.

Jumper Virtual Lab

Jumper Virtual lab is an emulator that provides a fast and easy way to execute firmware files on a virtual device running on the development machine. Jumper’s Eclipse plug-in uses the debug framework provided by the GNU MCU Eclipse plug-ins.

To install the Jumper Virtual Lab, use the following links:

Jumper Virtual lab is a product of Jumper Labs Ltd, a third party company not directly related to GNU MCU Eclipse. For questions and further info, please contact Jumper Labs via their support channels.

Java

As a prerequisite for Eclipse, Java is required.

Java is no longer a very hot technology, so it is generally not available by default on most platforms and requires separate installation.

More details are available in the How to install the GNU MCU Eclipse plug-ins page.

Eclipse & CDT

Eclipse is the development platform where the GNU MCU Eclipse plug-ins run. Generally it is not available by default on most platforms and requires separate installation.

The simple way is to download GNU MCU Eclipse IDE for C/C++ Developers from GitHub Releases and you get at once both Eclipse CDT and the MCU plug-ins.

If you prefer the manual way, be sure you install the Eclipse IDE for C/C++ Developers, not other package, since otherwise you’ll have to manually install CDT.

More details are available in the How to install the GNU MCU Eclipse plug-ins page.

Note: on GNU/Linux be sure you manually install the Eclipse; DO NOT try to install it via the Synaptics package manager, or similar, since usually you get an older version and the CDT plug-ins are not included.

Plug-ins

Once the Java & Eclipse are functional, please proceed with plug-ins install, as explains in the How to install the GNU MCU Eclipse plug-ins page.

Workspace preferences

It is highly recommended that this step be performed after creating each and any Eclipse workspace; for this please follow the steps in the Workspace preferences page.

CMSIS packages

To assist the debugger in finding the peripheral registers definitions, please check the The CMSIS Packs manager page, and install the CMSIS packs for the family of devices used by your projects.m