Public:Electrical Onboarding Fall 2023 - Revision history

Sharma93 at 15:42, 19 September 2023

2023-09-19T15:42:35Z

Sharma93: Firmware project 2

2023-09-19T02:57:54Z

Firmware project 2

Ryderch2: /* Project 1: Heartbeat */

2023-09-12T00:02:25Z

Project 1: Heartbeat

Ryderch2: /* Project 1: Heartbeat */

2023-09-12T00:01:59Z

Project 1: Heartbeat

Ryderch2: /* Project 1: Heartbeat */

2023-09-11T23:51:57Z

Project 1: Heartbeat

Eroth8: /* Library Setup */

2023-09-07T01:04:26Z

Library Setup

Gvi2: Fixed Hardware broken links

2023-09-06T23:50:46Z

Fixed Hardware broken links

Eroth8 at 01:28, 6 September 2023

2023-09-06T01:28:43Z

Eroth8 at 01:19, 6 September 2023

2023-09-06T01:19:17Z

Eroth8 at 01:09, 5 September 2023

2023-09-05T01:09:08Z

← Older revision		Revision as of 15:42, 19 September 2023
Line 168:		Line 168:
	*All done! You've just made your first board. Congrats! Now push your changes in your branch to the online repo using <code>''git add -u''</code> to add any updates you made to the files you worked on, then <code>''git'' ''commit -m "[some comment here]"''</code> to commit, and finally ''<code>git push</code>'' to push your changes to the onboarding repo.		*All done! You've just made your first board. Congrats! Now push your changes in your branch to the online repo using <code>''git add -u''</code> to add any updates you made to the files you worked on, then <code>''git'' ''commit -m "[some comment here]"''</code> to commit, and finally ''<code>git push</code>'' to push your changes to the onboarding repo.

		+	===(Hard) Project 2: Horns Board===
		+	Note, this is a long project. Do not try and finish this in one night, pace yourself.
		+
		+	So you've finished both easy projects and decided to start the harder hardware project! This hardware project #2 is a more in-depth look into how we do actual schematic and board design, using one of our old boards we designed for use in our solar cars!
		+
		+	We will be having you design a board that we really use on the car. This is the Horn Breakout board which we use to power the electronic horn. It will get +24V from the Low Voltage Bus Board and a digital signal from the Dash Board to sound a very loud horn. You will be going through the whole process, from Specs to Schematic to Layout. Feel free to work as a group and do not be discouraged if this is difficult!
		+
		+	Since you already know how to use KiCad, there's no setup needed aside from making a new folder in the Hardware directory of your local repo and naming it something like "jdoe_Horns_v1.0."
		+
		+	'''Here are the instructions for the second hardware project!'''
		+
		+	* Copy/paste the template files into your second project folder and rename everything starting with "Template..." to your second project name again.
		+
		+	Using a text editor, edit the specs file to be updated for everything needed for the horns board
		+
		+	* We will have 2 of these horns in series, so it would be nice to add the link to the specs
		+	* We will have 2 main High-Level Requirements
		+	** A Horn On/Off which will be a digital signal for whether or not it should be on
		+	** A Horn Output which will output 24V at 150 mAmps
		+	* As far as communication protocols, we use a digital GPIO to switch the horn
		+	* We will have 4 connectors for the board
		+	** Power in
		+	** Horn Control
		+	** And then 2 Horn outs linked in series
		+	* There are will be no ICs
		+	* You can choose to add a Button that would be used to debug the board
		+	* The power system is 24V from the LV Bus
		+	* You should add test points to any net you would like to add
		+	* You can add LED Indicators to any net you would like
		+
		+	Once you write the Spec Sheet, push it to your branch and move onto the Schematic
		+
		+	* The first thing to set up for the schematic is the connectors
		+	** You will need a 1x3pin connector for power, we use 3 pin connectors for Power so that they do not get plugged in backwards. We put +24V in the middle and two GND pins on the outside
		+	** You will want a 1x2pin connector for Horn Control. We want 1 pin to be grounded and another to be connected to a "Net Label" (Click L to add one). Give it a meaningful name
		+	** You will want two 1x2pin connectors for Horn Out. You need to link them together in series, from HORN_IN to 24V.
		+	* You will next want to add a way of switching from "on to off." To perform a switch at this level, we use a Mosfet. We recommend using the IRFR010PBF (this is the MPN), but you can go to octopart.com to find replacements.
		+	** Source should be tied GND, Drain should be tied to the HORN_IN of the series connectors, and Gate should be tied to the horn control net label you created earlier.
		+	** You will want a 1k ohm resistor and a .1uF capacitor between HORN_CTL and GND before it reaches the mosfet to help with noise reduction.
		+	** Between the mosfet and the connectors, add a 2A fuse.
		+	* The next thing to add are capacitors between +24V and GND
		+	** We recommend adding 3 .1uF capacitors, 2 1uF capacitors, 2 10uF capacitors, and 1 100uF polarized radial capacitor in parallel
		+	* Finally, you will want to add a rectifier diode from HORN_IN to +24V to ensure we do not short power to ground. You can use ES2DA-13-F or find an alternative from octopart.com.
		+
		+	After you have finished your schematic, make sure to run ERC. Once you pass, push your schematic to github and move onto the layout. Once all parts are added to the layout, and you pass DRC, push to your branch again. Once pushed, add a blurb to your pull request saying what you have done.
		+
		+
		+	The final step in the process is to complete an Instant DFM Report . The first thing you will need to do is get the Gerber files for your PCB. In your layout editor, go File > Fabrication Outputs > Gerbers. Follow [http://support.seeedstudio.com/knowledgebase/articles/1824574-how-to-generate-gerber-and-drill-files-from-kicad this tutorial] for instructions on how to extract the files. Once you have gotten the files, compress them into a zip file, push the zip file (not each individual gerber) to github, and use [https://instantdfm.bayareacircuits.com/ Bay Area Circuits' Instant DFM] to check if your board matches their manufacturing capabilities. Once all of them are green, add a link to the pdf file to your pull request, and you are done with your project!

	==Firmware==		==Firmware==

← Older revision		Revision as of 02:57, 19 September 2023
Line 244:		Line 244:

	'''There's an alternate way you can blink the LED - look at the <code>timing.addCallback(...)</code>method in the main.cpp <code>setup()</code> function for a clue. You can try to figure out how to blink the LED this way if you'd like.'''		'''There's an alternate way you can blink the LED - look at the <code>timing.addCallback(...)</code>method in the main.cpp <code>setup()</code> function for a clue. You can try to figure out how to blink the LED this way if you'd like.'''
		+
		+	=== Project 2: Potentiometer Blink Rate ===
		+	In Project 2, you will be adding to the code that you wrote in Project 1. This new code should use adjust the blinking rate of the LED using a potentiometer as input.
		+
		+	'''What You Need To Do'''
		+
		+	Once again, you will be instantiating a pin object. However, instead of a DigitalOut object, you will be instantiating an input pin object for a potentiometer (hint: pay attention to the comments!). If you're not familiar with a potentiometer, it is a variable resistor. As you turn the knob on the potentiometer to reduce resistance across a path, the voltage across that path will increase (following Ohm's Law). We can read this voltage and use it to carry out a task in firmware. You will be able to find more information about the object that you should be instantiating in <code>mbed</code>. Be careful about what value is being returned by the function you are using to read your input! Once finished with that, you will write code in the <code>while (!shutdown) {...}</code> loop in '''main.cpp''' that uses the potentiometer object to modify the task rate that you used in Project 1.

