Provides access to the current state of the Arduino IDE such as the sketch path, the currently selected board, and port, and etc.
-
↳
ArduinoContext
- boardDetails
- compileSummary
- config
- currentSketch
- dataDirPath
- fqbn
- onDidChangeConfig
- onDidChangeCurrentSketch
- onDidChangeSketch
- onDidChangeSketchFolders
- openedSketches
- port
- sketchPath
- userDirPath
• Readonly boardDetails: undefined | BoardDetails
Lightweight representation of the board's detail. This information is provided by the Arduino CLI for the currently selected board. It can be undefined if the fqbn is defined but the platform is not installed.
Deprecated
Use arduinoContext?.currentSketch?.boardDetails instead.
• Readonly compileSummary: undefined | CompileSummary
The summary of the latest sketch compilation. When the sketchPath is available but the sketch has not been verified (compiled), the buildPath can be undefined.
Deprecated
Use arduinoContext?.currentSketch?.compileSummary instead.
• Readonly config: CliConfig
The currently configured Arduino CLI configuration.
• Readonly currentSketch: undefined | SketchFolder
The currently active sketch (folder) or undefined. The current sketch is the one that currently has focus or most recently had focus.
The current sketch is in the opened sketches.
• Readonly dataDirPath: undefined | string
Filesystem path to the directories.data location.
Deprecated
Use arduinoContext?.config?.dataDirPath instead.
• Readonly fqbn: undefined | string
The Fully Qualified Board Name (FQBN) of the currently selected board in the Arduino IDE.
Deprecated
Use arduinoContext?.currentSketch?.board?.fqbn instead.
• Readonly onDidChangeConfig: Event<ChangeEvent<CliConfig>>
An event that is emitter when the sketchbook (directories.data) or the data directory (directories.data) path has changed.
• Readonly onDidChangeCurrentSketch: Event<undefined | SketchFolder>
An Event that is emitted when the current sketch has changed.
Note that the event also fires when the active editor changes to undefined.
• Readonly onDidChangeSketch: Event<ChangeEvent<SketchFolder>>
An event that is emitted when the selected board, port, etc., has changed in the sketch folder.
• Readonly onDidChangeSketchFolders: Event<SketchFoldersChangeEvent>
An event that is emitted when sketch folders are added or removed.
• Readonly openedSketches: readonly SketchFolder[]
All opened sketch folders in the window.
• Readonly port: undefined | Port
The currently selected port in the Arduino IDE.
Deprecated
Use arduinoContext?.currentSketch?.port instead.
• Readonly sketchPath: undefined | string
Absolute filesystem path of the sketch folder.
Deprecated
Use arduinoContext?.currentSketch?.sketchPath instead.
• Readonly userDirPath: undefined | string
Filesystem path to the directories.user location. This is the sketchbook path.
Deprecated
Use arduinoContext?.config?.userDirPath instead.
▸ onDidChange<T>(property): Event<ArduinoState[T]>
| Name | Type |
|---|---|
T |
extends keyof ArduinoState |
| Name | Type |
|---|---|
property |
T |
Event<ArduinoState[T]>
Deprecated
Use onDidChangeSketch and onDidChangeConfig instead.