|
2 | 2 | title: Rinkhals Installer |
3 | 3 | --- |
4 | 4 |
|
5 | | -Starting from release 20250514_01, Rinkhals is released as a stadard SWU update file and an Installer tool. |
| 5 | +Starting from release 20250514_01, Rinkhals is released as a standard SWU update file and an Installer tool. |
| 6 | + |
| 7 | +The installer allows you to: |
6 | 8 |
|
7 | | -The installer allows you to |
8 | 9 | - Quickly install / update / uninstall Rinkhals versions |
9 | 10 | - Update your printer firmware |
10 | 11 | - Perform some operations using tools (debug bundle, reset configuration, backups, ...) |
11 | 12 | - Collect some diagnostics in case something seems wrong and provide known fixes |
12 | 13 |
|
| 14 | +<figure markdown="span"> |
| 15 | + { width="160" }<figcaption>Installer main screen</figcaption> |
| 16 | +</figure> |
| 17 | + |
| 18 | +## Downlaod and use the Rinkhals Installer |
| 19 | + |
| 20 | +From the GitHub [Releases](https://github.com/jbatonnet/Rinkhals/releases) page, find the version you want and download the installer.swu matching your printer model. |
| 21 | +As detailed in the [installation](./installation-and-firmware-updates.md) page, copy the .swu file as update.swu on a FAT32 USB drive. Then plug into the printer. |
| 22 | + |
13 | 23 | The installer takes about 10s to start. Once started, a SSH server will be listening on port 2222. |
14 | 24 |
|
| 25 | +The main screen will show you some diagnostics results. You can tap on those to display more details and to apply the appropriate fix. |
| 26 | + |
| 27 | + |
15 | 28 | ## Install & Updates |
16 | 29 |
|
17 | | -To install last Rinkhals version: |
18 | | -Home > Install & Updates > Rinkhals / Manage > Click on latest > Download > Install |
| 30 | +{ width="160", align=left } |
| 31 | + |
| 32 | +From this view you'll be able to quickly see what Rinkhals and system version are installed right now on your printer and see the last available versions from GitHub and [https://rinkhals.meowcat285.com](https://rinkhals.meowcat285.com) |
| 33 | + |
| 34 | + |
| 35 | +<div style="clear: both;"></div> |
| 36 | + |
| 37 | + |
| 38 | +### Manage Rinkhals versions |
| 39 | + |
| 40 | +!!! note |
| 41 | + |
| 42 | + Test Rinkhals versions will be announced on the Discord server to collect users feedback. |
| 43 | + |
| 44 | +{ width="160", align=right } |
| 45 | +{ width="160", align=right } |
| 46 | + |
| 47 | +This screen shows installed and GitHub available versions of Rinkhals. You can choose wether to display test version from GitHub as well. |
| 48 | + |
| 49 | +Tapping on one version will allow you to install, update or uninstall depending on your selection. |
| 50 | + |
| 51 | +The version will be downloaded, extracted and then installed on your printer. The printer will then reboot to your new Rinkhals installation. |
| 52 | + |
| 53 | +<div style="clear: both;"></div> |
| 54 | + |
| 55 | + |
| 56 | +### Manage system versions |
| 57 | + |
| 58 | +!!! warning |
| 59 | + |
| 60 | + A couple of things to keep in mind: |
| 61 | + |
| 62 | + - Downgrading firmware is not recommended as other printer components could be incompatible with the version you want to downgrade to. |
| 63 | + - When upgrading, if your installed Rinkhals version is not compatible with the new version it will not work properly |
| 64 | + |
| 65 | +{ width="160", align=right } |
| 66 | +{ width="160", align=right } |
| 67 | + |
| 68 | +This screen shows the installed system firmware and all available firmware versions from a mirror server: [https://rinkhals.meowcat285.com](https://rinkhals.meowcat285.com) |
| 69 | + |
| 70 | +The installer will also check directly with Anycubic servers if a new version not yet mirrored is available. |
| 71 | + |
| 72 | +Tapping on one version will allow you to upgrade or downgrade depending on your selection. |
| 73 | + |
| 74 | +The version will be downloaded, extracted and then installed on your printer. The printer will then reboot to your new Firmware installation. |
| 75 | +During the installation process, the installation will be patched in order for Rinkhals to survive the OTA process. |
| 76 | + |
| 77 | +<div style="clear: both;"></div> |
19 | 78 |
|
20 | | -You can enable test versions to list beta / testing version from GitHub. Those will be anounced on the Discord server. |
21 | 79 |
|
22 | 80 | ## Tools |
23 | 81 |
|
24 | | -- Generate a Debug Bundle > Generate a ZIP of useful logs / states of your pritner on the USB drive |
25 | | -- Reset Rinkhals configuration > Create a backup of your configuration on the USB drive and resets printer, moonraker and other configurations to default |
26 | | -- Backup partitions > Create a backup of /userdata and /useremain partitions (excluding gcodes, Rinkhals and other less important things) on the USB drive |
27 | | -- Clean old Rinkhals > Remove older Rinkhals versions, keeping only the last 3 version including the currently running one |
28 | | -- Uninstall Rinkhals > Completely remove Rinkhals files and configuration and revert back to stock firmware |
| 82 | +{ width="160", align=right } |
| 83 | +{ width="160", align=right } |
| 84 | + |
| 85 | +- **Generate a Debug Bundle**: Generate a ZIP of useful logs / states of your pritner on the USB drive |
| 86 | +- **Reset Rinkhals configuration**: Create a backup of your configuration on the USB drive and resets printer, moonraker and other configurations to default |
| 87 | +- **Backup partitions**: Create a backup of /userdata and /useremain partitions (excluding gcodes, Rinkhals and other less important things) on the USB drive |
| 88 | +- **Clean old Rinkhals**: Remove older Rinkhals versions, keeping only the last 3 version including the currently running one |
| 89 | +- **Uninstall Rinkhals**: Completely remove Rinkhals files and configuration and revert back to stock firmware |
| 90 | + |
| 91 | +<div style="clear: both;"></div> |
| 92 | + |
29 | 93 |
|
30 | 94 | ## Diagnostics |
31 | 95 |
|
32 | | -- |
| 96 | +{ width="160", align=right } |
| 97 | +{ width="160", align=right } |
| 98 | + |
| 99 | +This view will list some diagnostics the installer performs to detect potential issues with your printer. |
| 100 | + |
| 101 | +Tapping on them will show more details and the appropriate fix to apply. |
| 102 | + |
| 103 | +The list of diagnostics is increasing over time, here are a couple of examples: |
| 104 | + |
| 105 | +- Rinkhals being disabled |
| 106 | +- Modified pritner configuration |
| 107 | +- Missing startup files |
0 commit comments