@@ Line 174: / Line 174: @@
 If you're not familiar with or you'd like to brush up on C++ / object-oriented programming, please read through the [[Public:Onboarding Fall 2022 - Basics of C++|basics of C++ (with firmware examples)]] before starting this project.
-Please read through the [[Onboarding 2021 - What is Firmware?|simplified explanation of firmware]] as well as the [[General:Firmware|slightly more detailed explanation]]. Reading through the [[Public:Firmware Standards|general firmware standards]] is optional for this project but good if you'd like to do more firmware later.
+Please read through the [[Public:Onboarding 2021 - What is Firmware?|simplified explanation of firmware]] as well as the [[General:Firmware|slightly more detailed explanation]]. Reading through the [[Public:Firmware Standards|general firmware standards]] is optional for this project but good if you'd like to do more firmware later.
 ====What You'll Be Doing====

@@ Line 174: / Line 174: @@
 If you're not familiar with or you'd like to brush up on C++ / object-oriented programming, please read through the [[Public:Onboarding Fall 2022 - Basics of C++|basics of C++ (with firmware examples)]] before starting this project.
-Please read through the [[Onboarding 2021 - What is Firmware?|simplified explanation of firmware]] as well as the [[General:Firmware|slightly more detailed explanation]]. Reading through the [[Firmware Standards|general firmware standards]] is optional for this project but good if you'd like to do more firmware later.
+Please read through the [[Onboarding 2021 - What is Firmware?|simplified explanation of firmware]] as well as the [[General:Firmware|slightly more detailed explanation]]. Reading through the [[Public:Firmware Standards|general firmware standards]] is optional for this project but good if you'd like to do more firmware later.
 ====What You'll Be Doing====
