open9x and companion9x docs

openTx has introduced a range of new features, ideas and bling. It is fast becoming the firmware of choice for many users. openTx will run on ALL current hardware platforms, including the gruvin9x and sky9x boards. Work has already started to support the new FrSky X9D radio!
bertrand35
9x Developer
Posts: 2764
Joined: Fri Dec 30, 2011 11:11 pm
Country: -

open9x and companion9x docs

Post by bertrand35 » Thu Nov 08, 2012 10:12 am

Here is the new "official" documentation.
http://code.google.com/p/open9x/downloa ... f&can=2&q=
It is in french. A group here in france starts working on an english translation.
Thanks Franck for this huge work!
Bertrand.

Note for translators: Franck has commited under SVN a zip file where all parts of the doc are splitted, it should make things easier to maintain!


User avatar
Rob Thomson
Site Admin
Posts: 4542
Joined: Tue Dec 27, 2011 11:34 am
Country: United Kingdom
Location: Albury, Guildford
Contact:

Re: open9x and companion9x docs

Post by Rob Thomson » Thu Nov 08, 2012 7:27 pm

Would it not be simpler to just do this all ok the wiki?
Slope Soaring, FPV, and pretty much anything 'high tech'
...........if you think it should be in the wiki.. ask me for wiki access, then go add it!

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Thu Nov 08, 2012 7:55 pm

I'd agree... would be easier for people to just change a word here and there without needinf a full repack of the ZIP and PDF...

User avatar
Rob Thomson
Site Admin
Posts: 4542
Joined: Tue Dec 27, 2011 11:34 am
Country: United Kingdom
Location: Albury, Guildford
Contact:

Re: open9x and companion9x docs

Post by Rob Thomson » Thu Nov 08, 2012 8:10 pm

Only hard part with the wiki is multi language. I must check if something exists to handle this!
Slope Soaring, FPV, and pretty much anything 'high tech'
...........if you think it should be in the wiki.. ask me for wiki access, then go add it!

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Thu Nov 08, 2012 8:14 pm

Could always have X different pages, one for each language. Pretty common on Wikis, doesn't seem to be so much of a problem...


User avatar
Rob Thomson
Site Admin
Posts: 4542
Joined: Tue Dec 27, 2011 11:34 am
Country: United Kingdom
Location: Albury, Guildford
Contact:

Re: open9x and companion9x docs

Post by Rob Thomson » Thu Nov 08, 2012 9:01 pm

Just been looking at the media wiki options.. and multi lingual support is carp!

Maybe that is the best option :-)
Slope Soaring, FPV, and pretty much anything 'high tech'
...........if you think it should be in the wiki.. ask me for wiki access, then go add it!

FAD
Posts: 6
Joined: Mon Oct 15, 2012 6:31 pm
Country: -

Re: open9x and companion9x docs

Post by FAD » Thu Nov 08, 2012 10:26 pm

Hi all,

I'm Franck, the writer of the french manual.

To my opinion, wiki is not the best way to make user guide, for three reasons :
- a software like OoO is much easier and faster to make or modify a user guide : you can drag and drop pictures (or screenshoots...), layout and synopsis are automatical, etc.
- you will always need OoO to make synoptics or diagrams, and theses files are to be stored somewhere
- for radio users, a .pdf file is the simplest, to read offline or to print

Regards,
Franck

User avatar
zdenek
Posts: 32
Joined: Tue Aug 14, 2012 1:02 pm
Country: -
Location: Hlubocinka
Contact:

Re: open9x and companion9x docs

Post by zdenek » Fri Nov 09, 2012 6:38 pm

bertrand35 wrote:... A group here in france starts working on an english translation...
This is great news! Finally I get rid of the responsibility for the maintenance of the English manual. And readers get rid of my bad English.

So even publish final editing my English manual and stop it updated. I will write less and fly more. :)

Update: Last version just published.
Zdenek
Hlubocinka, Czech Republic

User avatar
Scott Page
Posts: 864
Joined: Wed Dec 28, 2011 3:32 am
Country: United States
Location: Tri-Cities, Washington State

Re: open9x and companion9x docs

Post by Scott Page » Sat Nov 10, 2012 7:37 am

