diff --git a/.github/workflows/publish_docs_to_wiki.yml b/.github/workflows/publish_docs_to_wiki.yml new file mode 100644 index 0000000000..4cf0865e95 --- /dev/null +++ b/.github/workflows/publish_docs_to_wiki.yml @@ -0,0 +1,39 @@ +name: Publish docs to Wiki + +# Trigger this action only if there are changes pushed to the doc/** directory under the main branch +on: + push: + paths: + - doc/** # This includes all sub folders + branches: + - PublishDocsToWiki # This can be changed to any branch of your preference + +env: + USER_TOKEN: ${{ secrets.GH_WIKI_PAT }} # This is the repository secret personal access token + USER_NAME: ${{ vars.BOT_USER_NAME }} # Enter the username of your (bot) account + OWNER: ${{ github.event.repository.owner.name }} # This is the repository owner + REPOSITORY_NAME: ${{ github.event.repository.name }} # This is the repository name + +jobs: + publish_docs_to_wiki: + name: Publish docs to Wiki + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # 1. Clone the current wiki master branch to a folder named `tmp_wiki` + - name: Pull content from wiki + run: | + git config --global user.name "$USER_NAME" + git config --global user.email "$USER_NAME"@users.noreply.github.com + git clone https://"$USER_TOKEN"@github.com/"$OWNER"/"$REPOSITORY_NAME".wiki.git tmp_wiki + # 4. Synchronize differences between `doc` & `tmp_wiki` + # 5. Push new Wiki content + - name: Push main repo content to wiki + run: | + rsync -av --delete doc/ tmp_wiki/ --exclude .git + cd tmp_wiki + git add . + git commit -m "Updated Wiki content" + git push origin master diff --git a/doc/Calibration.md b/doc/Calibration.md new file mode 100644 index 0000000000..00ddcbe60b --- /dev/null +++ b/doc/Calibration.md @@ -0,0 +1,73 @@ +- [Flow rate](#Flow-rate) +- [Pressure Advance](#Pressure-Advance) + 1. [Line method](#Line-method) + 2. [Tower method](#Tower-method) +- [Temp tower](#Temp-tower) +- [Advanced calibration] + 1. [Max Volumetric speed] + 2. [VFA] + +**NOTE**: After completing the calibration process, remember to create a new project in order to exit the calibration mode. +# Flow rate +![flowrate](https://user-images.githubusercontent.com/103989404/210137579-3fd141ad-f2da-4542-a1fd-fc4b4d673908.gif) +Calibrating the flow rate involves a two-step process. +Steps +1. Select the printer, filament, and process you would like to use for the test. +2. Select `Pass 1` in the `Calibration` menu +3. A new project consisting of nine blocks will be created, each with a different flow rate modifier. Slice and print the project. +4. Examine the blocks and determine which one has the smoothest top surface. +![flowrate-pass1_resize](https://user-images.githubusercontent.com/103989404/210138585-98821729-b19e-4452-a08d-697f147d36f0.jpg) +![0-5](https://user-images.githubusercontent.com/103989404/210138714-63daae9c-6778-453a-afa9-9a976d61bfd5.jpg) + +5. Update the flow ratio in the filament settings using the following equation: `FlowRatio_old*(100 + modifier)/100`. If your previous flow ratio was `0.98` and you selected the block with a flow rate modifier of `+5`, the new value should be calculated as follows: `0.98x(100+5)/100 = 1.029`. ** Remember** to save the filament profile. +6. Perform the `Pass 2` calibration. This process is similar to `Pass 1`, but a new project with ten blocks will be generated. The flow rate modifiers for this project will range from `-9 to 0`. +7. Repeat steps 4 and 5. In this case, if your previous flow ratio was 1.029 and you selected the block with a flow rate modifier of -6, the new value should be calculated as follows: `1.029x(100-6)/100 = 0.96726`. ** Remember ** to save the filament profile. +![pass2](https://user-images.githubusercontent.com/103989404/210139072-f2fa91a6-4e3b-4d2a-81f2-c50155e1ff6d.jpg) +![-6](https://user-images.githubusercontent.com/103989404/210139131-ee224146-b242-4c1c-ac96-35ef0ca591f1.jpg) +![image](https://user-images.githubusercontent.com/103989404/210139721-919be130-fbba-4e3a-aa58-8a563e8c7792.png) + +### NOTE: +* For Bambulab X1/X1C users, make sure you do not select the 'Flow calibration' option.* +![uncheck](https://user-images.githubusercontent.com/103989404/221345187-3c317a46-4d85-4221-99b9-adb5c7f48026.jpeg) + +# Pressure Advance +I will present two approaches for calibrating the pressure advance value. Both methods have their own advantages and disadvantages. It is important to note that each method has two versions: one for a direct drive extruder and one for a Bowden extruder. Make sure to select the appropriate version for your test. + +### Line method +The line method is quick and straightforward to test. However, its accuracy highly depends on your first layer quality. It is suggested to turn on the bed mesh leveling for this test. +Steps: + 1. Select the printer, filament, and process you would like to use for the test. + 2. Print the project and check the result. You can select the value of the most even line and update your PA value in the filament settings. + 3. In this test, a PA value of `0.016` appears to be optimal. +![pa_line](https://user-images.githubusercontent.com/103989404/210139630-8fd189e7-aa6e-4d03-90ab-84ab0e781f81.gif) + +Screenshot 2022-12-31 at 12 11 10 PM + +![line_0 016](https://user-images.githubusercontent.com/103989404/210140046-dc5adf6a-42e8-48cd-950c-5e81558da967.jpg) +![image](https://user-images.githubusercontent.com/103989404/210140079-61a4aba4-ae01-4988-9f8e-2a45a90cdb7d.png) + +### Tower method +The tower method may take a bit more time to complete, but it does not rely on the quality of the first layer. +The PA value for this test will be increased by 0.002 for every 1 mm increase in height. (**NOTE** 0.02 for Bowden) +Steps: + 1. Select the printer, filament, and process you would like to use for the test. + 2. Examine each corner of the print and mark the height that yields the best overall result. + 3. I selected a height of 8 mm for this case, so the pressure advance value should be calculated as `0.002x8 = 0.016`. +![tower](https://user-images.githubusercontent.com/103989404/210140231-e886b98d-280a-4464-9781-c74ed9b7d44e.jpg) + +![tower_measure](https://user-images.githubusercontent.com/103989404/210140232-885b549b-e3b8-46b9-a24c-5229c9182408.jpg) +### NOTE: +* For Bambulab X1/X1C users, make sure you do not select the 'Flow calibration' option.* +![uncheck](https://user-images.githubusercontent.com/103989404/221345187-3c317a46-4d85-4221-99b9-adb5c7f48026.jpeg) + +# Temp tower +![temp_tower](https://user-images.githubusercontent.com/103989404/221344534-40e1a629-450c-4ad5-a051-8e240e261a51.jpeg) +Temp tower is a straightforward test. The temp tower is a vertical tower with multiple blocks, each printed at a different temperature. Once the print is complete, we can examine each block of the tower and determine the optimal temperature for the filament. The optimal temperature is the one that produces the highest quality print with the least amount of issues, such as stringing, layer adhesion, warping (overhang), and bridging. + +*** +*Credits:* +- *Flowrate test is inspired by [SuperSlicer](https://github.com/supermerill/SuperSlicer)* +- *PA Line method is inspired by [K-factor Calibration Pattern](https://marlinfw.org/tools/lin_advance/k-factor.html)* +- *PA Tower method is inspired by [Klipper](https://www.klipper3d.org/Pressure_Advance.html)* +- *Temp tower model is remixed from [Smart compact temperature calibration tower](https://www.thingiverse.com/thing:2729076) +- *chapgpt* ;) diff --git a/doc/Home.md b/doc/Home.md new file mode 100644 index 0000000000..6c3d6bf723 --- /dev/null +++ b/doc/Home.md @@ -0,0 +1,12 @@ +Welcome to the documentation wiki! + +We have divided it roughly into the following pages: + +* [Calibration](wiki/Calibration) +* [How to build - Linux et al](wiki/How-to-build---Linux-et-al) +* [How to build Mac OS](wiki/How-to-build---Mac-OS) +* [How to build Windows](wiki/How-to-build---Windows) +* [Localization guide](wiki/Localization_guide) +* [release_notes_cn](wiki/release_notes_cn) +* [release_notes_en](wiki/release_notes_en) +* [Seam](wiki/Seam) diff --git a/doc/How to build - Windows.md b/doc/How to build - Windows.md index 96afac2042..cfac395636 100644 --- a/doc/How to build - Windows.md +++ b/doc/How to build - Windows.md @@ -32,5 +32,4 @@ then build it using command or building it under the Visual Studio 2019 (set the OrcaSlicer_app_gui as start project) -![image](https://user-images.githubusercontent.com/106916061/179185940-06135b47-f2a4-415a-9be4-666680fa0f9a.png) - +![image](https://user-images.githubusercontent.com/106916061/179185940-06135b47-f2a4-415a-9be4-666680fa0f9a.png) \ No newline at end of file diff --git a/doc/Seam.md b/doc/Seam.md new file mode 100644 index 0000000000..77b1405313 --- /dev/null +++ b/doc/Seam.md @@ -0,0 +1,17 @@ +WIP... + +### Seam gap +![image](https://user-images.githubusercontent.com/103989404/215331359-236874c9-ca91-4dd4-b969-3cefc70ebe1b.png) + +### Role-based wipe speed(auto) +### Wipe speed +### Wipe on loop(inward movement) +![image](https://user-images.githubusercontent.com/103989404/215334479-2687c518-1931-46a9-a363-7ae57a0aecf6.png) + +Use outer wall speed and acceleration instead of travel speed and acceleration. +Added an option to disable this feature +### Support Cura style outer wall wipe(100% retract before wipe) +![image](https://user-images.githubusercontent.com/103989404/215334900-97c75010-4752-45f1-a57c-f0b723a8cb3f.png) +![image](https://user-images.githubusercontent.com/103989404/215335212-3253061d-bb7b-4853-a86c-10ff54cc8df5.png) + +Extra length on restart \ No newline at end of file