From 82bead899660162c7e6b633a2a079e3495153517 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Mon, 20 Nov 2023 02:08:21 -0500 Subject: [PATCH 1/2] Adjust readme: directory structure section. --- .vscode/settings.json | 1 + README.md | 40 ++++++++++------------------------------ 2 files changed, 11 insertions(+), 30 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 9bef908..226a9c2 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -23,6 +23,7 @@ "moonraker", "normalsize", "octahedroflake", + "osskc", "PARKBED", "PARKCENTER", "PARKFRONT", diff --git a/README.md b/README.md index bc407c7..154e25e 100644 --- a/README.md +++ b/README.md @@ -218,43 +218,23 @@ This repository contains many files and folders. Some are _necessary_ for this K - **Necessary** items are marked with a ✅. - Items that can _optionally_ be deleted are marked with a ❌. + -``` -├── cfgs ✅ -│ ├── adxl-direct.cfg -│ ├── adxl-rp2040.cfg -│ ├── adxl-rpi-pico-2x.cfg -│ ├── MECHANICAL_GANTRY_CALIBRATION.cfg -│ ├── misc-macros.cfg -│ ├── PARKING.cfg -│ └── TEST_SPEED.cfg +```sh +├── cfgs/ ✅ ├── CODE_OF_CONDUCT.md ❌ ├── CONTRIBUTING.md ❌ -├── .github ❌ -│ ├── FUNDING.yml -│ └── ISSUE_TEMPLATE -│ ├── bug_report.md -│ └── feature_request.md +├── .github/ ❌ ├── .gitignore ❌ -├── images ❌ -│ ├── cup-border.png -│ ├── githubstar.gif -│ ├── heart.gif -│ ├── logo_white_stroke.png -│ └── party_blob.gif -├── misc ❌ -│ ├── klipper-v0.11.0-148-g52f4e20c.bin -│ ├── M503-output.yml -│ ├── marlin-SV06V2.0.0A_2.24.bin -│ ├── SuperSlicer_config_bundle.ini -│ ├── sv06-buildPlate.png -│ ├── SV06-buildPlate.stl -│ └── SV06-texture.svg +├── images/ ❌ +├── LICENSE ❌ +├── misc/ ❌ ├── moonraker.conf ✅ +├── osskc.cfg ✅ ├── printer.cfg ✅ ├── README.md ❌ -└── .vscode ❌ - └── settings.json +├── SECURITY.md ❌ +└── .vscode/ ❌ ``` ## FAQ From ed1a6584196b8c6796c2b94367e2e70133111fd1 Mon Sep 17 00:00:00 2001 From: Bassam Husain Date: Mon, 20 Nov 2023 02:30:26 -0500 Subject: [PATCH 2/2] Adjust readme. --- README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 154e25e..3c1e0ef 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,11 @@ I am creating these files for my personal use and cannot be held responsible for - 💥 This Klipper configuration is an _endpoint_, meaning that it contains **everything** that you could possibly need in order to have an excellent Klipper experience! 💥 - Filament runout sensor usage implemented. -- Minimum configuration settings for Mainsail/Fluiddpi to work. -- A SuperSlicer config bundle that contains the printer configurations for the SV06/Plus, as well as what are considered by many to be the best print settings available for any FDM printer ([Ellis' SuperSlicer Profiles](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles)). -- `NEW` dancing blob A PrusaSlicer config bundle based on Ellis' SuperSlicer Profiles. +- Minimum configuration settings for Mainsail/Fluidd. +- Pre-configured configuration bundles based on the [Ellis SuperSlicer Print Profiles](https://github.com/AndrewEllis93/Ellis-SuperSlicer-Profiles) + - SuperSlicer + - PrusaSlicer + - Printer profiles: SV06; SV06 Plus - Bed model and texture to use in SuperSlicer/PrusaSlicer. - Macros - **Improved** mechanical gantry calibration/`G34` macro that provides the user audio feedback, and time to check the calibration. @@ -45,8 +47,8 @@ I am creating these files for my personal use and cannot be held responsible for - Parking macros (parks the printhead at various locations): `PARKFRONT`, `PARKFRONTLOW`, `PARKREAR`, `PARKCENTER`, `PARKBED`. - Load/unload filament macros. - `PURGE_LINE` macro. - - `NEW` dancing blob `TEST_SPEED` macro. Find instructions [here](#how-do-i-use-the-test_speed-macro). -- `NEW` dancing blob Klipper Adaptive Meshing & Purging (KAMP) added (disabled by default)! Read about it [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging). + - `TEST_SPEED` macro. Find instructions [here](#how-do-i-use-the-test_speed-macro). +- Klipper Adaptive Meshing & Purging (KAMP) integrated. Read about it [here](#how-do-i-enable-kamp-klipper-adaptive-meshing--purging). ## Stay Up-to-Date @@ -260,12 +262,12 @@ The printer will beep upon: Make the following changes according to your needs. All beeping will be disabled _except_ during gantry calibration. -| File | `cfgs/misc-macros.cfg` | -| --------------- | -------------------------- | -| Section | `[gcode_macro _globals]` | -| Variable | `variable_beeping_enabled` | -| Disable beeping | `0` | -| Enable beeping | `1` | +| File | `cfgs/misc-macros.cfg` | +| -------- | -------------------------- | +| Section | `[gcode_macro _globals]` | +| Variable | `variable_beeping_enabled` | +| Disable | `0` | +| Enable | `1` (default) | ##### I want to use a filament sensor. How do I set it up? @@ -275,12 +277,12 @@ You can find information about the physical setup [here](https://github.com/bass Make the following changes according to your needs. -| File | `cfgs/misc-macros.cfg` | -| -------------- | ---------------------------------- | -| Section | `[gcode_macro _globals]` | -| Variable | `variable_filament_sensor_enabled` | -| Disable sensor | `0` | -| Enable sensor | `1` | +| File | `cfgs/misc-macros.cfg` | +| -------- | ---------------------------------- | +| Section | `[gcode_macro _globals]` | +| Variable | `variable_filament_sensor_enabled` | +| Disable | `0` (default) | +| Enable | `1` | ##### My filament runout sensor works, but I just started a print without any filament loaded. What gives? @@ -316,7 +318,7 @@ The printhead is now parked front center waiting for you to insert filament. You ##### How do I enable KAMP (Klipper Adaptive Meshing & Purging)? -Although this repo contains all the code from the KAMP repository, only the `mesh` functionality of KAMP has been configured and tested. +Although this repo contains all the code from the KAMP repository, only the `mesh` functionality of KAMP has been configured and tested. To enable other functionality, adjust `/cfgs/kamp/KAMP_Settings.cfg`. The [Label objects setting](https://docs.mainsail.xyz/overview/features/exclude-objects#enable-the-label-objects-setting-in-your-slicer) in your slicer must be enabled for KAMP to work. @@ -330,7 +332,7 @@ Adjust according to your needs. | -------- | ------------------------ | | Section | `[gcode_macro _globals]` | | Variable | `variable_kamp_enable` | -| Disable | `0` | +| Disable | `0` (default) | | Enable | `1` | ##### How do I use the `TEST_SPEED` macro?