My two cents: I don't dislike the wiki - but I do like docs because I save them to .pdf and put on my ipad for reference when I'm @ the field.

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Sat Nov 10, 2012 8:24 am

You can "view printable version" of the wiki and save it to PDF if you like too. Editing isn't that hard, you upload the pics (screenshots etc) and simply copy/paste the tags where you want.

User avatar
dvogonen
Posts: 453
Joined: Tue Jan 31, 2012 9:38 pm
Country: Sweden
Location: Stockholm

Re: Sv: open9x and companion9x docs

Post by dvogonen » Sat Nov 10, 2012 12:16 pm

My take on Wikis as opposed to documents is that both have strengths and weaknesses. Wikis are great for documenting work in progress. They grow and evolve over time and many people can contribute. Perfect for things like howto descriptions etc.
But Wikis are less good for making end user documentation like user manuals. Perhaps as a way of gathering material, but not for producing the final result. Wikis are by nature never completed and the quality of information is always uneven since there is no such thing as a final editor. There will always be something that is wrong or missing, while other stuff is perfect. This is not what you are after in a manual.

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Sun Nov 11, 2012 1:42 pm

I have started porting the manual to the Wiki to see what it would look like. Frankly, I don't think it's any worse than the word processor / PDF approach in terms of output, AND we get the benefit of svn and diff tools...

http://code.google.com/p/open9x/wiki/Open9x_Manual_FR

User avatar
Rob Thomson
Site Admin
Posts: 4542
Joined: Tue Dec 27, 2011 11:34 am
Country: United Kingdom
Location: Albury, Guildford
Contact:

Re: open9x and companion9x docs

Post by Rob Thomson » Sun Nov 11, 2012 5:38 pm

I am all for it being in the wiki. Much easier in the long term to keep updated.

I will start an English version sometime this week.

I think most people are initially scared of learning the wiki formatting options. But really... It is not that hard! Just a bit quirky :)

Although... I do prefer it if the manual was on the 9xforums wiki. It allows all members in here to contribute. That has to be a good thing!
Slope Soaring, FPV, and pretty much anything 'high tech'
...........if you think it should be in the wiki.. ask me for wiki access, then go add it!

User avatar
zdenek
Posts: 32
Joined: Tue Aug 14, 2012 1:02 pm
Country: -
Location: Hlubocinka
Contact:

Re: open9x and companion9x docs

Post by zdenek » Sun Nov 11, 2012 9:12 pm

9xforums MediaWiki has the advantage that it is probably the most widely used of all wikis, so a lot of people who know how to work with it well (like me :)). Wiki on code.google.com other hand, is perfectly integrated into the infrastructure code.google.com.
Last edited by zdenek on Wed Nov 14, 2012 10:17 am, edited 1 time in total.
Zdenek
Hlubocinka, Czech Republic

User avatar
Spoogy
Posts: 305
Joined: Wed Dec 28, 2011 6:27 pm
Country: -

Re: open9x and companion9x docs

Post by Spoogy » Sun Nov 11, 2012 10:08 pm

