Skip to content

Latest commit

 

History

History

examples

README.md

Craft Micro SDK - Examples

The Craft Micro SDK uses the Arduino framework, so any tool set that uses this framework should work. However, Craft Micro highly recommends PlatformIO for cross-platform microprocessor development.

Run the examples using PlatformIO

First-time setup

  1. Install VSCode (Visual Studio Code) and the PlatformIO IDE (plugin for VSCode)
  2. Clone Craft Micro SDK from github. In these examples we clone it to C:/libraries/craftmicro-sdk

Project setup

  1. Create a new PlatformIO project
  2. Choose a location and your dev board, and select arduino as the framework (*)
  3. Once the project has been created, edit platformio.ini (see example below)
    1. Add lib_extra_dirs with the path to where you cloned the Craft Micro SDK (**)
    2. Add lib_deps and specify the SPI library (required for the ILI9341 TFT display)
    3. Add build_flags to add the include path to the Craft Micro SDK folder (for the resources)
  4. Copy and paste one of the example main.cpp files into your project's src directory
  5. Build and deploy!

(*) You can only target boards that support the Arduino framework at this stage.

(**) The path should be to the library folder (the parent of the Craft Micro folder), not to the Craft Micro folder itself.

See example platformio.ini In our example we are targeting the Teensy 3.6 dev board. Our platformio.ini looks like this: 
[env:teensy36]
platform = teensy
board = teensy36
framework = arduino
lib_deps = SPI
lib_extra_dirs = C:/libraries/
build_flags = -I"C:/libraries/craftmicro-sdk/"

Run the examples using Arduino IDE

First-time setup

  1. Install Arduino IDE
  2. You may need to install additional tools for your dev board. In our example we are using a Teensy 3.6 board, so we need to install TeensyDuino.
  3. Clone Craft Micro SDK from github into your Arduino/libraries folder (help)

Project setup

  1. Run Arduino IDE and create a new sketch if you need to
  2. Copy and paste the code from main.cpp in one of the examples into your sketch
  3. Save the sketch, then open the folder where the sketch is saved and create the subfolder resources
    1. Copy the resources your example needs from craftmicro-sdk/examples/resources to my-sketch/resources (*)
  4. Build and deploy!

(*) You need to copy the resources into each sketch that requires them. If you change the folder names, also update the #include path to match