Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
wgcv committed Jun 27, 2020
2 parents 965dd92 + 2f6221e commit 8e955fb
Showing 1 changed file with 37 additions and 9 deletions.
46 changes: 37 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,54 @@
The most powerful TFT Firmware for the Artillery X1 and Genius keeping the vanilla essence but with incredible tools.
</p>


## Table of Contents
- [Feature](#feature)
- [Screens](#screens)
- [How to update TFT Firmware](#how-to-setup-the-tft-firmware)
- [Customization](#customization)
- [Configuration](#editing-configuration)
- [Themes](#themes)
- [Reset](#reset)
- [Deployment](#deployment)
- [Contribute](#contribute)

## Feature
- M600 from USB and MicroSD (Pause, Change Filament and Resume, with out changing Marlin)
- Pre-Heat
- PID for ABS and PLA
- Extrude Calibration (E Steps)
- Filament Change
- Baby Steps
- Change configuraiton with out rebuilding (config.ini file)
- Auto Leveling and Manual Leveing (5 Points).
- Gcode Console


⚠️ **You don't need to modify or open the printer** to use the firmware and the M600.

📐For auto-leveling, could be necessary to make some changes in Marlin Firmware and add additional hardware

🐙 If you want to use M600 with **octoprint** check [RewriteM600](https://github.com/wgcv/RewriteM600)

🖨 ✅ Working in **Artillery Sidewinder X1** and **Artillery Genius***

👷🏽‍♀️ If you try it in another 3D printer with TFT28, please add it to the readme file.

## Screens
| Status page with flow and speed | Status page clasic |
|:--------------------------:|:-------------------------:|
|![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-statusscreen1.jpg) | ![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-statusscreen2.jpg)
| Main menu | Settings menu |
|![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-mainmenu.jpg) | ![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-settings.jpg)
| Printing menu | |
![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-printing.jpg) <img width=1080/>| <img width=1080/>
| Printing menu | M600 |
![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-printing.jpg) <img width=1080/>| ![](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-M600.jpg)<img width=1080/>

## How to setup the TFT firmware

1. Download the last realse from https://github.com/wgcv/RAWR-TFT-Firmware-Artillery3D/releases
1. Download the last release from https://github.com/wgcv/RAWR-TFT-Firmware-Artillery3D/releases
2. Unzip the download file.
3. Copy the files `mkstft28.bin` `config.ini` and the folders `bmp` `font` to the root of a blank SD Card (<8GB and formatted as FAT32).
4. Insert the SD card in the TFT's SD card slot and restart the TFT by pressing the reset buttion or disconnecting and connecting the power cable.
4. Insert the SD card in the TFT's SD card slot and restart the TFT by pressing the reset button or disconnecting and connecting the power cable.
5. Wait to update the firmware, configuration, font and icons.
![image](https://raw.githubusercontent.com/wgcv/RAWR-TFT-Firmware-Artillery3D/docs/img/readme-copysd.jpg)

Expand All @@ -41,16 +64,16 @@ The most powerful TFT Firmware for the Artillery X1 and Genius keeping the vanil
## Customization
### Editing configuration
The Firmware can be configured using the **config.ini** file.
- For edit the pre heat values you can check the lines `224` to `231`, the `T` is the extrusor temperature and `B` the bed temperature.
- For edit the bed size you can edit the line `155` for the x1 the default vaue are `size_max:X300 Y300 Z400` and the genius `size_max:X220 Y220 Z250`
- To edit the pre heat values you can check the lines `224` to `231`, the `T` is the extrusor temperature and `B` the bed temperature.
- For edit the bed size you can edit the line `155` for the x1 the default value are `size_max:X300 Y300 Z400` and the genius `size_max:X220 Y220 Z250`
- For show the flow and speed in the status screen change the line `308` to `show_status_speed_flow:1`

#### Updating Firmware Configuration
To update the Firmware configuration:
1. Edit the settings in **config.ini**.
2. Copy the **config.ini** file to the root of the SD card. (The SD card capacity should be less than or equal to 8GB and formatted as FAT32)
3. Insert the SD card in the TFT's SD card slot and restart the TFT by pressing the reset buttion or disconnecting and connecting the power cable.
4. The TFT will update and store the configuraiton form **config.ini** file.
3. Insert the SD card in the TFT's SD card slot and restart the TFT by pressing the reset button or disconnecting and connecting the power cable.
4. The TFT will update and store the configuration form **config.ini** file.

### Themes
You can create your own themes changing the BMP images and share the link opening a PR.
Expand All @@ -62,8 +85,10 @@ To reset the TFT's touch screen calibration, create a blank file named `reset.tx
<ol>
<li>Setup Visual Studio Code with PlatformIO <a href="https://github.com/bigtreetech/Document/blob/master/How%20to%20install%20VScode+Platformio.md">instructions</a></li>
<li>Click on the PlatformIO icon (1) and then click on Open Project (2):

<img src="https://user-images.githubusercontent.com/25599056/56637513-6b258e00-669e-11e9-9fad-d0571e57499e.png"></li>
<li>Find the firmware source directory , then click Open:

<img src="https://user-images.githubusercontent.com/25599056/56637532-77115000-669e-11e9-809b-f6bc25412f75.png"></li>
<li>After opening the project, edit <a href="platformio.ini"><code>platformio.ini</code></a> and check the <code>default_envs</code> to one that matches your TFT model and version, for the Artillery is:
<pre>
Expand All @@ -77,3 +102,6 @@ default_envs = MKS_28_Clone_V1_0
<img src="https://user-images.githubusercontent.com/25599056/56637550-809ab800-669e-11e9-99d3-6b502e294688.png"></li>
<li>A <code>mkstft28.xx.xbin</code> file will be generated in the <em>hidden</em> <code>.pio\build\MKS_28_Clone_V1_0</code> folder. Follow the update process outlined in the <a href="#how-to-setup-the-tft-firmware">How to setup the TFT Firmware</a> section above to update your TFT to the latest version.</li>

## Contribute
You can report issues, create themes, implement new features with PR or **Sponsor it on [PayPal](https://paypal.me/wgcvl)**.

0 comments on commit 8e955fb

Please sign in to comment.