In 9x wikipages if you click link to the english manual you will get an error: 404 URL not found (that's the link -> http://open9x.googlecode.com/files/Open9X%20Manual.pdf)
What goes up, must come down. -Isaac Newton
OpenTX - expanding possibilities

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Sun Nov 11, 2012 10:16 pm

It's here at the moment, but will certainly move again soon: http://code.google.com/p/open9x/downloa ... Manual.pdf

User avatar
zdenek
Posts: 32
Joined: Tue Aug 14, 2012 1:02 pm
Country: -
Location: Hlubocinka
Contact:

Re: open9x and companion9x docs

Post by zdenek » Sun Nov 11, 2012 11:06 pm

Spoogy wrote:In 9x wikipages if you click link to the english manual you will get an error: 404 URL not found (that's the link -> http://open9x.googlecode.com/files/Open9X%20Manual.pdf)
It's my error. I edit manual under Windows and upload it from Ubuntu. So, there is a case mismatch with "X" character. Most of links at forums are now to http://open9x.googlecode.com/files/Open9x%20Manual.pdf, in the wiki is old one. I will try contact birky to correct it, I don't have permission on wiki.
Zdenek
Hlubocinka, Czech Republic

User avatar
Spoogy
Posts: 305
Joined: Wed Dec 28, 2011 6:27 pm
Country: -

Re: open9x and companion9x docs

Post by Spoogy » Sun Nov 11, 2012 11:46 pm

Kilrah wrote:It's here at the moment, but will certainly move again soon: http://code.google.com/p/open9x/downloa ... Manual.pdf

Yes I know but the link on the wiki pages is wrong. That's what I meant to point out and as zdenek said he will try to get it fixed. ;)
What goes up, must come down. -Isaac Newton
OpenTX - expanding possibilities

User avatar
zdenek
Posts: 32
Joined: Tue Aug 14, 2012 1:02 pm
Country: -
Location: Hlubocinka
Contact:

Re: open9x and companion9x docs

Post by zdenek » Mon Nov 12, 2012 12:39 am

Fixed. Thank's, birky!
Zdenek
Hlubocinka, Czech Republic

Helle
Posts: 577
Joined: Sat Jul 21, 2012 7:08 am
Country: -

Re: open9x and companion9x docs

Post by Helle » Thu Nov 22, 2012 7:33 pm

Hy zdenek,

I thnik your englisch manual is the best we have!

same details description I am missing

Page 28
12 Protokoll
PPM PPM16 PPMsim
and what happen with the PPM at Power on or Power off
PPM to HF-Modul and PPM to DSC jacket output

13 There should be a diagramm of a PPM Signal
too explain a Frame, a Impuls, a Channel , a positv or a negativ PPMsignal

Helle

User avatar
zdenek
Posts: 32
Joined: Tue Aug 14, 2012 1:02 pm
Country: -
Location: Hlubocinka
Contact:

Re: open9x and companion9x docs

Post by zdenek » Fri Nov 23, 2012 11:46 pm

Helle wrote:... your englisch manual is the best we have!...
Yes, given that another English manual does not exist yet, mine is really the best :).
But my English is still terrible.
Helle wrote:...and what happen with the PPM at Power on or Power off
PPM to HF-Modul and PPM to DSC jacket output...
It do not know, I do not have the storage oscilloscope. Does anyone know?
Helle wrote:Page 28
12 Protokoll
PPM PPM16 PPMsim
I will try to add in the next version (if there will be my other version). Does anyone know what this is PPMSim?
Helle wrote:13 There should be a diagramm of a PPM Signal
too explain a Frame, a Impuls, a Channel , a positv or a negativ PPMsignal
I think that anyone who would like to change these parameters should know what he's doing. But I will try to get or produce a picture with explanation and put it into the next version of the manual (if there will be any).

For now, I give here a few links:
http://trandi.files.wordpress.com/2011/ ... iagram.jpg
http://www.aerodesign.de/peter/2000/PCM/frame_ppm.gif
http://www.pabr.org/pxarc/doc/pxarc.en.html
Last edited by zdenek on Sat Nov 24, 2012 12:42 am, edited 2 times in total.
Zdenek
Hlubocinka, Czech Republic

User avatar
Rob Thomson
Site Admin
Posts: 4542
Joined: Tue Dec 27, 2011 11:34 am
Country: United Kingdom
Location: Albury, Guildford
Contact:

Re: open9x and companion9x docs

Post by Rob Thomson » Sat Nov 24, 2012 12:09 am

Ppmsim pushes all the signal out of the trainer port, rather than through the RF module. :-)

Sent from my Nexus 7 using Tapatalk 2
Slope Soaring, FPV, and pretty much anything 'high tech'
...........if you think it should be in the wiki.. ask me for wiki access, then go add it!

User avatar
zdenek
Posts: 32
Joined: Tue Aug 14, 2012 1:02 pm
Country: -
Location: Hlubocinka
Contact:

Re: open9x and companion9x docs

Post by zdenek » Sat Nov 24, 2012 12:28 am

Rob Thomson wrote:Ppmsim pushes all the signal out of the trainer port, rather than through the RF module. :-)
This means that:

* PPM, PPM16 send a signal to the RF module, as well as to trainer port
* PPMSim disconnects RF module?

Do I understand correctly?

