Parameters and their meaning: Dynamic Wiki Documentation

 

 

With more than 200 parameters to "tweak", the ardupilot-mega system can be a bit intimidating. Documentation is critical, but in a fast-moving project like APM, it is almost impossible for the documentation to keep up with the code. A major improvement in the code was the addition of inline documentation for the configuration parameters, several months ago. This documentation has been visible recently in the superb new configuration screen in Mission Planner, which provides a detailed description, units, defaults etc. for many key parameters.

 

Now, this documentation can also be found in the Wiki. Best of all, this wiki page is dynamically generated with every single new revision of the code, just like in Mission Planner. As new parameters are added, or existing ones modified, the developers can change a few lines of comments and the wiki page will update to reflect that change, instantly, from code to wiki. 

 

Visit the new dynamic wiki page  Parameters and their meaning

Views: 847

Tags: configuration, documentation, parameters, wiki


3D Robotics
Comment by Chris Anderson on July 8, 2012 at 8:59pm

This is an incredibly useful tool. Huge kudos to Andreas!

Comment by Greg Fletcher on July 8, 2012 at 9:11pm

Excellent work.

Comment by Dror Caspi on July 8, 2012 at 9:20pm

Alt Hold RTL is described twice (?)


Developer
Comment by Andreas M. Antonopoulos on July 8, 2012 at 9:25pm

@Dror  Correct, once in ArduPlane and once in ArduCopter. There is some  overlap, but also some subtle differences. That is why it is organized by vehicle.

Comment by Dror Caspi on July 8, 2012 at 9:43pm

No, under arducopter, one is for RTL and one is for approach.


Developer
Comment by Andreas M. Antonopoulos on July 8, 2012 at 9:49pm

Yup, that's a bug in the documentation of the code. Will be fixed ASAP (and then the wiki will update live).

Already pushed some fixes to ArduPlane flight mode documentation.. should appear in a few minutes

Comment by hazy on July 8, 2012 at 10:04pm

Hi Andreas, what's your suggestion for document localization?

Comment by Hein du Plessis on July 8, 2012 at 10:32pm

Thank you!!

Comment by Perecastor on July 9, 2012 at 12:53am

thanks a lot! 

good job for this wiki!

Comment by Adrian Thomas on July 9, 2012 at 8:40am

Very useful. Shows up anomolies very easily. Two things.

Firstly, centidegrees. Hundreds of a degree or 0.01 degrees might be clearer, at least to me.

Secondly, under flight modes you have:

Value Meaning
0 Manual
1 CIRCLE
2 STABILIZE
5 FBWA
6 FBWB
10 Auto
11 RTL
12 Loiter
15 Guided

The last is a puzzle. It crops up in the Wiki under Geofencing, but I can't find it defined. What is 'Guided' mode, and how does it differ from, say, Auto or RTL?

Comment

You need to be a member of DIY Drones to add comments!

Join DIY Drones

Social Networking

Contests

Season Two of the Trust Time Trial (T3) Contest has now begun. The fourth round is an accuracy round for multicopters, which requires contestants to fly a cube. The deadline is April 14th.

A list of all T3 contests is here

Groups

Advertisement

© 2013   Created by Chris Anderson.   Powered by

Badges  |  Report an Issue  |  Terms of Service