Shop OBEX P1 Docs P2 Docs Learn Events
If a code error is a bug, what is a documentation error? — Parallax Forums

If a code error is a bug, what is a documentation error?

SteveWoodroughSteveWoodrough Posts: 190
edited 2010-03-30 15:23 in Propeller 1
smile.gif·I spent all day Sunday ripping my old BOE Bot apart and mounting the bread board from my PE kit to the BOE Bot chassis.·
Then a CAREFULLY wired the circuit shown in the Propeller Boe-Bot Schematic.spin file.· Each connection was double and triple checked like this thing was going to Mars!· Next I loaded the code into the·EPROM and ....the darn thing ran backwards and was completely unresponsive.· Servos worked (continuously backward) and my scope showed a good signal to the IR LEDS.
·jumpin.gif

·Checked the wiring again.·Yep, I did what the diagram showed.· Aw the heck with it, let's go to bed.....

Monday night I looked and the diagram from the PE Kit labs (p.148·for an IR sensor) and found the error.··Signal and ground are reversed....Hmm that would have an impact....

So I rewired the IR sensor·like the PE Kit shows, and IT WORKS!!!

So...FYI and correct me if I'm wrong, attached is the corrected schematic.

Regards

Steve





▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
Recent Project Videos:

http://www.youtube.com/watch?v=jI79Xsm_Kyk&feature=channel_page

Cool Cars:
http://www.youtube.com/watch?v=SLnPhYKZCqo&feature=channel_page
http://www.youtube.com/watch?v=d2xGkYN4v7g&feature=channel_page

Comments

  • w8anw8an Posts: 176
    edited 2010-03-30 03:12
    A typo?
  • Phil Pilgrim (PhiPi)Phil Pilgrim (PhiPi) Posts: 23,514
    edited 2010-03-30 04:32
    Nah, typos are for text (i.e. type). I think it would be a grapho if it's in a drawing, such as a schematic.

    -Phil
  • MagIO2MagIO2 Posts: 2,243
    edited 2010-03-30 06:04
    Hmmm ... where does the name bug come from? Common sense is that a real bug ran over some relays of ancient computers which caused programm errors.

    So, what's the reason for a documentation problem?

    I'd say there are several possibilities and I'd suggest the follwoing names for it:
    confusor - this is the case when the author simply was confused or wants to confuse with the documentation CONFUsion errOR -> CONFUSOR
    mixor - the author already had the next project in mind when writing documentation and mixed things up MIXup errOR
    boror - most likely ... what happens if the boss says : OK, work is done, now do the documentation! Developer: Oh nooooo .... this leads to BORedom errORs

    ;o)
  • hairymnstrhairymnstr Posts: 107
    edited 2010-03-30 12:01
    Typically they are referred to as "errata" in technical reference material I think.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Nathan

    "Free as in freedom, beer gratefully accepted though."
  • max72max72 Posts: 1,155
    edited 2010-03-30 12:10
    OpenBSD considers a documentation error a "SERIOUS BUG"
  • heaterheater Posts: 3,370
    edited 2010-03-30 13:21
    Sometimes "errata" become "features". When it's easier to break the hardware/software to match the documentation than fix the documentation[noparse]:)[/noparse]

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    For me, the past is not over yet.
  • kf4ixmkf4ixm Posts: 529
    edited 2010-03-30 13:24
    i.e.: like unexplained power loss= automatic system powersaver mode. [noparse]:)[/noparse]
    heater said...
    Sometimes "errata" become "features". When it's easier to break the hardware/software to match the documentation than fix the documentation[noparse]:)[/noparse]

  • potatoheadpotatohead Posts: 10,261
    edited 2010-03-30 15:23
    A gaffe.

    ▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔▔
    Propeller Wiki: Share the coolness!
    8x8 color 80 Column NTSC Text Object
    Safety Tip: Life is as good as YOU think it is!
Sign In or Register to comment.