Difference between revisions of "F19: Group3"

Latest revision as of 20:29, 20 October 2019

Grading Criteria

How well is Software & Hardware Design described?
How well can this report be used to reproduce this project?
Code Quality
Overall Report Quality:
- Software Block Diagrams
- Hardware Block Diagrams
  Schematic Quality
- Quality of technical challenges and solutions adopted.

Project Title

Abstract

This section should be a couple lines to describe what your project does.

Objectives & Introduction

Show list of your objectives. This section includes the high level details of your project. You can write about the various sensors or peripherals you used to get your project completed.

Team Members & Main Responsibilities

Administrative Roles
Team Lead	Kevin Chan & Lawrence Wan
Finance Manager	Yuming Cheng
Git Repository Manager	Lawrence Wan
Wiki Report Manager	Yuming Cheng & James Ding
Bill of Materials Manager	Kevin Chan
Grammar Check	Lawrence Wan & Kevin Chan

Technical Responsibilities

Schedule

Show a simple table or figures that show your scheduled as planned before you started working on the project. Then in another table column, write down the actual schedule so that readers can see the planned vs. actual goals. The point of the schedule is for readers to assess how to pace themselves if they are doing a similar project.

Team Deliverables Schedule

WEEK	START DATE	END DATE	TASK DETAILS	STATUS
1	15 Oct 2019	21 Oct 2019	Create and establish GitLab repository Establish slack channel and invite Preet Look through previous years projects and study it Distribute major roles among team members Select and order Parts, Circuit Design	In Progress In Progress In Progress In Progress In Progress
2	22 Oct 2019	Nov 4 2019	Create a Bill of Materials. Select and order Parts	In Progress In Progress
3	Nov 5 2019	Nov 11 2019
4	Nov 12 2019	Nov 18 2019
5	Nov 19 2019	Nov 25 2019
6	Nov 26 2019	Dec 2 2019	' ' ' ' ' Final Wiki Schedule.
8	Dec 2019	Dec 2019	Update Wiki with new details and information.
9	Dec 2019	Dec 2019	FIELD TESTING - CRITICAL WEEK Check overall robustness of the complete system. Establish complete connection on PCB Update wiki with details.
10	Dec 2019	Dec 2019	All hands on testing and final bug fixes. Check for tuning or calibration of sensors if required. Complete end-to-end testing for various scenarios and conditions. Create the semester long project activity video and upload to YouTube. Update and finalize wiki.
11	18 Dec 2019		DEMO: Final Project SUBMISSION: Final Project Wiki

Parts List & Cost

Give a simple list of the cost of your project broken down by components. Do not write long stories here.

PART NAME	PART MODEL & SOURCE	QUANTITY	COST PER UNIT (USD)
SJSUDEV2 Board	LPC 4078 (Purchased from Preet Kang)	1	50.00
something	Place purchase	Quantity	Price
something	Place purchase	Quantity	Price
something	Place purchase	Quantity	Price

Design & Implementation

The design section can go over your hardware and software design. Organize this section using sub-sections that go over your design and implementation.

Hardware Design

Discuss your hardware design here. Show detailed schematics, and the interface here.

Hardware Interface

In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the Software Design section is isolated to talk about high level workings rather than inner working of your project.

Software Design

Show your software design. For example, if you are designing an MP3 Player, show the tasks that you are using, and what they are doing at a high level. Do not show the details of the code. For example, do not show exact code, but you may show psuedocode and fragments of code. Keep in mind that you are showing DESIGN of your software, not the inner workings of it.

Implementation

This section includes implementation, but again, not the details, just the high level. For example, you can list the steps it takes to communicate over a sensor, or the steps needed to write a page of memory onto SPI Flash. You can include sub-sections for each of your component implementation.

Testing & Technical Challenges

Describe the challenges of your project. What advise would you give yourself or someone else if your project can be started from scratch again? Make a smooth transition to testing section and described what it took to test your project.

Include sub-sections that list out a problem and solution, such as:

<Bug/issue name>

Discuss the issue and resolution.

