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?

You need to be a member of diydrones to add comments!

Join diydrones

Email me when people reply –

Replies

  • 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 :)

  • 3D Robotics
    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.
  • Developer
    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 ;)
  • 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.
  • 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!
This reply was deleted.

Activity

DIY Robocars via Twitter
RT @SmallpixelCar: Wrote a program to find the light positions at @circuitlaunch. Here is the hypothesis of the light locations updating ba…
16 hours ago
DIY Robocars via Twitter
RT @SmallpixelCar: Broke my @HokuyoUsa Lidar today. Luckily the non-cone localization, based on @a1k0n LightSLAM idea, works. It will help…
Thursday
DIY Robocars via Twitter
@gclue_akira CC @NVIDIAEmbedded
Wednesday
DIY Robocars via Twitter
RT @luxonis: OAK-D PoE Autonomous Vehicle (Courtesy of zonyl in our Discord: https://discord.gg/EPsZHkg9Nx) https://t.co/PNDewvJdrb
Wednesday
DIY Robocars via Twitter
RT @f1tenth: It is getting dark and rainy on the F1TENTH racetrack in the @LGSVLSimulator. Testing out the new flood lights for the racetra…
Wednesday
DIY Robocars via Twitter
RT @JoeSpeeds: Live Now! Alex of @IndyAChallenge winning @TU_Muenchen team talking about their racing strategy and open source @OpenRobotic…
Nov 20
DIY Robocars via Twitter
RT @DAVGtech: Live NOW! Alexander Wischnewski of Indy Autonomous Challenge winning TUM team talking racing @diyrobocars @Heavy02011 @Ottawa…
Nov 20
DIY Robocars via Twitter
Incredible training performance with Donkeycar https://www.youtube.com/watch?v=9yy7ASttw04
Nov 9
DIY Robocars via Twitter
RT @JoeSpeeds: Sat Nov 6 Virtual DonkeyCar (and other cars, too) Race. So bring any car? @diyrobocars @IndyAChallenge https://t.co/nZQTff5…
Oct 31
DIY Robocars via Twitter
RT @JoeSpeeds: @chr1sa awesomely scary to see in person as our $1M robot almost clipped the walls as it spun at 140mph. But it was also awe…
Oct 29
DIY Robocars via Twitter
RT @chr1sa: Hey, @a1k0n's amazing "localize by the ceiling lights" @diyrobocars made @hackaday! It's consistently been the fastest in our…
Oct 25
DIY Robocars via Twitter
RT @IMS: It’s only fitting that @BostonDynamics Spot is waving the green flag for today’s @IndyAChallenge! Watch LIVE 👉 https://t.co/NtKnO…
Oct 23
DIY Robocars via Twitter
RT @IndyAChallenge: Congratulations to @TU_Muenchen the winners of the historic @IndyAChallenge and $1M. The first autonomous racecar comp…
Oct 23
DIY Robocars via Twitter
RT @JoeSpeeds: 🏎@TU_Muenchen #ROS 2 @EclipseCyclone #DDS #Zenoh 137mph. Saturday 10am EDT @IndyAChallenge @Twitch http://indyautonomouschallenge.com/stream
Oct 23
DIY Robocars via Twitter
RT @DAVGtech: Another incident: https://t.co/G1pTxQug6B
Oct 23
DIY Robocars via Twitter
RT @DAVGtech: What a great way to connect why @diyrobocars community is so valuable and important! Have to start somewhere @IndyAChallenge…
Oct 23
More…