Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit b2d5a76

Browse files
benmcmorranbenmcmorran
committed
Update to 0.30.0 and revise wording
1 parent 3a01ffa commit b2d5a76

File tree

6 files changed

+46
-42
lines changed

6 files changed

+46
-42
lines changed

‎README.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Welcome to the Visual Studio Code extension for **Arduino** <sup>preview</sup> !
1515
* Integrated Arduino Debugging <sup>New</sup>
1616

1717
## Prerequisites
18-
Either the Arduino IDE or Arduino CLI are required. The recommended approach is
19-
to use the version of Arduino CLI that comes bundled with the extension, which
20-
works out of the box.
18+
Either the legacy Arduino IDE or Arduino CLI are required. The recommended
19+
approach is to use the version of Arduino CLI that comes bundled with the
20+
extension, which works out of the box. Support for the legacy Arduino IDE will
21+
be removed in a future version of the extension.
2122

2223
### Arduino CLI
2324
To use the bundled version of Arduino CLI, `arduino.useArduinoCli` should be `true`,
@@ -31,12 +32,14 @@ the repository's [release page](https://github.com/arduino/arduino-cli/releases/
3132
For custom versions, `arduino.path` must be set to the directory containing the
3233
Arduino CLI executable.
3334

34-
### Arduino IDE
35-
The Arduino IDE can be installed the Arduino [download page](https://www.arduino.cc/en/main/software#download).
36-
- The supported Arduino IDE versions are `1.6.x` and up to, but not including, 2.0.0.
35+
### Legacy Arduino IDE
36+
Use of the legacy Arduino IDE is not recommended, and support for the legacy
37+
Arduino IDE will be removed in a future version of the extension. The legacy
38+
Arduino IDE can be installed from the Arduino [download page](https://www.arduino.cc/en/main/software#download).
39+
- The supported legacy Arduino IDE versions are `1.6.x` and up to, but not including, `2.0.0`.
3740
- The Windows Store's version of the Arduino IDE is not supported because of the sandbox environment that the application runs in.
3841
- *Note:* Arduino IDE `1.8.7` had some breaking changes, causing board package and library installation failures. These failures were corrected in `1.8.8` and later.
39-
- *Note:* Arduino IDE `2.X.Y` is not supported at this time [issue 1477](https://github.com/microsoft/vscode-arduino/issues/1477)
42+
- *Note:* Arduino IDE `2.X.Y` is not supported and there are no plans for support in the future ([issue 1477](https://github.com/microsoft/vscode-arduino/issues/1477)).
4043

4144
## Installation
4245
Open VS Code and press <kbd>F1</kbd> or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> *or* <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open command palette, select **Install Extension** and type `vscode-arduino`.
@@ -80,8 +83,8 @@ This extension provides several commands in the Command Palette (<kbd>F1</kbd> o
8083
## Options
8184
| Option | Description |
8285
| --- | --- |
83-
| `arduino.useArduinoCli` | Whether to use the Arduino CLI (`true`) or the Arduino IDE (`false`) -- defaults to `false`. If using `true`, either leave the `arduino.path` and `arduino.commandPath` values unset to use the bundled version of Arduino CLI, or point them at a custom version of Arduino CLI. Note that a future version of the extension will change this default to `true` and remove support for Arduino IDE. |
84-
| `arduino.path` | Path to the Arduino installation. You can use a custom version of Arduino by modifying this setting to include the full path. Example: `C:\\Program Files\\Arduino` for Windows, `/Applications` for Mac, `/home/<username>/Downloads/arduino-1.8.1` for Linux. (Requires a restart after change). The default value is automatically detected from your Arduino IDE installation path. To use the Arduino CLI, use the path that contains the `arduino-cli` executable (e.g. `/usr/local/bin`), or leave it unset to use the bundled version of Arduino CLI. |
86+
| `arduino.useArduinoCli` | Whether to use the Arduino CLI (`true`) or the legacy Arduino IDE (`false`) -- defaults to `false`. If using `true`, either leave the `arduino.path` and `arduino.commandPath` values unset to use the bundled version of Arduino CLI, or point them at a custom version of Arduino CLI. Note that a future version of the extension will change this default to `true` and remove support for legacy Arduino IDE. |
87+
| `arduino.path` | Path to the Arduino installation. You can use a custom version of Arduino by modifying this setting to include the full path. Example: `C:\\Program Files\\Arduino` for Windows, `/Applications` for Mac, `/home/<username>/Downloads/arduino-1.8.1` for Linux. (Requires a restart after change). The default value is automatically detected from your legacy Arduino IDE installation path. To use the Arduino CLI, use the path that contains the `arduino-cli` executable (e.g. `/usr/local/bin`), or leave it unset to use the bundled version of Arduino CLI. |
8588
| `arduino.commandPath` | Path to an executable (or script) relative to `arduino.path`. The default value is `arduino_debug.exe` for Windows, `Contents/MacOS/Arduino` for Mac and `arduino` for Linux, You also can use a custom launch script to run Arduino by modifying this setting. (Requires a restart after change) Example: `run-arduino.bat` for Windows, `Contents/MacOS/run-arduino.sh` for Mac and `bin/run-arduino.sh` for Linux. To use the bundled version of Arduino CLI, leave this option unset. To use a custom version of Arduino CLI, use `arduino-cli`. |
8689
| `arduino.additionalUrls` | Additional Boards Manager URLs for 3rd party packages as a string array. The default value is empty. |
8790
| `arduino.logLevel` | CLI output log level. Could be info or verbose. The default value is `"info"`. |

‎build/assets.json

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
{
2-
"version": "0.29.0",
2+
"version": "0.30.0",
33
"assets": {
4-
"arduino-cli_0.29.0_Linux_64bit.tar.gz": {
5-
"hash": "febc558bb36a9aeb881ebcce0af6fff955234afda14435791ca41daf492c9cac",
4+
"arduino-cli_0.30.0_Linux_64bit.tar.gz": {
5+
"hash": "f6b1cddf3459b1b6ca9dafe36315c2fa1f6f77386ab3795bbad6a117cbe4230b",
66
"platforms": ["linux-x64"]
77
},
8-
"arduino-cli_0.29.0_Linux_ARM64.tar.gz": {
9-
"hash": "ce5cd44808462461c88ab3d2441363a7fa08035a1d0cc300823d357929223ae6",
8+
"arduino-cli_0.30.0_Linux_ARM64.tar.gz": {
9+
"hash": "20d2d036a5af4586b5a046f65d926ed012f7fd85469b484a5fc57ef9ef72fb4b",
1010
"platforms": ["linux-arm64"]
1111
},
12-
"arduino-cli_0.29.0_Linux_ARMv7.tar.gz": {
13-
"hash": "b2b98400a643324219f8fca1a4eeef3a129d6fe87356e4d126b1b56f88635c94",
12+
"arduino-cli_0.30.0_Linux_ARMv7.tar.gz": {
13+
"hash": "1d873f3cb2b939b2df5a7d25e998bded9a4f0c8ac1226d1d5f9abc2bd95a66c3",
1414
"platforms": ["linux-armhf"]
1515
},
16-
"arduino-cli_0.29.0_macOS_64bit.tar.gz": {
17-
"hash": "d2e5aa10c66440b27a55deca54d12fc6071bb4963423706aeae97bc68a5597de",
16+
"arduino-cli_0.30.0_macOS_64bit.tar.gz": {
17+
"hash": "ece83e0bd15813e728d07ce584388a278d62e54529deb84ad07d1521bfe74748",
1818
"platforms": ["darwin-x64"]
1919
},
20-
"arduino-cli_0.29.0_macOS_ARM64.tar.gz": {
21-
"hash": "19da609c94383c98748ec79a751ac19dab38ce012880d9bb3e0e7e1d70128107",
20+
"arduino-cli_0.30.0_macOS_ARM64.tar.gz": {
21+
"hash": "e6c1a35df995ecb464ffa85fe8a96b82bd06135ea5ae961cb34d9c9e99e6c2fa",
2222
"platforms": ["darwin-arm64"]
2323
},
24-
"arduino-cli_0.29.0_Windows_32bit.zip": {
25-
"hash": "366a6d354083db5386ff5e0d92043d23940e11cba9c3a5cf46ccea5a849e21ea",
24+
"arduino-cli_0.30.0_Windows_32bit.zip": {
25+
"hash": "cccd4b90524581783cf78a3e4942a5c6bf7508a2a5ec4e008bb9c43f1cdb5dbe",
2626
"platforms": ["win32-ia32"]
2727
},
28-
"arduino-cli_0.29.0_Windows_64bit.zip": {
29-
"hash": "e7473a72e40c7d7a1b29c4a3ec4646f9b9163e46c35fd78e34f1e315c2dd1e38",
28+
"arduino-cli_0.30.0_Windows_64bit.zip": {
29+
"hash": "1808d288382f16594ad73f4797303058b2074b1b375fbb19fca0978033a633af",
3030
"platforms": ["win32-x64"]
3131
}
3232
}

‎cgmanifest.json

+14-14
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
"type": "other",
88
"other": {
99
"name": "arduino-cli (Linux x64)",
10-
"version": "0.29.0",
11-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_Linux_64bit.tar.gz",
10+
"version": "0.30.0",
11+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_Linux_64bit.tar.gz",
1212
}
1313
}
1414
},
@@ -17,8 +17,8 @@
1717
"type": "other",
1818
"other": {
1919
"name": "arduino-cli (Linux ARM64)",
20-
"version": "0.29.0",
21-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_Linux_ARM64.tar.gz",
20+
"version": "0.30.0",
21+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_Linux_ARM64.tar.gz",
2222
}
2323
}
2424
},
@@ -27,8 +27,8 @@
2727
"type": "other",
2828
"other": {
2929
"name": "arduino-cli (Linux ARMv7)",
30-
"version": "0.29.0",
31-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_Linux_ARMv7.tar.gz",
30+
"version": "0.30.0",
31+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_Linux_ARMv7.tar.gz",
3232
}
3333
}
3434
},
@@ -37,8 +37,8 @@
3737
"type": "other",
3838
"other": {
3939
"name": "arduino-cli (macOS x64)",
40-
"version": "0.29.0",
41-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_macOS_64bit.tar.gz",
40+
"version": "0.30.0",
41+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_macOS_64bit.tar.gz",
4242
}
4343
}
4444
},
@@ -47,8 +47,8 @@
4747
"type": "other",
4848
"other": {
4949
"name": "arduino-cli (macOS ARM64)",
50-
"version": "0.29.0",
51-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_macOS_ARM64.tar.gz",
50+
"version": "0.30.0",
51+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_macOS_ARM64.tar.gz",
5252
}
5353
}
5454
},
@@ -57,8 +57,8 @@
5757
"type": "other",
5858
"other": {
5959
"name": "arduino-cli (Windows x86)",
60-
"version": "0.29.0",
61-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_Windows_32bit.zip",
60+
"version": "0.30.0",
61+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_Windows_32bit.zip",
6262
}
6363
}
6464
},
@@ -67,8 +67,8 @@
6767
"type": "other",
6868
"other": {
6969
"name": "arduino-cli (Windows x64)",
70-
"version": "0.29.0",
71-
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.29.0/arduino-cli_0.29.0_Windows_64bit.zip",
70+
"version": "0.30.0",
71+
"downloadUrl": "https://github.com/arduino/arduino-cli/releases/download/0.30.0/arduino-cli_0.30.0_Windows_64bit.zip",
7272
}
7373
}
7474
}

