HARDWARIO Code Installation

Attention

The extension is still in development and you might experience some issues with it. If you do, please let us know on our forum or directly on GitHub.

There are two ways how to develop with the new extension. You can use your own Visual Studio Code and install the extension into it or you can download the portable version of Visual Studio Code.

Portable version of Visual Studio Code

There is a possibility to use the whole Visual Studio Code on its own.

This approach is good if you want to start developing quickly without setting up the environment.

You will have to do just a few simple steps based on your operating system.

Linux

• Download HARDWARIO Code

• Unpack the archive wherever you want

• Run the code binary

• You should see HARDWARIO Logo on the side panel

Warning

If you don’t have a git installed on your system, you will have to install it for the extension to work fully.

Tip

You can now start using the Visual Studio Code for developing HARDWARIO TOWER Firmware. To get some basic information on how to use the extension visit HARWARIO Code tutorial.

Windows

• Download HARDWARIO Code

• Unpack the archive wherever you want

• Run the Code.exe

• You should see HARDWARIO Logo on the side panel

Tip

You can now start using the Visual Studio Code for developing HARDWARIO TOWER Firmware. To get some basic information on how to use the extension visit HARWARIO Code tutorial.

OSX

• Download HARDWARIO Code installation package for macOS

• Run the installer by double clicking it

• Follow the installer instruction

• You should see a HARDWARIO_Code folder in your Applications folder

• Run HARDWARIO_Code/hardwario-code/Visual Studio Code

• You should see HARDWARIO Logo on the side panel

Tip

You can now start using the Visual Studio Code for developing HARDWARIO TOWER Firmware. To get some basic information on how to use the extension visit HARWARIO Code tutorial.

HARDWARIO TOWER extension to Visual Studio Code

For the extension to work with the standalone version of Visual Studio Code, you will need to install the extension and set up the environment of your PC.

Installation

To install the extension you will have to download the latest release from GitHub Releases.

To install the downloaded .vsix extension file just go to the Extensions tab, click the three dots and Install from VSIX...

Additional setup

You will need some dependencies for the extension to work as intended:

• make - for compiling the firmware

  • Windows installation make

  • Linux installation make

  • macOS installation make

• python - our flashing and logging tool is made in python

  • Windows installation python

  • Linux installation python

  • macOS installation python

• bcf - our flashing and logging tool made in python

  • Installation bcf with Python

• arm-none-eabi-gcc

  • Windows installation arm-none-eabi-gcc

  • Linux installation arm-none-eabi-gcc

  • macOS installation arm-none-eabi-gcc

• git - for cloning submodules and firmwares

  • All installations git

• Linux commands - you will need commands like rm and mkdir (Windows only)

  • You have to install git to your machine and then add the \usr\bin\ folder to PATH. The folder path should look something like C:\Program Files\Git\usr\bin\

Tip

The extension will warn you that you are missing some of those and provide you with a corresponding link.

You have to have all these things in the PATH for the extension to register it. If you don’t have these already, you can download the HARDWARIO Code portable version and you will find all the needed tools in the /data/tower/ folder. You will just have to add the correct folders to PATH.

Folders to add to PATH:

• python/

• python/Scripts/

• toolchain/make/bin/

• toolchain/gcc/bin/

• toolchain/gcc/arm-none-eabi/bin/

• toolchain/git/cmd/

• toolchain/git/usr/bin/

• toolchain/git/mingw64/bin

Note

If you are using a Linux version you will have to install git, we are not using portable version for Linux.

Tip

You can now start using the Visual Studio Code for developing HARDWARIO TOWER Firmware. To get some basic information on how to use the extension visit HARWARIO Code tutorial.

Firmware upgrade

Important

This feature makes it possible to upgrade the project from PlatformIO project to the new HARDWARIO Code project structure.

In the start you might encounter the warning that you are using a deprecated firmware version. You will get a warning on the bottom right corner. In this case just click the Upgrade button on the warning message and after a while the firmware should be upgraded and ready to use.

You can also use Upgrade Firmware Project button in the extension side panel if you missed the warning message.

Tip

After the upgrade you should reload the window for everything to work correctly.

If you encounter problems with compiling and uploading the firmware you can check these things:

• there is a sdk folder present and filled

• Makefile in sdk folder has this line at the begging: APP_DIR ?= src

• Makefile in the root folder looks something like this:

SDK_DIR ?= sdk
VERSION ?= vdev

CFLAGS += -D'VERSION="${VERSION}"'

-include sdk/Makefile.mk

.PHONY: all
all: debug

.PHONY: sdk
sdk: sdk/Makefile.mk

.PHONY: update
update:
    @git submodule update --remote --merge sdk

sdk/Makefile.mk:
    @git submodule update --init sdk