Skip to content

Installing GUIslice on Arduino

Jump to bottom Edit New page
Calvin Hass edited this page May 29, 2020 · 9 revisions

Overview >

Installation: Arduino IDE

The following options are available for users who wish to use the Arduino IDE for development.

Installing from Arduino IDE

Installing a major release version of GUIslice can be done from the Arduino IDE:

  • Click on Sketch -> Include Library... -> Manage Libraries...
  • In the search bar, type: GUIslice
  • Select the latest version from the dropbox and click Install

VERY IMPORTANT: When updating GUIslice from the Arduino IDE, always create a backup copy of any custom config file you have created. The Arduino IDE may delete/overwrite files when updating. After performing an update, you can copy your config file back into the GUIslice library folder.

Please Note: GUIslice versions installed from the IDE may be several weeks out of date versus new features & fixes posted to the GitHub repository.

Installing from GitHub source

If you would like the most recent version of GUIslice under development, you can install the library directly from the GitHub repository:

  • Make a backup of your GUIslice library folder
    • The intention is to ensure you save a copy of your existing configuration settings.
    • In particular, the most important files are /src/GUIslice_config.h (which selects one of the custom config files), and the custom config file in /configs/ that was selected in GUIslice_config.h.
  • Download the GUIslice library
    • From the GUIslice page, click Clone or Download and then Download ZIP.
    • image
    • Extract the ZIP file on your computer. This will probably create a GUIslice-master folder on your computer (let's call this the GUIslice unzipped folder).
  • Move this unzipped folder into your Arduino libraries folder
    • To find your Arduino IDE libraries folder, go to File -> Preferences and note the path to your Sketchbook folder
    • Navigate to this folder and look for the libraries subfolder. This is your Arduino Library folder.
    • Ensure that any old copies of GUIslice within the Arduino Library folder (either GUIslice or GUIslice-master are removed first. Note that if you have previously modified the GUIslice config file, you may want to save a copy of it or move it elsewhere first.
    • Drag the unzipped GUIslice folder into the Arduino libraries folder
  • Install selected graphics and hardware libraries
    • The GUIslice TFT/OLED Configuration table provides some guidance on determining which drivers and additional libraries may need to be installed via the Arduino IDE for the more popular displays.
    • Use the Arduino IDE's Include Library -> Manage Libraries option to add these libraries. eg. Adafruit-GFX, Adafruit-ILI9341 and Adafruit-STMPE610.
  • Update your config
    • If you have saved a copy of your existing config (in the first step), you can simply update the /src/GUIslice_config.h file to point to your custom config in /configs/.

Note about Arduino IDE Versions - LTO issue

Please note that there was a bug in the Arduino/gcc compiler that shipped with older Arduino IDE versions (1.8.6 to 1.8.9) that can impact build stability (resulting in a lto1.exe error). Thankfully, this has been fixed in the latest Arduino IDE. It is recommended that users upgrade their IDE to 1.8.10 (or later) and also upgrade the Arduino AVR Boards in the Board Manager to version 1.8.1 (or later):

  • Download and install the latest Arduino IDE from arduino.cc
  • In Arduino IDE, select Tools -> Board: ... -> Boards Manager
  • Find Arduino AVR Boards in the list
  • If the version installed is lower than 1.8.1, then click on Select version, change it to 1.8.1 (or later) and then click on Install
  • image

Installation: PlatformIO

The following method is available for users who wish to use PlatformIO for development. This is only an initial capture of the steps -- it will be revised soon.

  • Install PlatformIO. Often this can be done within an IDE environment such as Atom.
  • Install libraries via File -> Settings then click on Libraries
    • Search for the applicable library names in the search bar and click Install for each:
    • Adafruit GFX Library, Adafruit ILI9341, Adafruit STMPE610 (or as needed by your setup)
    • GUIslice
  • The above should download the libraries to your PlatformIO library folder, eg: C:\Users\username\.platformio\lib\
  • From the Home page, click on Import Arduino Project, navigate to the downloaded library folder and click on Import. This will create a copy of the project in your user projects directory, eg: C:\Users\username\Documents\PlatformIO\Projects\
  • Open the imported project, modify any configuration files necessary
  • Select PlatformIO -> Build then PlatformIO -> Run

...

Clone this wiki locally