This software is part of SLS4All project. For more information please visit https://sls4all.com.
SLS4All Compact source code and binaries are available under the terms of the License Agreement as described in the LICENSE.txt file located in the root directory of the repository or visit https://sls4all.com/terms-of-use/.
You can use, copy, modify, and convey the software for non-commercial purposes only. You can share modified versions of the software as long as you retain original notices, license and provide access to the modified source.
We are not responsible for any damages, injuries, etc. caused in connection with the software. By exercising any right granted under the License, you irrevocably accept all its terms and conditions.
SLS4All NuGet packages for parts that have not yet been open-sourced are published on GitHub package source. These NuGet packages are referenced from the projects present in this repository. Path to NuGet package source is https://nuget.pkg.github.com/sls4all/index.json. This source should already be configured in nuget.config in the root of this repository. Please note that GitHub currently requires a registered GitHub account and associated token to download NuGet packages, even if the packages are marked public.
GitHub package source has a limitation that it requires authentification even for public packages like ours. You will need a registered GitHub account, generate a personal access token (PAT) with at least a read:packages permission and use your e-mail and the generated token as a password to pull the packages and build the project.
Full GitHub NuGet packages documentation.
All sources in this repository are compilable using .NET 9.0 SDK. We recommend free Visual Studio Community for development. Suggested minumum workloads when installing Visual Studio are: .NET desktop development, ASP.NET and web development, Node.js development.
Since the host SLS4All Compact software is intended to be run on embedded computer, like Raspberry Pi 5,
the following code will clone the repository and build the software for linux-arm64 platform (you can build it on any OS supporting .NET SDK, including Windows and non ARM Linux).
64-bit OS with at least 4GB RAM for running the compiled software is very strongly recommended. That means you should use 64-bit variant of Raspberry Pi OS (formerly Raspbian)
if you will be running it on Raspberry Pi.
You will also need latest NPM that is internally required to build the web parts of the software.
git clone https://github.com/sls4all/SLS4All.Compact.git
cd SLS4All.Compact/SLS4All.Compact.PrinterApp
dotnet build -c Release
dotnet publish -c Release -r linux-arm64 --self-contained
cd bin/Release/net9.0/linux-arm64/publish
# contents of current directory should be copied
# to the embedded (or development) computer, properly configured and
# started using helper script, but at minimum by for example:
# ./SLS4All.Compact.PrinterApp --environment Development
#
# You should then open browser (preferably Chromium) to the computer
# where the software is running. Typical address is either
# http://localhost:5000 or just http://localhost
# depending on configuration. Please replace `localhost` with
# any other address the computer with the software has.
PrinterApp configuration is present in appsettings*.toml files that are published to the same directory as the main executable SLS4All.Compact.PrinterApp. In sources that corresponds to /SLS4All.Compact.PrinterApp/appsettings*.toml configuration files.
The main configuration file is taken from the running environment (--environment command line parameter). For development environment (--environment Development) without the HW, the main configuration file the appsettings.Development.toml and user override configuration file appsettings.Development.user.toml. For the Inova MK1 Printer Kit, the main configuration file is the appsettings.Inova-RaspberryPi5.toml (--environment Inova-RaspberryPi5).
For more complete startup script for the Inova MK1 Printer Kit, please see the sls4all_run_Inova_RaspberryPI5.sh bash script, that we use to start the software on the kits. This script also allows SLS4All Compact software update, data backup & restore, splash screen, system permissions, and opens the browser. As the name suggests, it is intended to be used on Raspberry PI 5 with Raspberry Pi OS and installed dependencies specified below.
Additional configuration and its overrides can be placed to ~/SLS4All/Configuration/appsettings.user.toml file. If this directory also contains files that would be normally loaded from the directory with the application binary, these files are loaded instead. E.g. if you create ~/SLS4All/Configuration/appsettings.toml, this file would be loaded instead of the default file.
Configuration files can reference and load other configuration files, using [Application.Dependencies] configuration dictionary. Please see the *Inova*.toml configuration files for an example of usage.
There are some dependencies for full functionality of the compiled software and bundled scripts running on the embedded PC.
If the embedded PC is Raspberry PI 5 with Raspberry PI OS, these can be installed using:
sudo apt-get update
sudo apt-get install -y \
xinput \
stm32flash \
avrdude \
libffi-dev \
libusb-dev \
libusb-1.0 \
pqiv \
wmctrl \
xdotool
For running the software during development no other hardware components are neccessary. Fake (testing) implementations are available for most of the interfaces. However for actual printing it is expected to connect the SLS4All Compact software with other SW and HW components running Klipper MCU Firmware.
Typical setup is that SLS4All Compact software runs on Raspberry Pi embedded computer, with it there also runs a Klipper MCU Linux host process (SLS4All Compact will start it itself if configured) and also there would be one or two additional HW boards (Bigtreetech SKR and Arduino board) for controlling the other HW parts. All these additional HW and SW components are expected to run Klipper MCU Firmware and be connected to the embedded computer (preferably via USB).
We have made modifications to Klipper sources and these are made available separately on our GitHub. Please note that some of our modifications are HW specific. We currently support Klipper firmware running on HW metioned above, i.e. Linux Host, Bigtreetech SKR v1.4 TURBO, and Arduino Nano.
Please also note that SLS4All Compact does not utilize Klipper Python implementation, only the Klipper MCU Firmware. In Klipper sources that corresponds to src subdirectory (i.e. we do not utilize contents of klippy directory).
We would like to thank Kevin O'Connor and all other Klipper authors and maintainers.
MCUs run modified Klipper firmware, licensed under GNU General Public License v3.0
PrinterApp uses Markdig Nuget for Markdown processing, licensed under BSD-2-Clause license