diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 15161fa8b..257ed6f33 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-22.04 steps: - name: Checkout - uses: actions/checkout@v4.1.3 + uses: actions/checkout@v4.2.2 - name: Install dependencies run: | diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ae7bdc1b6..18d0b8aba 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout master - uses: actions/checkout@v4.1.3 + uses: actions/checkout@v4.2.2 - name: Deploy docs uses: mhausenblas/mkdocs-deploy-gh-pages@master diff --git a/docs/electronics/skrpro.md b/docs/electronics/skrpro.md index 25451bc49..0ee9d7f6b 100644 --- a/docs/electronics/skrpro.md +++ b/docs/electronics/skrpro.md @@ -61,7 +61,7 @@ Depending on what wires you are plugging in you can take them off the end stops ## Wiring Steppers -We have a few options for how the steppers get connected to this board. Here are the three most +We have a few options for how the steppers get connected to this board. Here are the two most common ways we might use it. ### MPCNC and LowRider CNC @@ -76,6 +76,7 @@ common ways we might use it. | Z1 | Jumpers stay in place | | E0 | X2 | | E1 | Y2 | +| E2 | Not used | **LowRider CNC** @@ -87,6 +88,7 @@ common ways we might use it. | Z1 | Jumpers stay in place | | E0 | Y2 | | E1 | Z2 | +| E2 | Not used | ![!dual 0](../img/old/2020/07/dual2-scaled.jpg){: loading=lazy width="400"} @@ -115,34 +117,33 @@ the knob in for 3 seconds.** You do not need to use both; pay attention to the direction the wires are facing when connecting them. -!!! You can kill your screen - Pay attention to the direction the wires are facing when connecting -them. The single wire faces toward the drivers, 5V closest to the memory card. +!!! Caution + Pay attention to the direction the wires are facing when connecting them. The single wire faces toward the drivers, 5V closest to the memory card. Getting this wrong can damage the board. ## Touch plate -All the V1 firmware is ready for a touch plate. Easy as plugging into the Z min port. Use Ground "G" and Signal "S" pins, they are labeled on the back of the board. +All the V1 Engineering firmware are ready for a touch plate. It is as easy as plugging into the Z min port. Use Ground "G" and Signal "S" pins, they are labeled on the back of the board. ![!Probe](../img/old/2020/07/Z-probe-scaled.jpg){: loading=lazy width="400"} ## Dual End Stops, End Stops -If you are running the Current firmware you will need to have your endstops wired in Normally -Closed (NC), this is the outer two tabs on the endstops, we do not use the middle one. You will plug into the Signal and Ground pins, **Do not use the + pins.** Use Ground "G" and Signal "S" pins, they are labeled on the back of the board. +If you are running the current firmware you will need to have your endstops wired as "Normally +Closed" (NC), this is the outer two tabs on the endstops, we do not use the middle one. You will plug into the Signal and Ground pins on the SKR board, **Do not use the + pins.** Use the Ground "G" and Signal "S" pins, they are labeled on the back of the board. Optical endstops are not recommended on a machine used for milling or routing. The debris can inhibit their function. !!! Troubleshooting End Stops - There is a known issue on SKR Pro1.2 boards where a small percentage of boards intermittently do not trigger a stop in the firmware. The technical reason is the on board circuit was designed with a voltage divider that is on the edge of the microprocessors HIGH/LOW signal limit. This results in random missing of the stop signal. A symtom of this is that one or more of the steppers keep driving after the limit switch triggers. You will find the stop LEDs on the SKR board will illuminate, but the firmware does not react. This is discussed in [this thread](https://forum.v1e.com/t/firmware-issues/39109/5) There are a few ways to address this: 1) Replace the SKR board. 2) Solder 1.5K ohm resistors on the bottom of the board. 3) Modify the end stop wires to add the 1.5K ohm resistor. + There is a known issue on **OLDER** SKR Pro1.2 boards where a small percentage of boards intermittently do not trigger a stop in the firmware. The technical reason is the on board circuit was designed with a voltage divider that is on the edge of the microprocessors HIGH/LOW signal limit. This results in random missing of the stop signal. A symtom of this is that one or more of the steppers keep driving after the limit switch triggers. You will find the stop LEDs on the SKR board will illuminate, but the firmware does not react. This is discussed in [this thread](https://forum.v1e.com/t/firmware-issues/39109/5) There are a few ways to address this: 1) Replace the SKR board. 2) Solder 1.5K ohm resistors on the bottom of the board. 3) Modify the end stop wires to add the 1.5K ohm resistor. -### MPCNC Dual Endstops +### MPCNC Endstops ![!endstops](../img/old/2020/07/endstops-scaled.jpg){: loading=lazy width="400"} -### LowRider Dual endstops +### LowRider endstops ![!LR3 endstops](../img/LR3_endstops.jpg){: loading=lazy width="400"} !!! note - Do not use the + (positive) pins or you will ruin your SKR Pro board. Unless you are running a different project with powered endstops. + Do not use the + (positive) pins or you will ruin your SKR Pro board. These are only used whith powered endstops, and those are uncommon. ## Firmware @@ -165,7 +166,7 @@ When you unzip the file you have a .bin file. Rename to FIRMWARE.bin and save it Do not use a SKR Pro based machine with the microSD card in the SKR Pro board unless you are using the headless module. This seems to cause random performance issues otherwise. -![!SKR file](../img/old/2020/08/SKR_Bin.jpg){: loading=lazy width="400"} +![!SKR file](../img/SKR/SKR_Bin.jpg){: loading=lazy width="400"} The file will change extensions when a successful flash happens. @@ -179,19 +180,17 @@ You also have the option to get the full Marlin source and edit and compile your Flashing the screen takes a .bin file, the config file, and usually the TFT35 folder (unzipped) on the root of the screens SD card. -BIGTREE_TFT35_V3.0_E3.****.bin -config.ini -TFT35 (folder) +The V1 Engineering CNC version of the TFT firmware is on this page, use the most recent and the files can be had under the assets drop down - [TFT Firmware](https://github.com/V1EngineeringInc/BIGTREETECH-TouchScreenFirmware/releases) -![!TFT files](../img/old/2020/08/TFT35_bin.jpg){: loading=lazy width="400"} +Unzip the folder and load all the files on to the SD card like shown below. -Now reset the screen (or board) and watch the screen update itself. You can double check and the files will have a new extension after a successful flash. +![!TFT files](../img/SKR/tft_files.png){: loading=lazy width="400"} -The V1 Engineering CNC version of the TFT firmware is on this page, use the most recent and the files can be had under the assets drop down - [TFT Firmware](https://github.com/V1EngineeringInc/BIGTREETECH-TouchScreenFirmware/releases) +Now reset the screen (or board) and watch the screen update itself. This should take several minutes. #### TFT Touch reset -If you somehow mess up the touch calibration placing and empty reset.txt file on the card and resetting will trigger a re-calibration. +If you somehow mess up the touch calibration placing and empty reset.txt file on the card and rebooting will trigger a re-calibration. ## Compile your own (source) @@ -206,6 +205,14 @@ repo](https://github.com/V1EngineeringInc/BIGTREETECH-TouchScreenFirmware/releas ## Cases +### SKR Pro Cases + +[LowRider V4 CNC Specific case](https://www.printables.com/model/1051517-skr-pro-box-for-the-lowrider-4-cnc) + +[LowRider V3 case](https://www.printables.com/model/209348-skr-pro-lr3-specific-case) + +[Generic mount and cover](https://www.printables.com/model/422342-skr-pro-wire-management-and-cover) + ### TFT35 E3 V3 Case @@ -213,18 +220,11 @@ Box for the [TFT35 E3 V3](https://www.prusaprinters.org/prints/74330-tft35-e3-v3 ![!TFT35 E3 V3 Case](../img/TFT_Case_Picture.jpg){: loading=lazy width="400"} -### Flyfisher604 SKR Pro v1.2 and TFT E3 v3.0 Case - -A three-part case (lower box, top lid, and sloped TFT screen) that includes: -- Ventilation on two sides of the lower box -- Two fan mounts with integrated grates on the back of the sloped TFT screen -- Built in standoffs for the SKR Pro board and TFT screen -- Opening on TFT sloped screen mount exposing the SD card slot -- Openings for DB25 and DB15 connectors (with mounting screw holes) to interface internal wiring to MPCNC (or use these as pass throughs) +### Flyfisher604 SKR Pro v1.2 and TFT E3 v3.0 Case for the MPCNC Available [here](https://www.thingiverse.com/thing:4678675) on Thingiverse. ![!Flyflisher604 SKR Pro Case](../img/Flyfisher604_SKR_Pro_v1.2_and_TFT_E3_v3.0_Case.jpg){: loading=lazy width="400"} -![!Flyflisher604 SKR Pro Case Inside](../img/Flyfisher604_SKR_Pro_v1.2_and_TFT_E3_v3.0_Case_Inside.jpg){: loading=lazy width="400"} +![!Flyflisher604 SKR Pro Case Inside](../img/Flyfisher604_SKR_Pro_v1.2_and_TFT_E3_v3.0_Case_Inside.jpg){: loading=lazy width="400"} \ No newline at end of file diff --git a/docs/img/old/2020/08/SKR_Bin.jpg b/docs/img/SKR/SKR_Bin.jpg similarity index 100% rename from docs/img/old/2020/08/SKR_Bin.jpg rename to docs/img/SKR/SKR_Bin.jpg diff --git a/docs/img/SKR/tft_files.png b/docs/img/SKR/tft_files.png new file mode 100644 index 000000000..8c3d8c848 Binary files /dev/null and b/docs/img/SKR/tft_files.png differ diff --git a/docs/img/old/2020/08/TFT35_bin.jpg b/docs/img/old/2020/08/TFT35_bin.jpg deleted file mode 100644 index a0f544404..000000000 Binary files a/docs/img/old/2020/08/TFT35_bin.jpg and /dev/null differ diff --git a/docs/index.md b/docs/index.md index da67f3aaa..8fb18fd97 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,7 +48,7 @@ you will be guided to make the change and submit the changes back to the project "Pull Request". After that, your changes will be reviewed, approved, and merged into the documentation, and that way others can avoid the same problems you had. -Before you go, make sure you add yourself to the [Contributors](index.md#Contributors) section below so that everyone knows how +Before you go, make sure you add yourself to the [Contributors](index.md#contributors) section below so that everyone knows how awesome you are for making a contribution. ??? "I want to develop more, faster, better, stronger" diff --git a/docs/learn/platformio.md b/docs/learn/platformio.md index 065f9c2c2..09bf497be 100644 --- a/docs/learn/platformio.md +++ b/docs/learn/platformio.md @@ -42,7 +42,7 @@ Once you have PlatformIO installed there is really nothing else that needs to be ### Load Your Firmware -You should already have downloaded and **Unzipped** the firmware for your board. If you are unsure of that step have a look [here](../electronics/marlin-firmware.md#using-github). +You should already have downloaded and **Unzipped** the firmware for your board. If you are unsure of that step have a look [here](../electronics/marlin-firmware.md). In the top left of the VS Code window select "File", then "Open Folder". diff --git a/docs/mp3dp/version1.md b/docs/mp3dp/version1.md index e9e751c7e..c389a4010 100755 --- a/docs/mp3dp/version1.md +++ b/docs/mp3dp/version1.md @@ -95,7 +95,7 @@ You will also need some extra wire for the power supply, end stops, and fans. 5/11/17 -See [firmware](index.md#firmware) +See [firmware](../electronics/marlin-firmware.md) Assembly diff --git a/mkdocs.yml b/mkdocs.yml index 2ebe08d4d..2de4de0af 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,12 +63,8 @@ nav: - SKR Pro: electronics/skrpro.md - Ultimachine Boards: electronics/ultimachine.md - Ramps: electronics/ramps.md - - Wiring The Steppers: electronics/steppers.md - Setup: software/index.md - - Some Advanced Options: - - V1pi - Headless: electronics/v1pi.md - - Dual Endstops: electronics/dual-endstops.md - + - Use: - Tools: - Milling: @@ -76,17 +72,13 @@ nav: - Milling Basics: tools/milling-basics.md - "Kiri:Moto Basics": software/kiri.md - EstlCAM Intermediate (2.5d): software/estlcam-2p5d.md - - Milling Metal: tools/milling-metal.md - Inlays: software/Fengrave-vcarve-inlay.md - - 3D Printing: - - Import Extruder: tools/import-extruder.md - Lasers: - Main: tools/lasers.md - Engraving Mirrors: tools/laser-engraving-mirrors.md - Drag Knife/Vinyl: tools/drag-knife.md - Needle Cutter: tools/foam-needle-cutter.md - - Troubleshoot: - - Reversing a Stepper: software/reverse-motor.md + - Learn: - FAQ's: learn/faq.md - Editing mkdocs: mkdocs_info.md @@ -99,6 +91,14 @@ nav: - G-code: learn/gcode.md - Motion: learn/motion.md - Coordinates: learn/coordinates.md + - V1pi - Headless: electronics/v1pi.md + + - Archive: + - Wiring The Steppers: electronics/steppers.md + - Dual Endstops: electronics/dual-endstops.md + - Milling Metal: tools/milling-metal.md + - Import Extruder: tools/import-extruder.md + - Reversing a Stepper: software/reverse-motor.md theme: font: false @@ -119,12 +119,13 @@ theme: icon: material/brightness-4 name: Switch to light mode features: - - navigation.sections + - navigation.tracking + - navigation.instant + - navigation.top - toc.integrate - toc.follow - search.suggest - search.highlight - - navigation.instant - content.tabs.link - content.action.edit logo: "img/favicon.ico" diff --git a/requirements.txt b/requirements.txt index 892dc5f56..b3573f054 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ git+https://github.com/blueswen/mkdocs-glightbox -mkdocs>=1.6.0 -mkdocs-material>=9.5.39 +mkdocs>=1.6.1 +mkdocs-material>=9.5.48