You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
WARDuino currently supports both the Arduino and ESP-IDF toolchains. To use Arduino, you need to install the [arduino-cli](https://github.com/arduino/arduino-cli). For ESP-IDF you need to install the full toolchain, instructions can be found on the [official website](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#get-started-step-by-step).
45
50
46
-
## 🛠️ Arduino Toolchain Setup {#arduino}
47
-
48
-
In order to setup the Arduino toolchain for WARDuino, you need to first install the [arduino-cli](https://arduino.github.io/arduino-cli/0.21/installation/).
49
-
You will also need `python3` with the `pyserial` package.
50
-
51
-
Second, create the config file:
52
51
53
-
```bash
54
-
arduino-cli config init
55
-
```
52
+
WARDuino currently supports both the Arduino and ESP-IDF toolchains. To use Arduino, you need to install the [arduino-cli](https://github.com/arduino/arduino-cli). For ESP-IDF you need to install the full toolchain, instructions can be found on the [official website](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#get-started-step-by-step).
56
53
57
-
If you need additional boards, such as the esp32 boards, you can add them in the generated config file.
54
+
## 🎉 Your First Project
58
55
59
-
To find the location of your config file you can run:
56
+
To get started quickly, you can use the [AssemblyScript template](https://github.com/TOPLLab/as-warduino-template).
Then, update the index and install the ESP32 platform.
64
+
Now you can compile the example program.
74
65
75
66
```bash
76
-
arduino-cli core update-index
77
-
arduino-cli core install esp32:esp32
67
+
npm run build
78
68
```
79
69
80
-
::: warning
81
-
To use ESP32 boards with WARDuino you need at least version 2.0.2 of the board manager.
82
-
:::
83
-
84
-
Thirdly, make sure you install the `PubSubClient` and `Adafruit NeoPixel` library, which are used by some primitives.
70
+
Now you can flash your program.
85
71
86
72
```bash
87
-
arduino-cli lib install "PubSubClient"# for MQTT
88
-
arduino-cli lib install "Adafruit NeoPixel"
73
+
cd~/Arduino/libraries/WARDuino/
89
74
```
90
75
91
-
If you haven't done so already, clone (or symlink) the WARDuino repository to `~/Arduino/libraries/WARDuino` to make it available to Arduino. (see [#installation](#installation))
92
-
93
76
## 📸 Flashing using Arduino
94
77
95
78
After setting up the Arduino toolchain, you can upload your programs with the Makefile in the `platforms/Arduino` folder of the WARDuino virtual machine.
@@ -140,3 +123,50 @@ make flash
140
123
141
124
Or simply run `idf.py flash`.
142
125
126
+
## 🛠️ Arduino Toolchain Setup {#arduino}
127
+
128
+
In order to setup the Arduino toolchain for WARDuino, you need to first install the [arduino-cli](https://arduino.github.io/arduino-cli/0.21/installation/).
129
+
You will also need `python3` with the `pyserial` package.
130
+
131
+
Second, create the config file:
132
+
133
+
```bash
134
+
arduino-cli config init
135
+
```
136
+
137
+
If you need additional boards, such as the esp32 boards, you can add them in the generated config file.
138
+
139
+
To find the location of your config file you can run:
140
+
141
+
```bash
142
+
arduino-cli config dump --verbose
143
+
```
144
+
145
+
Add the ESP32 board manager URL to the config file:
Then, update the index and install the ESP32 platform.
154
+
155
+
```bash
156
+
arduino-cli core update-index
157
+
arduino-cli core install esp32:esp32
158
+
```
159
+
160
+
::: warning
161
+
To use ESP32 boards with WARDuino you need at least version 2.0.2 of the board manager.
162
+
:::
163
+
164
+
Thirdly, make sure you install the `PubSubClient` and `Adafruit NeoPixel` library, which are used by some primitives.
165
+
166
+
```bash
167
+
arduino-cli lib install "PubSubClient"# for MQTT
168
+
arduino-cli lib install "Adafruit NeoPixel"
169
+
```
170
+
171
+
If you haven't done so already, clone (or symlink) the WARDuino repository to `~/Arduino/libraries/WARDuino` to make it available to Arduino. (see [#installation](#installation))
Copy file name to clipboardExpand all lines: warduino/guide/plugin/get-started.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,6 @@
1
+
<scriptsetup>
2
+
import { data } from'../../.vitepress/config.data.ts'
3
+
</script>
1
4
# Getting Started
2
5
3
6
## Launch the Plugin {#launch}
@@ -18,9 +21,9 @@ The template contains the correct launch file.
18
21
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).
::: tip WARDuino VS Code {{ data.plugin.version }}
4
10
5
-
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).
11
+
This page describes the VS Code plugin <a:href="plugin"target="_blank">version {{ data.plugin.version }}</a>, which works with WARDuino <a:href="vm"target="_blank">version {{ data.vm.version }}</a>.
Copy file name to clipboardExpand all lines: warduino/reference/primitives.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,18 +10,18 @@ The WARDuino virtual machine includes built-in primitives that provide access to
10
10
11
11
The built-in primitives are divided conceptually into different modules, according to the functionality they provide. The primitives are hardware dependent and so have to be implemented for each hardware platform separately. The table below list all modules, and on which platforms they are supported.
0 commit comments