PROJECT: Voltage and Circuit Control (VCC2)

To continue our exploration of interfacing electronics with our pi's, and writing a program that controls it, and collaboratively authoring and documenting the project and its specifications.

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

Your task is write a program that:

• has 4 buttons:
  • 1 is a directional switch (up/down)
  • 3 are for individual red, green, and blue values
• has 3 LEDs:
  • a multicolored LED that is lit via its 3 color components to some state
  • 2 indicator LEDs (one lights up when we are set to increase values, one, one for when we are set to decrease values)
• program will receive input from the various buttons, lighting up various indicator LEDs and setting (via software PWM) the individual color RGB components of the multicolor LED.

Contributing to project documentation is also a core part of this project. If from reading the existing documentation or through your own exploring, you find something lacking, unclear, or outright missing, that is an opportunity to potentially contribute content.

You want the project documentation to provide you (as if coming in with no awareness of the project) with sufficient information so as to allow you to proceed. Asking questions on the discord is a great way of getting more information that you can use to add content.

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

• https://lab46.g7n.org/notes/c4eng/fall2022/projects/vcc2

AS LONG AS PROGRAM CONTINUES TO RUN:

    SHOULD THE DIRECTIONAL INDICATOR BE UP:
        LIGHT UP THE UP INDICATOR LIGHT
        TURN OFF THE DOWN INDICATOR LIGHT
        SET DIRECTION TO POSITIVE FIVE
    OTHERWISE:
        LIGHT UP THE DOWN INDICATOR LIGHT
        TURN OFF THE UP INDICATOR LIGHT
        SET DIRECTION TO NEGATIVE FIVE

    SHOULD THE RED BUTTON BE PRESSED:
        SET REDLEVEL TO REDLEVEL PLUS DIRECTION
        SHOULD REDLEVEL EXCEED ONE HUNDRED:
            RESET REDLEVEL TO ZERO
        SHOULD REDLEVEL FALL BELOW ZERO:
            RESET REDLEVEL TO ONE HUNDRED

    SHOULD THE GREEN BUTTON BE PRESSED:
        SET GREENLEVEL TO GREENLEVEL PLUS DIRECTION
        SHOULD GREENLEVEL EXCEED ONE HUNDRED:
            RESET GREENLEVEL TO ZERO
        SHOULD GREENLEVEL FALL BELOW ZERO:
            RESET GREENLEVEL TO ONE HUNDRED

    SHOULD THE BLUE BUTTON BE PRESSED:
        SET BLUELEVEL TO BLUELEVEL PLUS DIRECTION
        SHOULD BLUELEVEL EXCEED ONE HUNDRED:
            RESET BLUELEVEL TO ZERO
        SHOULD BLUELEVEL FALL BELOW ZERO:
            RESET BLUELEVEL TO ONE HUNDRED
    
    LIGHT UP RED COMPONENT OF RGBLED TO REDLEVEL
    LIGHT UP GREEN COMPONENT OF RGBLED TO GREENLEVEL
    LIGHT UP BLUE COMPONENT OF RGBLED TO BLUELEVEL

    DELAY EVER SO BRIEFLY

KEEP GOING

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:

78:vcc2:final tally of results (78/78)
*:vcc2:used grabit to obtain project by the Sunday prior to duedate [13/13]
*:vcc2:picture of unpowered breadboard to #desig for approval [7/7]
*:vcc2:picture of powered breadboard to #desig showing results [6/6]
*:vcc2:clean compile, no compiler messages [7/7]
*:vcc2:program conforms to project specifications [32/32]
*:vcc2: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