Public:Electrical Onboarding 2021 - Revision history

Achmiel4: /* Planned Dates/Deadlines */ Updated for spring

2022-02-05T03:51:15Z

Planned Dates/Deadlines: Updated for spring

Achmiel4: Added new vid and changed some instructions

2022-01-07T04:13:19Z

Added new vid and changed some instructions

Adityaj5: Adityaj5 moved page Electrical Onboarding 2021 to Public:Electrical Onboarding 2021 over redirect

2021-09-11T04:29:12Z

Adityaj5 moved page Electrical Onboarding 2021 to Public:Electrical Onboarding 2021 over redirect

Adityaj5: Adityaj5 moved page Public:Electrical Onboarding 2021 to Electrical Onboarding 2021 over redirect

2021-09-11T04:28:19Z

Adityaj5 moved page Public:Electrical Onboarding 2021 to Electrical Onboarding 2021 over redirect

Adityaj5: Adityaj5 moved page Electrical Onboarding 2021 to Public:Electrical Onboarding 2021

2021-09-11T04:27:16Z

Adityaj5 moved page Electrical Onboarding 2021 to Public:Electrical Onboarding 2021

Rkajjam2: onboarding goals expanded

2021-09-04T05:28:53Z

onboarding goals expanded

Dking32: changed onboarding dates/deadlines

2021-09-03T05:19:53Z

changed onboarding dates/deadlines

Dking32: more edits to firmware onboarding section

2021-09-01T21:48:39Z

more edits to firmware onboarding section

Dking32: edit to firmware onboaridng project explanation

2021-09-01T21:46:59Z

edit to firmware onboaridng project explanation

Dking32: added project dates

2021-08-27T16:02:34Z

added project dates

@@ Line 8: / Line 8: @@
 Spring onboarding will be a shortened and more self paced version of the typical fall onboarding process. This page contains all the tutorials and instructions needed to install all our software and complete the onboarding projects. Like always if you have any questions feel free to ask during meetings or on slack.
-Wed., Sep. 8 - Electrical system overview
+Monday 2/7: Finish Git setup, install and setup Kicad.
-Sat., Sep. 11 - Install git + KiCad + MCUXpresso
+Wednesday 2/9: Finish Kicad Project Schematic and create PR
-Mon., Sep. 13 - Troubleshoot git/KiCad/MCUXpresso installations
+Saturday 2/12: Finish Kicad Layout
-Wed., Sep.15 to Wed., Sep. 29  - KiCad onboarding project 1
+Monday 2/14: Setup MCUExpresso and finish Firmware project
-Wed., Sep. 29 to Wed., Oct. 6 - KiCad onboarding project 2
+Wednesday 2/16: End of onboarding info presentation, finish any remaining projects/installation
-Wed., Oct 6 to Mon., Oct. 16 - Firmware onboarding project 1
+Saturday 2/19: Receive Mentors and Projects, first meeting as full members.<B> Get OpenLab access by this date</B>
-For each end date above, '''we'd like the project to be done by the beginning of the meeting on that end date.''' To encourage people to stay on track during onboarding, we will only offer help for each project during its specified start/end period. If you finish the hardware/firmware projects early, that's great - we have some additional challenge hardware/firmware projects below.
 === GitHub Instructions ===

@@ Line 6: / Line 6: @@
 === Planned Dates/Deadlines ===
 Mon., Sep. 6 - Introductions, brief electrical system overview, wiki + Github access, icebreakers
@@ Line 19: / Line 24: @@
 Wed., Oct 6 to Mon., Oct. 16 - Firmware onboarding project 1
 For each end date above, '''we'd like the project to be done by the beginning of the meeting on that end date.''' To encourage people to stay on track during onboarding, we will only offer help for each project during its specified start/end period. If you finish the hardware/firmware projects early, that's great - we have some additional challenge hardware/firmware projects below.