@@ Line 180: / Line 180: @@
 =====Getting Started=====
-Make sure that you’ve [[MCUXpresso|set up MCUXpresso]] on your computer. This is an IDE, similar to Visual Studio, Eclipse, or IntelliJ, except that it provides more support for microcontroller programming. Follow the steps for your operating system carefully or you could encounter problems later.
+Make sure that you’ve [[Public:MCUXpresso|set up MCUXpresso]] on your computer. This is an IDE, similar to Visual Studio, Eclipse, or IntelliJ, except that it provides more support for microcontroller programming. Follow the steps for your operating system carefully or you could encounter problems later.
 Make sure that you’ve cloned the Onboarding repository on your computer. This branch has the starter code for this project, in the <code>project_1</code> folder.

@@ Line 172: / Line 172: @@
 ===Project 1: Heartbeat ===
-If you're not familiar with or you'd like to brush up on C++ / object-oriented programming, please read through the [[Onboarding Fall 2022 - Basics of C++|basics of C++ (with firmware examples)]] before starting this project.
+If you're not familiar with or you'd like to brush up on C++ / object-oriented programming, please read through the [[Public:Onboarding Fall 2022 - Basics of C++|basics of C++ (with firmware examples)]] before starting this project.
 Please read through the [[Onboarding 2021 - What is Firmware?|simplified explanation of firmware]] as well as the [[General:Firmware|slightly more detailed explanation]]. Reading through the [[Firmware Standards|general firmware standards]] is optional for this project but good if you'd like to do more firmware later.

@@ Line 79: / Line 79: @@
 # Open KiCad. Start these Instructions from the home screen
 # Click on ''Preferences --> Configure Paths...''
-# Add a new path (press "Add") with the name <code>ISC_SYMBOL_DIR</code> and insert the path to the Libraries in your repo: <code>PathOnYourComputer\PCB\Libraries</code>
+# Add a new path (press "Add") with the name <code>ISC_SYMBOL_DIR</code> and insert the path to the Libraries in your repo: <code>PathOnYourComputer\ElecOnboarding23\Hardware\Libraries</code>
 [[File:Kicad symbol path.png|none|frame|Your Environment Variable should look like this]]This should be all you need! Our libraries are now managed using project specific libraries specified by the library tables in the project (provided with the template project)

@@ Line 74: / Line 74: @@
 ''Note: This applies to KiCad v6 and v7 projects on GitHub since'' {{GithubPRLink|repo=isc-hw-libs|number=84}}.''This should cover most projects, and all new projects. But if you need to view older projects please update them following the instructions at [[Viewing KiCad v5 Projects]]''
-Our libraries, as well as KiCad's own schematic symbol libraries, have now been moved to a submodule of the main repo. Make sure you've followed the [[GitHub]] directions in order to get those libraries on your machine. They are in the Libraries folder of the PCB repository. If you first open a schematic in KiCad, without setting this up, you'll probably see a lot of question marks (?) all around the schematic. To fix this follow the below instructions.
+Our libraries, as well as KiCad's own schematic symbol libraries, have now been moved to a submodule of the main repo. Make sure you've followed the [[Public:Github|GitHub]] directions in order to get those libraries on your machine. They are in the Libraries folder of the PCB repository. If you first open a schematic in KiCad, without setting this up, you'll probably see a lot of question marks (?) all around the schematic. To fix this follow the below instructions.
 To setup the Libraries in General we need to let KiCad know where they are! To prevent our set-up from Interfering with your outside usage of KiCad we use ISC specific Environment Variables.

@@ Line 37: / Line 37: @@
 Be aware that you may or may not have access to the ISC GitHub right away.  We will have a form sent out in early onboarding days to get everyone access, but if you still have trouble joining later there will be a channel for questions on the Onboarding Slack.
