From cf08e281d63ef3b9831f87d972c92e4667891229 Mon Sep 17 00:00:00 2001 From: RCdiy Date: Fri, 1 Sep 2017 11:54:01 -0400 Subject: [PATCH 1/4] Clarifying the need of for zadig & flashing methods The download section may be better in a different stand alone page... If a page stub is provided I can place it there. For now it is just an edit of what was already started on this page. --- companion/flashing.md | 125 ++++++++++++++++++++++++++++++------------ 1 file changed, 89 insertions(+), 36 deletions(-) diff --git a/companion/flashing.md b/companion/flashing.md index 783a1e1..3a8fd1a 100644 --- a/companion/flashing.md +++ b/companion/flashing.md @@ -1,17 +1,43 @@ ## Flashing your FrSky radio -As mentioned before, the program of your radio can be replaced, either -to change the display language or to take advantage of new functions -or corrections. The first thing to do is to power your radio off and -connect it to your computer's USB port. +### Are Additional Drivers Required? -## Installing the driver \(for Windows only\) +Most new transmitter such as the Taranis series do not require any additional software or drivers to be installed on the computer. One exception is the FrSKY Horus X12S. The Taranis models all have a bootloader that allows flashing without additional drivers. Once flashed using the bootloader menu (described below) the bootloader is also updated and windows drivers will not be required for FrSKY transmitters except the Horus X12S. -Installing the driver is only needed when you want or need to flash -your radio directly from the PC. The Taranis models all have a -bootloader that allows flashing without these drivers. For flashing a -Horus TX or if you need to recover your Taranis, you will need to -install these drivers. +Do not install these drivers unless you are sure you need it. + +To check power up the transmitter in Bootloader mode: +* Power off the transmitter +* Pull the two horizontal trims towards the centre +* Power on the transmitter +* Release the trims +* Check the bootloader version number on the top line of the LCD screen + +![bootloadersmall](https://user-images.githubusercontent.com/20209851/29190168-1b415e06-7de7-11e7-8d92-0010df929bbd.png) + + +| Tx | OpenTX Bootloader | PC OS | Add PC Driver | +| --- | ------------------- | ------ | ----------------------- | +| X7 | 2.2 | Any | No | +| X9D | 1.x | Windows | Zadig | +| X9D | 1.x | Linux | Dfu-util | +| X9D | 1.x | Mac | Dfu-util | +| X9D | 2.x | Any | No | +| X9D+ | 2.x | Any | No | +| X9E | 2.x | Any | No | +| X12S | 2.2 + later | Windows | Zadig | +| X12S | 2.2 + later| Linux | Dfu-util | +| X12S | 2.2 + later| Mac | Dfu-util | + +MAC Note: Companion 2.2 for Mac comes with Dfu-util. + + +## Installing The Windows Driver If Required + +The first thing to do is to power your radio off and connect it to your computer's USB port. + + For flashing a +Horus TX or if you need to recover your Taranis, you will need to install these drivers. Installing the driver is only required the first time you flash your radio on a given computer. If already done this step, you can skip @@ -41,7 +67,7 @@ Zadig will install the driver, and should report success. When done you can dism Should none of these options work, you can download the driver here and install it manually \(instructions are on the download page\). When the driver is properly installed, you should see this in the device manager: -### Installing the flashing utility \(Linux\) +### Installing The Linux Flashing Utility Dfu-util is avaialble in most distributions. For example in Ubuntu it can be installed by @@ -49,35 +75,62 @@ Dfu-util is avaialble in most distributions. For example in Ubuntu it can be ins sudo apt-get install dfu-util ``` -### Setup for Mac OS X +### Flashing Using A Mac OS Companion for Mac OS already includes the required \`\`dfu-util'' tool and does not require any additional installation of tools or drivers. -## Downloading and flashing the firmware - -In OpenTX companion's preferences window, make sure the proper -firmware is selected \(OpenTX for FrSky Taranis \(X9D\), or OpenTX for -Taranis Plus \(X9D+\) according to the hardware you have\), and the -language / options match your preference, then click the top Download -button and select a location for the file. This will automatically -build and download the latest available version of OpenTX for Taranis. -Close the Preferences window, and select the Burn -> Write Flash -memory command. Make sure your radio is powered off and connected. -Browse for the file you just downloaded. It will be recognised -automatically and the version will be displayed. If you wish to -replace the radio's splash screen, you can either load one from a file -or select it from the available library, and click the "Substitute -image in firmware" box. Click "Burn to TX". Once the progress bar is -done and the success prompt is shown you can dismiss it and disconnect -your radio :\) If you get an error about the dfu-util executable not -being found, open the flashing tool settings with the Burn -> -Configure menu item. Browse for the dfu-util executable, which should -be: On Windows: In the OpenTX companion installation folder \(by -default C:\Program Files\companion9x\dfu-util.exe on 32-bit systems, -and C:\Program Files \(x86\)\companion9x\dfu-util.exe on 64-bit -systems\). On Mac OS: `/Applications/OpenTX Companion -2.2.app/Contents/Resources/dfu-util` +## Downloading The OpenTX Firmware + +The only recommended way to download the OpenTX firmware is using Companion. This process compiles/builds the firmware on the OpenTX servers and downloads a copy to the computer. + +To download the firmware follow these steps: + +* Radio Profile: Make sure the correct transmitter profile is selected +* Build Options: Make sure the build options selected are the ones you want +* Download Firmware: File -> Download +* Click on Download firmware (The download could take a few minutes) +* Save the firmware .bin file on the computer +* You may be prompted to write the firmware to the transmitter +* If you want to choose yes connect the transmitter to the computer in bootloader mode +* Click on Yes +* Select Check Hardware compatibility to make sure the firmware being written to the transmitter is for that particular hardware. +* Click on Write to TX +* Eject the mounted drives +* Disconnect the USB cable +* Power the transmitter off + +# Writing The OpenTX Firmware + +Connect the transmitter to the computer in bootloader mode. + +There are two options to write the firmware: +* Using The Bootloader Menu +* Using Companion + +## Using The Bootloader Menu + +* Place a copy of the firmware on the sd card in the FIRMWARE folder +* Rename the firmware file so that the filename including the .bin extension is 35 characters or less. +* Eject the two mounted drives +* Disconnect the USB cable +* Choose Write Firmware from the bootloader menu +* Select the firmware to be written +* Press ENT +* Hold ENT down to start writing the firmware +* When the “Writing Complete” message is displayed press EXIT +* Power the transmitter off + +## Using Companion + +* Read/Write -> Write Firmware to Radio +* A Flash Firmware window appears +* Click on Load and select the firmware file downloaded using companion +* Select Check Hardware compatibility to make sure the firmware being written to the transmitter is the correct one +* Click on Write to TX +* Eject the two mounted drives +* Disconnect the USB cable +* Power off the transmitter ## Downloading and installing SD card content. From dd4e6a4db27500d59592938b0267fcee628c2c9a Mon Sep 17 00:00:00 2001 From: Arne Schwabe Date: Tue, 5 Sep 2017 17:51:40 +0200 Subject: [PATCH 2/4] Update flashing.md --- companion/flashing.md | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/companion/flashing.md b/companion/flashing.md index 3a8fd1a..7246b4b 100644 --- a/companion/flashing.md +++ b/companion/flashing.md @@ -2,11 +2,11 @@ ### Are Additional Drivers Required? -Most new transmitter such as the Taranis series do not require any additional software or drivers to be installed on the computer. One exception is the FrSKY Horus X12S. The Taranis models all have a bootloader that allows flashing without additional drivers. Once flashed using the bootloader menu (described below) the bootloader is also updated and windows drivers will not be required for FrSKY transmitters except the Horus X12S. +Most new transmitter such as the Taranis series do not require any additional drivers to be installed on the computer to use it with Companion for configuration and model editing. Flashing the remotes via PC (with dfu-util) needs drivers installed but this can be avoided by flashing with the bootloader. The exception is the FrSKY Horus X12S that, unlike the Taranis model, does not have a bootloader that allows flashing without additional drivers. Once flashed using the bootloader menu (described below) the bootloader is also updated and windows drivers will not be required for FrSKY transmitters except the Horus X12S. -Do not install these drivers unless you are sure you need it. +You do not need install these drivers unless you are sure you need it. -To check power up the transmitter in Bootloader mode: +To power up the transmitter in Bootloader mode: * Power off the transmitter * Pull the two horizontal trims towards the centre * Power on the transmitter @@ -16,23 +16,19 @@ To check power up the transmitter in Bootloader mode: ![bootloadersmall](https://user-images.githubusercontent.com/20209851/29190168-1b415e06-7de7-11e7-8d92-0010df929bbd.png) -| Tx | OpenTX Bootloader | PC OS | Add PC Driver | +| Tx | OpenTX Bootloader | Flash method | | --- | ------------------- | ------ | ----------------------- | -| X7 | 2.2 | Any | No | -| X9D | 1.x | Windows | Zadig | -| X9D | 1.x | Linux | Dfu-util | -| X9D | 1.x | Mac | Dfu-util | -| X9D | 2.x | Any | No | -| X9D+ | 2.x | Any | No | -| X9E | 2.x | Any | No | -| X12S | 2.2 + later | Windows | Zadig | -| X12S | 2.2 + later| Linux | Dfu-util | -| X12S | 2.2 + later| Mac | Dfu-util | +| X7 | 2.2 | Bootloader, Dfu-util | +| X9D | 1.x | Dfu-util | +| X9D | 2.x | Bootloader, Dfu-util | +| X9D+ | 2.x | Any | Bootloader, Dfu-util | +| X9E | 2.x | Any | Bootloader, Dfu-util | +| X12S | 2.2 + later | Windows | Dfu-util | -MAC Note: Companion 2.2 for Mac comes with Dfu-util. +Companion 2.2 for Mac and Windows comes with Dfu-util. Linux distribution usuall have a package for dfu-util. Windows needs drivers installed via Zadiag utility -## Installing The Windows Driver If Required +## Installing The Windows Driver with Zadiag (optional) The first thing to do is to power your radio off and connect it to your computer's USB port. @@ -121,7 +117,7 @@ There are two options to write the firmware: * When the “Writing Complete” message is displayed press EXIT * Power the transmitter off -## Using Companion +## Using Companion (dfu-util) * Read/Write -> Write Firmware to Radio * A Flash Firmware window appears From dcc6b1b5434791203e4c5b2521d76676bc8082fa Mon Sep 17 00:00:00 2001 From: Arne Schwabe Date: Tue, 5 Sep 2017 17:55:16 +0200 Subject: [PATCH 3/4] Reade section with dfu-util paths --- companion/flashing.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/companion/flashing.md b/companion/flashing.md index 7246b4b..7ebeb3f 100644 --- a/companion/flashing.md +++ b/companion/flashing.md @@ -119,6 +119,13 @@ There are two options to write the firmware: ## Using Companion (dfu-util) +If you get an error about the dfu-util executable not + being found, open the flashing tool settings menu item. Browse for the dfu-util executable, which should be: On Windows: In the OpenTX companion installation folder \(by default\) + `C:\Program Files\OpenTX Companion 2.2\dfu-util.exe` on 32-bit systems, + and `C:\Program Files\OpenTX Companion 2.2\dfu-util.exe` on 64-bit + systems. On Mac OS: `/Applications/OpenTX Companion 2.2.app/Contents/Resources/dfu-util` + + * Read/Write -> Write Firmware to Radio * A Flash Firmware window appears * Click on Load and select the firmware file downloaded using companion From 08feb5e9ab248268079e1ee1db39a04345df35fc Mon Sep 17 00:00:00 2001 From: Arne Schwabe Date: Tue, 5 Sep 2017 18:04:12 +0200 Subject: [PATCH 4/4] Fix table --- companion/flashing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/companion/flashing.md b/companion/flashing.md index 7ebeb3f..f37ed26 100644 --- a/companion/flashing.md +++ b/companion/flashing.md @@ -17,13 +17,13 @@ To power up the transmitter in Bootloader mode: | Tx | OpenTX Bootloader | Flash method | -| --- | ------------------- | ------ | ----------------------- | +| --- | ------------------- | ------ | | X7 | 2.2 | Bootloader, Dfu-util | | X9D | 1.x | Dfu-util | | X9D | 2.x | Bootloader, Dfu-util | | X9D+ | 2.x | Any | Bootloader, Dfu-util | | X9E | 2.x | Any | Bootloader, Dfu-util | -| X12S | 2.2 + later | Windows | Dfu-util | +| X12S | 2.2 + later | Dfu-util | Companion 2.2 for Mac and Windows comes with Dfu-util. Linux distribution usuall have a package for dfu-util. Windows needs drivers installed via Zadiag utility