Bob-the-Kuhn

Installing Marlin (Sublime)

Before reading this article, you should have already read Installing Marlin with PlatformIO.

Auto Build support for Sublime

The Marlin Sublime extension provides access to the Auto Build script for the Sublime IDE.

Installation

Overview:

  1. Install Sublime
  2. Install Auto Build menu
    1. Install Install Package Control which is used to install:
      • Deviot (Deviot Console is used to launch the Auto Build Script)
      • WebDevShell (this will execute the Auto Build script via the Deviot Console)
    2. Copy the menu configuration to the proper Sublime directory
  3. Restart Sublime

Install Sublime

Open the Sublime main page and then click on the “DOWNLOAD FOR …“ button where the “…“ will list your operating system.

Downloading Sublime

This will download the Sublime installer. Install as usual for your operating system.

Install Auto Build menu

  1. Install Install Package Control

    • Click on Tools then Command Palette Command Palette

    • Start typing Install Package Control into the search box. Click on Install Package Control when it pops up in the window. Install Package Control

    • Click on the OK in the success popup. Install P.C. Success

    1. Install WebDevShell

      • Click on Tools then Command Palette Command Palette

      • Start typing Install Package Control into the search box. Click on Install Package Control when it pops up in the window. Install Package Control

      • Start typing WebDevShell into the search box. Click on WebDevShell when it pops up in the window. Install P.C. Success

      A Success window will NOT popup.

    2. Install Deviot

      Using the previous step as a guide, install Deviot.

      Install Deviot

      Install Python 2.7 if prompted

      Download Python

      PlatformIO CLI/core will be automatically installed if needed

  2. Copy the Auto Build menu to the correct subdirectory

Copy the directory buildroot/share/sublime/auto_build_sublime_menu to the Sublime extension directory and then (re)start Sublime.

The Sublime extension directory is usually located at:

  • Windows - C:/Users/YOUR_USER_NAME/.Sublime/extensions/ or C:/Users/YOUR_USER_NAME/AppData/Roaming/Sublime Text 3/Packages
  • Mac - /Users/YOUR_USER_NAME/Library/Application Support/Sublime Text 3/Packages/User
  • Linux - /home/YOUR_USER_NAME/.config/sublime-text-3/Packages/User/

Restart Sublime

Usage

Open the Marlin folder

Click on File and then Open Folder...

Open Folder

This brings up the Open Folder dialog. Select the folder that has the Marlin and buildroot folders in it.

Open Marlin Folder

You should see something like the following. If not, repeat this step from the beginning.

Marlin Folder

Run Auto Build

  1. Click on the “Auto Build” menu near the right end of the menus in the main menu bar.

Auto Build Menu

This brings up the Auto Build menu.

  1. Click on the desired action

Auto Build Menu List

This brings up the Deviot Console window and the (first) Auto Build window.

Deviot Console

After this everything is the same as in the Atom IDE