-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve documentation for plugin + better overall structure
- Loading branch information
Showing
19 changed files
with
291 additions
and
191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,3 +13,4 @@ config.local.js | |
| basement_dist | ||
| .idea | ||
| *.sh | ||
| .obsidian | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,6 @@ | ||
| --- | ||
| next: VS Code Plugin | ||
| --- | ||
| # Smartlamp App with MQTT | ||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,16 @@ | ||
| --- | ||
| title: Latch | ||
| next: WARDuino Reference | ||
| next: Developer's Guide | ||
| --- | ||
| # Testing: Latch framework | ||
|
|
||
| **<span style="font-variant: small-caps;">Latch</span> (Large-scale Automated Testing on Constraint Hardware)** is a novel testing framework for running large scale unit and integration tests in constrained environments. | ||
|
|
||
| ::: tip Open source | ||
|
|
||
| You can find the open source code on [github](https://github.com/TOPLLab/latch). | ||
|
|
||
| ::: | ||
|
|
||
| ## Getting Started | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Getting Started | ||
|
|
||
| ## Launch the Plugin {#launch} | ||
|
|
||
| Open your local plugin repository (see [install step](./index.md)), and click on `Run Extension` under the _Run and Debug_ tab. | ||
| This will launch the plugin in a new VS Code window. | ||
|
|
||
| In this new window, open your project folder. | ||
| If you don't have a project yet, you can use the [AssemblyScript template](https://github.com/TOPLLab/as-warduino-template) for WARDuino to get started quickly. | ||
|
|
||
| ## Project Configuration {#vscode-config} | ||
|
|
||
| ::: tip Add `launch.json` file | ||
| If you use any of our templates, you can skip this configuration step. | ||
| The template contains the correct launch file. | ||
| ::: | ||
|
|
||
| To use the WARDuino plugin to debug your project, you need to create a `launch.json` file in the `.vscode` subfolder of your project root directory [<sup>\[1\]</sup>](https://code.visualstudio.com/docs/editor/debugging). | ||
| The file should look like this: | ||
|
|
||
| ```json | ||
| { | ||
| "version": "0.4.1", | ||
| "configurations": [ | ||
| { | ||
| "type": "WARDuinoDBG", | ||
| "request": "launch", | ||
| "name": "Debug WARDuino", | ||
| "program": "${workspaceFolder}/src/main.ts", | ||
| "stopOnEntry": true, | ||
| "trace": false | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| The `program` key within the JSON file specifies the application's entry file that needs to be debugged. | ||
|
|
||
| Depending on the file extension pointed by the `program` entry, the plugin will load the required WebAssembly compiler and create source mappers accordingly. | ||
|
|
||
| ## Start Debugging | ||
|
|
||
| By default, the plugin will debug using a local running instance of WARDuino (emulator). | ||
| This means you don't need any further configuration. | ||
| Navigate to the _Run and Debug_ tab, and click on `Debug WARDuino`. | ||
|
|
||
| The next tutorial goes through the steps needed to debug on real hardware. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # VS Code Plugin | ||
|
|
||
| ::: tip WARDuino VS Code 0.4.1 | ||
|
|
||
| This page describes the VS Code plugin [version 0.4.1](https://github.com/TOPLLab/WARDuino-VSCode/releases/tag/v0.4.1), which works with WARDuino [version 0.4.2](https://github.com/TOPLLab/WARDuino/releases/tag/v0.4.2). | ||
|
|
||
| ::: | ||
|
|
||
| ::: warning Unstable prerelease | ||
|
|
||
| The plugin is still in experimental phase. | ||
| The following describes the current state of the VS Code plugin, which is not yet fully stable. | ||
| Consequently, the plugin may crash unexpectedly or become unresponsive. | ||
|
|
||
| ::: | ||
|
|
||
| The WARDuino plugin is a VS Code extension designed for debugging applications running on the WARDuino VM. The plugin offers two debugging techniques: | ||
|
|
||
| 1. [remote debugging](/reference/architecture.md#classic) and | ||
| 2. [event-based out-of-place debugging](/reference/edward/index). | ||
|
|
||
| Noteworthy functionality of the plugin: | ||
|
|
||
| - On-demand switching from [remote debugging](/reference/architecture.md#classic) to [event-based out-of-place debugging](/reference/edward/index). | ||
| - Access to classic debug operations: add a breakpoint, remove a breakpoint, step, step-over, run, and more. | ||
| - Access to advanced debug operations: step back debug operations to view past state. (experimental) | ||
| - A view on the whole debugging history to easily jump back to a previous state. (experimental) | ||
| - Upload new source code on the device once a fault has been fixed. | ||
| - Debug on a board | ||
| - Debug on an emulator. | ||
| - Control over interrupts (e.g., button press, incoming MQTT message) and the handling of it. | ||
|
|
||
| ## Manual Installation {#installation} | ||
|
|
||
| ::: warning Soon to be released! | ||
|
|
||
| The VS Code plugin has not been published yet. Look out for it in the VS Code Marketplace! | ||
| ::: | ||
|
|
||
| Before installing the plugin, make sure that you followed the [installation guide](/guide/get-started.md#installation) for the needed development software. | ||
|
|
||
| Once the installation is completed follow these steps: | ||
|
|
||
| - Install VS Code (version 1.63.2 or higher) | ||
|
|
||
| - (Optional) In case you plan to debug Textual WebAssembly source files make sure to install this [VS Code WebAssembly Syntax Highlight plugin](https://github.com/AlanCezarAraujo/vscode-webassembly-syntax-highlight). | ||
|
|
||
| - Change the VS Code settings to enable allow `Allow Breakpoints Everywhere`. | ||
| For this, navigate to the VS Code settings and search for `Allow Breakpoints Everywhere` in the search bar. | ||
| - Download the [WARDuino VS Code plugin](https://github.com/TOPLLab/WARDuino-VSCode) repo and execute the installation bash script named `install.sh`. | ||
| This script downloads and builds the essential libraries such as the WARDuino VM. |
Oops, something went wrong.