‎package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@
473473
"arduino.useArduinoCli": {
474474
"type": "boolean",
475475
"default": false,
476-
"markdownDescription": "Use Arduino CLI installed instead of Arduino IDE. If `#arduino.path#` and `#arduino.commandPath#` are not set, the extension will use a version of Arduino CLI bundled with the extension. (Requires a restart after change)"
476+
"markdownDescription": "Use Arduino CLI installed instead of the legacy Arduino IDE. If `#arduino.path#` and `#arduino.commandPath#` are not set, the extension will use a version of Arduino CLI bundled with the extension. (Requires a restart after change)"
477477
},
478478
"arduino.path": {
479479
"type": "string",

‎src/common/constants.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ export const EXAMPLES_URI = vscode.Uri.parse("arduino-manager://arduino/arduino-
2929
export const messages = {
3030
ARDUINO_FILE_ERROR: "The arduino.json file format is not correct.",
3131
NO_BOARD_SELECTED: "Please select the board type first.",
32-
INVALID_ARDUINO_PATH: "Cannot find Arduino IDE.",
32+
INVALID_ARDUINO_PATH: "Cannot find Arduino tools.",
3333
INVALID_COMMAND_PATH: "Cannot find the command file:",
34-
SWITCH_TO_BUNDLED_CLI: "Use arduino-cli bundled with this extension instead?",
35-
REMOVE_ARDUINO_IDE_SUPPORT: "Support for the Arduino IDE will be removed soon.",
34+
SWITCH_TO_BUNDLED_CLI: "Use Arduino CLI bundled with this extension instead?",
35+
REMOVE_ARDUINO_IDE_SUPPORT: "Support for the legacy Arduino IDE will be removed soon.",
3636
FAILED_SEND_SERIALPORT: "Failed to send message to serial port.",
3737
SERIAL_PORT_NOT_STARTED: "Serial Monitor has not been started.",
3838
SEND_BEFORE_OPEN_SERIALPORT: "Please open a serial port first.",

‎src/extension.ts

+1
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ export async function activate(context: vscode.ExtensionContext) {
108108
// intentionally using the Arduino IDE but relied on the current default
109109
// value of false. A future will make this breaking change with
110110
// appropriate messaging.
111+
Logger.traceUserData("using-legacy-arduino-ide");
111112
void askSwitchToBundledCli(constants.messages.REMOVE_ARDUINO_IDE_SUPPORT + " " + constants.messages.SWITCH_TO_BUNDLED_CLI);
112113
}
113114

0 commit comments

Comments
 (0)