Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
**/__pycache__/**
build/**
dist/**
.vscode/settings.json
docs/_p2pp/.cache/
site/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Getting strarted

Have a look at the [P2PP Wiki pages](https://github.com/tomvandeneede/p2pp/wiki/Home) to get youstarted.
Have a look at the [P2PP Docs](https://vhspace.github.io/p2pp/) to get youstarted.


## Acknowledgements
Expand Down
17 changes: 17 additions & 0 deletions docs/_p2pp/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
:root {
--md-admonition-icon--exclamation-circle: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M256 512a256 256 0 1 1 0-512 256 256 0 1 1 0 512m0-192a32 32 0 1 0 0 64 32 32 0 1 0 0-64m0-192c-18.2 0-32.7 15.5-31.4 33.7l7.4 104c.9 12.6 11.4 22.3 23.9 22.3 12.6 0 23-9.7 23.9-22.3l7.4-104c1.3-18.2-13.1-33.7-31.4-33.7z"/></svg>')
}
.md-typeset .admonition.important,
.md-typeset details.important {
border-color: rgb(155, 43, 43);
}
.md-typeset .important > .admonition-title,
.md-typeset .important > summary {
background-color: rgba(155, 43, 43, 0.1);
}
.md-typeset .important > .admonition-title::before,
.md-typeset .important > summary::before {
background-color: rgb(155, 43, 43);
-webkit-mask-image: var(--md-admonition-icon--exclamation-circle);
mask-image: var(--md-admonition-icon--exclamation-circle);
}
10 changes: 10 additions & 0 deletions docs/_p2pp/javascripts/katex.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
document$.subscribe(({ body }) => {
renderMathInElement(body, {
delimiters: [
{ left: "$$", right: "$$", display: true },
{ left: "$", right: "$", display: false },
{ left: "\\(", right: "\\)", display: false },
{ left: "\\[", right: "\\]", display: true }
],
})
})
6 changes: 6 additions & 0 deletions docs/_p2pp/mkdocs-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Python virtualenv module requirements for mkdocs
mkdocs>=1.6.1
mkdocs-material>=9.7.1
click==8.2.1
mkdocs-git-committers-plugin-2>=1.6.1
mkdocs-git-authors-plugin>=1.0.4
82 changes: 82 additions & 0 deletions docs/_p2pp/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
site_name: P2PP Documentation
repo_url: https://github.com/vhspace/p2pp
repo_name: vhspace/p2pp
edit_uri: blob/master/docs/
use_directory_urls: False
docs_dir: '../'
site_dir: '../../site/'

markdown_extensions:
- tables
- attr_list
- admonition
- pymdownx.details
- pymdownx.superfences
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.arithmatex:
generic: true

plugins:
- git-committers:
repository: vhspace/p2pp
branch: master
- git-authors

extra_javascript:
- _p2pp/javascripts/katex.js
- https://unpkg.com/katex@0/dist/katex.min.js
- https://unpkg.com/katex@0/dist/contrib/auto-render.min.js


extra_css:
- _p2pp/css/extra.css
- https://unpkg.com/katex@0/dist/katex.min.css

theme:
name: material
logo: images/p2pp_logo.png
favicon: images/p2pp_logo.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.footer
- content.code.copy
- content.action.edit
- content.action.view

nav:
- Home: index.md
- Getting Started: getting_started.md
- User Guide:
- PrusaSlicer Configuration: prusa_config.md
- P2PP Configuration: p2pp_config.md
- P2PP Parameter Overview: p2pp_param_overview.md
- Blobster Setup: blobster.md
- First Print Calibration: first_print_calibration.md
- Process Flow: process_flow.md
- Purge Length Calculation: purge_length_calc.md
- Reference Configurations: ref_configs.md
- Troubleshooting: troubleshooting.md
- Developer Guide:
- Code Overview: code_overview.md
- Building P2PP: building_p2pp.md
- Contributing: contributing.md
- FAQ: faq.md
96 changes: 96 additions & 0 deletions docs/blobster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Blobster Setup


## Purpose


BLOBSTER is a (currently only) Prusa MK3S printer extension that allows for eficient extruder purging through a side-purge mechanism attached to the right X-rod holder of the printer. BLOBSTER is being developped by Evzen Mayer as an open source project. More information on this device and how to make one can be found [here](https://github.com/blobster-io/blobster).


## What setup is required


BLOBSTER has 2 modes that can be used under P2PP - Standard mode and Advanved mode. Both will be explained in the next sections.


### Standard Mode


In standard mode BLOBSTER will take the following configuration parameters (values indicated are the default values pre-programmed in P2PP):

;P2PP BLOBSTER_ENABLE
;P2PP BLOBSTER_PURGEPOSITION=254
;P2PP BLOBSTER_BLOBSIZE=180
;P2PP BLOBSTER_ENGAGETIME=1000
;P2PP BLOBSTER_BLOBSPEED=200
;P2PP BLOBSTER_COOLINGTIME=60
;P2PP BLOBSTER_PRIME_BLOBS=0
;P2PP BLOBSTER_CLEARANCE_MM=30
;P2PP BLOBSTER_RETRACT=3


### Advanced Mode


In advanced mode BLOBSTER will take the following configuration parameters (values indicated are the default values pre-programmed in P2PP). There are NO default values for the ADVANCED_LENGTH, ADVANCED_FAN and ADVANCED_SPEED parameters.


;P2PP BLOBSTER_ENABLE
;P2PP BLOBSTER_ADVANCED
;P2PP BLOBSTER_PURGEPOSITION=254
;P2PP BLOBSTER_COOLINGTIME=60
;P2PP BLOBSTER_PRIME_BLOBS=0
;P2PP BLOBSTER_CLEARANCE_MM=30
;P2PP BLOBSTER_ENGAGETIME=1000
;P2PP BLOBSTER_RETRACT=3
;P2PP BLOBSTER_ADVANCED_LENGTH=100,100,8
;P2PP BLOBSTER_ADVANCED_SPEED=300,200,100
;P2PP BLOBSTER_ADVANCED_FAN=0,20,80


## Command explaination


- `BLOBSTER_ENABLE`
This ocmmand instructs P2PP to generate code for usage with the BLOBSTER hardware. Please note that for P2PP BLOBSTER is considered a side-purge mechanism so you will have to move the tower off the bed as a secondary trigger to use BLOBSTER.

- `BLOBSTER_ADVANCED` (Advanced mode only)
Triggers the use of the ADVANCED features of BLOBSTER config in P2PP. Note that you will have to supply the ADVANCED_LENGTH, ADVANCED_FAN and ADVANCED_SPEED parameters in order to use this feature

- `BLOBSTER_ADVANCED_LENGTH` (Advanced mode only)
BLOBSTER_ADVANCED_LENGTH is a list of lengths in mm. The sum of all these values defines the size of ONE blob. For each element in the list, there needs to be a corresponding element in the BLOBSTER_ADVANCED_SPEED and BLOBSTER_ADVANCED_FAN list that defines the fan speed and purge speed of that section. Purpose of these settings is to get better control over the BLOB formation, specially with larger blobs All values must be WHOLE numbers separated by a comma

- `BLOBSTER_ADVANCED_SPEED` (Advanced mode only)
BLOBSTER_ADVANCED_SPEED defines the speed in mm/min at which the specific segment of the blob will be printed. The number of elements in this list needs to match the number of elements in the BLOBSTER_ADVANCED_LENGTH list.
All values must WHOLE numbers separated by a comma

- `BLOBSTER_ADVANCED_FAN` (Advanced mode only)
BLOBSTER_ADVANCED_FAN defines the fan speed in % for a specific section of the blob. It allows for tweaking the cooling applied already during the generation of the blob. The number of elements in this list needs to match the number of elements in the BLOBSTER_ADVANCED_LENGTH list.
All values must WHOLE numbers in range of [0-100] separated by a comma

- `BLOBSTER_PURGEPOSITION`
Sets the X-coordinate of the purge position. Before producing a blob, the printer will move the head into that position before starting to purge

- `BLOBSTER_COOLINGTIME`
Defines the cooling time after the blob is generated with the fan blowing at full speed of ver blob. This will allow the blob to solidify and be pushed off afterwards.

- `BLOBSTER_CLEARANCE_MM`
When printing lower layers, BLOBSTER will sit underneath the bed. In order to engage, the hardware must move in place over the bed to the print head will need to raise a few mm to make room for BLOBSTER. This amount can be altered by using the BLOBSTER_CLEARANCE_MM command. The default of 30mm should just be fine, but you may beed to change in case you make changes to the BLOBSTER hardware yourself

- `BLOBSTER_ENGAGETIME`
BLOBSTER uses servo motors to put the arm in place. Therefor it takes a short while for the arm to engage after the print head moves into the purging position. This parameter defines the number of miliseconds the printer waits to start purging after the head has been moved into it's purging position.

- `BLOBSTER_RETRACT`
Defines the amount of retract implemented during the moved between the purging position and the print. You can play with this variable if you encounter stringing.

- `BLOBSTER_BLOBSIZE` (Standard mode only)
Defines the amount of filament deposited in one BLOB. The amount is specified in mm

- `BLOBSTER_BLOBSPEED` (Standard mode only)
Defines the speed in mm/min at which the blob will be printed. The amount is specified in mm/min

- `BLOBSTER_PRIME_BLOBS`
Since the rower needs to be put besides the print bed in BLOBSTER mode, there is no option to use a skirt because that would partially print off the bed. When getting a short splice warning, you can then add one or more PRIME_BLOBS. These are blobs generated right before the actual print starts so the first splice will become longer.


# Good luck & happy printing !!!
12 changes: 12 additions & 0 deletions docs/building_p2pp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Building P2PP


(TODO: Add more detailed explanation on creating installers)


To test your modifications contributed to P2PP, use the following command in your terminal:

python setup.py build

Your application will be situated inside the `/build` folder of the project.
Note the file path to use it inside PrusaSlicer as a Post Processing script.
120 changes: 120 additions & 0 deletions docs/code_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Code Overview


## [p2ppparams.py](https://github.com/vhspace/p2pp/blob/master/p2pp/p2ppparams.py)


Here will all the P2PP parameters be checked and mapped to their corresponding variables. These variables can be used throughout the project.


## [psconfig.py](https://github.com/vhspace/p2pp/blob/master/p2pp/psconfig.py)


All the settings and parameters from PrusaSlicer are being stripped from the generated gcode.


## [gcode.py](https://github.com/vhspace/p2pp/blob/master/p2pp/gcode.py)


All gcode commands are getting stripped from the gcode file and categorised by type. The gcode also gets manipulated using the functions provided in the file.


## [mcf.py](https://github.com/vhspace/p2pp/blob/master/p2pp/mcf.py)


Contains the main logic for processing the gcode. (It links all the features here)


## [omega.py](https://github.com/vhspace/p2pp/blob/master/p2pp/omega.py)


Generate the Omega; Header that drives the Palette to p2pp_process_file filament.
All the splice lengths and splice algorithms are inserted into this file.


## [pings.py](https://github.com/vhspace/p2pp/blob/master/p2pp/pings.py)


Contains the logic for inserting pings.


## [p3_upload.py](https://github.com/vhspace/p2pp/blob/master/p2pp/p3_upload.py)


Code for uploading to the P3 (Pro).


## [side_wipe.py](https://github.com/vhspace/p2pp/blob/master/p2pp/sidewipe.py)


Contains side wipe logic.


## [purgetower.py](https://github.com/vhspace/p2pp/blob/master/p2pp/purgetower.py)


Contains purge tower logic.


## [manualswap.py](https://github.com/vhspace/p2pp/blob/master/p2pp/manualswap.py)


Contains manual swap logic.


## [checkversion.py](https://github.com/vhspace/p2pp/blob/master/p2pp/checkversion.py)


Contains check version logic.


## [variables.py](https://github.com/vhspace/p2pp/blob/master/p2pp/variables.py)


Contains all the variables with their default values.


## [gui.py](https://github.com/vhspace/p2pp/blob/master/p2pp/gui.py)

Contains gui logic.

## [formatnumbers.py](https://github.com/vhspace/p2pp/blob/master/p2pp/formatnumbers.py)


Helper for formatting numbers.


## [colornames.py](https://github.com/vhspace/p2pp/blob/master/p2pp/colornames.py)


Helper for determining the name of colors.


## [P2PP.py](https://github.com/vhspace/p2pp/blob/master/P2PP.py)


Main application code. (This does not contain any post processor logic)


## [setup.py](https://github.com/vhspace/p2pp/blob/master/setup.py)


Used to build the application.


## [genpreview.py](https://github.com/vhspace/p2pp/blob/master/p2pp/genpreview.py)


Developer tool to visualize the preview. (Not yet tested)


## [bedprojection.py](https://github.com/vhspace/p2pp/blob/master/p2pp/bedprojection.py)


Developer tool to visualize the printbed area. (Not yet tested)


## [tower.py](https://github.com/vhspace/p2pp/blob/master/tower/tower.py)


Developer tool to test purge tower generation algorithms. (Not yet tested)
7 changes: 7 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing


TODO


When you've implemented a new feature, please document it in our docs. It wil help to maintain the project and help others to use your implemented feature.
4 changes: 4 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Frequently Asked Questions (FAQ)


TODO
Loading