diff --git a/docs/Configuring-Quicksilver.md b/docs/Configuring-Quicksilver.md index 1a08b52..909cb3f 100644 --- a/docs/Configuring-Quicksilver.md +++ b/docs/Configuring-Quicksilver.md @@ -1,6 +1,6 @@ Connect via usb as for flashing. Press the **_CONNECT_** button and select the offered port in the pop up window. Once connected you will be in the Profile tab. -Occasionally on a Windows pc the serial port doesn't show up. If this happens firstly make sure you have power cycled the fc by replugging the usb. If that doesn't work refer to the [Troubleshooting Page](/Troubleshooting/). +Occasionally on a Windows pc the serial port doesn't show up. If this happens firstly make sure you have power cycled the fc by replugging the usb. If that doesn't work refer to the [Troubleshooting Page](Troubleshooting.md). Every time you make a change on a tab remember to click **_APPLY_** before leaving the tab. There will always be a confirmation pop up after successfully applying changes. @@ -16,7 +16,7 @@ Every time you make a change on a tab remember to click **_APPLY_** before leavi 5. Set up rates and expo and load PID profiles. Filter adjustments should be made after a test flight, defaults are safe. -6. If you are using a serial connected rx (uart) it will autodetct the protocol, turn on your transmitter and bind. Save the bind with [stick gesture](/Features/#stick-gestures) U,U,U on the pitch stick followed by D,D,D. +6. If you are using a serial connected rx (uart) it will autodetct the protocol, turn on your transmitter and bind. Save the bind with [stick gesture](Features.md#stick-gestures) U,U,U on the pitch stick followed by D,D,D. 7. Set Aux channels and flight modes remembering that Quicksilver uses two position switch logic, high or low. Arm is already set on CH5. (Racemode and Horizon mode both require Angle to be active) If no other flight modes are set it will be in Acro/Rate mode only. @@ -32,7 +32,7 @@ Every time you make a change on a tab remember to click **_APPLY_** before leavi !!! Info Quicksilver calibrates the IMU (gyro) on every boot up of the fc. Connect lipo and place the quad down and still within 15 seconds to get correct calibration. - You can also calibrate at any time by placing the quad level and using the [stick gesture](/Features/#stick-gestures) D,D,D + You can also calibrate at any time by placing the quad level and using the [stick gesture](Features.md#stick-gestures) D,D,D More detail is available below on the contents of each tab. There is a tooltip available for many settings, just click on the ``?`` @@ -42,7 +42,7 @@ Here is where you view and save profile information or load a saved profile. You Profiles are saved as .yaml files and can be edited in a code editor. -Target configurations can be uploaded/downloaded here as well, they are also .yaml format (see [Runtime targets](/Features/#runtime-targets)) +Target configurations can be uploaded/downloaded here as well, they are also .yaml format (see [Runtime targets](Features.md#runtime-targets)) We will supply template profiles for some bnf models [here](https://github.com/BossHobby/Templates) These are available within the configurator and are applied after flashing your target. @@ -89,7 +89,7 @@ Unless otherwise recommended we advise leaving most of the settings here at defa ## Receiver -[Supported protocols](/Features/#receivers) +[Supported protocols](Features.md#receivers) As long as a uart is set for serial connected rx or an spi integrated rx is used the firmware will detect the correct protocol. (Some flight controllers may need a lipo connected to power the rx) @@ -117,7 +117,7 @@ If only Arm is set you will be in Acro/Rate mode. -To find out about other features operated by Aux channels check [Features](/Features/) +To find out about other features operated by Aux channels check [Features](Features.md) diff --git a/docs/Features.md b/docs/Features.md index d0f7db2..a801c5e 100644 --- a/docs/Features.md +++ b/docs/Features.md @@ -122,7 +122,7 @@ We also advise setting Turtle mode to ON in **_Receiver_** tab which means all y ## OSD -The OSD menu is accessed by performing a **R,R,R** [stick gesture](/Features/#stick-gestures) on the ROLL/PITCH stick. +The OSD menu is accessed by performing a **R,R,R** [stick gesture](Features.md#stick-gestures) on the ROLL/PITCH stick. OSD font and boot logo can be changed, select and upload. diff --git a/docs/Quick-Start-Guide.md b/docs/Quick-Start-Guide.md index 1f2a0ba..49464f2 100644 --- a/docs/Quick-Start-Guide.md +++ b/docs/Quick-Start-Guide.md @@ -22,9 +22,9 @@ Open the Configurator. Click on the `Flash` tab to go to the firmware flash page Whilst in the `Flash` tab you will _**NOT**_ be using the `Connect` button in the top right -![Flashing](/assets/img/QS_flash.gif) +![Flashing](assets/img/QS_flash.gif) -Connect a compatible flight controller via usb cable. To flash the QUICKSILVER firmware, the flight controller must be in DFU mode (bootloader mode); this can be done by holding the boot button while plugging in the flight controller, or by clicking the `Reset to Bootloader` button on the GUI. If no compatible device is found, check the [Troubleshooting Page](/Troubleshooting/). +Connect a compatible flight controller via usb cable. To flash the QUICKSILVER firmware, the flight controller must be in DFU mode (bootloader mode); this can be done by holding the boot button while plugging in the flight controller, or by clicking the `Reset to Bootloader` button on the GUI. If no compatible device is found, check the [Troubleshooting Page](Troubleshooting.md). Select the _Source_ from which you want to retrieve a hex file to flash. Selecting BossHobby/QUICKSILVER will download the firmware from github, or choose LOCAL if you have built your own hex file from the source code. @@ -39,7 +39,7 @@ Select the `Flash` button to initiate the flashing process. Progress bars will a It is best practise to power cycle the fc after flashing and before connecting to the configurator for setup -After flashing, proceed to [Configuring Quicksilver](/Configuring-Quicksilver). +After flashing, proceed to [Configuring Quicksilver](Configuring-Quicksilver.md). If your flash was unsuccessful for any reason - do not stress. The stm32 microprocessors will not be damaged or bricked through the flashing process but may appear unresponsive after a failed flash. diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 50122f4..755d4de 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -3,10 +3,10 @@ Hold the boot button or use the **Reset to Bootloader** function in the configurator Download and open [Zadig](https://zadig.akeo.ie/) -![zadig_list_all_devices](/assets/img/zadig_all_devices.png) +![zadig_list_all_devices](assets/img/zadig_all_devices.png) Ensure `List All Devices` is selected in the options. -![zadig_dfu](/assets/img/zadig_dfu.png) +![zadig_dfu](assets/img/zadig_dfu.png) Choose `STM32 BOOTLOADER` in the dropdown and select `WinUSB` in the right hand pane. Click `Replace Driver` and wait for it to finish. Try flashing again in the configurator. @@ -16,10 +16,10 @@ Try flashing again in the configurator. Unplug the fc and replug to ensure a power cycle Download and open [Zadig](https://zadig.akeo.ie/) -![zadig_list_all_devices](/assets/img/zadig_all_devices.png) +![zadig_list_all_devices](assets/img/zadig_all_devices.png) Ensure `List All Devices` is selected in the options. -![zadig_serial](/assets/img/zadig_serial.png) +![zadig_serial](assets/img/zadig_serial.png) Choose `QUICKSILVER` in the dropdown and select `USB serial (CDC)` in the right hand pane. Click `Replace Driver` and wait for it to finish. Power cycle again then try the configurator. @@ -28,5 +28,5 @@ Click `Replace Driver` and wait for it to finish. Power cycle again then try the The bmi270 gyros internal filtering differs from what other common gyros (mpu, icm) come with. As such it needs slightly different software filtering. Recommended values are: -- A single gyro pt2 [filter](/Configuring-Quicksilver/#filter) at 100hz -- About half the d-term [pid gain](/Configuring-Quicksilver/#pid) (or kd) for Pitch and Roll, of what is specified in the presets. +- A single gyro pt2 [filter](Configuring-Quicksilver.md#filter) at 100hz +- About half the d-term [pid gain](Configuring-Quicksilver.md#pid) (or kd) for Pitch and Roll, of what is specified in the presets.