@@ Line 34: / Line 40: @@
 KiCad is an electrical CADing software that our team uses to design the custom circuit boards (aka PCBs) for the solar car. All of our designs exist on the [https://github.com/IlliniSolarCar/PCB Illini Solar Car GitHub page] in the PCB repository. You will clone this repository and any hardware contribution you make to the team will be in here forever :)
-# Clone the GitHub [https://github.com/IlliniSolarCar/PCB PCB repository] onto your computer by following the '''Initial Setup''' instructions [[GitHub/PCB|here]].
+# First clone the PCB repository and set up KiCad following the instructions in [[User:Rkajjam2|Rahul's]] first [https://www.youtube.com/watch?v=6VV7DvNGEA8&list=PLYWKqdG09eYLCqh8V8gjJpYXOJ60yJ5xG&index=2 KiCad youtube tutorial] or the wiki instructions below.
-# Go through the [[KiCad]] '''First Time Setup''' instructions
+#* To clone the GitHub [https://github.com/IlliniSolarCar/PCB PCB repository] onto your computer follow the '''Initial Setup''' instructions [[GitHub/PCB|here]].
-# Follow [[User:Rkajjam2|Rahul's]] KiCad [https://www.youtube.com/playlist?list=PLYWKqdG09eYLCqh8V8gjJpYXOJ60yJ5xG youtube tutorial] series '''(only the first 3 videos for now)''' to complete the first introduction project to familiarize yourself with the software
+#* To setup KiCad follow the [[KiCad]] '''First Time Setup''' instructions.
-# Start working on the Onboarding Projects below! We created a series of projects to act as goals to progress yourselves with KiCad. We have 2 intro projects planned out for now and a 3rd as an optional project. Depending on your pace we could add more. '''You don’t have to complete all of them. Just do your best :D'''
+# Follow [[User:Rkajjam2|Rahul's]] KiCad [https://www.youtube.com/playlist?list=PLYWKqdG09eYLCqh8V8gjJpYXOJ60yJ5xG youtube tutorial] series '''(only the next 3 videos for now)''' to complete the first introduction project to familiarize yourself with the software
 # '''While working on the onboarding projects''' take a look at these useful guidelines.
 #* [[Schematic Conventions|KiCad Schematic Conventions]] - has information about specifics regarding each part of the schematic design from naming conventions to symbol creation to part selection
 #* [[Layout Standards|KiCad Layout Standards]] - has information about the design guidelines for PCBs and illustrates what is allowed and what isn't
-# '''After Completing the schematic for your first onboarding project''' watch the [https://youtu.be/Z-K7Q_TfRrM 4th video from the KiCad playlist] and put your work on the PCB repository
+# '''After Completing the schematic for your first onboarding project''' watch the [https://youtu.be/Z-K7Q_TfRrM 5th video from the KiCad playlist] and put your work on the PCB repository
 # Finish the layout and push the changes to your branch to get more feedback
 # Repeat with the rest of the onboarding projects
@@ Line 51: / Line 58: @@
 #* When both buttons are pressed, both LEDs are on
 #* When only button 2 is pressed, neither LED is turned on
-# <u>Onboarding Goal 2:</u> Create a 3-input NAND gate using 3 buttons and an LED
+# <u>Onboarding Goal 2: '''(OPTIONAL CHALLENGE PROJECT):'''</u> Create a 3-input NAND gate using 3 buttons and an LED
 #* Requires 3 buttons and 1 LED
 #* When all buttons are pressed, the LED turns off

@@ Line 46: / Line 46: @@
 ==== KiCad Onboarding Projects: ====
-# <u>Onboarding Goal 1</u>
+# <u>Onboarding Goal 1:</u> In this project, it will be much like the tutorial video, except with additional circuitry. You will require 2 buttons and 2 LED’s for this project.
 #* Requires 2 buttons, and 2 LEDs
 #* When button 1 is pressed, LED 1 turns on
 #* When both buttons are pressed, both LEDs are on
 #* When only button 2 is pressed, neither LED is turned on
-# <u>Onboarding Goal 2</u>
+# <u>Onboarding Goal 2:</u> Create a 3-input NAND gate using 3 buttons and an LED
 #* Requires 3 buttons and 1 LED
 #* When all buttons are pressed, the LED turns off
 #* Else, the circuit remains turned on
-# <u>Onboarding Goal 3 '''(OPTIONAL CHALLENGE PROJECT)'''</u>
+# <u>Onboarding Goal 3 '''(OPTIONAL CHALLENGE PROJECT):'''</u> Create an XOR gate that is implemented using 2 inputs and 1 LED output. This project can be done in many more ways than the first two, so if you can think of a creative solution that bends the outline below a little bit, by all means try it out.
 #* 2 inputs and 1 LED output
 #* When both buttons are not pressed, the light is off

@@ Line 5: / Line 5: @@
 * Wiki
-=== Onboarding Project Dates/Deadlines ===
+=== Planned Dates/Deadlines ===
-Mon., Sep. 6 to Mon., Sep. 13  - install software / ISC repositories (KiCad, git, MCUXpresso) and get access to online services (Drive, Github, wiki)
+Mon., Sep. 6 - Introductions, brief electrical system overview, wiki + Github access, icebreakers
-Mon., Sep.13 to Sat., Sep. 25  - KiCad onboarding project 1
+Wed., Sep. 8 - Electrical system overview
-Sat., Sep. 25 to Mon., Oct. 4 - KiCad onboarding project 2
+Sat., Sep. 11 - Install git + KiCad + MCUXpresso
-Mon., Oct. 4 to Mon., Oct. 16 - Firmware onboarding project 1
+Mon., Sep. 13 - Troubleshoot git/KiCad/MCUXpresso installations
 For each end date above, '''we'd like the project to be done by the beginning of the meeting on that end date.''' To encourage people to stay on track during onboarding, we will only offer help for each project during its specified start/end period. If you finish the hardware/firmware projects early, that's great - we have some additional challenge hardware/firmware projects below.
@@ Line 40: / Line 46: @@
 ==== KiCad Onboarding Projects: ====
-# <u>Onboarding Goal 1 (Mon., Sep.13 - Sat., Sep. 25)</u>
+# <u>Onboarding Goal 1</u>
 #* Requires 2 buttons, and 2 LEDs
 #* When button 1 is pressed, LED 1 turns on
 #* When both buttons are pressed, both LEDs are on
 #* When only button 2 is pressed, neither LED is turned on
-# <u>Onboarding Goal 2 (Sat., Sep. 25 - Mon., Oct. 4)</u>
+# <u>Onboarding Goal 2</u>
 #* Requires 3 buttons and 1 LED
 #* When all buttons are pressed, the LED turns off
@@ Line 75: / Line 81: @@
 #[[General:Firmware|More detailed explanation of firmware]]
 #[[Onboarding Fall 2021 - Basics of C++|Basics of C++ (with examples from our code)]] - the Intro, Variables, Operators, Macros, Conditionals, Functions, Basics of C++ Files, and Objects sections might be helpful for Project 1.
-#<u>Project 1</u> - [[Onboarding Fall 2021 - Project 1 (LED Blinking)|LED blinking project]] (Mon., Oct. 4 - Mon., Oct. 16)
+#<u>Project 1</u> - [[Onboarding Fall 2021 - Project 1 (LED Blinking)|LED blinking project]]
 #[https://wiki.illinisolarcar.com/w/index.php/General:Firmware#Communication_Protocols Basics of communications protocols]
 #<u>Project 2</u> - [[Onboarding Fall 2021 - Project 2 OLED Display|OLED Display project]] (Optional Challenge)

@@ Line 66: / Line 66: @@
 ==== Onboarding Project Goals ====
-The firmware onboarding projects are meant to help you broaden your understanding of the basics of programming, the C++ language, and ISC's codebase so that you can start contributing to actual firmware projects that make the car run. You'll write code to do things like blink an LED or write a message to an OLED display, and in the process learn how to build, flash, and debug your own code.
+The firmware onboarding projects are meant to help you broaden your understanding of the basics of programming, the C++ language, and ISC's codebase so that you can start contributing to actual car firmware projects. You'll write code to do things like blink an LED or write a message to an OLED display, and in the process learn how to build, flash, and debug your own code.
-Here are some links below to help you get started. If you're familiar with C++, you can probably skip links 1 and 3 - I'd still recommend going through link 2 as it provides a reasonably detailed explanation of ISC firmware.
+Here are some links below to help you get started.
 '''Project 1 is the only official firmware onboarding project. Project 2 is an optional (and harder) project, but recommend for people interested in writing more firmware.'''

@@ Line 70: / Line 70: @@
 Here are some links below to help you get started. If you're familiar with C++, you can probably skip links 1 and 3 - I'd still recommend going through link 2 as it provides a reasonably detailed explanation of ISC firmware.
-# [[Onboarding 2021 - What is Firmware?|What is firmware?]]
+'''Project 1 is the only official firmware onboarding project. Project 2 is an optional (and harder) project, but recommend for people interested in writing more firmware.'''
 # [[General:Firmware|More detailed explanation of firmware]]
-# [[Onboarding Fall 2021 - Basics of C++|Basics of C++ (with examples from our code)]] - the Intro, Variables, Operators, Macros, Conditionals, Functions, Basics of C++ Files, and Objects sections might be helpful for Project 1.
+#[[Onboarding 2021 - What is Firmware?|What is firmware?]]
-# <u>Project 1</u> - [[Onboarding Fall 2021 - Project 1 (LED Blinking)|LED blinking project]] (Mon., Oct. 4 - Mon., Oct. 16)
+#[[General:Firmware|More detailed explanation of firmware]]
-# [https://wiki.illinisolarcar.com/w/index.php/General:Firmware#Communication_Protocols Basics of communications protocols]
+#[[Onboarding Fall 2021 - Basics of C++|Basics of C++ (with examples from our code)]] - the Intro, Variables, Operators, Macros, Conditionals, Functions, Basics of C++ Files, and Objects sections might be helpful for Project 1.
-# <u>Project 2</u> - [[Onboarding Fall 2021 - Project 2 OLED Display|OLED Display project]] (Challenge) - This is an optional, but recommended, project for those interested in writing more firmware
+#<u>Project 1</u> - [[Onboarding Fall 2021 - Project 1 (LED Blinking)|LED blinking project]] (Mon., Oct. 4 - Mon., Oct. 16)