Sorry, this is a little bit off topic... Maybe this should be moved to another topic ...
Zdenek
Hlubocinka, Czech Republic

User avatar
Rob Thomson
Site Admin
Posts: 4542
Joined: Tue Dec 27, 2011 11:34 am
Country: United Kingdom
Location: Albury, Guildford
Contact:

Re: open9x and companion9x docs

Post by Rob Thomson » Sat Nov 24, 2012 2:58 am

Ppmsim -= Ppm simulator.

No radio signal out to model, everything down the wire to a pc simulator. Normally used with a sim or when using 9xas a buddy box for a trainer.

That help?

Sent from my Nexus 7 using Tapatalk 2
Slope Soaring, FPV, and pretty much anything 'high tech'
...........if you think it should be in the wiki.. ask me for wiki access, then go add it!

Helle
Posts: 577
Joined: Sat Jul 21, 2012 7:08 am
Country: -

Re: open9x and companion9x docs

Post by Helle » Sat Nov 24, 2012 6:35 am

Hy zdenek,

PPM all output goes to the HF-Modul depending on channels 4,6,8,10, Frametime 22,5ms, Pulseseparator 300us , +/- edge

PPM16 Channel 1 to 8 goes out to the HF-Modul and paralell Channel 9 to16 goes out to the DSC jacket, so you can connect there a second HF-Modul and you have really 16 channels Transmitter.

PPMSIM all output goes to the DSC Jacket no one to the HF-Modul, depending of Channels 4,6,8,10 Frameteime, Pulse. +/-
for PC-Simulator or as a trainer output

DSM2 work with other Framesets I think 18 or 19 ms and Impulstime, who does ist know in detail?


Both diagramms are well known
first is a Standard 22ms 8 Channel, Positiv with TX PPM and RX Servo-Impuls
second ist a negativ PPM TX from eraly Days of FM-Modulation the HF -Modul

lots of other TX have other Min, Mid and Max Impulstimes Graupner, Multiplex, Futaba
1ms 1,5ms 2ms or 0,85ms, 1,5ms, 2,15ms depending of 100% 125% or 150% DR/Mix
and other Pulsseparator 250us 300us ... to 400us
most have round of 20 to 22ms Frametime
So sometimes its importand to know how to work together with other Reveivers


Helle
Last edited by Helle on Sat Nov 24, 2012 7:23 am, edited 2 times in total.

Helle
Posts: 577
Joined: Sat Jul 21, 2012 7:08 am
Country: -

Re: open9x and companion9x docs

Post by Helle » Sat Nov 24, 2012 7:19 am

Hy,

At a Frametime of 22ms you can get max 9 cannels not more! (in one Frame!)

9x2ms=18ms inclusive the impulsseparator 300us
Frame separator min twice of max Impuls 2*2ms = 4ms
so you have max 9 channels!
18ms +4 ms =22ms
this is/was a "Standard" Frametime all FM-receivers work

But with modern uC you could generate a other PPM Protokoll
Exampple:
100us Separator,
Channel Impuls Min 300us Mid 500us Max 800us
Frametime 12ms
Resolution 2048bit

12*800us=9,6ms
Frame separator minimum is twice of max Impuls 2*800us=1,6ms
9,6ms + 1,6ms= 11,2ms

So in 12ms you can send 12 channels to a HF-Modul
For example ZD T7AH-2400 has a Framerate of 11,5ms and send 7 or 9 channels

And then the HF-Modul is sendeing at 2,4GHz all as a serieall datapacket not as a simple FM-Modulation
if you would not send a PPM-frameset from the Tx-uC to the HF-uC Modul
you could use a sereiell Protokoll and Transmit 32, 64, or 128 channels with no Problem
this will be the futur, PPM Framesets are dead

Helle


mfg

User avatar
Scott Page
Posts: 864
Joined: Wed Dec 28, 2011 3:32 am
Country: United States
Location: Tri-Cities, Washington State

Re: open9x and companion9x docs

Post by Scott Page » Tue Nov 27, 2012 7:46 am

When setting custom switches the following choices are available. Some seem obvious - but many are .. alluding me. I think this would be good info for the Wiki -- I've taken my buest guesses -- but obviously some of these are just fooling me.


