Difference between revisions of "S19: Mystery Machine"

From Embedded Systems Learning Academy
Jump to: navigation, search
(Created page with " == Grading Criteria == <font color="green"> * How well is Software & Hardware Design described? * How well can this report be used to reproduce this project? * Code Qualit...")
 
Line 1: Line 1:
 +
== Project Title ==
 +
===Mystery Machine===
  
−
== Grading Criteria ==
+
== Abstract ==
−
<font color="green">
+
<2-3 sentence abstract>
−
*  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.
 
−
</font>
 
  
−
== Abstract ==
+
=== Introduction ===
−
The RUN D.B.C project, involves the design and construction of an autonomously navigating, electric R.C car. Development of the R.C car's subsystem modules will be divided amongst and performed by seven team members.
+
 
 +
The project was divided into N modules:
  
−
== Objectives & Introduction ==
+
* Sensor ...
−
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.
+
* Motor..
 +
* ...
 +
* Android
  
 
=== Team Members & Responsibilities ===
 
=== Team Members & Responsibilities ===
 +
<Team Picture>
 +
 +
Gitlab Project Link - [https://gitlab.com/...]
 +
<BR/>
 +
 +
<Provide ECU names and members responsible>
 +
<One member may participate in more than one ECU>
 +
 +
* Sensor
 +
** Link to Gitlab user1
 +
** Link to Gitlab user2
 +
 +
* Motor
 +
** Link to Gitlab user1
 +
** Link to Gitlab user2
 +
 +
* Geographical
 +
** Link to Gitlab user1
 +
** Link to Gitlab user2
 +
 +
* Communication Bridge Controller & LCD
 +
** Link to Gitlab user1
 +
** Link to Gitlab user2
 +
 +
* Android Application
 +
** Link to Gitlab user1
 +
** Link to Gitlab user2
 +
 +
* Testing Team
 +
** Link to Gitlab user1
 +
** Link to Gitlab user2
 +
 +
<br>
  
 
== Schedule ==
 
== Schedule ==
−
{| class="wikitable" style="margin-left: 0px; margin-right: auto;"
+
 
 +
 
 +
{| class="wikitable"
 
|-
 
|-
 
! scope="col"| Week#
 
! scope="col"| Week#
−
! scope="col"| Date
+
! scope="col"| Start Date
−
! scope="col"| Deliverables
+
! scope="col"| End Date
 +
! scope="col"| Task
 
! scope="col"| Status
 
! scope="col"| Status
 +
|-
 +
! scope="row"| 1
 +
| 09/15/2017
 +
| 09/16/2017
 +
|
 +
* Read previous projects, gather information and discuss among the group members.
 +
* Distribute modules to each team member.
 +
 +
| Completed
 +
|-
 +
! scope="row"| 2
 +
| 09/17/2017
 +
| 10/03/2017
 +
|
 +
|
 +
|-
 +
|}
  
 +
== Parts List & Cost ==
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Item#
 +
! scope="col"| Part Desciption
 +
! scope="col"| Vendor
 +
! scope="col"| Qty
 +
! scope="col"| Cost
 +
|-
 +
! scope="row"| 1
 +
| RC Car
 +
| Traxxas
 +
| 1
 +
| $250.00
 +
|-
 +
! scope="row"| 2
 +
| CAN Transceivers MCP2551-I/P
 +
| Microchip [http://www.microchip.com/wwwproducts/en/en010405]
 +
| 8
 +
| Free Samples
 +
|-
 
|}
 
|}
−
== 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.
+
== Printed Circuit Board  ==
 +
<Picture and information, including links to your PCB>
 +
<br>
 +
 
 +
== CAN Communication ==
 +
<Talk about your message IDs or communication strategy, such as periodic transmission, MIA management etc.>
  
 
=== Hardware Design ===
 
=== Hardware Design ===
−
Discuss your hardware design here.  Show detailed schematics, and the interface here.
+
<Show your CAN bus hardware design>
  
−
=== Hardware Interface ===
+
=== DBC File ===
−
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.
+
<Gitlab link to your DBC file>
 +
<You can optionally use an inline image>
 +
 
 +
 
 +
<HR>
 +
<BR/>
 +
== Sensor ECU ==
 +
<Picture and link to Gitlab>
 +
 
 +
=== Hardware Design ===
  
 
=== Software Design ===
 
=== 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. 
+
<List the code modules that are being called periodically.>
 +
 
 +
=== Technical Challenges ===
 +
 
 +
<Bullet or Headings of a module>
 +
==== Unreliable sonor sensors ====
 +
<Problem Summary>
 +
<Problem Resolution>
 +
 
 +
<HR>
 +
<BR/>
 +
== Motor ECU ==
 +
<Picture and link to Gitlab>
  
−
=== Implementation ===
+
=== Hardware Design ===
−
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 ==
+
=== Software Design ===
−
Describe the challenges of your project.  What advise would you give yourself or someone else if your project can be started from scratch again?
+
<List the code modules that are being called periodically.>
−
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:
+
=== Technical Challenges ===
  
−
=== <Bug/issue name> ===
+
<Bullet or Headings of a module>
−
Discuss the issue and resolution.
+
==== Unreliable Servo Motors ====
 +
<Problem Summary>
 +
<Problem Resolution>
  
 +
<HR>
 +
<BR/>
 +
== Geographical Controller ==
 +
 +
<Picture and link to Gitlab>
 +
 +
=== Hardware Design ===
 +
 +
=== Software Design ===
 +
<List the code modules that are being called periodically.>
 +
 +
=== Technical Challenges ===
 +
 +
<Bullet or Headings of a module>
 +
==== Unreliable GPS lock ====
 +
<Problem Summary>
 +
<Problem Resolution>
 +
 +
<HR>
 +
<BR/>
 +
== Communication Bridge Controller & LCD ==
 +
<Picture and link to Gitlab>
 +
 +
=== Hardware Design ===
 +
 +
=== Software Design ===
 +
<List the code modules that are being called periodically.>
 +
 +
=== Technical Challenges ===
 +
 +
<Bullet or Headings of a module>
 +
==== Insane Bug ====
 +
<Problem Summary>
 +
<Problem Resolution>
 +
 +
<HR>
 +
<BR/>
 +
== Master Module ==
 +
 +
<Picture and link to Gitlab>
 +
 +
=== Hardware Design ===
 +
 +
=== Software Design ===
 +
<List the code modules that are being called periodically.>
 +
 +
=== Technical Challenges ===
 +
 +
<Bullet or Headings of a module>
 +
==== Improper Unit Testing ====
 +
<Problem Summary>
 +
<Problem Resolution>
 +
 +
<HR>
 +
<BR/>
 +
== Mobile Application ==
 +
<Picture and link to Gitlab>
 +
 +
=== Hardware Design ===
 +
 +
=== Software Design ===
 +
<List the code modules that are being called periodically.>
 +
 +
=== Technical Challenges ===
 +
 +
<Bullet or Headings of a module>
 +
==== Wifi Link Reliability ====
 +
<Problem Summary>
 +
<Problem Resolution>
 +
 +
<HR>
 +
<BR/>
 
== Conclusion ==
 
== 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?
+
<Organized summary of the project>
 +
 
 +
<What did you learn?>
  
 
=== Project Video ===
 
=== Project Video ===
−
Upload a video of your project and post the link here.
 
  
 
=== Project Source Code ===
 
=== Project Source Code ===
−
*  [https://sourceforge.net/projects/sjsu/files/CmpE_S2016/ Sourceforge Source Code Link]
 
  
−
== References ==
+
=== Advise for Future Students ===
 +
<Bullet points and discussion>
 +
 
 
=== Acknowledgement ===
 
=== Acknowledgement ===
−
Any acknowledgement that you may wish to provide can be included here.
 
−
 
−
=== References Used ===
 
−
List any references used in project.
 
  
−
=== Appendix ===
+
=== References ===
−
You can list the references you used.
 

Revision as of 21:27, 11 March 2019

Project Title

Mystery Machine

Abstract

<2-3 sentence abstract>

Introduction

The project was divided into N modules:

  • Sensor ...
  • Motor..
  • ...
  • Android

Team Members & Responsibilities

<Team Picture>

Gitlab Project Link - [1]

<Provide ECU names and members responsible> <One member may participate in more than one ECU>

  • Sensor
    • Link to Gitlab user1
    • Link to Gitlab user2
  • Motor
    • Link to Gitlab user1
    • Link to Gitlab user2
  • Geographical
    • Link to Gitlab user1
    • Link to Gitlab user2
  • Communication Bridge Controller & LCD
    • Link to Gitlab user1
    • Link to Gitlab user2
  • Android Application
    • Link to Gitlab user1
    • Link to Gitlab user2
  • Testing Team
    • Link to Gitlab user1
    • Link to Gitlab user2


Schedule

Week# Start Date End Date Task Status
1 09/15/2017 09/16/2017
  • Read previous projects, gather information and discuss among the group members.
  • Distribute modules to each team member.
 Completed
2 09/17/2017 10/03/2017

Parts List & Cost

Item# Part Desciption Vendor Qty Cost
1 RC Car Traxxas 1 $250.00
2 CAN Transceivers MCP2551-I/P Microchip [2] 8 Free Samples

Printed Circuit Board

<Picture and information, including links to your PCB>

CAN Communication

<Talk about your message IDs or communication strategy, such as periodic transmission, MIA management etc.>

Hardware Design

<Show your CAN bus hardware design>

DBC File

<Gitlab link to your DBC file> <You can optionally use an inline image>



Sensor ECU

<Picture and link to Gitlab>

Hardware Design

Software Design

<List the code modules that are being called periodically.>

Technical Challenges

<Bullet or Headings of a module>

Unreliable sonor sensors

<Problem Summary> <Problem Resolution>


Motor ECU

<Picture and link to Gitlab>

Hardware Design

Software Design

<List the code modules that are being called periodically.>

Technical Challenges

<Bullet or Headings of a module>

Unreliable Servo Motors

<Problem Summary> <Problem Resolution>


Geographical Controller

<Picture and link to Gitlab>

Hardware Design

Software Design

<List the code modules that are being called periodically.>

Technical Challenges

<Bullet or Headings of a module>

Unreliable GPS lock

<Problem Summary> <Problem Resolution>


Communication Bridge Controller & LCD

<Picture and link to Gitlab>

Hardware Design

Software Design

<List the code modules that are being called periodically.>

Technical Challenges

<Bullet or Headings of a module>

Insane Bug

<Problem Summary> <Problem Resolution>


Master Module

<Picture and link to Gitlab>

Hardware Design

Software Design

<List the code modules that are being called periodically.>

Technical Challenges

<Bullet or Headings of a module>

Improper Unit Testing

<Problem Summary> <Problem Resolution>


Mobile Application

<Picture and link to Gitlab>

Hardware Design

Software Design

<List the code modules that are being called periodically.>

Technical Challenges

<Bullet or Headings of a module>

Wifi Link Reliability

<Problem Summary> <Problem Resolution>


Conclusion

<Organized summary of the project>

<What did you learn?>

Project Video

Project Source Code

Advise for Future Students

<Bullet points and discussion>

Acknowledgement

References

Retrieved from "http://socialledge.com/sjsu/index.php?title=S19:_Mystery_Machine&oldid=51789"