Alpha version, with limited functionality and for development only.
Please don't use it in production and be careful while using it!
Following sections are mandatory in printer.cfg (of Klipper):
[virtual_sdcard]
path: <path to existing dir>
[display_status]
[pause_resume]
Following sections are mandatory in Moonraker's config file:
[history]
Create plugin's config.ini with following content:
# uncomment what you need to customize
[thespaghettidetective]
# -- by default plugin connects to TSD Cloud
# url = https://app.thespaghettidetective.com
# auth_token = <filled in by link command, see installation section>
# -- (TSD cloud) error reporting is disabled by default
# -- Uncomment next line to help team detecting bugs sooner
# sentry_opt = in
# -- TSD upload directory, relative to klipper's virtual sdcard
# upload_dir = thespaghettidetective
[moonraker]
# url = http://127.0.0.1:7125
# api_key = <grab it from moonraker, visit /access/api_key from trusted host>
[webcam]
# stream_url = http://127.0.0.1:8080/?action=stream
# -- set snapshot_url if you want to use the snapshot action
# snapshot_url = http://127.0.0.1:8080/?action=snapshot #
# -- whether to flip the webcam horizontally/vertically
# flip_h = false
# flip_v = false
# -- whether to rotate the webcam 90° counter clockwise
# rotate_90 = false
# -- set when aspect ratio is 16:9 (instead of 4:3)
# aspect_ratio_169 = false
You can grab Moonraker api key from /access/api_key.
If TSD plugin connects from a trusted host, you can skip this.
# clone repo
cd ~
git clone https://github.com/TheSpaghettiDetective/tsd-moonraker.git
# when the process is done, run the install script:
cd tsd-moonraker
./scripts/install.sh
# fill in essential configuration
nano ~/klipper_config/config.ini
# link printer (grab tsd auth token)
source ~/tsd-moonraker-env/bin/activate
python3 -m tsd_moonraker.link -c ~/klipper_config/config.ini
# start service
sudo systemctl start tsd-moonraker
Add an entry for Moonraker's update manager:
[update_manager tsd-moonraker]
type: git_repo
path: ~/tsd-moonraker
origin: https://github.com/TheSpaghettiDetective/tsd-moonraker.git
primary_branch: main
env: ~/tsd-moonraker-env/bin/python3
requirements: requirements.txt
install_script: scripts/install.sh
is_system_service: True
# requires python3; install python3 packages
sudo apt-get install python3 python3-pip python3-venv
# clone repo
git clone https://github.com/TheSpaghettiDetective/tsd-moonraker.git
# setup virtual environment
python3 -m venv tsd-moonraker/
cd tsd-moonraker
source ./bin/activate
pip3 install -r requirements.txt
# fill in essential configuration
cp config.sample.ini config.ini
nano config.ini
# link printer (grab tsd auth token)
python3 -m tsd_moonraker.link -c config.ini
# start app
python3 -m tsd_moonraker.app -c config.ini -l tsd_moonraker.log