Difference between revisions of "S17: MyAutoHealth"

Revision as of 21:57, 21 March 2017

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 & Responsibilities

Yaron Alexandrovich
Emil Kurian
Gerard Ramos
Fred Sun

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.

Week#	Date	Task	Actual
1	10/8	Task list	Completed? Problems Encountered?

Parts List & Cost

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

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:

My Issue #1

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 1: / Line 1: @@
-Sample Project Report
+=== Grading Criteria ===
-Contents [hide]
+<font color="green">
-	Grading Criteria
+*  How well is Software & Hardware Design described?
-	Project Title
+*  How well can this report be used to reproduce this project?
-	Abstract
+*  Code Quality
-	Objectives & Introduction
+*  Overall Report Quality:
-.1	Team Members & Responsibilities
+**  Software Block Diagrams
-	Schedule
+**  Hardware Block Diagrams
-	Parts List & Cost
+**:  Schematic Quality
-	Design & Implementation
+**  Quality of technical challenges and solutions adopted.
-.1	Hardware Design
+</font>
-.2	Hardware Interface
-.3	Software Design
-.4	Implementation
-	Testing & Technical Challenges
-.1	My Issue #1
-	Conclusion
-.1	Project Video
-.2	Project Source Code
-	References
-.1	Acknowledgement
-.2	References Used
-.3	Appendix
-Grading Criteria[edit]
-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[edit]
-Abstract[edit]
+== Project Title ==
+== Abstract ==
 This section should be a couple lines to describe what your project does.
-Objectives & Introduction[edit]
-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.
+== Objectives & Introduction ==
-Team Members & Responsibilities[edit]
+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.
-Yaron Alexandrovich
-Emil Kurian
-Gerard Ramos
-Fred Sun
-Schedule[edit]
-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 Members & Responsibilities ===
-Week#	Date	Task	Actual
+*  Yaron Alexandrovich
-	10/8	Task list	Completed? Problems Encountered?
+**
-Parts List & Cost[edit]
+*  Emil Kurian
+**
+*  Gerard Ramos
+**
+*  Fred Sun
+**
-Give a simple list of the cost of your project broken down by components. Do not write long stories here.
+== Schedule ==
-Design & Implementation[edit]
+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.
-The design section can go over your hardware and software design. Organize this section using sub-sections that go over your design and implementation.
+{| class="wikitable"
-Hardware Design[edit]
+|-
-Discuss your hardware design here. Show detailed schematics, and the interface here.
+! scope="col"| Week#
-Hardware Interface[edit]
+! scope="col"| Date
-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.
+! scope="col"| Task
-Software Design[edit]
+! scope="col"| Actual
-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[edit]
+! scope="row"| 1
-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.
+| 10/8
-Testing & Technical Challenges[edit]
+| Task list
+| Completed?  Problems Encountered?
+|}
+== Parts List & Cost ==
+Give a simple list of the cost of your project broken down by components.  Do not write long stories here.
+== 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.
-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:
-My Issue #1[edit]
+=== My Issue #1 ===
 Discuss the issue and resolution.
-Conclusion[edit]
-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?
+== Conclusion ==
-Project Video[edit]
+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[edit]
-Sourceforge Source Code Link
-References[edit]
-Acknowledgement[edit]
+=== Project Source Code ===
+*  [https://sourceforge.net/projects/sjsu/files/CmpE_S2016/ Sourceforge Source Code Link]
+== References ==
+=== Acknowledgement ===
 Any acknowledgement that you may wish to provide can be included here.
-References Used[edit]
+=== References Used ===
 List any references used in project.
-Appendix[edit]
+=== Appendix ===
 You can list the references you used.