PROJECT: Press The Button (PTB0)

We continue our explorations of the electronics kit, this time by encountering our first interactions with input devices, in the form of the button.

Do note, the productive way to go about this project involves taking the following steps:

• starting early
• reading the project page
• asking questions regarding things you do not know, are not clear on, or are confused about
• as information, concepts, processes become clear, that is something you can contribute to the project documentation (so you can better remember)

If you start too late, and do not ask questions, and do not have enough time and don't know what is going on, you are not doing the project correctly.

After exploring, assembling, and testing the intended circuit (1 button, 1 red LED, 1 green LED, 1 speaker- all independently connected to the pi via separate GPIO pins), adapt the provided C code to provide software control to coordinate button presses with speaker activations, and have the also independently-connected LEDs light up or turn off to mark whether the button is pressed/speaker is activated or not.

Green means button is pressed/speaker is active.

Red means button is not pressed/speaker is inactive.

To assist with consistency across all implementations, data files for use with this project are available on lab46 via the grabit tool. Be sure to obtain it and ensure your implementation properly works with the provided data.

lab46:~/src/SEMESTER/DESIG$ grabit DESIG PROJECT

You will want to go here to edit and fill in the various sections of the document:

• https://lab46.g7n.org/notes/c4eng/fall2024/projects/ptb0

The general core idea of the process (one way of going about it, anyway) can be described as follows:

REPEAT:
    SHOULD THE BUTTON BE PRESSED:
        ACTIVATE THE GREEN LED   -> SENSORY ORGANS SENSE PERTINENT ELECTROMAGNETIC RADIATION
        DEACTIVATE THE RED LED   -> SENSORY ORGANS NO LONGER SENSE ELECTROMAGNETIC RADIATION
        ACTIVATE THE SPEAKER     -> SENSORY ORGANS SENSE PERTINENT ELECTROMAGNETIC RADIATION
    OTHERWISE:
        DEACTIVATE THE GREEN LED -> SENSORY ORGANS NO LONGER SENSE ELECTROMAGNETIC RADIATION
        ACTIVATE THE RED LED     -> SENSORY ORGANS SENSE PERTINENT ELECTROMAGNETIC RADIATION
        DEACTIVATE THE SPEAKER   -> SENSORY ORGANS NO LONGER SENSE ELECTROMAGNETIC RADIATION
    
    DELAY AT LEAST FIFTY MILLISECONDS

To be successful in this project, the following criteria (or their equivalent) must be met:

• Project must be submit on time, by the deadline.
  • Late submissions will lose 33% credit per day, with the submission window closing on the 3rd day following the deadline.
• All code must compile cleanly (no warnings or errors)
  • Compile with the -Wall and –std=gnu18 compiler flags
  • all requested functionality must conform to stated requirements (either on this document or in a comment banner in source code files themselves).
• Executed programs must display in a manner similar to provided output
  • output formatted, where applicable, must match that of project requirements
• Processing must be correct based on input given and output requested
• Output, if applicable, must be correct based on values input
• Code must be nicely and consistently indented
• Code must be consistently written, to strive for readability from having a consistent style throughout
• Code must be commented
  • Any “to be implemented” comments MUST be removed
    • these “to be implemented” comments, if still present at evaluation time, will result in points being deducted.
    • Sufficient comments explaining the point of provided logic MUST be present
• No global variables (without instructor approval), no goto statements, no calling of main()!
• Track/version the source code in your lab46 semester repository
• Submit a copy of your source code to me using the submit tool (make submit on lab46 will do this) by the deadline.

Let's say you have completed work on the project, and are ready to submit, you would do the following (assuming you have a program called uom0.c):

lab46:~/src/SEMESTER/DESIG/PROJECT$ make submit

You should get some sort of confirmation indicating successful submission if all went according to plan. If not, check for typos and or locational mismatches.

I'll be evaluating the project based on the following criteria:

91:ptb0:final tally of results (91/91)
*:ptb0:used grabit to obtain project by the Sunday prior to duedate [13/13]
*:ptb0:clean compile, no compiler messages [13/13]
*:ptb0:speaker and button each hooked to unique GPIOs [13/13]
*:ptb0:speaker only makes noise on activation [13/13]
*:ptb0:button state is read, on press code activates speaker [13/13]
*:ptb0:button state (ON, OFF) is indicated by two LEDs [13/13]
*:ptb0:code tracked in lab46 semester repo [13/13]

• each class member is to participate in the contribution of relevant information and formatting of the documentation
  • minimal member contributions consist of:
    • near the class average edits (a value of at least four productive edits)
    • near the average class content change average (a value of at least 256 bytes (absolute value of data content change))
    • near the class content contribution average (a value of at least 1kiB)
    • no adding in one commit then later removing in its entirety for the sake of satisfying edit requirements
  • adding and formatting data in an organized fashion, aiming to create an informative and readable document that anyone in the class can reference
  • content contributions will be factored into a documentation coefficient, a value multiplied against your actual project submission to influence the end result:
    • no contributions, co-efficient is 0.50
    • less than minimum contributions is 0.75
    • met minimum contribution threshold is 1.00

• Solutions not abiding by spirit of project will be subject to a 50% overall deduction
• Solutions not utilizing descriptive why and how comments will be subject to a 25% overall deduction
• Solutions not utilizing indentation to promote scope and clarity or otherwise maintaining consistency in code style and presentation will be subject to a 25% overall deduction
• Solutions not organized and easy to read (assume a terminal at least 90 characters wide, 40 characters tall) are subject to a 25% overall deduction