More work on configuration

docs/README.md

@@ -5,21 +5,6 @@ To run V-CoreOS on your V-Core 3 you need a supported control board and a Raspbe
 
 
 
-## Updating
-
-In the settings page in Fluidd, you'll see a sheet with the title "Update Manager", if you're familiar with Fluidd or Mainsail, you'll notice a new entry called `vcore3`. This `vcore3` package will update all the config files in the v-core-3 folder, improvements, support for hotends, extruders etc, will be coming to your printer this way in the future.
-
-## (Optional) Input Shaping using an ADXL345
-
-If you want to use an ADXL345 for automatic input shaper calibration, all the software you need is already installed on the pi, you just need to wire up your ADXL345 to you control board, and you're good to go. A default config is included, check the ADXL345 dropdown at the bottom of [wiring page](https://v-core.ratrig.com/electronics/#skr-pro-12) for how to connect the ADXL directly to the SKR Pro. For other boards it's included in the wiring diagram. Read more about tuning input shaper via an ADXL345 here: https://www.klipper3d.org/Measuring_Resonances.html.
-
-
-## Finalizing
-You'll need to adjust your endstop and probe z-offset before printing and be sure to run PID tuning for your extruder and your bed. After that it's advisable to run [Pressure Advance tuning](https://www.klipper3d.org/Pressure_Advance.html), [Input Shaper calibration](https://www.klipper3d.org/Resonance_Compensation.html) and [Skew Correction](https://www.klipper3d.org/skew_correction.html).
-
-### Quick z-offset adjustment method
-An easy way to do probe z-offset calibration is to home the printer, then put a piece of paper underneath. Now babystep Z through the Fluidd interface (or by issuing G0 commands through the console) until the nozzle touches the paper and there's a tiny bit of resistance when you pull on it. Then write "GET_POSITION" in the console and find the line that says `// kinematic: ...` And use the Z coordinate from that line, multiplied by -1. So if it says `// kinematic: X:0.000000 Y:0.000000 Z:-0.400000` Your probe's z_offset will be 0.4.
-
 # Troubleshooting
 If klipper won't connect, try restarting your raspberry pi. Make sure the SKR Pro is connected to the Pi via USB, that both are powered, and that the firmware.bin has been properly flashed. You can verify the last part by checking if the firmware.bin file has been changed to firmware.CUR on the SD card. If you have trouble flashing the motherboard (a green light should flash while booting, indicating the firmware has been flashed succefully), try disconnecting your endstops, if these are wired incorrectly the board will not boot properly.
 

docs/_sidebar.md

@@ -1,10 +1,12 @@
 - Getting started
   - [Quick start](quickstart.md)
   - [Configuration](configuration.md)
+  - [Manual Firmware Compilation](manual-firmware.compilation.md)
 
 - Boards
   - Big Tree Tech 
-    - [Octopus v1.1](boards/btt/octopus.md)
+    - [Octopus v1.1](boards/btt/octopus-11.md)
+    - [SKR Pro v1.2](boards/btt/skr-pro-12.md)
 
 - Printers
   - Rat Rig

docs/boards/btt/octopus.md → docs/boards/btt/octopus-11.md

@@ -5,7 +5,7 @@
 
 ## Firmware installation
 
-Move the firmware.bin file from the release page to the SD card that goes into your control board, and insert the SD card in to the control board.
+Move the `firmware-octopus-11.bin` file from the release page to the SD card that goes into your control board and call it `firmware.bin`, then insert the SD card in to the control board.
 
 ### Firmware installation without an SD-Card
 Another option is to jump the boot0 pins on the board, and click the reset button. Then SSH into the pi using something like PuTTy or `ssh [email protected]` via the commandline on OS X and Linux machines. Execute `~/klipper_config/config/boards/btt-octopus-11/make-and-flash-mcu.sh` and the Pi will compile the klipper firmware and flash the board for you. When done, power off the board and remove the boot0 jumper.

docs/boards/btt/skr-pro-12.md

@@ -1 +1,11 @@
-test
+# Big Tree Tech SKR Pro V1.2
+?> This page is incomplete, please refer to the [official V-Core 3 wiring diagram](https://v-core.ratrig.com/electronics/#skr-pro-12) and [V-CoreOS setup](https://v-core.ratrig.com/firmware/#v-coreos-klipper-firmware) for the time being.
+
+## Firmware installation
+
+Move the `firmware-skr-pro-12.bin` file from the release page to the SD card that goes into your control board and call it `firmware.bin`, then insert the SD card in to the control board.
+
+## Compiling and flashing the newest firmware via USB
+!> Requires an SD card in your SKR Pro 1.2.
+
+To compile and flash the newest firmware to the board, you need to SSH into the pi using something like PuTTy or `ssh [email protected]` via the commandline on OS X and Linux machines. Execute `~/klipper_config/config/boards/btt-skr-pro-12/make-and-flash-mcu.sh` and the Pi will compile the klipper firmware and flash the board for you.

docs/configuration.md

@@ -6,11 +6,34 @@ V-CoreOS only needs minimal configuration to work, but comes with a lot of optio
 ?> V-CoreOS comes preconfigured for the V-Core 3, to use other printers, copy the contents of the printer template from `config/templates/` to your printer.cfg
 
 Once you have completed the initial [setup](quickstart.md) and opened [http://v-coreos.local/](v-coreos.local) in your browser, you are almost ready to print. There's a just a few things to go over to make sure the configuration matches your particular setup.
-
 ## Fluidd
-In the configuration page in Fluidd (the webinterface you just opened in your browser), there's a list of files, among them is `printer.cfg`. Right click it and choose "Edit". This is where your klipper configuration lives. As you can see, it's prepopulated with some included files which are meant to get you up and running quick and easy. Follow the instructions in the file to make sure the configuration matches your setup.
-
+In the configuration page in Fluidd (the webinterface you just opened in your browser), there's a list of files, among them is `printer.cfg`. Right click it and choose "Edit". This is where your klipper configuration lives. As you can see, it's prepopulated with some included files which are meant to get you up and running quick and easy. **Follow the instructions in the file to make sure the configuration matches your setup.**
 ## Overrides
 
-You can override any setting in V-CoreOS, to do so you just copy the section and the parameter you need to change, and paste it in your printer.cfg after the related config file has been loaded. Let's say we wanted to change the current the extruder motor. If we navigate to `config/printers/v-core-3/steppers.cfg` we will be presented with the following file:
- wef [gist: script.js](https://gist.githubusercontent.com/anikethsaha/f88893bb563bb7229d6e575db53a8c15/raw/script.js ':include :type=code')
+You can override any setting in V-CoreOS, to do so you just copy the section and the parameter you need to change, and paste it in your printer.cfg after the related config file has been loaded. Let's say we wanted to change the current the extruder motor. If we navigate to `config/printers/v-core-3/steppers.cfg` we'll see this section:
+```properties
+[tmc2209 extruder]
+uart_pin:  e_uart_pin
+run_current: 0.5
+hold_current: 0.400
+stealthchop_threshold: 900
+
+```
+We're only interested in the `run_current` and `hold_current` settings, so all we need to do is go back to printer.cfg, scroll down to the `USER OVERRIDES` comment section and put in the following:
+
+```properties
+### USER OVERRIDES
+# Place all your overrides here
+
+[tmc2209 extruder]
+run_current: 0.35
+hold_current: 0.200
+```
+
+This works for any section (including gcode macros) and any parameter. You only need to override the parts you're interested in. You can have the same section defined multiple times, they will all get merged by klipper when it reads the config, with the last parameters taking precedence. This makes for a super powerful way to build your config! Refer to the [klipper config reference](https://www.klipper3d.org/Config_Reference.html) for all the cool things you can do.
+
+## Finalizing
+You'll need to adjust your endstop and probe z-offset before printing and be sure to run PID tuning for your extruder and your bed. After that it's advisable to run [Pressure Advance tuning](https://www.klipper3d.org/Pressure_Advance.html), [Input Shaper calibration](https://www.klipper3d.org/Resonance_Compensation.html) and [Skew Correction](https://www.klipper3d.org/skew_correction.html).
+
+?> **Quick z-offset adjustment method**<br/>
+An easy way to do probe z-offset calibration is to home the printer, then put a piece of paper underneath the nozzle. Now babystep Z through the Fluidd interface (or by issuing G0 commands through the console) until the nozzle touches the paper and there's a bit of resistance when you pull on it. Then write "GET_POSITION" in the console and find the line that says `// kinematic: ...` And use the Z coordinate from that line, multiplied by -1. So if it says `// kinematic: X:0.000000 Y:0.000000 Z:-0.400000` Your probe's z_offset will be 0.4.

docs/index.html

@@ -99,6 +99,8 @@
   <script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
   <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-properties.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
   <!-- <script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script> -->
 </body>
 </html>

docs/manual-firmware.compilation.md

@@ -0,0 +1,45 @@
+# Manual klipper firmware compilation
+?> If you don't know what SSH is or how to use the commandline, consider following the instructions for your specific boards instead. There are easier ways to do this.
+
+If you need to compile the firmware for your board yourself, here's how you do it.
+
+## SSH into the Raspberry Pi
+You're need to log into the Pi via SSH. The default username is `pi` and the password is `raspberry` (sidenote: it's a good idea to change this via `sudo raspi-config`). If you're on linux or Mac OS, you can do this by opening a terminal and type:
+```bash
+ssh [email protected]
+```
+
+Now navigate to the klipper directory:
+
+```bash
+cd ~/klipper
+```
+
+The configuration klipper needs to compile the firmware for your board is stored in `~/klipper_config/config/boards/[BOARD_NAME]/firmware.config`. To list the board names execute the following command:
+
+```bash
+ls -la ~/klipper_config/config/boards
+```
+
+Let's say we need to compile the firmware for the octopus. We then need to copy the configuration file from `~/klipper_config/config/boards/btt-octopus-11/firmware.config`
+
+```bash
+cp -f ~/klipper_config/config/boards/btt-octopus-11/firmware.config ~/klipper/.config
+```
+
+Now we're ready to compile the firmware!
+
+```bash
+make olddefconfig
+make clean
+make
+```
+
+## Download the firmware from the Pi
+Now klipper has compiled it's firmware to `~/klipper/out/klipper.bin`. We can download that to our machine via `scp` or [WinSCP](https://winscp.net/eng/download.php) (for windows users).
+
+Linux and Mac OS users can use scp from their local machines like this: 
+
+```bash
+scp [email protected]:klipper/out/klipper.bin firmware.bin
+```

docs/quickstart.md

@@ -21,13 +21,15 @@ When that is done reinsert the SD card into the Raspberry Pi, but don't turn on
 
 See the documentation for your specific board.
 
-[BTT Octopus v1.1](boards/btt/octopus.md)
-[BTT SKR Pro v1.2](boards/btt/skr-pro-12.md)
+[Big Tree Tech Octopus v1.1](boards/btt/octopus.md)
+
+[Big Tree Tech SKR Pro v1.2](boards/btt/skr-pro-12.md)
 
 ## Setup
 
 With the control board connected via USB to your Raspberry Pi, turn on your printer. After a couple of minutes, open your browser and navigate to [http://v-coreos.local/](http://v-coreos.local)
 
-## Configuration
 
-In the settings page in Fluidd, there's a list of files, among them should be a `printer.cfg`. Right click that and choose "Edit". This is where your klipper configuration lives. As you can see, it's prepopulated with some included files which are meant to get you up and running quick and easy. Follow the instructions in the file to make sure the configuration matches your setup.
+## Updating
+
+In the settings page in Fluidd, scroll to the bottom (or click "Software Updates") and you'll see a sheet with the title "Software Updates", if you're familiar with Fluidd or Mainsail, you'll notice a new entry called `v-coreos`. This `v-cores` package will update all the config files in the config folder, improvements, support for hotends, macros, extruders, new boards etc, will be coming to your printer this way in the future. Be sure to keep this up to date, especially if you update klipper.