Developers Documentation
Is there a group/person working on, or is anyone interested in working on, developers documentation?
I'll start by saying I'm new to this project.
So, as a way of getting familiar with everything, I've been studying both the hardware and software by reading data sheets on all the chips and doing a code review of all the code.
If anyone is working on documentation I'd like to help. Here is an outline of what I'm working on.
1) Block diagram of the hardware communications from chip level.
This should be combined with the schematic and a short / long description of how the electronics function.
2) Wiring diagram and photos of how everything connects.
This might include multiple examples showing a minimum configuration and a full configuration. It should also show some examples of how the system could be expanded.
3) Block diagram of code functions outline.
This is not a users manual. It would not cover normal operation procedures. This would describe the internal workings of the code.
4) Code descriptions and analysis.
How is the system initialized?
How is data collected from the censors?
How are flight controls manipulated?
What are the functions used to maintain level flight?
What happens if the code crashes?
Given the Min/Max values of all inputs, what happens through all values? Any divide by zero problems?
5) Logs and telemetry.
What data is maintained by the system?
What data is transmitted to the ground and how can it be analyzed?
I'll start by saying I'm new to this project.
So, as a way of getting familiar with everything, I've been studying both the hardware and software by reading data sheets on all the chips and doing a code review of all the code.
If anyone is working on documentation I'd like to help. Here is an outline of what I'm working on.
1) Block diagram of the hardware communications from chip level.
This should be combined with the schematic and a short / long description of how the electronics function.
2) Wiring diagram and photos of how everything connects.
This might include multiple examples showing a minimum configuration and a full configuration. It should also show some examples of how the system could be expanded.
3) Block diagram of code functions outline.
This is not a users manual. It would not cover normal operation procedures. This would describe the internal workings of the code.
4) Code descriptions and analysis.
How is the system initialized?
How is data collected from the censors?
How are flight controls manipulated?
What are the functions used to maintain level flight?
What happens if the code crashes?
Given the Min/Max values of all inputs, what happens through all values? Any divide by zero problems?
5) Logs and telemetry.
What data is maintained by the system?
What data is transmitted to the ground and how can it be analyzed?
Replies to This Discussion
-
Permalink Reply by Joel on -
I'm so for this. At least functions outline. I'm just now trying to start editing some code and I think that any documentation even an outline would be helpful and would bring more people into development which would hopefully lead to a better product!
-
Permalink Reply by Ken on -
That would be lovely. The answer to so many questions here is, "read the manual." But that really only tells you how to put it together and leaves you in the dark about so much of the operation, customization, etc. etc.
-
DeveloperPermalink Reply by Doug Weibel on -
If you are up for the job, contact Chris. He will put you in touch with the teams developing the wiki's (manuals).
More content would be appreciated ;)
-
3D RoboticsPermalink Reply by Chris Anderson on -
Please PM me if you'd like to volunteer for this job. Right now we're assuming that people who want this level of detail are able to read the comments in the code (it's pretty well commented) and use that as documentation, but I agree it would be helpful to break that out in more functional block diagrams. The dev team is not going to do that, but it is a great way for the community to contribute.
-
Permalink Reply by Mark Grennan on -
I agree the code is well commented. And there is no better documentation then the code itself (being an Open Source guy). But I like giving back to the community with documentation. (Linux Firewall HOWTO) As I push the big rock up the learning curve hill, I like to plow off some of it for the next guy.
Sure. Gulp.. I'll v v v volunteer.
-
3D RoboticsPermalink Reply by Chris Anderson on -
Excellent. I'll PM you with my email address and details.
-
Permalink Reply by Mark Grennan on
-
Oh. I forgot to tell you I'm also working on a general FAQ as well. Taken from the list of questions I had when I started.
-
Permalink Reply by Yousef Yousef on -
my final grad project is making a uav, I've done everything on the practical side however i need to understand the code for my documentation. I'm not a programming wiz at all so its all really hard for me if you do have any block diagrams for the codes it would be really good help for me..thanks :)
Social Networking
Top Content
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
-
Andropilot Users Group
203 members
-
Moderators
24 members
-
ArduRover User Group
207 members
-
Japan ArduCopter Group
58 members
-
ArduCopter User Group
1355 members
Advertisement
© 2013 Created by Chris Anderson.
Powered by
