View source for F17: FoxP2


== FOXP2 ==

[[File:Cmpe243_F17_FOXP2_CAR01.jpg|1000px|middle|FOXP2 autonomous car]]

[[File:Cmpe243_F17_FOXP2_Group_Pic.jpg|1000px|middle|FOXP2 Group]]

== Abstract ==
This project entails the aggregated knowledge from the Embedded System courses offered at SJSU leveraged into a fully functioning self-driving vehicle. This vehicle will navigate the terrain, avoid obstacles, and relay feedback to the user. The Initialization is enabled using the custom application which will set the final destination using GPS and destination node.

== 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 ===

*  '''R Nikfar'''
** Team Lead
** Electrical Circuits Engineering
** PCB design
** Sensor testing and implementation. 

*  '''Jason Tran'''
** Infrastructure
** Sensor IO Implementation
** Testing
  
*  '''[https://www.linkedin.com/in/ahsanu/ Ahsan Uddin]'''
** Git Admin
** Motor Control  

*  '''Yuyu Chen'''
** Geographical Implementation
** Bridge Support 

*  '''[https://www.linkedin.com/in/marvinbflores/ Marvin Flores]'''
** Android Application development
** Bridge Implementation  

*  '''[https://www.linkedin.com/in/rabeel-elahi-155217a0/ Rabeel Elahi]'''
** Master/Gateway Controller Implementation. 
** Object Detection Implementation. 

*  '''Sophia Quan'''
** LCD interface 

*  '''Michael Jaradah'''
**  Testing.

*  '''Taylor Kearns'''
**   Testing.

*  '''Bohan Liu'''
** Master Controller.

== 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.

{| class="wikitable"
|-
! scope="col"| Week#
! scope="col"| Date
! scope="col"| End Date
! scope="col"| Task
! scope="col"| Status
! scope="col"| Completion Date
|-
! scope="row"| 1
| 10/8/2017
| 10/14/2017
| Geographical: Order GPS and Compass
Android: Setup Android Studio; Run test application 

Motor: PWM proof of concept

Sensors: Research and requirement for the proper front and reverse sensors. IO design.

PCB: Initial design of PCB without peripherals was Completed.

Master: Research Self-driving car algorithm.
| Completed
Completed

Completed

Completed

Completed

Completed
|

Android & Bridge: 10/21/2017

|-
! scope="row"| 2
| 10/15/2017
| 10/21/2017
| Geographical: Interface with micro-controller to receive raw data
Android & Bridge: Initial App UI running. Create a solid plan for checkpoint algorithm.

Motor: Run the car in straight line in manual mode.

Sensors: Purchase and create the protocols and IO.

Master: Start the design of the master controller for all IO.
| Completed
On-going 

Completed

Completed

On-going
|
Geographical: 10/21/2017

Android & Bridge: 10/28/2017 
|-
! scope="row"| 3
| 10/22/2017
| 10/28/2017
| Geographical: Implement algorithm to parse GPS NMEA sentence and calibrate compass
Android & Bridge: Checkpoint algorithm implemented. Phone to SJSUOne board communication setup.

Motor: LCD Display initial integration

Sensors: Initialize testing and debugging on the sensors.

Master: Set priorities for the connected IO, and design a flowchart of the whole system
| 
Geographical: Completed

Android & Bridge: Completed

Delayed due to shipping issues
|
Geographical: 10/28/2017

Android & Bridge: 11/04/2017

|-
! scope="row"| 4
| 10/29/2017
| 11/04/2017
| Geographical: Integrate GPS and compass together to get heading, bearing, and distance
Android & Bridge: Checkpoint algorithm testing. Full Communication with SJSUOne board implemented. 

Motor: Implement Speed and Voltage sensor. Full functional motor system that can support Gateway  

Sensors: Implement the IO and sensors with the master controller.

PCB: initial design sent out to be printed.

Master: Create and Design the Algorithm to handle IO from sensors and output motor controls. 
| Completed
Geographical: Completed

Android & Bridge: Completed

Master: Completed

|
Geographical: 11/04/2017

Android & Bridge: 11/11/2017
|-
! scope="row"| 5
| 11/05/2017
| 11/11/2017
| Geographical: Update DBC with Bridge controller and interface with other nodes on CAN bus
Android & Bridge: Other commands such as start and stop implemented and tested. Checkpoint algorithm finalized.

Motor: Implement full functional LCD and Speed sensor feedback control

Sensors: Further testing and fine-tuning of sensors for a fluid and seamless drive.

Master: Testing of Signals, CAN, and behavior of the vehicle.
|
Geographical: On-going

Android & Bridge: Completed

Master: On-going
|
Geographical: 11/11/2017

Android & Bridge: 11/18/2017 
|-
! scope="row"| 6
| 11/12/2017
| 11/18/2017
| Geographical: Calibrate compass with car  

Motor: Reverse end to end system integration test 

Android & Bridge: Forward commands to GEO board

Sensors: Improve filtering algorithm. Develop proof of concept for TOF sensors.
| 
Android & Bridge: Completed

Motor: Completed
|
Geographical: 11/14/2017

Android & Bridge: 11/25/2017 
|-
! scope="row"| 7
| 11/19/2017
| 11/25/2017
| Geographical: Checkpoint algorithm

Motor: Speed integration check for final speed settings

Android & Bridge: Receive messages from GEO & SENSOR. Add features to the app to display sensor values.

Sensors: Compare TOF sensor viability. Look into other forms of measurement such as voltage, etc.
| 
Android & Bridge: Completed

Motor: Completed
|
Geographical: 11/25/2017

Android & Bridge: 11/25/2017 
|-
! scope="row"| 8
| 11/26/2017
| 12/02/2017
| Geographical: System testing

Motor: Code freeze after feature complete. Clean up and unit test

Android & Bridge: Implement auto-connect.

Sensors: System testing
|
Android & Bridge: Completed
 
Motor: Completed
|
Geographical: 12/02/2017

Android & Bridge: 12/02/2017
|-
! scope="row"| 9
| 12/03/2017
| 12/09/2017
| Geographical: System testing
Android & Bridge: Testing

Sensors: System testing
| 
| 
|-
! scope="row"| 10
| 12/10/2017
| 12/16/2017
|Geographical: Testing
|Android & Bridge: Testing 
|
| 
|-
! scope="row"| 11
| 12/17/2017
| 12/20/2017
| Demo autonomous car on 12/20
| 
| 
|}

