Rinkhals project
Core principles¶
The goal of Rinkhals is to expand existing Anycubic features with better compatibility, apps and more. It will likely not support all use cases, like running vanilla Klipper or your specific feature / plugin.
Even though progress have been made for running vanilla Klipper (still not working), the goal is NOT to provide a complete replacement for Anycubic firmware, but instead to complement stock firmware.
Rinkhals is targeted at a wide audience, not experts. I designed it to be as easy to use as possible with the default configuration for anyone to use. It is still a firmware mod and people should avoid using it if they are not comfortable potentially making their printer not work anymore. Because of that, experts might find the firmware still too limited, it's intended even though I exposed ways to go deeper if needed.
Rinkhals includes many firmware protection features. It is designed as an overlay and won't modify any files in stock firmware except for the launcher script. Then everyhting is isolated to allow reverting back to stock very easily. Rinkhals will disable itself if anything goes wrong during its startup.
For anyone curious enough: Rinkhals internals
Kobra X status¶
Some Kobra X firmware images are available publicly and the SWU password is known.
However, the software stack differs significantly from the K3 family. Anycubic appears to have moved from GoKlipper-based firmware to a K4 base with a C++ Klipper port. Because of this, Kobra X support is not expected to be a straightforward Rinkhals port.
Additionally, Kobra X SWU updates appear to require certificate validation. Until a reliable method is found to bypass or satisfy this requirement, Rinkhals-style SWU injection is not currently feasible on Kobra X.
Summary¶
- There are no prerequisites for Rinkhals, except version compatibility
- Installation instructions
- Rinkhals will not remove any feature from Anycubic, just add more
- The only difference is the camera not being available in Anycubic apps by default. This can be changed, check the FAQ
- After installation; Orca, OctoApp, Mainsail and more will work directly without any special configuration (except adding the printer IP of course)
TLDR: - SSH on port 22 (root: rockchip except for K3M) - Mainsail on port 80 and 4409 - Fluidd on port 4408
Features and built-in apps¶
ADB (Android Debug Bridge)¶
ADB is a protocol and client / server programs to help remote accessing and debugging Android devices. Nowadays it is used as a remote access protocol on many other devices.
ADB is bundled but disabled in most Anycubic Kobra firmwares (except for the KS1). Rinkhals re-enables ADB on startup. ADB listens on port 5555 by default.
To connect, you'll need to install the ADB client usually available in Android SDK platform tools: https://developer.android.com/tools/adb
Then, to connect and access a shell:
SSH¶
OpenSSH is bundled but disbaled in most Anycubic Kobra firmwares (except for the KS1). Rinkhals bundles Dropbear, a lightweight SSH server alternative to OpenSSH.
During Rinkhals startup, Dropbear is started and listens on port 22. Default root credentials are used for password authentication exclusively.
On the K2P, K3, K3V2 and KS1, the root password is rockchip
On the K3M, the root password is not yet known.
Default apps¶
System apps are normal Rinkhals apps that are bundled in every Rinkhals release. They can still be enabled or disabled depending on your preference, and they can be overriden by adding a user app with the same name.
Moonraker¶
Moonraker is an API gateway for Klipper. It exposes Klipper information and interactions to 3rd party clients using web API and websockets.
Rinkhals is using vanilla Moonraker plus a special Kobra component. This component is used to modify vanilla Moonraker behavior and adapt it to GoKlipper.
When using GoKlipper and LAN mode, this component will intercept Print calls from Mainsail, Fluid, Orca and more and replace it with a proprietary Anycubic call. This call allows a few settings to be changed, such as Bed leveling on print start, flow calibration and resonance testing. By default, those settings are all disabled for every print. This behavior can be changed using app configuration.
Warning
This app consumes a lot of memory. Be careful while using multiple frontends (Mainsail, Fluidd, ...) at the same time.
| 40-moonraker | |
|---|---|
| App manifest | app.json |
| Default state | Enabled |
| Port | 7125 |
| CPU usage | 10% ~ 20% |
| Memory usage | 25MB ~ 100+MB |
Mainsail¶
Mainsail is a web interface for Klipper-based printers. It connects to Moonraker over web API and websocket to expose live control and metrics.
It's a SPA (Single Page Application) served using Lighttpd web server. Replication on port 80 is done using socat to keep memory consumption as low as possible.
Lighttpd is also configured to expose up to 4 cameras proxying to mjpg-streamer. Cameras are accessible using /webcam or /webcam0 for the first one, then /webcam1, /webcam2 and /webcam3 for the other.
Note
Port 80 is dynamically allocated depending on the order of app startup. By default during their startup, Mainsail and Fluidd will try to use port 80. This is made to ensure that you can expose multiple frontends while choosing which one is using port 80.
Tip
It is possible to expose another interface on port 80. Make sure that your custom app open and listens to port 80 before Mainsail and/or Fluidd by using a name prefix with a number below 25.
| 25-mainsail | |
|---|---|
| App manifest | app.json |
| Default state | Enabled |
| Port | 4409, 80* |
| CPU usage | 0 ~ 3 % |
| Memory usage | 1 ~ 4 MB |
Fluidd¶
Fluidd is another web interface for Klipper-based printers. It connects to Moonraker over web API and websocket to expose live control and metrics.
Please refer to Mainsail documentation above as the behavior is exactly the same.
| 26-fluidd | |
|---|---|
| App manifest | app.json |
| Default state | Enabled |
| Port | 4409, 80* |
| CPU usage | 0 ~ 3 % |
| Memory usage | 1 ~ 4 MB |
mjpg-streamer¶
mjpg-streamer is a lightweight web server to expose a camera stream over HTTP. In Rinkhals, it is used to expose the connected cameras in Mainsail, Fluidd and other Moonraker clients.
When starting, this app will scan for connected cameras and start one process for each of them. The first process will listen to port 8080, the next 8081 and so on.
By default, a low compatible resolution of 640x480 is used. Resolution can be changed using app configuration.
| 30-mjpg-streamer | |
|---|---|
| App manifest | app.json |
| Default state | Enabled |
| Port | 8080, 8081, 8082, 8083* |
| CPU usage | ? |
| Memory usage | ? |
VNC / Remote display¶
This app starts a VNC server on the printer to expose remote control of the display and its touch inputs.
When enabled and started, you can connect your VNC client to port 5900 or access a web version on port 5800.
| 50-remote-display | |
|---|---|
| App manifest | app.json |
| Default state | Disabled |
| Port | 5800, 5900 |
| CPU usage | 1% when idle, 15 ~ 25 % with active connections |
| Memory usage | ? |
Rinkhals monitor¶
This app allows to collect system metrics and expose them in a MQTT server. The data is preformatted to be discovered and used with Home Assistant but might be used by anything reading MQTT messages.
When enabled and started and if using LAN mode, this app will send metrics to the internal printer Mochi server. This server is available on port 9883 and you will need credentials to connect to it. Username and password can be found in /userdata/app/gk/config/device_account.json
Metrics are be collected and sent every 30s. High level system metrics are also written to the app log in /useremain/rinkhals/.current/logs/app-monitor.log
| rinkhals-monitor | |
|---|---|
| App manifest | app.json |
| Default state | Disabled |
| CPU usage | 0 ~ ? |
| Memory usage | 6 MB |