Clarifying the need of for zadig & flashing methods #46
Conversation
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.
|
images will follow once we decide where the downloads section is going to be. |
|
Time from one of us to review it. |
companion/flashing.md
Outdated
|
|
||
|
|
||
| ## Installing The Windows Driver If Required | ||
| ## Installing The Windows Driver with Zadiag (optional) |
There was a problem hiding this comment.
Sure... I deliberately chose "If Required" based on forum feedback form people helping users who installed zadig and went through all of that when it was not required and did nothing to solve the problem they were addressing... but you approach is a different way... up to you...
There was a problem hiding this comment.
I would rather add an additional setence under that. if required in a title sounds a bit odd to me.
companion/flashing.md
Outdated
| @@ -16,23 +16,19 @@ To check power up the transmitter in Bootloader mode: | |||
|  | |||
|
|
|||
|
|
|||
| | Tx | OpenTX Bootloader | PC OS | Add PC Driver | | |||
| | Tx | OpenTX Bootloader | Flash method | | |||
There was a problem hiding this comment.
I deliberately chose the Add PC driver because users are reading about zadig and installing it... the idea of the table is that from the user point of view do I have to go get and install drivers.... no an under the hood technical document.... the table was posted in issues and discussed... consensus reached and then I posted the changes here.... I neither agree nor disagree with your changes... it is a different style....
There was a problem hiding this comment.
I wanted to be precise as the flash method is dfu-util even under windows.
companion/flashing.md
Outdated
| @@ -2,11 +2,11 @@ | |||
|
|
|||
| ### Are Additional Drivers Required? | |||
There was a problem hiding this comment.
Different style.... up to you... I obviously prefer my style but you have final say...
There was a problem hiding this comment.
You removed that part, not me :)
|
could this be accepted and closed? |
|
|
||
| There are two options to write the firmware: | ||
| * Using The Bootloader Menu | ||
| * Using Companion |
There was a problem hiding this comment.
This is not accurate!
First using dfu-util on Windows requires Zadig driver. So they are tied together. On Linux/MAC there is no need for Zadig driver (since driver is built into the kernel), only dfu-util is needed.
Flashing from Companion, these are possible ways:
- radio off - connect to computer - you are in STM Bootloader - Companion auto detects this and uses zadig/dfu-util to flash
- radio on with trim held inwards - you are in OpenTX Bootloader, connect to computer. Now you have two sub choices:
- either flash directly from Companion - this will work without any drivers, the bin file is copied to special file (using mass storage USB mode) that represents the flash of the radio.
- or copy the file on the SD card (via file manager), disconnect radio - use menu in OpenTX Bootloader to flash it.
Then there is also procedure to update the OpenTX Bootloader itself. It is similar to the last option above, just the flashing is done from the regular OpenTX, using the same file.
There was a problem hiding this comment.
So what is the goal of this section?
For me the goal is to guide users to get things done; not list every single technical way things can be done. These extra ways can be in an advanced trouble shooting section.
When it says there are two options to write the firmware it is under the sentence connect the transmitter to the computer in boot loader mode. Then there will be a boot loader screen image and then the rest of that text.
There was a problem hiding this comment.
It does not need to explain every detail. But what it explains should be correct.
There was a problem hiding this comment.
Agreed...
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
So when the Tx is turned on in boot loader moder this screen appears
Now there are two choices
Write the firmeware using that menu
Plug in the usb cable and use companion to write the firmware
What is not accurate? What do I need to change?
It is formatted easier to read here
http://rcdiy.ca/opentx-guide/introduction-to-opentx-companion/#Writing_The_OpenTX_Firmware
There was a problem hiding this comment.
We could add a separate section on boot loader... what it is and the ways it get updated...
| * When the “Writing Complete” message is displayed press EXIT | ||
| * Power the transmitter off | ||
|
|
||
| ## Using Companion (dfu-util) |
There was a problem hiding this comment.
This section is wrong.
In order for Companion to use dfu-util/zadig the radio has to be in STM Bootloader. So the radio has to be OFF and then connected to computer.
What you describe below is also possible, using OpenTX Bootloader like you described above. But in this case dfu-util/zadig is not used. This method uses USB mass storage mode (that is implemented by the OpenTX Bootloader) so no special driver needed for this.
There was a problem hiding this comment.
I think the confusion is that we have writing firmware under the driver section... the writing firmware may be clearer if put in its own section... When I wrote the writing firmware instructions I wrote if for a majority audience of FrSKY Tx purchased today and going forward... well purchased within the last year... for this audience informaing them about dfu/zadig etc. is unnecessary and adds confusion... many users forst want to know how to do something and only want to know the why and underlying details later on out of curiosity or have problems... This section makes more sense when arranged as it is in this article
http://rcdiy.ca/opentx-guide/introduction-to-opentx-companion/
Where I state
Transmitter Read & Write
Connecting The Transmitter In Bootloader Mode
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 which is covered here (link).
So how do I remove this section from here while retaining the other edits that have passed?
There was a problem hiding this comment.
I've browsed trough your page (link above) and there instructions are much more clear. I agree that skipping whole dfu-util/zadig is a good thing.
But on the other hand dfu-util/zadig has to be documented somewhere because it is needed for X12 and can be helpul/needed for X9D.
So how do I remove this section from here while retaining the other edits that have passed?
Just move the dfu-util/zadig to a separate section.
| * When the “Writing Complete” message is displayed press EXIT | ||
| * Power the transmitter off | ||
|
|
||
| ## Using Companion (dfu-util) |
There was a problem hiding this comment.
Ahh... I went back up and noticed this table which is not how I wrote it....
| 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 |
| X9E | 2.x | Any |
| X12S | 2.2 + later | Dfu-util |
I wrote is as below after gaining a consensus here
#24
Is Zadig required
| Tx | OpenTX Boot Loader | 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. (Need some wording for linux?)
The difference is
- do I as a user need to install a driver
versus
- telling me the user what is being used....
I wrote the rest of the instructions in the context on how to get something done without the what is being used....
So should I just close this pull request?
Or will someone fix its...
The way it is now we have mixed two different approaches which is beyond me to fix...
There was a problem hiding this comment.
Your last table looks good.
Still I hope you realize that for example a 9XE with 2.x can also be written with dfu-util. Perhaps your way of mentioning only no driver needed is more appropriate since it is less confusing to the user. But the fact is that all radios in the above table regardless of the OpenTX version installed support dfu-util/zadig method, just that some of them also support no driver needed method.
|
I would like to point out that we really appreciate your work on documentation. As you can see it is not easy and fun, that is why we don't like to do it 😛 |
|
Thanks |
|
I am reoping this since I think the changes are good and just need some more work. If you do not want to that work, it is fine with me but someone still use this as basis. |
As per #24
The two download sections 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.