Description
First of all, thank you very much for building this! I've been getting requests for some of the plugins used w/arduino-pico like the LittleFS uploader to be ported to IDE 2.x.
As part of the uploader we run some external commands (like you do w/the ESP exception decoder you ported) that depend on some of the build.xxx properties (i.e. how large a filesystem, where it's located, what upload port, etc.).
What I'm seeing is that when the IDE starts up and opens the sketch from last time, is that the arduinoContext only has three fields:
{
"sketchPath": "/home/earle/Arduino/Blink_copy_20221005103501",
"userDirPath": "/home/earle/Arduino",
"dataDirPath": "/home/earle/.arduino15"
}
If I open another sketch (but not build it), or run a build on the automatically opened sketch, the context seems to fully populate:
{
"sketchPath": "/home/earle/Arduino/Blink",
"fqbn": "pico:rp2040:rpipico",
"boardDetails": {
"buildProperties": {
"version": "3.6.0",
....
"build.fqbn": "pico:rp2040:rpipico",
"build.arch": "RP2040",
"build.libpicow": "libpicow-noipv6-nobtc-noble.a",
"build.libpicowdefs": "-DLWIP_IPV6=0 -DLWIP_IPV4=1",
"build.debug_level": "",
"build.f_cpu": "133000000L",
"build.flags.optimize": "-Os",
"build.flags.rtti": "-fno-rtti",
....
"port": {
"label": "/dev/ttyACM1",
"address": "/dev/ttyACM1",
"hardwareId": "E6614C775B6C7F31",
"properties": {
"pid": "0xf00a",
"serialNumber": "E6614C775B6C7F31",
"vid": "0x2e8a"
},
"protocol": "serial",
"protocolLabel": "Serial Port (USB)"
},
"userDirPath": "/home/earle/Arduino",
"dataDirPath": "/home/earle/.arduino15"
}
The uploader plugins don't have any need for a build before being run, but they do need properties like the port and the buildProperties to do their jobs.
Is there a way to make the arduinoContext force-update from an end-user of the extension? Or is there a way to update this extension to populate it?
MCVE extension.ts (basically helloworld from yo code):
// The module 'vscode' contains the VS Code extensibility API
// Import the module and reference it with the alias vscode in your code below
import * as vscode from 'vscode';
import type { ArduinoContext } from 'vscode-arduino-api';
// This method is called when your extension is activated
// Your extension is activated the very first time the command is executed
export function activate(context: vscode.ExtensionContext) {
// Use the console to output diagnostic information (console.log) and errors (console.error)
// This line of code will only be executed once when your extension is activated
console.log('Congratulations, your extension "pico-littlefs-upload" is now active!');
const arduinoContext: ArduinoContext = vscode.extensions.getExtension(
'dankeboy36.vscode-arduino-api'
)?.exports;
if (!arduinoContext) {
// Failed to load the Arduino API.
console.log(`Failed to find IDE context`);
return;
}
console.log('Got IDE context 5!');
// The command has been defined in the package.json file
// Now provide the implementation of the command with registerCommand
// The commandId parameter must match the command field in package.json
let disposable = vscode.commands.registerCommand('pico-littlefs-upload.uploadLittleFS', () => {
// The code you place here will be executed every time your command is executed
// Display a message box to the user
let str = JSON.stringify(arduinoContext, null, 4);
console.log(str);
});
context.subscriptions.push(disposable);
}
// This method is called when your extension is deactivated
export function deactivate() {}
--edit--more testing--
I also attempted to grab the context on each command invocation thinking maybe I got a static copy of the context at a "bad time" during plug in initialization. That seems to make no difference, though, and only by building or opening another sketch can I get the state properly for the auto-opened sketch
export function activate(context: vscode.ExtensionContext) {
let disposable = vscode.commands.registerCommand('pico-littlefs-upload.uploadLittleFS', () => {
const arduinoContext: ArduinoContext = vscode.extensions.getExtension(
'dankeboy36.vscode-arduino-api'
)?.exports;
if (!arduinoContext) {
return;
}
let str = JSON.stringify(arduinoContext, null, 4);
console.log(str);
});
context.subscriptions.push(disposable);
}
--edit--even more testing--
The behavior is that the first auto-opened sketch does NOT get its data populated until a build. Switching from the auto-open sketch, to a different one, then back to the auto-opened sketch still does not give any additional fields. Only building populates its object.