== 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
| [http://www.Amazon.com Amazon]
| 1
| 240.00
|-
! scope="row"| 2
| SJOne board
| [http://www.socialledge.com/sjsu/index.php?title=Main_Paget Preet]
| 7
| 560.00
|-
! scope="row"| 3
| Adafruit Ultimate GPS Breakout
| [https://www.adafruit.com/product/746]
| 1
| 39.95
|-
! scope="row"| 4
| CMPS11 - Tilt Compensated Compass Module
| [https://www.robotshop.com/en/tilt-compensated-magnetic-compass-cmps11.html]
| 1
| 29.90
|-
! scope="row"| 5
| Bluetooth Module
| [https://www.sparkfun.com/products/11601 Sparkfun]
| 1
| 24.95
|-
! scope="row"| 6
| LIPO Batteries + Charger
| 
| 1
| 130.00
|-
! scope="row"| 7
| Ultrasonic sensor
| [https://www.maxbotix.com/ Maxbotix]
| 5
| 150.00
|-
! scope="row"| 8
| PCB
| [https://bayareacircuits.com Bay Area Circuits]
| 2
| 75.00
|-
! scope="row"| 9
| DB9 Connector + PCB components
| [http://www.halted.com/commerce/catalog/product.jsp?product_id=16322&czuid=1477806005100 HSC]
| 1
| 40.00
|-
! scope="row"| 10
| CAN Transceiver
| [http://www.microchip.com/wwwproducts/en/en010405 Microchip]
| 10
| 20.00
|-
! scope="row"| 11
| LED HeadLights
| [http://www.Amazon.com Amazon]
| 1
| 30.00
|-
! scope="row"| 12
| Traxxas XL-5 ESC (Replacement)
| [https://sheldonshobbies.com/]
| 1
| 55.00
|-
! scope="row"| 13
| 4D Systems LCD
| [https://www.digikey.com/en/product-highlight/4/4d-systems/ulcd-32ptu-display-module]
| 1
| 100.98
|}

== Overall Design and Methodology ==

'''''Rob Nikfar'''''

[[File:CMPE243 Eagle FoxP2.JPG|300px|thumb|right|frame|Eagle Schematic]]
[[File:CMPE243 Eagle1 FoxP2.JPG|300px|thumb|right|frame|Eagle Board]]

'''Board Connection Architecture''' 

Our team's approach to the design of this project was solely based on the integrity of its connections and communication between the nodes. Each node would handle specific parts of the car that would require an extensive amount of computing. At the center of this communication would be our design and printed PCB(printed circuit board). This board was designed in a manner that would reduce the amount of noise within the circuitry of its components, and place its nodes at an optimal location relative to the car.


'''Printed Circuit Board''' 

The PCB which is at the heart of this project was designed in Eagle CAD. There were 2 iterations of this board. The first one was designed without validation and had problems with noise within the CAN communications(discussed in problems encountered section). This design lacked several necessary connections and was limited by functionality.


The Second version of the board would incorporate 4 external power outlets that supply 3.3V and 5V to external components as necessary. There would also be an external power unit with regulators that make sure that a clean power is fed to the boards if necessary. As shown in the schematic, the can transceivers are connected to the boards using the terminating resistors. This CAN bus line also connects to the DB9 connections to easily read the CAN data using the PCAN Dongle. 









Before the Board was sent for printing, the rat nests had to be removed and the connections had to be routed in such a way that minimum amount of noise was created. this ensured a robust communication for the CAN bus and stable noise-free power supply for the external components such as the Ultrasonic Sensors.


== Motor Controller ==
Motor Controller primary tasks are as follows:

* Control the rear wheels for moving forward, backward and stop

* Control the front wheels to maneuver

* Display contents on the LCD

=== Drivetrain ===

'''''Ahsan Uddin'''''

----

==== ESC (Electronic Speed Control) ====

Our car came up Traxxas XL5 installed already. We knew that the onboard wireless receiver controls the ESC through PWM but we didn’t know the frequency and the duty cycle. So we hooked up the ESC with an oscilloscope and used the Wireless transmitter to go forward/backward and found out that the operating frequency of the ESC is 100Hz.

 
[[File:Cmpe243_F17_FOXP2_OEM_IDLE.bmp|500px|OEM Idle ON PWM]]   [[File:Cmpe243_F17_FOXP2_OEM_FORWARD.bmp|500px|OEM FORWARD PWM]]   [[File:Cmpe243_F17_FOXP2_OEM_REVERSE.bmp|500px|OEM REVERSE PWM]] [[File:Cmpe243_F17_FOXP2_Traxxas_XL5_Titan12T.jpg|thumb|right|185px|Traxxas XL-5 ESC + Titan 12 Motor]]

Then we tried implementing the same driving frequency on the SJ one board and we came across several issues:

1.	Even though we were setting the SJ Board to 100Hz frequency, for some reason it was outputting ~110Hz

2.	The percentage duty cycle we set in the SJ One board FW, was not exactly the same percentage that was output to the pins

3.	Due to the above issue in (2), we couldn’t control the car to the finest level of speeds, either it would be stopped or it would be racing down so we had come up with different plans

Our solution to the above problems were to overclock the ESC to ~420Hz where we could control the speed limits very finitely within the scope of the PWM driving frequency of the SJ One board. Below are the scope shots of the PWM driven by the SJ One board to control the ESC

[[File:Cmpe243_F17_FOXP2_Motor_IDLE_SJOne.bmp|500px|SJOne Board Idle ON PWM]]   [[File:Cmpe243_F17_FOXP2_Motor_Forward_SJOne.bmp|500px|SJOne Board Forward PWM]]   [[File:Cmpe243_F17_FOXP2_Motor_Reverse_SJOne.bmp|500px|SJOne Board Reverse PWM]]

==== Servo (to turn the front wheels) ====

The Servo also uses PWM as an input to control the direction of the wheels. SJ One board has a limitation where all PWM signals need to be driven at the same frequency. Which means that as we are driving the ESC signals at ~420 Hz, we also had to drive the servo PWM signals at 420Hz. We had to do a parametric search of various PWM percentages to find out which ones would be best suited for turning the servos. Below are the scope shots of the PWM signals that SJOne board is using to drive the servo directions.

[[File:Cmpe243_F17_FOXP2_SJOne_Turn_Straight.bmp|500px|SJOne Board Turn Straight PWM]]   [[File:Cmpe243_F17_FOXP2_SJOne_Turn_Left.bmp|500px|SJOne Board Turn Left PWM]]   [[File:Cmpe243_F17_FOXP2_SJOne_Turn_Right.bmp|500px|SJOne Board Turn Right PWM]]   [[File:Cmpe243_F17_FOXP2_Traxxas_Servo.jpg|thumb|right|185px|Traxxas 2075 Servo]]

==== RPM Sensor (for detecting speed) ====

[[File:Cmpe243_F17_FOXP2_Traxxas_RPM.jpg|right|230px|Traxxas RPM sensor]] 

We used Traxxas RPM sensor (6520) to detect the speed. The package came with a single magnet which, along with the RPM sensor, needed to be mounted inside the motor compartment. The idea is that everytime the motor completes 1 whole revolution, it reaches very close to the sensor. And when the sensor detects the magnet nearby, it sends out a high pulse until the magnet moves away from it. Therefore, upon detecting the X number of rising edge in Y seconds we can say that there were X revolutions/Y seconds



The schematic for hooking up the RPM sensor was challenging because of the following:

* First we came across an issue where we were able to mount the magnet on the motor but it wasn't possible to mount the RPM sensor head inside the motor compartment. Later we found out that we needed a special compartment designed by Traxxas to hold the RPM sensor inside the motor compartment

* When we were prototyping the RPM sensor on breadboard, we saw that regardless of whether we bring the magnet close to the sensor or not, the signal voltage was always high. After many researches and trail and errors we found out that the signal pin had to be connected to the VCC across a 1K resistor so that it can effectively pull it down when it detects the magnet

* The Traxxas RPM sensor package came with a single magnet and a Hall effect sensor. So we put the single magnet inside the motor compartment and it was working fine when we were manually bring the hall effect sensor close by. But when we would put the motor cover on, we would see that the RPM sensor would never trigger. We fixed the issue by putting 2 magnets on top of each other to increase the magnetic field and then we were able to see the RPM sensor work seamlessly.

==== Hardware Interface ====

* CAN bus

:Motor ECU uses can1 to communicate with other ECUs. Motor primarily receives data from Master/Gateway to maneuver left/straight/right and also stop/forward/reverse the wheels. Motor also receives non-critical system data from Geographical ECU which needs to be displayed to the LCD. For the CAN configuration, we used XXX pin with baud rate YYY.

* PWM to Motor and servo

:There are 3 PWM pins available on SJ One Board. As explained earlier, all PWM frequencies were set to 420Hz. The Motor PWM PIN is driven from XXX and the servo PWM pin is driven from YYY. 

* RPM sensor for edge detection

:The RPM input is connected to P2.6. It should be noted that there's a 1K resistor between the VCC of the RPM and the Signal Input 

:Motor, Servo and the RPM share the power directly from the 8.4V Traxxas battery

* UART to LCD

: LCD uses UART TX/RX port to talk to the LCD. The UART is configured at 9600 bauds/sec.



[[File:Cmpe243_F17_FOXP2_Motor_HW_Design.JPG|800px|middle|Motor ECU's HW design]]

==== Software Design ====

1. Initialization sequence 

In the Motor ECU's init sequence we do the following in order:

* '''CAN Init'''

:: Motor CAN is initialized on ''can1'' with BAUD rate 100bps and TX/RX queue sizes of 100. Then the filter is setup for 100-150 MSG IDs.

* '''PWM Init'''

:: 2 PWMs are set at P2.0 and P2.1 at 420Hz for Motor and Servo respectively. By default, the PWMs are set to straighten up the front wheels and put the back wheels to IDLE 

* '''LCD Init'''

:: UART is initialized at TXD2/RXD2 for LCD at 9600 baud rate

* '''RPM sensor Init'''

:: P2.6 PIN is initialized as input with pull down resistor and a rising edge interrupt is being installed to detect the RPM triggers

2. 1 Hz Task

1Hz task is responsible for:

* '''CAN Bus reset logic'''

:: In this handler we simply check if the CAN bus is off or not. If it's off, we do a BUS reset

* '''Handle Manual PWM (only in debug mode)'''

:: This mode is only for debugging purpose. Just by change of a #define flag, we can shutdown all CAN related code and turn on the manual mode where we can use the on board switches to control the front and the back wheels. This has been a very effective was of debugging to find out HW related issues without taking off any of the components.  

* '''RPM check '''

:: We count the number of ticks that happened in 1 sec and reset the value of the ticks, therefore we get a revolution/second value 

* '''Speed check '''

:: We have predefined macros of what should be a high speed value and a low speed value. If we detect the current speed values are not in limit, we upshift or downshift the gears to control the speed

* '''Update LCD'''

:: We get the following data and update them to the LCDs:
** RPM data
** Bearing data
** Compass data 

* '''Send CAN messages'''

:: We send CAN messages to Gateway with our current speed values

3. 10 Hz task

10Hz task is responsible for:

* '''Reverse State machine'''

:: In order to reverse properly, we have to follow a specific sequences of Stop and Reverse. This handler takes care of it. Details of this state machine is described below in Bugs section

4. 100 Hz task

* '''Handle CAN messages'''

:: This is the master handler for receiving all the CAN messages. Primarily they are motor CMDs from Gateway and compass data from Geographical for displaying on LCD.  

[[File:Cmpe243_F17_FOXP2_Motor_SW_Design.JPG|1000px|middle|Motor ECU's SW design]]

==== Implementation ====

* Overall
: The Motor ECU's main task is to make sure the motor wheels and the servo turns are always in accordance to Master ECU's commandment. Motor ECU dequeues CAN messages in 100Hz task therefore the reaction time of wheels movement is never over 10ms. Although to reach full speed from stop, and more importantly, brake from full speed, it would take the car more than ~1s due to the weight and the inertia from speed.

* Debug mode
: In order to debug the motor side easily on the field we implemented a debug mode where we shut down all CAN communications and let the on board switches to control the front and the back wheels. In this mode, all the other peripherals like LCD ad RPM sensors are fully functional.

=== LCD ===

'''''Sophia Quan'''''

The uLCD-32PTU is a 3.2" (240x320) LCD screen with a micro SD connector, GPIO's along with I2C and serial COMMS.  Workshop4 IDE was used to program the GUI, and data was transmitted from the SJOne board through UART communication.  The LCD displays RPM clicks, GPS heading, bearing, distance, and also the current firmware version and branch name.
 
[[File:Cmpe243_f17_foxp2_lcd_hw_architecture.png|500px|thumb|center|frame|LCD Hardware Architecture]]

[[File:LCD_display.PNG|750px|thumb|center|frame|LCD Display]]
Note:  The display here shows the angularmeter which will display the rpm, the top right box will display the bearing, heading, and distance from the GPS, and the bottom box will disply the firmware git hash, and branch.

== Sensors ==

'''''Jason Tran''''' and '''''Rob Nikfar'''''

The primary responsibility of the sensor ECU is to provide object detection capabilities.

=== Hardware Design ===
For object detection, distance sensors are used to provide proximity awareness. 3 distance sensors are placed on the front of the car (front left, front, and front right) to continuously measure the distance of the general directions.
An object or obstacle can be detected when the distance of a given direction is below a threshold which indicates that the car cannot traverse in that direction and should attempt steer away from the blocked path. 

=== Hardware Interface ===

[[File:cmpe243_f17_foxp2_sensor_hw_architecture.png|500px|thumb|center|frame|Sensor Hardware Architecture and Interface]]
Note: Despite the names, the TX and RX pins do not function as asynchronous serial transmit and receive in the implementation above. The TX functions as a digital output that drives the line high for a short duration when the sensor wants to trigger a cascaded sensor. The RX functions as an digital input that acts as a trigger for the sensor to begin measuring a distance.

[[File:Cmpe243_f17_foxp2_LV-MaSonar-EZ_Datasheet.png|500px|thumb|center|frame|MB1010 Pinout]]

=== Software Design ===
The sensor software follows a modular design pattern. Sensors is the top level module that contains periodic function definitions. The CAN Interface module consists of a periodic task that is responsible for broadcasting the most up to date sensor readings over CAN. The Car Proximity module also consists of several periodic tasks that are responsible for managing the frontal sensor readings.

[[File:CmpE243_F17_FoxP2_Sensor_SW_Architecture.png|500px|thumb|center|frame|Sensor Software Architecture]]

=== Implementation ===
At 100Hz, the ECU reads the analog voltage of all 3 sensors, performs scaling on the raw ADC values to decode the voltage into inches, then stores the value in 3 circular buffers respectively. A circular buffer represents a history of inches reported by a sensor; the most recent firmware version stores the 3 most recent sensor readings into a circular buffer which represents a 30ms time frame.

At 10Hz, the ECU broadcasts the distance of all 3 sensors over CAN.

Filtering is also applied against the circular buffers. Of the data in a given circular buffer, the ECU reports the minimum distance.

There are 3 onboard LEDs that represent the state of the 3 frontal sensors. The LEDs are driven by GPIO. If, for example, the front sensor detects an object, then the ECU will assert the center onboard LED.

== Geographical Controller==

'''''Yuyu Chen'''''

The main purpose of the geographical controller is to guide the car towards its destination. This is done by processing data from the GPS and Compass module in order to get the '''Heading''', '''Bearing''', and '''Distance'''. <br>
The compass will allow the user to calculate the '''Heading''', which tells us which direction the car is pointing relative to magnetic north or simply, '''"Which way the car is pointing"'''?<br>
The GPS will allow the user to get the current coordinate of the car, which will be useful when calculating the '''Bearing''' and '''Distance'''.<br>
The '''Bearing''' tells us the direction from the current location to a checkpoint coordinate, and is given as the angle between the location and the current location of the car.<br>
The '''Distance''' tells us how many meters away the current checkpoint is. Essentially, '''How far away are we from our destination'''?<br>
<br>
The geographical controller is also responsible for: <br> 
1. Process data from GPS and Compass module.<br>
2. Navigate to nearest checkpoints and to set destination. <br>
3. Receive checkpoints from Bridge controller.<br>



=== Hardware Design ===
[[File:CMPE243_F17_FOXP2_geo_sensors.jpg|left|200px]]
[[File:CMPE243_F17_FOXP2_geo_block_diagram.jpg|500px]]

=== Hardware Interface ===

'''CAN Bus'''
<br>
The CAN bus interface allows the geographical controller to send and receive data from other microcontrollers on the bus. For example, the geographical controller will send requests to the Gateway controller to tell it to turn right, left, or keep straight in order to reach the set checkpoints. The geographical controller will receive checkpoints from the Bridge controller in order for the geographical controller to know how to steer or how far away the destination is at. 

'''MTK3339 Ultimate GPS'''
<br>
<br>
The MTK3339 Ultimate GPS module from Adafruit was chosen because it provided good results when it was used previously for a different project. The main purpose of the GPS module is to provide an accurate location of the car while the car navigates towards its destination. This is done by parsing NMEA sentences, which are transmitted by up to 22 satellites to pinpoint the current location of the module. There are various different types of NMEA sentences, such as $GPRMC and $GPGGA. The NMEA sentence that was used was $GPRMC, which provides only the recommended minimum. $GPRMC was also chosen because it is the only NMEA sentence the GPS module is able to provide data at 10Hz for real-time application. The module is interfaced via '''UART''' with a baud-rate set to 57600bps. The module also comes with a fix LED, which indicates if a GPS fix by blinking every 15 seconds, if not, it blinks every 1Hz. The module is powered by 3.3V from the SJOne board.
<br>
[[File:CMPE243_F17_FOXP2_gps_module.jpg|150px]]
<br>
The $GPRMC sentence is separated by commas, which the user has to parse in order to get useful data out of the module. The most important data that the user want is the GPS coordinate, '''Latitude and Longitude'''. The strtok_r() function was used in order to parse the NMEA sentence. 
<br>
Below is an example of a parsed $GPRMC sentence:
<br>
       Example: $GPRMC,225446,A,4916.45,N,12311.12,W,000.5,054.7,191194,020.3,E*68
                        1     2    3    4    5     6    7    8      9     10  11 12

{| class="wikitable"
|-
! scope="col"| Number
! scope="col"| Raw form
! scope="col"| Description
|-
! scope="row"| 1
|  225446  
| Time of fix 22:54:46 UTC
|-
! scope="row"| 2
| A
| Navigation receiver warning A = OK, V = warning
|-
! scope="row"| 3
|  4916.45
| Latitude 49 deg. 16.45 min
|-
! scope="row"| 4
| N
| North
|-
! scope="row"| 5
| 12311.12
| Longitude 123 deg. 11.12 min
|-
! scope="row"| 6
| W
| West
|-
! scope="row"| 7
| 000.5 
| Speed over ground, Knots
|-
! scope="row"| 8
| 054.7  
| Course Made Good, True
|-
! scope="row"| 9
| 191194 
| Date of fix  19 November 1994
|-
! scope="row"| 10
| 020.3
| Magnetic variation 20.3 deg
|-
! scope="row"| 11
| E
| East
|-
! scope="row"| 12
| *68
|  mandatory checksum
|}
<br>
'''CMPS11 - Tilt Compensated Compass Module'''
<br>
The CMPS11 - Tilt Compensated Compass module was chosen because it provides the '''heading''' value, which let the user know which way the car is facing relative to magnetic north. Not only does it provide heading, the module also has a 3-axis gyro and a 3-axis accelerometer to remove or neglect any errors while the module is tilted (going up or down a slope). Another compass module was considered before choosing this module because the old module had to be calibrated extensively in order for it to work properly. This module only needed to be calibrated one time in an environment free of magnetic interference. The heading was double-checked after the module was mounted onto the car.
<br>
The compass module is placed away from all other components of the car to minimize any magnetic interference from the motor, servo, sensors, and microcontrollers. Placing it in an environment where there is magnetic interference will cause incorrect reading of the heading and the car will navigate towards the wrong direction. The compass module is interfaced via '''I2C'''. It is powered on by 3.6-5V, but 3.3V works also.
<br>
[[File:CMPE243_F17_FOXP2_cmps11_module.png|200px]]

=== Software Design ===
The Geographical Controller is designed in a way so that the code is modular and organized. Only what is needed are exposed.<br>
[[File:CMPE243_F17_FOXP2_geo_sw_design.jpg|300px|Geographical Controller Software Architecture]]
            '''GPS'''                                                 '''Compass'''                                                                '''Geo_Sensor'''
 bool gps_init(gps_data_ready_cb cb);                  bool cmps11_init(void);                                                   bool geo_sensor_init(void);
 bool get_lat_long(float *gps_data);                   float cmps11_get_heading(void);                                           void geo_sensor_run(void);
                                                       bool cmps11_calibrate(bool start_calibration, bool end_calibration);      

The GPS library and Compass library are used by Geo_Sensor in order to calculate the Heading, Bearing, and Distance when geo_sensor_run() is called. Extern variables are used to share data between the CAN layer and Geo_Sensor. <br>
 
 extern float e_heading;
 extern float e_bearing;
 extern float e_distance;
 extern float e_curr_latitude;
 extern float e_curr_longitude;
 extern float e_checkpoint_latitude;
 extern float e_checkpoint_longitude;
 extern uint8_t e_heading_valid;
 extern bool e_gps_distance_valid;

{| class="wikitable"
|-
! scope="col"| Task
! scope="col"| Description
|-
! scope="row"| geo_init()
| CAN_init()
geo_sensor_init()
|-
! scope="row"| geo_1Hz() 
| CAN_reset_bus()
|-
! scope="row"| geo_10Hz()
| geo_sensor_run()<br>
command_car()<br>
geo_bridge_handshake()<br>
|-
! scope="row"| geo_100Hz()
| can_rx()
|-
! scope="row"| geo_1kHz()
| N/A
|}

=== Implementation ===
<br>
'''GPS'''<br>
The GPS main purpose is to provide the latitude and longitude for its current location. It is interfaced via UART. This will help us calculate the bearing and distance to the destination. An example of raw NMEA string is provided in the Hardware Interface section of Geographical Controller.<br>

'''Compass'''<br>
The compass will provide the Heading, which tells us the direction where the car is facing. It is interfaced via I2C. The Heading value is in units of degree, from 0 degree to 360 degree. Only two registers are read (Hi and Lo) for heading value. <br>
Register 2 & 3 are read to get the heading value
 uint16_t heading = 0;
 uint8_t heading_byte[2] = {0};
 s_compass->readRegisters(CMPS11_ADDR, heading_16_bit_hi, &heading_byte[0], 2);   
 heading = heading_byte[0] << 8 | heading_byte[1];
<br>
There is a calibration sequence in order to initiate calibration mode.
3 separate I2C transactions are needed by first writing 0xF0 to Register 0, second write of 0xF5 to Register 0, and 0xF6 to Register 0.<br>
After entering calibration mode, the module is needs to be rotated slowly on all axis to calibrate the magnetometer. After all the LED on the module stops blinking, place the module on all 6 sides to calibrate the accelerometer.<br>
After calibrating the compass module, 0xF8 is written to Register 0 to end calibration mode. 
[[File:CMPE243_F17_FOXP2_cmps11_regmap.jpg|thumb|center|700px|cmps11 register map]]

'''Geo-Sensor'''<br>
This layer combines the data from the GPS (latitude and longitude) and Compass (heading). In this layer, the distance (in meter) and bearing (in degree) are calculated. The distance and bearing are calculated by the current latitude and longitude, along with the checkpoint's latitude and longitude.
 The Bearing (in degrees) is calculated from the following formula (Forward Azimuth):
    bearing = atan2( sin(longDiff_rad)*cos(lat2_rad), cos(lat1_rad)*sin(lat2_rad)-sin(lat1_rad)*cos(lat2_rad)*cos(longDiff_rad))
<br>
 The distance (in meters) is calculated from the following formula (Haversine Formula):
 a = sin^2(latDiff_rad/2) + cos(lat1_rad) * cos(lat2_rad) * sin^2(longDiff_rad/2)
    formula: c = 2 *atan2(sqrt(a), sqrt(1-a))
    d = Radius of Earth * c
<br>
The heading, bearing, and distance values are shared with the CAN layer for further manipulation. A simple moving average with a window of 10 was implemented to filter out bad GPS parsing (corrupt data) which occur after some time. Any distance value above the moving average will mark the GPS data as invalid and is dropped. <br>

To navigate the car in the direction of the destination, the difference of the heading and bearing will have to be approximately zero. After many test runs, the team realize that the car moves to the right when the steering is straight. To account for this, the threshold for which to turn right is decreased so that it will turn right less. 
 Difference = Heading - Bearing
<br>
The difference between heading and bearing will tell us the offset between the direction of the current checkpoint and the current location of the car. It should steer the difference amount in order to go in direction of the checkpoint.

The distance to mark a checkpoint as reached is 5 meters radius from the actual destination, which accounts for some GPS inaccuracy. Therefore it will reach its destination within a 10 meter diameter. 5 meters was chosen after many test runs and seems to best fit because it does not over/under-shoot the checkpoint.<br>

[[File:CMPE243_F17_FOXP2_geo_bridge_sm.jpg|300px|left|thumb|frame|geo bridge state machine]]
[[File:CMPE243_F17_FOXP2_geo_checkpoint_algo.jpg|330px|center|thumb|frame|checkpoint, destination algorithm]]
<br>
To receive checkpoints from the Bridge controller, the Bridge controller has to send the checkpoints via CAN to the Geographical controller. This is done with a handshake protocol between the two controllers. The Bridge will first send the number of checkpoints available to the Geographical controller. Once a non-zero number is received by the Geographical controller, the Geographical controller will start receiving Latitude and Longitude pairs from the Bridge controller. After receiving a "Done" signal from the Bridge, the Geographical controller responds with the number of Latitude and Longitude pair received. The handshake state machine for the Geographical controller is the left one above. <br>

To command the car to navigate towards the destination, a '''GO''' signal needs to be sent from the Android App. To stop the car, a '''STOP''' signal is also sent from the Android App. After receiving checkpoints from the Bridge/App and Go is received, the Geographical controller will calculate which checkpoint is the closest based on distance between the checkpoints and the car's current location. After reaching that checkpoint, mark the checkpoint as "reached" to skip that checkpoint and find the next closest checkpoint until all checkpoint has been reached. The checkpoint algorithm for the Geographical controller is the right one above.

== Bridge Controller==

'''''Marvin Flores & Yuyu Chen'''''

The Bridge controller's main purpose is to act as a bridge between the Android Application and the car. The Android app is able to send and receive data wirelessly via Bluetooth. Any data, such as sensor data and current car location, can be sent to the bridge from other controllers via CAN. The Bridge controller will send the data wirelessly to the Android app to be displayed.<br>
The main purpose of the Bridge Controller is to send checkpoints to the Geographical controller. This will be explained in the Implementation section of the Bridge Controller.


=== Hardware Interface ===
[[File:Cmpe243_F17_FOXP2_Bridge_Bluetooth_module_on_board.jpg|450px|thumb|center|frame|Bluetooth module on the SJSUOne board]]
Since SJOne Board has an XBee interface, The Bluetooth XBee module was the easiest to interface with. A Bluetooth module is installed on the Bridge controller for communication between the SJOne board and the Android App. The Bluetooth module is interfaced via SJOne board's UART.

=== Software Design ===
In order to receive or send data, an additional command is added to the TerminalTask to handle Bluetooth Commands.<br>

  //Pseudocode command handler, bluetoothMessage is an extern variable that is defined in the periodic_task bridge class
  if command == "signal go" -> bluetoothMessage.setGoSignal()
  else if command == "signal stop" -> bluetoothMessage.setStopSignal()
  else if command == "data_start" -> payloadSize = arg1
  else if command == "checkpoint" -> checkpoints[index].latitude = arg1, checkpoints[index].longitude = arg2
  else if command == "data_end" -> bluetoothMessage.setPayload(checkpoints, payloadSize)

Periodic Task Bridge class functions <br>
{| class="wikitable"
|-
! scope="col"| Task
! scope="col"| Description
|-
! scope="row"| bridge_init()
| CAN_init()
|-
! scope="row"| bridge_1Hz() 
| CAN_reset_bus() <br>
sendHeartbeat() - to Android App <br>
sendGPSCoordinates() - to Android App <br>
sendSensorValues() - to Android App <br>
|-
! scope="row"| bridge_10Hz()
| 
<br>
bridge_geo_handshake() -> to Geo <br>
sendCheckPoints() -> to Geo <br>
sendStart() -> to Geo <br>
sendStop() -> to Geo <br>
<br>
|-
! scope="row"| bridge_100Hz()
| can_rx()
|-
! scope="row"| bridge_1kHz()
| N/A
|}

=== Implementation ===
[[File:bridge_geo_state_machine.jpg|330px|center|thumb|frame|bridge_geo_handshake]]
<br>
A Bridge-Geo handshake was designed in order to send checkpoints to the Geographical controller. Checkpoints are received from the Android App after the '''"Checkpoints"''' button on the app is pressed. This will initiate sending the number of checkpoints to the Geographical controller. After sending the number of checkpoints, the Bridge will start sending checkpoints to the Geographical controller. After all checkpoints are sent, the Bridge will send a '''Done''' signal to the Geographical to notify it that it has finish sending checkpoints. After receiving a response with the correct number of checkpoints sent, the Bridge will be notified that the handshake is complete and '''"Go"''' can be pressed on the Android App. The state machine for the Bridge-Geo handshake is above.

== Android Application ==

'''''Marvin Flores'''''

=== Main Tasks ===
* Generate checkpoints
* Send START and STOP commands
* Auto-connect to the Bridge module
* Display relevant information:
** map
** current phone location
** current car location
** connection heartbeat
** checkpoint

=== Software Design ===
 
==== High Level Architecture Design ====
[[File:Cmpe243_f17_foxp2_high_level_arch_android.png|center|frame|Android Application High Level Architecture Diagram]]

The application's high level design is simple: Use Google Maps API to get the checkpoints and forward them to the bridge controller. Once the checkpoints are sent, the START command can be executed by clicking the START button on the app. This sends a start command signal to the bridge controller which then forwards the message to the Geo Controller via CAN bus. The STOP command, however, can be executed at any point in time and has the same process as the START command.

=== Implementation ===
[[File:Cmpe243_F17_FOXP2_Android_screenshot_01.png|thumb|450px|center|frame|Commander243 Android Application]]
[[File:Cmpe243_F17_FOXP2_android_architecture.png|center|frame|Android Architecture Diagram]]

Android applications follows the MVC pattern by default to allow developers to manage their applications easily. For this application, the Views are the MapView, Buttons, Heartbeat (ImageView), and TextViews to display extra information from the bridge. The Controller is the main fragment that contains all the logic. The Models are the data that come from the the Google Maps API and data coming from the bridge.

==== MapPane Fragment ====
The MapPane Fragment is used as the main class of the application and provides the link between the Models and the Logic of the application. MapPane Fragment contains the MapView, buttons for CHECKPOINTS, START, and STOP, as well as some extra information from the Bridge Controller such as heartbeat and sensor values.

==== Logic ====
The Logic resides in the MapPane Fragment and is a combination of different objects:
* Button Click Listeners - these listeners are attached to specific button views to execute methods when clicked.
* Message Handler - this handler is responsible for communication between the main fragment and the Bluetooth Service.
* Connection Watcher - this is a thread that runs at startup which monitors the connectivity with the Bridge Controller by checking the heartbeat message.

==== Bluetooth Service ====
This component is responsible for connecting/disconnecting with the Bridge Controller via Bluetooth. It's also responsible for sending/receiving data, as well as parsing the received data from the Bridge Controller.

==== MapHelper ====
This helper class is responsible of requesting a GET REST call to Google Maps API. It's also responsible of parsing the Json response and extract the checkpoints.

=== Use Cases ===

==== Auto Connect ====

[[File:Cmpe243_F17_FOXP2_Android_flow_diagram_bt_connect.png|center|frame|Flow Diagram Bluetooth Auto-connect]]

The auto-connect feature happens right after the user opens up the application. During startup, the MapFragment sends a connect message to the MessageHandler. The MessageHandler of the BluetoothService receives it and calls the appropriate method on the BluetoothService. The method then initializes the ConnectThread class that handles the Bluetooth socket connection. 
Since the default Android's BluetoothListener only triggers once when gets disconnected, the author decided to create a custom Watcher to monitor the Bluetooth connection. This was done by checking the heartbeat coming from the Bridge Controller once connection is established. If the heartbeat message is lost for a given amount of time, the Watcher automatically reconnects to the bridge by resending the connect message from the MapPaneFragment.

==== Send Checkpoints ====

[[File:Cmp243_F17_FOXP2_Android_flow_diagram_send_checkpoints.png|center|frame|Flow Diagram Send Checkpoints]]

* User tap a location in the MapView.
* MapView has a click listener that initiates (with the help of MapHelper) a GET request to Google Maps API based on the phone location and the target location.
* The json response is then parsed and the checkpoints gets extracted, the target location and the checkpoints are now shown to the MapView.
* The user then clicks the CHECKPOINTS button
* Button Click Listener invokes a sendMessage that contains the checkpoints
* MessageHandler from the BluetoothService receives the message and forwards it to the ConnectThread.
* ConnectThread invokes ConnectedThread write function to send the message as bytestream to the Bridge Controller via Bluetooth. ConnectedThread gets initialized right after the connection is established.
* Once checkpoints are sent, the START/STOP command can be sent using similar process (without the MapHelper part).

== Gateway/Master Controller ==

'''''Rabeel Elahi'''''

The Gateway/Master controller is one controller however, as the name suggests, it is responsible for two main functions: 

* Gateway: Receiving, processing, and forwarding CAN messages to the respective nodes
* Master: Running object detection


[[File:Cmpe243_F17_FOXP2_Gateway_Master_Architecture.png|thumb|center|500px|Gateway/Master Architecture]]

=== Gateway === 

==== FullCAN Hardware Layer ====

[[File:Cmpe243_F17_FOXP2_FullCAN_Diagram.png|500px|thumb|right|FullCAN]]

The CAN controller can be driven by two principles known as BasicCAN or FullCAN. The advantage and disadvantages of both are listed below. The Gateway/Master utilizes FullCAN because the number of received messages were a finite number (< 10). However, the API has been  designed to be scalable so more messages could be added if need be. Additionally, to minimize CPU usage by not polling for received messages in BasicCAN, FullCAN stores received messages into dedicated RX buffers without any CPU cycles. 

--'''''BasicCAN'''''--

'''Pros'''

1. Not limited to a finite number of receive messages

'''Cons'''

1.  One RX Buffer (FIFO)

2.  FIFO management -- needs to be checked periodically

3.  Received CAN identifier needs to compared with list of identifiers -- Time complexity: O(N)

4.  Burden of message filtering

5.  Messy Scalability

--'''''FullCAN'''''--

'''Pros'''

1. Set of dedicated RX buffers

2. Configured messages go straight to predefined section of CAN RAM – no CPU cycles required for transfer

3. Hardware filtering 

4. Ability to check if a new message arrived 

5. Clean Scalability

'''Cons'''

1. Limited to a finite number of received messages due to max 2k CAN RAM


==== Software Design ====

[[File:Cmpe243_F17_FOXP2_gateway_fullCAN.png|500px|thumb|right|FullCAN]]

The goal of the IO layer is to make it straight and simple to add a new message to the gateway/master controller. After a new message has been added, the API automatically initializes FullCAN, adds the new message to FullCAN's hardware message filter, and takes care of either encoding or decoding the message periodically. High level layers can access the encoded or decoded data by simply calling the struct handle for the respective message. 

'''The following steps briefly describes how the API accomplishes this:''' 

1. Add the message to respective enum, TX or RX and extern the generated can struct handles (e.g., extern RPM_VALUE_CMD_t rpm)

2. In the struct array definition, with the enum index you just defined above, define the CAN message hex id and add the generated decode function to the respective function pointer array for the message

3. Add a struct getter function for the message in IO_CAN_gateway.c 

4. Add IO_gateway_init and IO_gateway_run_100ms to your periodics

5. Call the struct handle to write or read data






















=== Master ===

==== Object Detection ====

[[File:Cmpe243_F17_FOXP2_ObjectDetection.png|400px|thumb|right|Object Detection States]]

The object detection algorithm is a simple state machine. The input is ultrasonic data from the sensor controller and the outputs are motor commands to the motor controller.

==== Software Design ====


'''State Machine Design''' 

1. Determine desired state based on ultrasonic data 

   else if ((app_object_detection_getSensorData(APP_OBJECT_DETECTION_SENSOR_LEFT) >= app_object_detection_config.sensorThreshInInches) && 
   (app_object_detection_getSensorData(APP_OBJECT_DETECTION_SENSOR_RIGHT) >= app_object_detection_config.sensorThreshInInches) && 
   (app_object_detection_getSensorData(APP_OBJECT_DETECTION_SENSOR_FRONT) >= app_object_detection_config.sensorThreshInInches))
   {
   state = APP_OBJECT_DETECTION_STATE_ALL_CLEAR;
   }

2. if (currentState != desiredState) 

* exitAction(currentState); 
* entryAction(desiredState);
* currentState = desiredState;

4. Select motor parameters based on current state 

*runAction(currentState);

  case APP_OBJECT_DETECTION_STATE_ALL_BLOCKED:
  app_object_detection_setMotorParameters(MOMENTUM_STOP, TURN_STRAIGHT);
  app_object_detection_data.reverseRequest = true;
  break;

== SCons - Build Automation ==

'''''Jason Tran'''''

SCons is a build automation tool similar to Make and is based on the Python programming language. The 2 documents below describe the basic usage of SCons to build firmware and unit tests.

[[File:cmpe243_f17_foxp2_SCons_Build_Automation.docx|750px|thumb|center|frame|Building Firmware]]

[[File:cmpe243_f17_foxp2_SCons_Building_Unit_Tests.docx|750px|thumb|center|frame|Building Unit Tests]]


Reference source code:

https://bitbucket.org/cmpe243f17/foxp2/src/70cfcf22095e00ef079fe45c088908d1b0a0ec02/SConscript?at=master&fileviewer=file-view-default


There are 3 build environments defined for the FoxP2 project.

1. ARM build environment

2. DBC build environment

3. Unit test build environment


''' ARM Build Environment '''

The ARM build environment utilizes the GNU ARM embedded toolchain to compile code for ARM targets namely for the SJOne Board's LPC1758 powered by an ARM Cortex-M3 (ARMv7-M architecture). Resources used by this build environment include Cortex-M3 specific code, FreeRTOS, start up code, linker scripts, LPC1758 drivers, and finally application-specific code. To  build an ECU-specific program, an ECU name can be provided as a command line argument.

''' DBC Build Environment '''

The DBC build environment utilizes the default Python interpreter (defined in PATH) and the DBC parser Python tool to generate a C header file. The build environment uses the target ECU name as the target NODE required by the DBC parser.

''' Unit Test Build Environment '''

The unit test build environment utilizes the native C compiler on Linux hosts and Cygwin's C compiler on Windows hosts. SCons automatically searches for all unit tests source files in a test directory with file names starting with "test_". When the unit test flag is provided on command line, SCons will build then executed all unit tests. If any unit test fails, the overall SCons build will fail. For Windows, the FoxP2 repository contains pre-built shared libraries (.dll) of Cgreen unit testing library and Cygwin's POSIX references which are linked at run-time.

== Validation and Testing Plan ==

'''''Michael Jaradah and Taylor Kearns'''''


'''Sensor Testing:'''
**Front left sensor detection (values)
**Front right sensor detection (values)
**Front middle sensor detection (values)
**Back left sensor detection (values)
**Back right sensor detection (values)
**Response & accuracy / precision
***put object 1 ft away, and make sure it reads 12 in (inches are sent over can)
***response to approaching obstacles (start from 3ft away and move in)
***LED correspondence with values
**All sensor MIA handling

----

'''Object Avoidance Testing:'''
**If right sensor blocked, go left
**If left sensor blocked, go right
**If front sensor blocked, reverse, go right/left
**If right & left sensor blocked, reverse, go right/left
**If back sensor blocked, move forward
**If back and front left blocked, go right
**If back and front right blocked, go left

----

'''Motor Testing:'''
**If ramped up, speed up
**If ramped down, slow down
**If no ramp, constant speed

----

'''LCD Testing:'''
**Display compass
**Display voltage
**Display speed
**Githash version
**Branch name
**All values update accordingly
**Display values MIA handling

----

'''Voltage sensor Testing:'''
**Compare smart device, voltmeter, and sensor readings

----

'''App Testing:'''
**Automatic car connection
**Set a GPS location
**Sends stop to car until destination chosen
**MIA car / GPS lock handling

----

'''Geographical testing: '''
**Losing the GPS Lock
**Accuracy in sending coordinates
**Location accuracy in chosing destination
**MIA GPS sensor 

----

'''Basic Hardware Testing:'''
**Confirm switch to turn on car works
**7-Seg value indication
**LED indications
**No loose / flimsy wires
**Car doesn't move unless given a GPS coordinate
**Avoids obstacles while moving towards a target destination
**Can reverse away from obstacles and continue towards the destination
**Avoid GPS when reversing for 5 seconds

----

== 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:

== Bugs/Issues ==

=== ESC Initialization sequence ===

The Electronic speed control (ESC) unit is driven by PWM input signals and are pretty sensitive to the timings. We faced an issue where the ESC would keep blinking green LED which means that it can't detect the input signals even though the SJ One board is connected to the ESC driving the PWM signals. After a lot of scoping we found out that when the ESC is turned ON, its important that the SJ One baord has to send the same IDLE signature PWM to the ESC in order for it to detect the driver. Until this happens, the ESC will be in reset mode. Therefore, in our Init sequence for the SJ One board we made sure that upon start up, we send in the IDLE PWM sequence and then only we send other signals like forward, reverse, etc.  

=== Reversing the ESC ===

During the initial stage of the system bring up we saw that even though we were putting the exact PWM frequency to the ESC to reverse, but for some reason it would never reverse. Through a lot of trial and error we found out that due to security reasons for protecting the motor from burning out when switching momentum at high speed, its intentionally designed to not reverse when the reverse signal comes while the motor is going forward. And hence we had to put a workaround where we created a state machine which will cycle through the following states when it will receive reverse command fro gateway:

* Stop
* Reverse 
* Stop
* Reverse

At the 4th cycle of the state machine it would start reversing. But the challenging part was that we had to cycle through these states with a gap of 100ms or so and it was not possible to simply put a delay in the tasks as the task would take 500ms and would be over run. Instead we implemented a circular ping mechanism where we would change the state machine from the 10Hz callback and cycle through the state machines. It should be noted that during this 500ms, motor ECU ignores all other commands from Gateway. But as the car is sitting IDLE in this 500ms so motor doesn't expect Gateway to send any system critical CMD.

===FullCAN Initialization===

When generating FullCAN IDs, the SJ1 would crash when adding new messages. It wasn't initially clear as to why this was happening, but after taking some educated guesses it turned out that CAN IDs needed to be added to the FullCAN hardware filter starting from least to greatest.

===Corrupt GPS NMEA sentences===
After some time corrupt NMEA sentences would appear and give us erroneous values for latitude and longitude. Bad data will give us the wrong distance and bearing values. Since NMEA sentences have fixed formats and are delimited by commas, we know which data to pull out of the NMEA sentence. Rigorous unit testing has been done on the GPS module. But when its corrupt, the data becomes useless and should not be accounted for. Since the GPS is receiving data every 10Hz, the issue could be the UART baud rate. The issue is still unknown, but a filter has been set up to ignore any corrupt data. A Simple Moving Average with a window size of 10 was implemented to filter out any spike (corrupt data) on the calculated distance. Since we know that as the car gets closer to its destination, the distance decreases. If any data is above the moving average times some constant, the data is ignored.

== 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 ===
[https://youtu.be/R2bnKiLIw10 FoxP2 Project Video]

=== Project Source Code ===

[https://bitbucket.org/cmpe243f17/foxp2 BitBucket Source Code Repo]

[https://gitlab.com/nivram07/Commander243 Gitlab Android Application Repo]

== Lessons Learned ==

=== Design for Debug (DFD) ===

In our project we moved onto PCB very early in the project life cycle. While in one hand it gives the whole project a very cool look and reduces fly wire uses but at the same time it severely hinders HW debugging capability. For example, initially when the RPM sensor was tested on component level, it was very easy for us to characterize the behaviors by simple connecting the RPM sensor on a breadboard and using a scope with fly wires to observe the signals and their behaviors. But once the whole circuit moved onto the PCB, it was very hard to probe any of the signals without explicitly soldering fly wires onto the connections itself. There could be 3 ways to remdy this situation:

* Use either SJOne on board LEDs or external GPIO triggered LEDs on the customized PCB and use them as indication of signals. Limitation of this would be that the debugging will be limited to only SIGNAL_ON or SIGNAL_OFF not the actual values of the signal. For example, this method can not be used to debug a PWM frequency

* Use stacking header set with raised male pins ([https://www.adafruit.com/product/706 example of stacking header from Adafruit]). The beauty of using this is that, at any given time, any of the SJ One on board pins can be scoped out without any interference! By far this would give us the best debugging capabilities possibly known to mankind in case of any HW issues. It would also give the flexibility to conenct a fly wire to any other pins at any given time without the need of soldering.

=== HW and FW reviews across the board ===

As the project went along we made rapid changes to our designs in both HW and FW. But these changes were sometimes sensitive to the whole system and caused hiccups here and there. It would have been a great idea if all the ECUs would do design reviews with all stake holders even though the others might not be directly related to those specific designs. Fr example, Motor ECU owner should create design document of the power and the ESC/Servo wiring and share with others especially when there's a major risk that Motor ECU combines the secondary 5V power and the Primary 8.2V Traxxas power through GND ref. Similarly the Sensor ECU owner would do design reviews on what sensors to use, how they differ and how they would be used with other stakeholders and so on.

=== Rigorous component level testing ===

Rigorous component level testing is something we could have improved in this project. For example, earlier in the development phase we could have done a parametric sweep of PWM frequency of the front wheels to see at what percentage of PWM, we can turn the wheels at what degree. Once that would have been documented, it would have been very easy for  us to implement multiple angles of operation for the front wheels. Similarly, we could have done a parametric characterization of the ADC values for sensor readings vs a measured distances to see if the curve is really linear or there are some weird behavior when the distance increases drastically.

=== Second sourcing ===

Often times in the project, we would jump onto a component and will dive in to bring up the system but we completely overlooked the idea of what if we end up empty handed in the bring up process? For example, in our project we used Ultra sonic sensors for obstacle avoidance but we never had a backup plan, should we have failed to use the ultra sonic sensors effectively. In ideal scenario, we should have brought up Lidar lite system in parallel so any day if there would have been an issue with the ultra sonics, we would right away jump onto Plan B and get the Lidars on.

It would also be a great idea that whenever we get a component for the car, if it's not something very expensive, we need to buy couple of more extra pieces too. For example, when we bought the sensors, we bought exact amounts that we needed but once when the car crashed, we never had any extra ones so we had to wait for over night shipping to get more sensors. It would have been easily avoided if only we would have bought some extra pieces initially.

== References ==
=== Acknowledgement ===

* Preetpal Kang for guiding us over our accomplishments
* Marvin Flores for the awesome 3D printed sensor mounts
* Western Digital Firmware Lab for letting us borrow the tools for electrical characterization and debugging
* Families for being patient while we spend weekends and weekday nights working on the car

=== References Used ===

* LCD: [http://www.4dsystems.com.au/productpages/ViSi-Genie/downloads/Visi-Genie_refmanual_R_2_0.pdf Genie User Guide]
* ESC: [https://traxxas.com/sites/default/files/58076OM-EN-R00.pdf Traxxas VXL ESC Guide]
* Sensors: [https://www.maxbotix.com/documents/LV-MaxSonar-EZ_Datasheet.pdf Ultrasonic sensor datasheet]
* General: [https://www.google.com Google] and [https://www.youtube.com Youtube]