KISS-C Manual Changes

8 replies [Last post]
redbaron148
Title: Former Botball Youth Advisory Council Member
Joined: 04/22/2009
Posts:
BotPoints: 34
User offline. Last seen 1 year 47 weeks ago.

I know the KISS-C manual isn't perfect (me being the one who edited it...) so this is a forum to post problems and issues with the KISS-C manual. I believe having the problems posted online will help ensure the changes will be made.

Please post any changes you would like to see to the KISS-C Manual and any problems that can be fixed.

stcarlso
Title: NooBot
Joined: 07/17/2010
Posts:
BotPoints: 4
User offline. Last seen 7 years 21 weeks ago.

While the manual is highly informative and useful for someone looking for a basic C tutorial or some of the technical aspects of the sensors, it can be intimidating to those seeking only a basic description of the wait_for_light() or analog10() functions. Several of the new members on my team had little knowledge of Botball basics, and when asked to look at the manual, replied that "the manual doesn't have that information" when in fact it was buried three levels deep in the last tree item on the left.

Condensing the C tutorial into one or two first-level headings and expanding the Botball/CBC function section to several headings would help, as well as providing some examples for the use of Botball and CBC functions. While members unfamiliar with programming in general also need to learn C, they are most likely the types who will read the manual through anyway. A quick reference might also be useful at the very top of the document.

Great job on the manual - with just a few small changes, it can be made better for new and experienced teams alike.

redbaron148
Title: Former Botball Youth Advisory Council Member
Joined: 04/22/2009
Posts:
BotPoints: 34
User offline. Last seen 1 year 47 weeks ago.

Sonar function should be removed, it doesn't seem to function and analog10 is used anyways...

Adam
Title: MiniBot+
Joined: 07/28/2009
Posts:
BotPoints: 74
User offline. Last seen 5 years 33 weeks ago.

There should be a block_servo_done(int port); function.

redbaron148
Title: Former Botball Youth Advisory Council Member
Joined: 04/22/2009
Posts:
BotPoints: 34
User offline. Last seen 1 year 47 weeks ago.

That function does not exist in the kiss-c programming environment. This thread is for suggestions to make the manual itself better, more readable, more logical, etc... not for suggestions for the kiss-c library itself. If you would like to start a thread for the addition of code to the kiss-c library feel free to do so. :)

Another thing to consider is that these servos are not digital servos, ie we cannot get data back from them thus we cannot know when the servo has reached it's goal. The closest thing you could do to simulate a block_servo_done function is to calculate the time it would take the servo to get to that position and just sleep that long.

Adam
Title: MiniBot+
Joined: 07/28/2009
Posts:
BotPoints: 74
User offline. Last seen 5 years 33 weeks ago.

I apologize for the inappropriateness of my last response. On the actual subject i would like to point out that in the manual for sin, cos, tan, and atan, that it says both the input and the output are radians. For sin, cos, and tan, the input is radians while the output is just a ratio(not radians) and vice-verse for atan.

Jeremy Rand
Jeremy Rand's picture
Title: Botball Youth Advisory Council
Joined: 04/03/2009
Posts:
BotPoints: 1168
User offline. Last seen 2 years 29 weeks ago.

Adam, that is not quite correct. Mathematically, radians and unitless numbers are identical, i.e. the angle 3.14rad and the number 3.14 are exactly the same. The radian unit is appended to angles for clarity, but it doesn't affect the result. So, the functions sin/cos/tan accept a unitless number and return a unitless number, same for atan; the manual is correct.

-Jeremy Rand
Senior Programmer, Team SNARC (2012-2013), Norman Advanced (2010-2011), Norman HS (2008-2009), Norman North (2005-2007), Whittier MS (2003-2004)
2012-2013 VP of Tech, 2011 President, Botball YAC (2009-2013)
Mentor, Alcott and Whittier MS

Adam
Title: MiniBot+
Joined: 07/28/2009
Posts:
BotPoints: 74
User offline. Last seen 5 years 33 weeks ago.

I realize that, I was just posting the suggestion since one is intentionally the input/output of an angle while the other is not. I just suggested it for clarity's sake, not as a point of correctness. (will be more clear next time i make a post)

redbaron148
Title: Former Botball Youth Advisory Council Member
Joined: 04/22/2009
Posts:
BotPoints: 34
User offline. Last seen 1 year 47 weeks ago.

That's a good suggestion Adam, that kind of wording issue is exactly what I want to hear about.