-#Go to the [[Public:GitHub|GitHub wiki page]] and ensure you have a working version of Git on your computer. Look through the '''Installing Git section''' of the page.  Make sure you have the most recent version of Git!
+#Go to the [[Public:GitHub|GitHub wiki page]] and ensure you have a working version of Git on your computer. Here's the installation process for each computer:
-#*'''Important: When setting up your git folder, keep this in mind!!'''
-#*Make a Solar Car folder to copy all your Github Repos into in your main directory for organization!
+=== Linux ===
-#*Copy the '''[https://github.com/IlliniSolarCar/ElecOnboarding23 ElecOnboarding23]''' Repo from Illini Solar Car's github group, ''not'' the PCB repo!  The PCB repo is not public and not what we are using for this semester.
+You are done, it ships with git - congrats! {{Emoji Grin}}
-#*Only follow the github install instructions!
-#Look through Jarod's git [https://www.youtube.com/playlist?list=PLYWKqdG09eYIEZwwE4W5KDJekruAlOvuW youtube tutorials] to get a better understanding of why we use git as well as a few basic commands
+=== MacOS ===
-#If you'd like more practice with Git, checkout these other interactive tutorials to learn more:
+Many Macs also ship with git, you can check by running <code>git --version</code>. It will either tell you the version or how to install it.
-#*Interactive tutorial: https://try.github.io/
-#*Git Branching: https://learngitbranching.js.org/
+=== Windows ===
 This part is important to getting a good feel of our workflow.  Proper push/pull form helps keep our work space clean!
@@ Line 150: / Line 165: @@
 **#Remember that your version of KiCad will look different from Rahul's!  Things change with time, as did the software.  Don't panic!  Everything he can do in the video, you can too.  Try playing around with the tools for a while before asking one of the elec members if you're having issues with the software.
-*After watching through Rahul's fourth tutorial, you're done with the schematic and layout!  Now you'll need to export your Bill of Materials (A.K.A BOM) to a spreadsheet and generate a DFM!  These are two important steps to our process!  You can learn how to make a BOM here, and how to generate a DFM here.
+*After watching through Rahul's fourth tutorial, you're done with the schematic and layout!  Normally you'll need to export your Bill of Materials (A.K.A BOM) to a spreadsheet and generate a DFM, but we'll learn these later during the harder hardware project.  These are two important steps to our process that you can learn from the wiki later since it's not a huge focus during onboarding.
 *All done!  You've just made your first board.  Congrats!  Now push your changes in your branch to the online repo using <code>''git add -u''</code> to add any updates you made to the files you worked on, then <code>''git'' ''commit -m "[some comment here]"''</code> to commit, and finally ''<code>git push</code>'' to push your changes to the onboarding repo.

← Older revision		Revision as of 01:19, 6 September 2023
Line 29:		Line 29:

	Please complete the setup of GitHub, KiCad, and MCUXPresso before the first onboarding meeting. If you have any questions, ask them in a Slack Public Channel. We use public channels because you are likely not the only person to have this question. If you are still stuck, you can ask us at the first meeting.		Please complete the setup of GitHub, KiCad, and MCUXPresso before the first onboarding meeting. If you have any questions, ask them in a Slack Public Channel. We use public channels because you are likely not the only person to have this question. If you are still stuck, you can ask us at the first meeting.
		+
		+	Remember, everything you need to know for Onboarding will be in '''public pages on the wiki!''' you don't need any other pages than the ones provided to you.

	==GitHub Setup==		==GitHub Setup==

@@ Line 54: / Line 54: @@
 ##Use <code>cd</code> to move to the location you want your Repository to go; it's best to use your default User directory in files; making a Solar Car folder helps keep all your solar car repositories in one place!
 ##Run <code>git clone <nowiki>https://github.com/IlliniSolarCar/ElecOnboarding23.git</nowiki></code> in either GitBash (Windows) or Terminal (MacOS) to clone the repository to your local machine.  It should copy the code in the online repo into a local folder on your computer-- you can see it now in your file explorer!
 ##*If you still have issues,  follow the '''Initial Setup''' instructions [[Public:GitHub/PCB|here]]. (The page is setup for using the PCB repository.  Don't use that!  We are using the new Onboarding repo this year for an easier work space.  Please follow all the instructions but use the [https://github.com/IlliniSolarCar/ElecOnboarding23.git Onboarding] repository instead.)
 #Setup KiCad by following the [[Public:KiCad|KiCad]] '''First Time Setup''' instructions.