README.md

# About this Fork
This fork is a Marlin version, based on the original branch of MKS (board manufacturer), and was created to bring Marlin 2.0 with the easy configurability of Marlin implementation from l3tspeak to TwoTrees printers like the Sapphire Plus an Pro.

## Preconfigured printers:
- Sapphire Pro
- Sapphire Plus
- Bluer
- Sapphire Pro/Plus with E3D Hemera

As I own a Sapphire Plus with Hemera, this will be the only tested version.

# Some other Recommendation
I'm using the Cura for slicing with the Voron 300 as base-profile. Some configurations had been made.

# Mks-Robin-Nano-Marlin2.0-Firmware (Description of original project...)
## Features
The firmware of Mks Robin Nano, based on [Marlin2.0.x](https://github.com/MarlinFirmware/Marlin), added the [LittlevGL](https://github.com/littlevgl/lvgl), supporting colourful GUI and touch screen. It is developed on PlatformIO, we hope more and more developers will participate the development of this repository.

![](https://github.com/makerbase-mks/Mks-Robin-Nano-Marlin2.0-Firmware/blob/master/Images/MKS_Robin_Nano_printing.png)

## Build
As the firmware is based on Marlin2.0.x which is built on the core of PlatformIO, the buid compiling steps are the same as Marlin2.0.x. You can directly using [PlatformIO Shell Commands](https://docs.platformio.org/en/latest/core/installation.html#piocore-install-shell-commands), or using IDEs contain built-in PlatformIO Core(CLI), for example, [VSCode](https://docs.platformio.org/en/latest/integration/ide/vscode.html#ide-vscode) and [Atom](https://docs.platformio.org/en/latest/integration/ide/atom.html). VSCode is recommended.

## About the gcode file preview
The images should be added to gcode file when slicing, and MKS has developed the [plugin for Cura](https://github.com/makerbase-mks/mks-wifi-plugin) to make it.

## About the image conversion
- Open [LVGL online image converter tool](https://lvgl.io/tools/imageconverter).
- Open bmp images.
- Enter the saved file name.
- Choose color format:True color.
- Choose file output format:Binary RGB565.
- Start convertion.
- Save bin file.
- Copy the converted bin file to the assets folder.
- Copy the assets folder to the SD card.
- SD card is connected to the motherboard, and you can see the update interface after powering on.

## Firmware Can be run on Robin Nano V1.x and V2.x boards
## MKS Robin Nano V1.x build and update firmware

1. Build config:

- platformio.ini:

     default_envs = mks_robin_nano35    
- Configuation.h:

     #define MOTHERBOARD BOARD_MKS_ROBIN_NANO   

     #define TFT_LVGL_UI_FSMC

     //#define TFT_LVGL_UI_SPI

2. Update firmware:

- Enter the `.pio\build\mks_robin_nano35` directory, copy the `assets` folder and `Robin_nano35.bin` to the sd card
- SD card is connected to the motherboard, and you can see the update interface after powering on.   

## MKS Robin Nano V2.x build and update firmware

1. Build config:

- platformio.ini:

     default_envs = mks_robin_nano35    
- Configuation.h:

     #define MOTHERBOARD BOARD_MKS_ROBIN_NANO_V2   

     //#define TFT_LVGL_UI_FSMC

     #define TFT_LVGL_UI_SPI

2. Update firmware:

- Enter the `.pio\build\mks_robin_nano35` directory, copy the `assets` folder and `Robin_nano35.bin` to the sd card
- SD card is connected to the motherboard, and you can see the update interface after powering on.   

## More information about the Robin Nano V1.X
Please refer to [MKS Robin Nano github](https://github.com/makerbase-mks/MKS-Robin-Nano-V1.X).

##  More information about the Robin Nano V2.X
Please refer to [MKS-Robin-Nano-V2 wiki](https://github.com/makerbase-mks/MKS-Robin-Nano-V2/wiki/Marlin_firmware).