======PROJECT======
PROJECT: Light Emitting Diodes (led1)

=====Objective=====
To expand upon our previous efforts, through wiring up additional LEDs and discovering what pattern they activate in, given the provided program.

We also further utilize time constraints, tying project credit to your starting on the project before the deadline (so be sure to plan accordingly!)

=====Abstraction=====
{{page>haas:fall2020:common:projects:abstraction&noheader}}

=====Locational Awareness=====
{{page>haas:fall2020:common:projects:location&noheader}}

=====Reading=====
Please be sure to familiarize yourself with the following content in "[[https://publications.gbdirect.co.uk//c_book/|the C book]]":

  * [[https://publications.gbdirect.co.uk//c_book/chapter4/|Chapter 4]]

=====Background=====
For this project, you will be working with a C program using the wiringPi library on the Raspberry Pi, wiring up a set of four red LEDs to your breadboard and witnessing your ability to control them via software.

=====Input and Output via the GPIO pins on the pi=====
One of the intended uses of the Raspberry Pi and other small, single board computers is as an interface tool to peripherals in projects, personal and industrial.

The pi has a set of **General Purpose Input Output** (GPIO) pins intended for precisely this purpose:

{{ :haas:fall2020:common:projects:gpio-pinout-diagram-2.png |}}

Please note the orientation of the pi (ethernet/USB at bottom) to calibrate yourself to the location of pin 1 and all subsequent pins, along with their identified function (ie top left pin, pin 1, provides a constant 3.3v DC power)

We can also get a live update on the state of each pin on our pi itself, using the '**gpio readall**' command at our pi prompt:

<cli>
yourpi:~/src/desig/led1$ gpio readall
 +-----+-----+---------+------+---+---Pi 4B--+---+------+---------+-----+-----+
 | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
 +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
 |     |     |    3.3v |      |   |  1 || 2  |   |      | 5v      |     |     |
 |   2 |   8 |   SDA.1 | ALT0 | 1 |  3 || 4  |   |      | 5v      |     |     |
 |   3 |   9 |   SCL.1 | ALT0 | 1 |  5 || 6  |   |      | 0v      |     |     |
 |   4 |   7 | GPIO. 7 |   IN | 0 |  7 || 8  | 1 | ALT5 | TxD     | 15  | 14  |
 |     |     |      0v |      |   |  9 || 10 | 1 | ALT5 | RxD     | 16  | 15  |
 |  17 |   0 | GPIO. 0 |   IN | 0 | 11 || 12 | 0 | IN   | GPIO. 1 | 1   | 18  |
 |  27 |   2 | GPIO. 2 |   IN | 0 | 13 || 14 |   |      | 0v      |     |     |
 |  22 |   3 | GPIO. 3 |   IN | 0 | 15 || 16 | 0 | IN   | GPIO. 4 | 4   | 23  |
 |     |     |    3.3v |      |   | 17 || 18 | 0 | IN   | GPIO. 5 | 5   | 24  |
 |  10 |  12 |    MOSI |   IN | 0 | 19 || 20 |   |      | 0v      |     |     |
 |   9 |  13 |    MISO |   IN | 0 | 21 || 22 | 0 | IN   | GPIO. 6 | 6   | 25  |
 |  11 |  14 |    SCLK |   IN | 0 | 23 || 24 | 1 | IN   | CE0     | 10  | 8   |
 |     |     |      0v |      |   | 25 || 26 | 1 | IN   | CE1     | 11  | 7   |
 |   0 |  30 |   SDA.0 |   IN | 1 | 27 || 28 | 1 | IN   | SCL.0   | 31  | 1   |
 |   5 |  21 | GPIO.21 |   IN | 1 | 29 || 30 |   |      | 0v      |     |     |
 |   6 |  22 | GPIO.22 |   IN | 1 | 31 || 32 | 0 | IN   | GPIO.26 | 26  | 12  |
 |  13 |  23 | GPIO.23 |   IN | 0 | 33 || 34 |   |      | 0v      |     |     |
 |  19 |  24 | GPIO.24 |   IN | 0 | 35 || 36 | 0 | IN   | GPIO.27 | 27  | 16  |
 |  26 |  25 | GPIO.25 |   IN | 0 | 37 || 38 | 0 | IN   | GPIO.28 | 28  | 20  |
 |     |     |      0v |      |   | 39 || 40 | 0 | IN   | GPIO.29 | 29  | 21  |
 +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
 | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
 +-----+-----+---------+------+---+---Pi 4B--+---+------+---------+-----+-----+
yourpi:~/src/desig/led1$ 
</cli>

Yes, it may be packed with information, but it is an informative, technical reference.

Why is this so layered and directed, you may ask? Well, it is a matter of competing standards (approaches to identification of each pin, based on particular reference points).

For example, the "Physical" columns (dead center) in the center conform to the image diagram I posted above of the 40 pins (where pin 1 is the top-left).

The "BCM" columns (far left and far right) refer to the hardware identifications for each pin by the manufacturer. You might notice that BCM pin 17 (physical pin 11) corresponds to wPi pin 0.

And the "wPi" columns (second from left, and second from right), correspond to the pin identifications as use by the wiringPi library, which we are using here.

Additionally, we see "Mode" and "V" columns; mode informs us of the operating mode of that pin at present configuration (IN means it is configured for INPUT, OUT means it is configured for OUTPUT). V implies voltage on the pin (0 means no voltage, 1 means there is voltage present at time of checking). For this project, we will be configuring a specific pin to OUTPUT mode, and modulating it between a state of ON (1) and OFF (0).

So, in exploring the use of the table: if we wanted to hook a component up to wiringPi pin #0, that corresponds to manufacturer (BCM) pin 17, which is physical pin 11.

You will want to verify placement before supplying power, that is why we are taking things slow, and providing you opportunities to confirm (by posting pictures in the discord channel) before proceeding.

It may seem a bit bewildering or overwhelming at first, but like anything, time and exposure will ensure it becomes increasingly second nature.

=====Wiring up our circuit=====
This circuit is basically an expansion upon the one you made last week. So the parts needed remains the same, only expanding in the quantity of certain items as we expand the number of LEDs.

In this project, we will be hooking up a peripheral to some of our Raspberry Pi pins: light emitting diodes (LED) and supporting hardware, and then proceed to interface with them to control its state (of being ON or OFF).

You have likely encountered LEDs endlessly in your everyday life: commonly used as a "power light", which when lit, indicates the device is powered on, among many, MANY, **MANY** other applications.

For this endeavour, you will need to obtain the following items out of the electronics kit you obtained for the class:

====(1) breadboard====
In your electronics kit, what will serve as the base, or mounting point for our electronic circuits, will be the solderless breadboard, which resembles the following:

{{ :haas:fall2020:common:projects:breadboard.jpg |}}

<WRAP round info>We will be inserting the metal legs of various components in various holes on the breadboard, to connect our circuit together.</WRAP>

On the breadboard, there are 2 different pathways of connectivity. If you look along the top and bottom of the breadboard, do you see the red and blue strip running horizontal across the board? That means that ALL pins in that row are hooked together (all the pins along the blue line are hooked together with each other, all the pins along the red lines are hooked together with each other). We will be using that to to provide things like a common voltage (+) or a common ground (-) to components that need such things.

In the middle of the breadboard, separated by the valley in the plastic molding, are columns of connected pins (unique columns, also separate from the other side of the valley). Each group of those 5 pins is hooked together.

You'll notice occasional "by 5" counting off silkscreened on the breadboard, which can be used to try to keep things organized.

Here's a logical diagram of the breadboard layout:

{{ :haas:fall2020:common:projects:breadboardlogic.png?400 |}}

Here's a good video overview of the functionality of a breadboard:

  * https://www.youtube.com/watch?v=6WReFkfrUIk
====(1) T-cobbler and data cable====
In your kit should be a T-shaped device (known as the "T-cobbler" with some aspect of pin names silkscreened on it, and a 40-pin ribbon cable). Colors may vary, but essentially it looks like this:

{{ :haas:fall2020:common:projects:tcobbler.jpg?400 |}}

<WRAP info>Note that the T-cobbler, on top has a set of pins, enclosed in a plastic rectangle, shaped to fit the ribbon cable.</WRAP>

<WRAP info>The plastic rectangle should have a notch cut out from it, and notice that the ribbon cable connector has a notch included in it. That is a key to indicate how you need to connect the ribbon cable into the T-cobbler</WRAP>
====(4) red LEDs====
You have a few LEDs included in your kit, some of notably different colours. Go for four of the distinctly red-looking ones, resembling the following:

{{ :haas:fall2020:common:projects:redled.png?400 |}}

Do note that the two legs of the LED are not equal in length.

The longer leg is the positive side of the LED, called the “anode,” and the shorter leg is the negative side, called the “cathode.” Within an LED, current can only flow from the anode (positive side) to the cathode (negative side) and never in the opposite direction.

====(4) 220 Ohm resistors====
Your kit should come with 3-4 packs of differently rated resistors (220, 1K, and 10K). You want FOUR of the lowest rated ones, the 220 ohm variety. You should see the value marked on the paper strip holding the legs of the resistors.

{{ :haas:fall2020:common:projects:220ohm_resistor.jpg?400 |}}

<WRAP round info>The color bands are important, not the body color itself. You resistor body may be beige, may be blue, but the color of the 4-5 rings is what is important. Here we have red (2), red (2), brown (x10); 22 * 10 = 220</WRAP>

<WRAP round info>Unlike the LED, where the direction of connection matters, it does not matter which way you plug in a resistor. Its purpose is simply to resist.</WRAP>

====male to male jumper wire, as needed====
As a final piece of equipment you will need, locate and have a few male-to-male jumper wires handy for use in our circuit:

{{ :haas:fall2020:common:projects:male_male_jumper.jpg?400 |}}

=====The Circuit to Construct=====
With those components, you will want to place them onto your breadboard, expanding upon last week's circuit (picture of last week's circuit provided):

{{ :haas:fall2020:common:projects:led_circuit.png?400 |}}

Take note of how everything is being plugged in, and what connection on the T-cobbler is being utilized.

Notice how the circuit runs from ground to LED to resistor to pin "GPIO17/Physical pin 11/Wiring Pi pin 0"

Please keep in mind:

  * EACH LED needs to be interfaced with a unique GPIO pin
  * EACH LED needs a corresponding resistor (no sharing!) Forgetting to use the resistor can lead to damage to the LED!
  * ground connections can be shared (we call this "common ground")
  * take note of which GPIO pin you are using, so can update the led1.c program

<WRAP info>Before you seek to actually test your circuit, please get verification to proceed from the class channel on discord by posting a clear picture of everything. There are MANY moving parts, and especially as we have our first exposure, it is best to insert as many quality control checks as possible to ensure the greatest chances of mistakes are mitigated.</WRAP>

<WRAP info>It may be clarifying if you arranged your four LEDs in a row, from right to left, in order of your GPIO pins you've plugged into.</WRAP>
====Testing connectivity====
To verify whether everything is hooked up correctly (including the correct positioning of the LED), please try the following:

===Set wiringPi pin 0 to OUTPUT mode===
Remember in that big readout of all the gpio pins above? Take a look at the settings for wiringPi pin 0:

<cli>
 +-----+-----+---------+------+---+---Pi 4B--+---+------+---------+-----+-----+
 | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
 +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
 | ...
 |  17 |   0 | GPIO. 0 |   IN | 0 | 11 |
</cli>

Note that, currently wPi pin 0 is set to INPUT (with no voltage). We need to change that to OUTPUT, which you can do by doing the following:

<cli>
yourpi:~/src/desig/led1$ gpio mode 0 OUT
</cli>

At which point that particular pin will be changed from IN to OUT:

<cli>
 +-----+-----+---------+------+---+---Pi 4B--+---+------+---------+-----+-----+
 | BCM | wPi |   Name  | Mode | V | Physical | V | Mode | Name    | wPi | BCM |
 +-----+-----+---------+------+---+----++----+---+------+---------+-----+-----+
 | ...
 |  17 |   0 | GPIO. 0 |  OUT | 0 | 11 |
</cli>

Okay, output mode enabled, now to twiddle the bits off and on:

<cli>
yourpi:~/src/desig/led1$ gpio write 0 1      ## activate voltage on wiringpi pin 0 (turn on)
yourpi:~/src/desig/led1$ gpio write 0 0      ## deactivate voltage on wiringpi pin 0 (turn off)
</cli>

If your LED is hooked up correctly, the LED should light up, ideally during the ON line.

If you get no activity out of the LED, try reversing it and try again.

With an expanded set of LED circuits, be sure to test the operation of each one.
=====Program=====
It is your task to compile, run, expand upon, and understand a program to interface with a set of LEDs (light emitting diodes), a nice software-hardware connection, on your raspberry pi.

The program files provided for this project are, while not complete, minimally functional. You merely have to get it on your pi, compile it, and run it, and expand it with the appropriate circuitry hooked up to the specified places. You will want to make sure you UNDERSTAND what is going on. So be sure to ASK QUESTIONS, and do so EARLY enough so that you aren't in a mad dash to make the deadline.

In future projects you will start implementing more logic to attain further functionality.

====Grabbing project resources (on lab46)====
I have prepared a **grabit** for resources related to this project. To obtain:

<cli>
lab46:~/src/desig$ grabit desig led1
make: Entering directory '/var/public/SEMESTER/desig/led1'
'/var/public/SEMESTER/desig/led1/Makefile' -> '/home/user/src/desig/led1/Makefile'
'/var/public/SEMESTER/desig/led1/led1.c' -> '/home/user/src/desig/led1/led1.c'
make: Leaving directory '/var/public/SEMESTER/desig/led1'
lab46:~/src/desig$ 
</cli>

At which point you can change into the newly created and populated **led1** directory.

====Getting project resources from lab46 to your pi====
Okay, you've snagged the project files on lab46. Now, how to get them to your pi?

The same way you've been juggling project files already, by using your mercurial repository!

Using the **hg** tool, be sure to **add**, **commit**, and **push** successfully on lab46.

Then, over on your pi, use **hg** to **pull** and **update** the new changes into place. Then you can proceed.

====On your pi====
Study and run this program on your pi in conjunction with testing and verifying operation of your properly hooked up electronics circuit. When done, submit it on lab46.

To utilize the needed functionality for this project, you will need to ensure you have the following packages installed:

  * **build-essential** (hopefully you took care of this in ntr0)
  * **wiringpi**

===Installing wiringpi===
<WRAP info>NOTE: you should have already installed wiringpi in order to do the led0 project; you do not need to do it again</WRAP>

An exception to the usual package installation process, especially for those with a Raspberry Pi model 4B: when you install **wiringpi** the usual way, we may end up with errors when proceeding further, such as the following:

<cli>
yourpi:~/src/desig/led1$ gpio readall
Oops - unable to determine board type... model: 17
</cli>

What you will need to do is manually install an updated (and out of database) version of the **wiringpi** package, as follows (looking out for errors along the way):

<cli>
yourpi:~/src/desig/led1$ wget https://project-downloads.drogon.net/wiringpi-latest.deb
...
yourpi:~/src/desig/led1$ sudo dpkg -i wiringpi-latest.deb
...
yourpi:~/src/desig/led1$ rm -f wiringpi-latest.deb
</cli>

=====Compiling=====
Since the grabit brought in a Makefile, you can compile your code simply by typing: **make**

Any compiler errors will go into a text file called **errors**

To do a full cleaning, run: **make clean** then **make** (or **make debug**)

If you'd like to see compiler messages as you compile, run: **make debug**

When done and ready to submit, on lab46: **make submit**

=====Submission=====
To successfully complete this project, the following criteria must be met:

  * Code must compile cleanly (no notes, warnings, nor errors)
  * Output must be correct, and match the form given in the sample output above.
  * Code must be nicely and consistently indented
  * Code must be well commented
  * Do NOT double space your code. Group like statements together.
  * Output Formatting (including spacing) of program must conform to the provided output (see above).
  * Track/version the source code in a repository
  * Submit a copy of your source code to me using the **submit** tool.
  * Post required images and obtain needed confirmation to proceed from me on class channel on discord.

To submit this program to me using the **submit** tool, run the following command at your lab46 prompt:

<cli>
lab46:~/src/desig/led1$ submit desig led1 led1.c
Submitting desig project "led1":
    -> led1.c(OK)

SUCCESSFULLY SUBMITTED
</cli>

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.

What I'll be looking for:

<code>
39:led1:final tally of results (39/39)
*:led1:post picture of unpowered layout to #desig and get approval [6/6]
*:led1:post picture to #desig by Sunday before deadline [6/6]
*:led1:post picture of powered LEDs in layout to #desig [6/6] 
*:led1:grabit on the code on lab46 by Sunday before deadline [3/3]
*:led1:led1.c code adequately expanded per project requirements [6/6]
*:led1:led1.c comments describing what is happening [6/6]
*:led1:updated code is pushed to lab46 repository [6/6]
</code>

Additionally:
  * Solutions not abiding by spirit of project will be subject to a 25% 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 will be subject to a 25% overall deduction
  * Solutions not organized and easy to read are subject to a 25% overall deduction