WPI Robotics Library C/C++ Edition documentation

[BradAMiller]

Everyone has been asking for documentation to begin to understand the direction we have been taking for the Robotics Library. We've been holding back until we thought it was stable enough to not confuse everyone.

So with the understanding that it is not final, we are still fixing bugs, and making final changes we would like to publish the doxygen output for the C/C++ library. Here are some caveats on the documentation:

1. It's automatically generated from the comments in the code. We are planning on going back and refining it in those cases where it might not make a lot of sense.
2. There will also be a users guide that really isn't ready to publish yet that will augment this stuff.
3. The PID and Task classes aren't finished and will be changing.
4. There will be C functions that "wrap" most of the C++ features. Those wrapper functions aren't included because we're waiting for the final C++ code to settle down.

With that said, here's the temporary link to the docs. Please post comments/questions to this forum that developers and beta teams are monitoring.

Doxygen output

This is subject to change as we continue to approach the final release.

[Booksy]

Does the victor class mean that jaguars and victors will be legal, or is that not worked out yet?

[BradAMiller]

Does the victor class mean that jaguars and victors will be legal, or is that not worked out yet?

That's up to the Game Design Committee, but the code supports both. There are different classes to support the higher update rates that the Jaguars can support.

[The Lucas]

Brad I am having some trouble with your website in FireFox 3.0, but it works in IE7

The problem I have in Firefox is when I click on a link in the left frame it doesn't load into the right frame, it just reloads the index. However, I can Ctrl-Click a link in the left frame and open it as a new tab successfully. You might want to check it with FF yourself.

Thanks for the documentation, what I have read so far is good.

-Brian Lucas

[Booksy]

Brad I am having some trouble with your website in FireFox 3.0, but it works in IE7

The problem I have in Firefox is when I click on a link in the left frame it doesn't load into the right frame, it just reloads the index. However, I can Ctrl-Click a link in the left frame and open it as a new tab successfully. You might want to check it with FF yourself.

Thanks for the documentation, what I have read so far is good.

-Brian Lucas

I've being using FF3 with this site on my mac with no problems.

[Booksy]

Sorry to double post, but... The more I look at this site the better I think it is. I don't even care how final it is, just the perspective of what I'm going to be dealing with. Thanks for the link.

[The Lucas]

I've being using FF3 with this site on my mac with no problems.

I tried it on my laptop with FF 3 and it works. Now I have to figure out what is wrong with my FF install on my office computer. I probably should update TabsMixPlus extension

EDIT: FYI it was the Skype Extension, it cause other problems too.

Sorry,
Brian

[gene f]

I see a task class, is there also going to be other OS primatives available like mail boxes, semaphores, timers, etc?

Also is the underlying OS a version of something that's publicly available like say Micro C/OSII?

[Kate]

Does the victor class mean that jaguars and victors will be legal, or is that not worked out yet?

Yes, Victors will be permitted for the 2009 FRC season. This information was released in the Q&A on the WPI FIRST Robotics Resource Center. Click here for the .pdf of the Technical Q&A..

[BradAMiller]

I see a task class, is there also going to be other OS primatives available like mail boxes, semaphores, timers, etc?

Also is the underlying OS a version of something that's publicly available like say Micro C/OSII?

The underlying OS is VxWorks and it has all the interprocess communications functions available. Currently we only have the Task class and another class for handling critical regions using semaphores. But you can use the others by calling the C functions provided by Wind River.