minihil Extension README

The miniHIL VSCode extension provides language support for the CaGe testing framework and simplifies building and flashing miniHIL projects.

Documentation for miniHIL projects can be found at [docs.protossoftware.de](https://docs.protossoftware.de/minihil/latest/)

CaGe code completion and syntax highlighting

Suggestions will appear as you are typing, including code snippets for certain keywords. Keywords will also be highlighted in a different color.

codeCompletion

CaGe errors and warnings

Code errors are shown as you type (both as red squiggle underlines, and in the "Problems" panel).

codeErrors

CaGe hover and go to definition

Hovering over elements will display any comments written for that element. Additionally, ctrl + clicking an element in the editor will take you to that elements definition.

codeHints

CaGe sequence diagrams

A graphical representation of a CaGe Test can be opened by pressing 'ctrl + alt + shift + c' while highlighting a test. * Scroll the diagram using the mousewheel * To pan or zoom the diagram hold down 'alt' while using the mouse * Click on underscored elements to jump to the corresponding text document (Note: Checking workbench.editor.revealIfOpen in the settings is recommended)

cageTrace

Building, debugging, testing

A new section for flashing and building miniHIL projects is added to the bottom left of the IDE. The buttons appear when mousing over project names. This menu can also be moved to the left sidebar.

buildAndFlash

The above menu also allows developers to easily debug code using VSCode’s built-in debugger. Just click on the debug miniHIL project button for the project you want to debug.

After your code is ready to be executed, you can directly execute your tests on the miniHIL. Make sure your miniHIL is connected correctly and click the Run tests for miniHIL project button. You can then also visualize the results in the miniHIL dashboard by clicking the Run dashboard for miniHIL project button.