https://github.com/thelastoutpostworkshop/arduino-maker-workshop

The ultimate tool for makers to bring Arduino projects to life in Visual Studio Code
https://github.com/thelastoutpostworkshop/arduino-maker-workshop

vscode-extension

Last synced: about 1 month ago
JSON representation

The ultimate tool for makers to bring Arduino projects to life in Visual Studio Code

• Host: GitHub
• URL: https://github.com/thelastoutpostworkshop/arduino-maker-workshop
• Owner: thelastoutpostworkshop
• License: mit
• Created: 2024-09-07T02:06:39.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-12-27T21:23:36.000Z (about 2 months ago)
• Last Synced: 2024-12-27T22:22:43.563Z (about 2 months ago)
• Topics: vscode-extension
• Language: TypeScript
• Homepage:
• Size: 217 MB
• Stars: 18
• Watchers: 1
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Arduino Maker Workshop

The ultimate tool for makers to bring Arduino projects to life in Visual Studio Code on Windows.

> **Currently supported on Windows x64 and MacOS ARM64 and Linux x64**, help needed for [for other platforms](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/discussions/2)

## Microcontrollers Platforms

All the platforms supported by the [Arduino CLI](https://arduino.github.io/arduino-cli) (the CLI is included in this extension).

## Tutorial : [Get Started](https://youtu.be/rduTUUVkzqM)

### Arduino Code Snippets : [Documentation](https://github.com/thelastoutpostworkshop/arduino-maker-workshop/blob/main/Arduino_Snippets_Documentation.md)

## New Sketch

![new sketch](.readme/new_sketch.gif)

## Board Selection

![new sketch](.readme/board_selection.gif)

## Board Configuration

![new sketch](.readme/board_configuration.gif)

## Boards Manager

![new sketch](.readme/board_manager.gif)

## Library Manager

![new sketch](.readme/library_manager.gif)

## Library Example

![new sketch](.readme/library_example.gif)

## About IntelliSense

IntelliSense data (c_cpp_properties.json) is generated after each successful compile.  

For a new project, IntelliSense mark almost everything as "undefined" until you make your first good compile.

## Contributors

Contributors are welcomed! 

Take a look at [the project](https://github.com/users/thelastoutpostworkshop/projects/3) to see features to be implemented or bugs to be fixed

If you want to submit pull requests, [here is how you can do it](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).

## Extension Development

Install the dependancies:

- run `npm install` in the main folder of the extension

- run `npm install` in the webview folder

**Testing**

- Use `npm run watch` in the main folder to debug the extension in Visual Studio Code

- If you modify the webview, you must build it before testing the extension with the command `npm run build`

- You can test the webview in standalone mode using the command `npm run dev`, (in the webview folder). In development the webview uses mock files to simulate call to the Arduino CLI.