Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marlinfirmware/autobuildmarlin
Visual Studio Code extension to more easily build Marlin Firmware
https://github.com/marlinfirmware/autobuildmarlin
3d-printing arduino marlin-firmware platformio visual-studio-code
Last synced: 2 days ago
JSON representation
Visual Studio Code extension to more easily build Marlin Firmware
- Host: GitHub
- URL: https://github.com/marlinfirmware/autobuildmarlin
- Owner: MarlinFirmware
- License: gpl-3.0
- Created: 2019-12-18T00:11:40.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-15T19:21:44.000Z (about 1 month ago)
- Last Synced: 2025-01-20T00:03:57.974Z (2 days ago)
- Topics: 3d-printing, arduino, marlin-firmware, platformio, visual-studio-code
- Language: JavaScript
- Size: 690 KB
- Stars: 260
- Watchers: 20
- Forks: 63
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Auto Build Marlin
"Auto Build Marlin" provides a simplified interface to configure, build, and upload Marlin Firmware.
The **Auto Build** tool automatically detects the correct environments for your `MOTHERBOARD` and provides an interface to build them. No more editing `platformio.ini` or scanning a long list of environments in the PlatformIO IDE. Just press the **Build** button and go!
The **Configuration Editor** provides an enhanced interface to locate and edit configuration options. The config editor includes a search filter to find the options you need and discover useful features. To use, right-click a file in the VSCode file explorer and select **Open With… > Config Editor**. ***This is only an alpha preview at this time and will probably have some issues.***
## PlatformIO Required
When installing "Auto Build Marlin" you'll also be prompted to install the [PlatformIO extension](http://marlinfw.org/docs/basics/install_platformio_vscode.html). PlatformIO handles all the details of the build and is required for "Auto Build Marlin" to function.
## Usage
- Start *Visual Studio Code* and open a project folder with *Marlin Firmware* version 2.0 or later. Be careful to open the folder containing `platformio.ini` and not the "`Marlin`" folder within it. (You may also use the **Import Project…** option from the "PlaformIO Home" page.)
- The "File Explorer" should point to your Marlin Firmware folder like so:
### Configuration Editor
- Open the file `Configuration.h` or `Configuration_adv.h` to use the Configuration Editor. You may need to right-click on the window tab and choose "Reopen Editor with…" to activate the Config Editor. The Config Editor replaces the text view with a form divided up into sections.
- Use the "Filter" field to locate options by name.
- Click the "Show Comments" checkbox to show or hide comments.
- Click the title of a section to hide/show that section.
- Hold down `alt`/`option` and click on any title to hide/show all sections.
- Configuration files are annotated to provide some hints to configuration tools. Edit the configuration file text to add your own `@section` markers, provide allowed values for options, or improve documentation. Please submit your improvements and suggestions to improve the configuration experience.
### Auto Build
- Click the **Auto Build Marlin** icon  in the Activity Bar (on the far side of the *Visual Studio Code* window) to activate the **Auto Build Marlin** sidebar panel.
- Use the **Show ABM Panel** button (or click on any of the buttons in the toolbar) to open the Auto Build Marlin panel. If more than one target environment exists for your board you'll have to choose the specific environment to use before the build.
Icon|Action
----|------
|Start **Marlin Build** to test your Marlin build
|Start **Marlin Upload** to install Marlin on your board
|Start **Marlin Upload (traceback)** to install Marlin with debugging
|Start **Marlin Clean** to delete old build files
|Open the **Configuration Tool**
- The **Auto Build Marlin** panel displays information about your selected motherboard and basic machine parameters. Each board comes with one or more build environments that are used to generate the final Marlin binary. Choose the environment that best matches your MCU, bootloader, etc.
### Formatters
- Open the Command Palette and choose "Format Marlin Code." The file will be formatted according to Marlin standards.
- NOTE: The context menu item "Format Document With…" -> "Auto Build Marlin" doesn't work so ignore that menu command for now.
## Internals
The Auto Build Marlin extension for VSCode contributes a welcome panel, registered commands, a web view panel, a custom editor, and (soon) a tree view. It is built in Javascript so we don't have to learn TypeScript.