diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..506e831 --- /dev/null +++ b/README.md @@ -0,0 +1,113 @@ +# Mks-Robin-Nano-Marlin2.0-Firmware +## 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. + + + +## 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 / V2.x boards and V3.x boards +## MKS Robin Nano V1.x build and update firmware + +1. Build config: + +- platformio.ini: + + default_envs = mks_robin_nano35 +- Configuation.h: + #define SERIAL_PORT 3 + #define MKS_ROBIN_TFT35 + #define MOTHERBOARD BOARD_MKS_ROBIN_NANO + #define TFT_LVGL_UI + #define TOUCH_SCREEN + +2. Update firmware: + +- Enter the `.pio\build\mks_robin_nano35` directory, copy the `assets` folder and `Robin_nano35.bin` to the sd card +- Insert SD card to the motherboard, and you can see the update interface after power on. + +## MKS Robin Nano V2.x build and update firmware + +1. Build config: + +- platformio.ini: + + default_envs = mks_robin_nano35 +- Configuation.h: + #define SERIAL_PORT 3 + #define MKS_TS35_V2_0 + #define MOTHERBOARD BOARD_MKS_ROBIN_NANO_V2 + #define TFT_LVGL_UI + #define TOUCH_SCREEN + +2. Update firmware: + +- Enter the `.pio\build\mks_robin_nano35` directory, copy the `assets` folder and `Robin_nano35.bin` to the sd card +- Insert SD card is to the motherboard, and you can see the update interface after power on. + +## MKS Robin Nano V3.x build and update firmware + +1. Build config: + +- platformio.ini: + + default_envs = mks_robin_nano_v3_usb_flash_drive_msc +- Configuation.h: + #define SERIAL_PORT -1 + #define MKS_TS35_V2_0 + #define MOTHERBOARD BOARD_MKS_ROBIN_NANO_V3 + #define TFT_LVGL_UI + #define TOUCH_SCREEN + +- Configuation_adv.h: + Now you can either use the TF card or USB disk, use TF card: + // #define USB_FLASH_DRIVE_SUPPORT + Use USB disk: + #define USB_FLASH_DRIVE_SUPPORT + +2. Update firmware: + +- Enter the `.pio\build\mks_robin_nano35` directory, copy the `assets` folder and `Robin_nano_v3.bin` to the sd card or usb disk +- Insert sdcard or usb disk to the motherboard, and you can see the update interface after power on. + +3. Example build config: + +- [Open the example configuration file](https://github.com/makerbase-mks/Mks-Robin-Nano-Marlin2.0-Firmware/tree/master/config/MKS%20Robin%20nano%20v3.0). +- Modify the parameters, replace configuration.h and configuration_adv.h in the Marlin path of the source code. +- Compile the firmware. + +4. Prebuilt *.bin firmware for update + +- We have prebuilt the robin nano v3 [firmware](https://github.com/makerbase-mks/MKS-Robin-Nano-V3.X/tree/main/firmware/Marlin-bugfix2.0.x-MKS-2.1.2) for some type of printers and some extended usage. + + +## For more function configuration, please refer to Robin nano series Wiki +- [MKS Robin Nano V1.x Wiki](https://github.com/makerbase-mks/MKS-Robin-Nano-V1.X/wiki). +- [MKS Robin Nano V2.x Wiki](https://github.com/makerbase-mks/MKS-Robin-Nano-V2.X/wiki). +- [MKS Robin Nano V3.x Wiki](https://github.com/makerbase-mks/MKS-Robin-Nano-V3.X/wiki). + +## 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 github](https://github.com/makerbase-mks/MKS-Robin-Nano-V2). + +## More information about the Robin Nano V3.X +Please refer to [MKS Robin Nano V3 github](https://github.com/makerbase-mks/MKS-Robin-Nano-V3.X). + |