Rud = value of rudder stick between -100 and 100
Ele = Value of elevator stick between -100 and 100
Thr = Value of throttle stick between between -100 and 100
Ail = Value of Aileron Stick between -100 and 100
P1 = Value of Pot 1 between -100 and 100
P2 = Value of Pot 2 between -100 and 100
P3 = Value of Pot 4 between -100 and 100
Rea ??
Reb ??
TrmR ??
Timer2 = Timer 2 -- units?
Tx - Transmitter RSSI between 0 and 100
Rx - Receiver RSSI between 0 and 100
A1 = ?
A2 =
Alt = Altitude -- numbers from vario? what range?
Rpm - RPM -- true RPM if blades are set right? What range?
Fuel -- is this fuel sensor and it is a percentage?
T1 - No idea
T2 - No idea
Speed - Derived from GPS?? what units?
Dist -- Derived from GPS?? what units
GPS Alt -- apparently Altitude from GPS -- what units?
Cell -- apparently volts -- but of what?
Cels -- also apparently volts but of what
Vfas -- is this voltage detected by the FAS100 or FAS40? or what?
Curr -- Assume current in amps being measured by FAS
CNsp -- No idea
Powr -- Is this a derived number? What is the source and the unit?

I'd like to see a display of all cells voltage in the lipo -- I'd expect to see some unit like C1, C2, C3, C4, C5, C6, but perhaps you have a slicker way of doing this.
3.png

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Tue Nov 27, 2012 11:23 am

Rea,b: Rotary encoders a and b if installed
TrmR,E,T,A: The 4 trims
Tmr1,2 Timers in seconds
A1,2: Analog ports on frsky receivers
Alt: Frsky alt sensor
Rpm: frsky rpm sensor, no of blades adjusted on telemetry page
Fuel: frsky fuel sensor
T1,2: frsky temp sensors 1 and 2
Spd, GAlt, Dist: From frsky GPS, units metric unless the "imperial" compilation option is used
Cell: Lowest cell on FLVS-01
Cels: Sum of all cells on FLVS-01
Vfas: FAS-100 voltage
Curr: Current, source configured on telemtry page (FAS or analog)
Cnsp: mAh used totalizer
Powr: Power, voltage source used is configured on telemetry page, current as above
Individual cells not accessible in custom switches but already displayed on the first page (on the right)
Attachments
screenshot-1.png
screenshot-1.png (1.21 KiB) Viewed 16051 times

User avatar
Scott Page
Posts: 864
Joined: Wed Dec 28, 2011 3:32 am
Country: United States
Location: Tri-Cities, Washington State

Re: open9x and companion9x docs

Post by Scott Page » Tue Nov 27, 2012 7:13 pm

Kilrah wrote:Rea,b: Rotary encoders a and b if installed
TrmR,E,T,A: The 4 trims
Timer1,2 Timers in seconds
A1,2: Analog ports on frsky receivers
Alt: Frsky alt sensor
Rpm: frsky rpm sensor, no of blades adjusted on telemetry page
Fuel: frsky fuel sensor
T1,2: frsky temp sensors 1 and 2
Spd, GAlt, Dist: From frsky GPS, units metric unless the "imperial" compilation option is used
Cell: Lowest cell on FLVS-01
Cels: Sum of all cells on FLVS-01
Vfas: yep
Curr: Current, source configured on telemtry page (FAS or analog)
Cnsp: mAh used totalizer
Powr: Power, voltage source used is configured on telemetry page, current as above
Individual cells not accessible in custom switches but already displayed on the first page (on the right)

You sir, are a gentleman and a scholar. Whoever has Wiki access -- me thinks that would be a handy table to include (unless I missed it and it's there).

I have other questions -- in fact I have a word document of my questions -- but I try to solve them first myself.. This one is going to be printed out.

User avatar
Kilrah
Posts: 10795
Joined: Sat Feb 18, 2012 6:56 pm
Country: Switzerland

Re: open9x and companion9x docs

Post by Kilrah » Tue Nov 27, 2012 7:37 pm

Scott Page wrote:me thinks that would be a handy table to include (unless I missed it and it's there).
It's not, but that's been added to my todo list for the manual ;)


Post Reply

Return to “openTx”