search

nullboundary / Triggertrap

Triggertrap is an universal camera trigger.
http://triggertrap.com/
GNU General Public License v3.0
8 stars 29 forks source link

To-Do: Tidy code and prepare for release #27

Open Triggertrap opened 12 years ago

Triggertrap commented 12 years ago

Just adding a quick to-do here so we don't forget:

We need to prepare the code for release before we ship the final version of the code on board all the triggertraps, including giving all the in-line comments a once-over to make sure they are all clear and make sense. I'm happy to go through and do that at the end (the comments and inline help, not the code tidying - I'd probably break stuff), so when we get that far, I'm happy to pull a version of the code and push it back in with some more extended help built in.

Please just let me know when that's ready to happen, and I'll do it!

~haje

nullboundary commented 12 years ago

TTConfig.h is looking very good. If we could have similar heavy commenting for auxiliary.h and TriggerTrap.h it would be very good. Also I imagine we will need to create some API docs sometime soon, correct? I am guessing written up by hand similar in style to the arduino website?

Triggertrap commented 12 years ago

I don't really understand Triggertrap.h and Auxiliary.h in the same way that I was able to understand the config file.

If you could add some additional comments about how to use it, that'd be great.

As for API - yes, we probably should do that.

I think perhaps the best way to do this would be to add a new mode (Manual Trigger, perhaps? Press up or to trigger? Or a long exposure mode, where someone chooses how many seconds exposure they want, then when they press start, the Triggertrap does an exposure of that many seconds? Whatever, doesn't really matter - it's the process that is important), and document how you can do that...?

At least, we should document:

Or similar.