Conclusion

Conclude your project here. You can recap your testing and problems. You should address the "so what" part here to indicate what you ultimately learnt from this project. How has this project increased your knowledge?

Project Video

Upload a video of your project and post the link here.

Project Source Code

Sourceforge Source Code Link

References

Acknowledgement

Any acknowledgement that you may wish to provide can be included here.

References Used

List any references used in project.

Appendix

You can list the references you used.

@@ Line 73: / Line 73: @@
 *<font color="#808080">'''Look through previous years projects and study it'''</font>
 *<font color="#808080">'''Distribute major roles among team members'''</font>
-*<font color="#808080">'''Select and order Parts'''</font>
+*<font color="#808080">'''Select and order Parts, Circuit Design'''</font>
 || In Progress <br> In Progress <br> In Progress <br>In Progress <br> In Progress <br>
 |-
-| '''2''' || '''22 Oct 2019''' || ''' Oct 2019''' ||
+| '''2''' || '''22 Oct 2019''' || ''' Nov 4 2019''' ||
 *<font color="#808080">'''Create a Bill of Materials.'''</font>
 *<font color="#808080">'''Select and order Parts'''</font>
 || In Progress <br> In Progress <br>
 |-
-| '''3''' || '''Nov 2019'''|| ''' Nov 2019''' ||
+| '''3''' || '''Nov 5 2019'''|| ''' Nov 11 2019''' ||
 *<font color="#808080">''' '''</font>
 *<font color="#808080">''' '''</font>
@@ Line 87: / Line 87: @@
 ||<br> <br>  <br>  <br> <br> <br> <br>
 |-
-| '''4''' || '''Nov 2019'''|| ''' Nov 2019''' ||
+| '''4''' || '''Nov 12 2019'''|| ''' Nov 18 2019''' ||
 *<font color="purple">''' '''</font>
 *<font color="green">''' '''</font>
@@ Line 95: / Line 95: @@
 ||<br> <br>  <br>  <br> <br> <br> <br>
 |-
-| '''5''' || '''Nov 2019'''|| ''' Nov 2019''' ||
+| '''5''' || '''Nov 19 2019'''|| ''' Nov 25 2019''' ||
 *<font color="#148F77">''' '''</font>
 *<font color="#148F77">''' '''</font>
@@ Line 101: / Line 101: @@
 ||<br> <br>  <br>  <br> <br> <br> <br>
 |-
-| '''6''' || '''Nov 2019'''|| ''' Nov 2019''' ||
+| '''6''' || '''Nov 26 2019'''|| ''' Dec 2 2019''' ||
 *<font color="FUCHSIA">''''''</font>
 *<font color="FUCHSIA">''''''</font>
@@ Line 148: / Line 148: @@
 == Parts List & Cost ==
 Give a simple list of the cost of your project broken down by components.  Do not write long stories here.
+{| class="wikitable"
+|-
+! scope="col" style="text-align: left;" style="background:#7acee2;" | <span style="color:#FFFFFF"> PART NAME </span>
+! scope="col" style="text-align: left;" style="background:#7acee2;" | <span style="color:#FFFFFF">
+PART MODEL & SOURCE </span>
+! scope="col" style="text-align: left;" style="background:#7acee2;" | <span style="color:#FFFFFF">
+QUANTITY </span>
+! scope="col" style="text-align: left;" style="background:#7acee2;" | <span style="color:#FFFFFF">
+COST PER UNIT (USD) </span>
+|-
+|
+* ''' SJSUDEV2 Board'''
+|
+* LPC 4078 '''(Purchased from Preet Kang)
+|
+* 1
+|
+* 50.00
+|-
+|
+* ''' something '''
+|
+* Place purchase'''
+|
+* Quantity
+|
+* Price
+|-
+|
+* ''' something '''
+|
+* Place purchase '''
+|
+* Quantity
+|
+* Price
+|-
+|
+* ''' something'''
+|
+* Place purchase '''
+|
+* Quantity
+|
+* Price
+|}
+<BR/>
 == Design & Implementation ==