Difference between revisions of "F17: Rolling Thunder"

Latest revision as of 21:39, 22 December 2017

1 Rolling Thunder self-driving car
2 Legend
3 Team Members & Responsibilities
4 Abstract
5 Objectives & Introduction
6 Schedule
7 Parts List & Cost
8 DBC File Implementation
9 PCB Design
10 Master Controller
11 Sensor Controller
12 Motor & I/O Controller
13 Geographical Controller
14 Communication Controller (Bridge)
15 Android Application
- 15.1 Design & Implementation
  - 15.1.1 Software Design
  - 15.1.2 Implementation
- 15.2 Testing & Technical Challenges
  - 15.2.1 Bluetooth connection
  - 15.2.2 JSON
16 Conclusion
- 16.1 Project Video
- 16.2 Project Source Code
17 References
- 17.1 Acknowledgement
- 17.2 References Used

Rolling Thunder self-driving car

This is our creation, The Rolling Thunder !!

Rolling Thunder

Legend

Color	Component
Orange	Master Controller
Red	Geographical Controller
Indigo	Communication Controller (Bridge)
Green	Motor/IO Controller
Blue	Sensor Controller
Teal	Android App
Brown	QA

Team Members & Responsibilities

Master Controller
- Akil Khan
- Jerry John
Sensor Controller
- Sona Bhasin
- Thrishna Palissery
Motor and I/O Controller
- Saurabh Ravindra Badenkal
- Joshua Skow
Geographical Controller
- Abhilash Tuse
- Vishal Shrivastava
Communication Controller (Bridge)
- Akinfemi Akin-Aluko
Android Application
- Johnny Nigh
QA Team
- Akil Khan
- Saurabh Ravindra Badenkal

Abstract

The project aims at building a self-navigating RC car. The car uses five Control Units (CU), each responsible for a specific functionality, and the concept of sensor fusion to steer around obstacles to a destination set from an Android application. The CUs include a master controller, sensor controller, motor controller, geographical controller, and a communication controller. SJOne programming board is used for implementing the firmware for each CU. The CUs communicate with each other via CAN bus using their respective message formats predefined in a DBC file. The sensor controller detects the presence of obstacles, the motor controller controls the motors of the car, the geographical controller determines the navigation course of the car based on GPS coordinates, compass data and the information on the route to destination, conveyed by the communication controller, from the Android application. The master controller is the intelligent node that takes decisions based on the data received from other nodes and autonomously drives the car to its destination.

Objectives & Introduction

With several versions of the idea being prototyped and tested extensively, self-driving cars are the imminent future of transportation industry. Through this project, we enhanced a remote-controlled RC car with the capability to autonomously navigate to a destination, provided by an Android application, while avoiding obstacles. There are five Control Units (CUs) that coordinate with each other to achieve this functionality, namely:

Sensor Controller: This unit has four ultrasonic sensors interface to it covering the front, left, right and rear of the car. The readings from the four sensors help in detecting potential obstacles on the navigation path of the car and subsequently steer clear of them.

Motor and I/O Controller: This unit is responsible for controlling the motors of the car and enable the car to move forward or reverse; turn left or right, and adjust or attain desired speed using a PID control loop. It also has an LCD interfaced to it to display the car diagnostics in real time.

Geographical Controller: This unit has a compass and GPS module interfaced to it. The compass readings help to ensure that the car is heading in the right direction. It also provides the distance between the current position of the car and the GPS coordinates of the nearest checkpoint.

Communication Controller (Bridge): This unit is responsible for making the checkpoints from the Android application available to the car. It also provides the start and stop commands to the car.

Master Controller: This unit is the sole intelligent node that oversees the functioning of the car. The node receives data from other nodes based on which the navigation course of the car is adjusted to drive the car to the destination.

System Architecture

The primary objectives of the project are:

to be able to navigate to a destination as set by the Android application
to be able to steer clear of obstacles on the path
to be able to follow the route to destination with the help of compass and GPS
to be able to attain the desired speed, maintain it as well as adjust the speed depending on the terrain

With this project, we also aim:

to learn the use of CAN bus in automotive industry
to learn the basics of version control system - Git
to learn unit testing of functionality of each control unit and their integration
to learn periodic scheduling in RTOS
to learn to work as a team

Schedule

	Start Date	End Date	Task	Status	Date of Completion
1	09/20/2017	09/26/2017	Order components and distribute project modules. Research on project requirements. Research on different sensors to be used.	Completed	09/26/2017
2	09/27/2017	10/03/2017	Set up project Git and Wiki page. Understand the hardware specifications of each component. Study the datasheet of each component and the hardware interfacing. Test the compatibility of each module.	Completed	10/03/2017
3	10/04/2017	10/10/2017	Establish a connection over Bluetooth between the Android app and the BRIDGE.	Completed	10/10/2017
	10/10/2017		Wiki Schedule	Completed	10/10/2017
4	10/11/2017	10/17/2017	Test ultrasonic sensors (Maxbotix and Parallax ping) and identify the suitable one for front and rear. Verify basic commands to Traxxas motor, send basic commands (e.g. forward) to RC car from SJOne board. Configure GPS device baud rate and interface it with SJOne board using UART. Parse data received from GPS device to transmittable format. Analyse the information required to communicate across the controllers. Chalk out the Message IDs based on the priority of the messages and the data to be sent across nodes. Understand DBC and implement the DBC file compatible with all the controllers. Transfer data from the Android app to the BRIDGE.	Completed	10/17/2017
5	10/18/2017	10/24/2017	Implement sensor code and perform standalone testing. Finish motor controller API. Test motor driving in different situations, begin to listen to CAN for controls. Interface motor to the SJOne board and check for basic functionality. Interface Compass module with SJOne board using I2C serial bus. Interface Geo controller module with CAN Bus. Establish communication across all the CAN controllers over CAN bus based on the DBC file. Verify the power-up interactions and configurations between Master and the other controllers Receive data in the Android app from the BRIDGE.	Completed	10/24/2017
	10/24/2017		DBC File	Completed	10/24/2017
	10/24/2017		DEMO: CAN communication between controllers	Completed	10/24/2017
6	10/25/2017	10/31/2017	Add a button for setting the destination and stopping the car manually. Add a TextView for displaying the Bluetooth connection status.	Completed
7	11/01/2017	11/07/2017	Implement basic obstacle avoidance algorithm based on sensor data and test the same. Adjust sensor orientation based on testing. Continue testing motor driver via commands from CAN bus. Build in speed steps to reverse motor for reverse to work correctly. Calibrate Compass Module. Develop code for GPS and Compass module communication over CAN. Send and recieve current location, destination and checkpoint coordinates to and from App and Geo module via BRIDGE.	Completed	11/07/2017
	11/07/2017		DEMO: Motors driven by wheel feedback and sensors, Basic obstacle avoidance Final Wiki Schedule	Completed	11/07/2017
8	11/08/2017	11/14/2017	Filter sensor value readings if necessary and decide on incorporating the filter algorithm either in master controller or sensor controller based on performance testing Begin work on LCD to show vehicle status (speed, fuel status, obstacles, distance to destination etc.) in an intuitive GUI. Finish implementing speed control on motor (to make sure requested speed is met based on RPM read). Fine tune motor reversing. Integrate all modules with the Master to test the data flow. Fine tune obstacle avoidance steering logic with rear sensor input and reversing. Start incorporating Geo module information to master module steering logic. Decide, implement and test data exchange between Geo module and BRIDGE. Calculate and send simple bearing angle and destination status on CAN to figure out initial challenges. Add a Google Map for setting the car's destination. Send car location to app and check points received to Geo module. Test each module individually Verify the stringent requirement of Start-up Sync, Periodic heart-beat messages. Start adding contents to the relevent sections of wiki.	Completed	11/14/2017
9	11/15/2017	11/21/2017	Test obstacle avoidance algorithm and fine tune sensor readings Test the LCD at run time for vehicle status and decide on improvements if any. Stabilize navigation logic with multiple checkpoints, bearing angle and destination status info. Identify and mitigate GPS locking, offset and other issues. Assure correctness of compass calibration. Determine if any more changes to DBC are required and lock it down. Implement the steering logic with bearing angle and status provided by geo-module. Consistently communicate current car location to App, get check points from App and relay them to Geo module. Send additional vehicle status information from can bus to the app for display. Send the request to Google for getting the checkpoints (use the Google Maps Directions API). Field test and check for obvious issues in obstacle avoidance, navigation, maintaining speed (up/down hill). Provide feed backs to each team on identified short comings. Update wiki with details.	Completed	11/21/2017
	11/21/2017		DEMO: GPS driving	Completed	11/21/2017
10	11/22/2017	11/28/2017	Analyse areas lagging behind and redeploy team where additional resources are required. Implement turning indicators, break lights and head light. Improvise steering logic based on field tests under various conditions and locations. Analyse field test results to re-calberate GPS offset values if required. Generate new checkpoints manually between the waypoints received from Google for better navigation accuracy. Test the accuracy of check-points from the Bluetooth controller, location data from the Geo-controller sensor and Navigation Algorithm. Check overall robustness of the complete system. Update wiki with details.	Completed
11	11/29/2017	12/19/2017	All hands on testing and final bug fixes. Check for tuning or calibration of modules 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.	Completed	12/20/2017
	12/20/2017		DEMO: Final Project SUBMISSION: Final Project Wiki	Completed	12/20/2017

Parts List & Cost

Item #	Description	Distributor	Qty	Cost
1	SJOne Board	Provided by Preet	5	$400
2	RC Car - Traxxas 1/10 Slash 2WD	Amazon	1	$189.95
3	Bluetooth Bee BLE 4.0 Module	ebay	1	$15
4	GPS Module	Amazon	1	$28.99
5	Compass (CMPS11)	Acroname	1	$45.95
6	Traxxas 6520 RPM Sensor	Amazon	1	$10.82
7	Traxxas 2991 LiPo Battery and Charger	Amazon	1	$199.95
8	Breadboard Jumper Wires	Amazon	1	$6.99
9	MIFFLIN Acrylic Plexiglass Clear Plastic Sheet	Amazon	1	$9.89
10	Printed Circuit Board	Amazon	1	$16.83
11	PCB Mounting Feet Set	Amazon	1	$11.99
12	Traxxas 6538 Telemetry Trigger Magnet Holder	Amazon	1	$4.63
13	MB1240 XL-MaxSonar EZ4 Ultrasonic Sensor	Amazon	2	$73.90
14	Parallax Ping Ultrasonic Range Sensor	Amazon	2	$69.98
15	CAN Transceiver (MCP 2551)	Microchip	10	Free
16	4D systems 32u LCD	4D Systems	1	$85.00
17	Miscellaneous Items		1	$100.00

Total cost: $1,269.87

DBC File Implementation

The DBC file describes the format of messages broadcast over the Controller Area Network (CAN) bus. The format of each message, corresponding to a control unit, comprises of a distinct message id assigned based on priority for bus arbitration. It also specifies the source and destination of the message, length of the message, datatype of different data fields within the message, their offset, scaling factor and minimum and maximum value the data field can hold.

The DBC file used for the project is as shown below.

VERSION ""

NS_ :
       BA_
       BA_DEF_
       BA_DEF_DEF_
       BA_DEF_DEF_REL_
       BA_DEF_REL_
       BA_DEF_SGTYPE_
       BA_REL_
       BA_SGTYPE_
       BO_TX_BU_
       BU_BO_REL_
       BU_EV_REL_
       BU_SG_REL_
       CAT_
       CAT_DEF_
       CM_
       ENVVAR_DATA_
       EV_DATA_
       FILTER
       NS_DESC_
       SGTYPE_
       SGTYPE_VAL_
       SG_MUL_VAL_
       SIGTYPE_VALTYPE_
       SIG_GROUP_
       SIG_TYPE_REF_
       SIG_VALTYPE_
       VAL_
       VAL_TABLE_

BS_:
BU_: MASTER GEO BRIDGE MOTOR SENSOR

BO_ 100 MASTER_CONTROL: 1 MASTER
SG_ MASTER_CONTROL_cmd : 0|1@1+ (1,0) [0|0] "" SENSOR,GEO,MOTOR,BRIDGE
BO_ 150 BRIDGE_START_STOP: 8 BRIDGE
SG_ BRIDGE_START_STOP_cmd : 0|1@1+ (1,0) [0|0] "cmd" GEO,MASTER
SG_ BRIDGE_CHECKPOINT_latitude : 1|28@1+ (0.000001,-90.000000) [-90|90] "" GEO,MASTER
SG_ BRIDGE_CHECKPOINT_longitude : 29|29@1+ (0.000001,-180.000000) [-180|180] "" GEO,MASTER
SG_ BRIDGE_FINAL_COORDINATE : 58|1@1+ (1,0) [0|0] "" GEO,MASTER

BO_ 200 SENSOR_DATA: 5 SENSOR
SG_ SENSOR_left_sensor : 0|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
SG_ SENSOR_middle_sensor : 8|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
SG_ SENSOR_right_sensor : 17|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
SG_ SENSOR_back_sensor : 25|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR

BO_ 250 GEO_DATA: 4 GEO
SG_ GEO_bearing_angle : 0|9@1- (1,0) [-180|180] "degrees" MASTER,MOTOR
SG_ GEO_distance_to_checkpoint : 9|16@1+ (0.01,0) [0|500] "meters" MASTER,MOTOR
SG_ GEO_destination_reached : 25|1@1+ (1,0) [0|0] "" MASTER,MOTOR

BO_ 300 MOTOR_UPDATE: 2 MASTER
SG_ MOTOR_speed : 0|10@1+ (0.1,-34) [-34.0|34.0] "mps" MOTOR
SG_ MOTOR_turn_angle : 10|6@1- (1,0) [-30|30] "" MOTOR

BO_ 350 MOTOR_FEEDBACK: 2 MOTOR
SG_ MOTOR_actual_speed : 0|10@1+ (0.1,-34) [-34.0|34.0] "mps" BRIDGE,MASTER
SG_ sensed_battery_voltage : 10|6@1+ (0.5,0) [0|5] "volts" BRIDGE,MASTER

BO_ 400 UPDATE_CURRENT_LOCATION: 8 GEO
SG_ UPDATE_calculated_latitude : 0|28@1+ (0.000001,-90.000000) [-90|90] "" BRIDGE,MOTOR
SG_ UPDATE_calculated_longitude : 28|29@1+ (0.000001,-180.000000) [-180|180] "" BRIDGE,MOTOR

BO_ 450 UPDATE_COMPASS_BEARING: 2 GEO
SG_ COMPASS_bearing_angle : 0|9@1+ (1,0) [0|360] "degrees" MOTOR

BO_ 500 BRIDGE_HB: 1 BRIDGE
SG_ BRIDGE_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER

BO_ 510 SENSOR_HB: 1 SENSOR
SG_ SENSOR_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER

BO_ 520 GEO_HB: 1 GEO
SG_ GEO_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER

BO_ 530 MOTOR_HB: 1 MOTOR
SG_ MOTOR_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER

CM_ BU_ MASTER  "The Master controller driving the car";
CM_ BU_ MOTOR   "The Motor controller of the car";
CM_ BU_ SENSOR  "The Sensor controller of the car";
CM_ BU_ BRIDGE  "The Bridge controller (Bluetooth module) of the car";
CM_ BU_ GEO     "The GEO (GPS + Compass) controller of the car";

BA_DEF_ "BusType" STRING ;
BA_DEF_ BO_ "GenMsgCycleTime" INT 0 0;
BA_DEF_ SG_ "FieldType" STRING ;
BA_DEF_DEF_ "BusType" "CAN";
BA_DEF_DEF_ "FieldType" "";
BA_DEF_DEF_ "GenMsgCycleTime" 0;

BA_ "GenMsgCycleTime" BO_ 150 100;
BA_ "GenMsgCycleTime" BO_ 100 100;
BA_ "GenMsgCycleTime" BO_ 200 100;
BA_ "GenMsgCycleTime" BO_ 400 100;
BA_ "GenMsgCycleTime" BO_ 250 100;
BA_ "FieldType" SG_ 100 MASTER_CONTROL_cmd "MASTER_CONTROL_cmd";

VAL_ 100 MASTER_CONTROL_cmd 1 "DRIVER_HEARTBEAT_cmd_START" 0 "DRIVER_HEARTBEAT_cmd_RESET" ;

PCB Design

PCB

Hardware setup

Master Controller

Group Members

Jerry John
Akil Khan

Design & Implementation

The master controller acts as the brainpower of the car and processes the data from the rest of the nodes to achieve smooth navigation of the car to its destination. Basically, it takes data from the sensor and geo node to ensure obstacle avoidance and navigation.

Hardware Design & Interface

Master controller does not need any other additional hardware to be connected/interfaced to it as it is responsible for implementing the obstacle avoidance and directing the car to the destination. Hence, the hardware design of master controller only consists of the node being connected to the CAN bus via CAN transceiver module. The figure shows the hardware design of the master.

Master controller Interface

Below is the pin connection table of the master controller to the CAN bus

S.R.	CAN Transceiver Pins	SJOne Board Pins
1	GND	GND
2	RXD	P0.1 (RXD3)
3	TXD	P0.0 (TXD3)

Software Design and Implementation

Heartbeat messages

To ensure operability of all nodes on the car, all slave nodes are configured to automatically transmit a 1 byte heartbeat message to the master. In this way, the system achieves network monitoring. If the master doesn't receive the heartbeat message for couple of seconds, it raise a flag and simply asks the corresponding node to restart again.

Heartbeat mechanism

Communication and driving algorithm

From the power cycle, every node starts sending out its intended CAN messages on the bus. Once the user has set the destination, the app calculates the list of checkpoints and sends it to the bridge node via UART. Bridge node then decodes these checkpoints and sends it to the geo node via the CAN bus. Geo then takes one checkpoint at a time and guides/navigates the master to navigate the car towards the checkpoint. During this operation, whenever an obstacle is encountered, master tries to avoid obstacle ignoring the geo navigation information till the time the obstacle has been avoided. Internally, the priority of CAN messages plays a vital role in achieving this algorithm. In master, all the processing has been done in the 100Hz task. For example: if the left sensor detects an obstacle in the 100Hz, it straight away sends a right turn command to the motor. This helps for faster processing and greater accuracy and precision.

The following flowchart shows the entire operation of the car.

Control Flow

In order to avoid the obstacle successfully, we had placed a higher priority on the sensor data message. Also, we were taking into account what direction is the destination so that the car doesn't take a longer route to get to the destination after avoiding the obstacle. Even the direction of reversing the car was controlled by the destination/checkpoint bearing angle. For the navigation of the car, we divided the received bearing angle from the GEO node by 6 and fed it to motor without any additional calculations. The received bearing angle was in the range of -180 to +180. The valid turn angles for the motor were -30 to +30 degrees. Dividing by 6 would give a more smoother navigation operation and hence we decided to stick with that.

Testing & Technical Challenges

Testing is the single-most important task of this project. Unit testing got rid of some of the bugs, but it was on-field testing which picked up a lot of bugs.

Test individual algorithms first (Obstacle avoidance, navigation) and then integrate the two and test the integrated mechanism.
Test the car for an approaching obstacle at every possible angle.
Test the car for straight paths and then move onto testing complex shaped paths.
Test the car during different times of the day.
Testing different types of checkpoint strategies and finalizing on the most efficient one.

Some of technical issues that we faced during the course of this project are as follows:

Messages not being received due to small CAN RX Queue size

Issue: Initially, master controller node had 20 as the RX Queue size. We observed that some CAN messages were visible on the Busmaster, but in the firmware, they weren't being received.

Solution: The RX Queue size was increased on all nodes in order to overcome this issue.

Car taking time to reverse

Issue: Initially, direct negative speed was being sent to the motor controller. Motor took a lot of time to reverse, as it had to break from its PID loop.

Solution: We fixed this issue by sending a '0' speed before giving the negative speed. We took the feedback from the motor, when the motor reached zero speed, it would then issue the negative speed to reverse.

Sensor Controller

Group Members

Thrishna Palissery
Sona Bhasin

Design & Implementation

XL-MaxSonar-EZ4 Sensor

The sensor controller oversees the functioning of ultrasonic sensors for the purpose of obstacle avoidance. The sensor controller comprises of four ultrasonic sensors interfaced to an SJOne board. XL-Maxbotix-ez4 sensors are installed on the front and back of the car respectively and Parallax ping sensors are placed to guard the sides of the car from obstacles. Based on the beam angle of each sensor, they have been mounted to protect the front and rear of the car from hitting obstacles.

XL-MaxSonar-EZ4

The XL-Maxbotix-ez4 sensor can detect obstacles up to 7.65 meters and works between a supply voltage range of 3.3 V to 5.5 V. The sensor operates at 42 KHz and is equipped with inbuilt acoustic and electrical noise filtering. It has the highest noise tolerance compared to other Maxbotix sensors. It has low power consumption and can also detect small objects, This sensor has a dead zone between 0cm - 20cm, wherein the objects cannot be accurately detected.

Parallax Ping Sensor

Parallax ping

The Parallax ping sensor requires a supply voltage of 5 V. It can measure the distance of obstacles within a range of 3 cm to 3 m. An LED indicator on the sensor shows that the measurement is in progress. A single General-purpose input/output(GPIO) pin is used to trigger the sensor (to send an ultrasonic burst) as well as to listen for the echo pulse that is returned. The distance to the target can be calculated by measuring the width of the echo pulse.The sensor won’t be able to accurately measure the distance to an obstacle in the following scenarios:

If the object is at a distance of more than 3 meters
If the object is too small
The sound gets reflected off the floor if the sensor is mounted low on the device
If the sound is reflected at a shallow angle ( < 45 °), it won’t be reflected back to the sensor

Hardware Design

The sensors are interfaced to the SJOne board on port 2 pins. The ultrasonic sensor triggering and ranging is implemented with the help of GPIO and external interrupts. All sensors and CAN transceiver (MCP 2551) requires a supply voltage of 5V. An external power supply is provided to SJOne board. Port 0 pins are configured as CAN receiver and transmitter. A 120 ohm resistor is used as terminating resistor for CAN bus.

Sensor Controller Interface

Sensor Positioning

Maxbotix Ultrasonic Sensor
Position	Maxbotix Sensor Pins	SJOne Board Pins
Front	RX - Trigger	2.1
	PWM - Echo	2.3
Back	RX - Trigger	2.0
	PWM - Echo	2.5

Parallax Ping Ultrasonic Sensor
Position	Parallax Sensor Pins	SJOne Board Pins
Left	SIG	2.4
Right	SIG	2.2

Hardware Interface

Pin 2.1 of SJOne board is configured as GPIO and is connected to the RX pin (Pin 4) of Front Sensor(Maxbotix sensor)
Pin 2.0 of SJOne board is configured as GPIO connected to the RX pin (Pin 4) of Back Sensor (Maxbotix sensor)
Pin 2.3 of SJOne board is configured as GPIO and external interrupt is enabled for rising and falling edge. This pin is connected to the PWM (Pin 2) pin of Front Sensor (Maxbotix sensor)
Pin 2.5 of SJOne board is configured as GPIO and external interrupt is enabled for rising and falling edge. This pin is connected to the PWM pin (Pin 2) of Back Sensor (Maxbotix sensor)
Pin 2.4 of SJOne board is configured as GPIO and external interrupt for both rising and falling edge is also enabled. It is connected to SIG pin of left sensor (Parallax ping)
Pin 2.2 of SJOne board is configured as GPIO and external interrupt for both rising and falling edge is also enabled. It is connected to SIG pin of right sensor (Parallax ping)
Pin 0.0 of SJOne board is configured as RD1 and is connected to RXD pin (Pin 4) of MCP 2551 (can transceiver). Messages from other nodes are received via this pin.
Pin 0.1 of SJOne board is configured as TD1 and is connected to TXD pin (Pin 1) of MCP 2551 (can transceiver). The sensor values are tranmitted over the CAN BUS via this pin.

  CAN DBC Message: sensor node
   BO_ 200 SENSOR_DATA: 5 SENSOR
   SG_ SENSOR_left_sensor : 0|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
   SG_ SENSOR_middle_sensor : 8|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
   SG_ SENSOR_right_sensor : 17|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
   SG_ SENSOR_back_sensor : 25|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR

CAN 1 of sensor controller (SJOne board) is configured and used for transmitting all sensor values (distance to obstacles) to the master controller.

Software Design

Flow chart

Pseudo code - 100 Hz task

The front and the back sensors (Maxbotix sensors) are triggered first by driving their respective Rx pin (Pin 4 of the sensors) high for around 25 microseconds. The PW (Pin 2 of the sensors) pin is set high after the Rx pin is triggered and will be set to low if an object is detected. The PW pin will be held high for 44.4 milliseconds(ms) in case if no obstacle is detected. The front and back sensors are triggered at 10 ms,100ms,200ms, 300ms… and so on. The left and right sensors (parallax ping sensors) are triggered after 50ms is elapsed from the time the Maxbotix sensors are triggered. This is to minimize the effect of reflected waves from the maxbotix interfere with parallax ping which results in erroneous values. The SIG pin of the parallax ping sensors is set high for around 5us to send the trigger pulse. The sensor emits a short 40 kHz (ultrasonic) burst. The same pin is used for listening the echo pulse that is returned from obstacle in parallax ping. The SIG pin is set high after the trigger pulse is sent from the host microcontroller and will be set low if an obstacle is detected. The PW pin will be held high for 18 milliseconds(ms) approximately in case if no obstacle is detected. The left and right sensors are triggered at 60ms, 160ms, 260ms, 360ms… and so on. All the four sensor values will be available at every 90ms and will be transmitted over the CAN bus at 90ms, 190ms, 290ms, 390ms and so on… Triggering as well as transmission of the sensor values over the CAN bus is handled in 100Hz periodic task with proper elapsed time count check. A heartbeat message is transmitted to master controller using 1Hz periodic task

Implementation

Flow chart - Maxbotix

Flow chart - Parallax ping

Pseudo Code - Distance Calculation

Steps for triggering and distance calculation for Maxbotix sensors:

Configure the micro-controller pin which is connected to the RX pin of the sensor as output
Configure the micro-controller pin which is connected to the PWM pin of the sensor as input
Enable external interrupts for rising and falling edge for the pin connected to PWM pin of sensor
Trigger the RX pin by sending a clean high pulse through host micro-controller
1. Set GPIO pin connected to RX as low (for a clean high pulse)
2. Give delay of ~2us
3. Set GPIO pin connected to RX as high
4. Give delay of ~25us
5. Set GPIO pin connected to RX as low
Get the time at which rising edge interrupt occurs on micro-controller pin connected to PWM (start time)
Get the time at which falling edge interrupt occurs on micro-controller pin connected to PWM(stop time )
Calculate the distance in inches to the obstacle using the formula: Distance = [ ( start_time – stop_time ) / 147 ] ( inches )
Send the calculated distance to the master controller using CAN Bus.
Repeat the steps 4 to 8

Steps for triggering and distance calculation for Parallax ping sensors:

Enable external interrupts for rising and falling edge for the pin connected to PWM pin of sensor
Configure the micro-controller pin which is connected to the SIG pin of the sensor as output
Trigger the SIG pin by sending a clean high pulse through host micro-controller
1. Set GPIO pin connected to SIG as low (for a clean high pulse)
2. Give delay of ~2us
3. Set GPIO pin connected to SIG as high
4. Give delay of ~5us
5. Set GPIO pin connected to SIG as low
Configure the micro-controller pin which is connected to the SIG pin of the sensor as input
Get the time at which rising edge interrupt occurs on microcontroller pin connected to SIG (start time)
Get the time at which falling edge interrupt occurs on microcontroller pin connected to SIG (stop time)
Calculate the distance in inches to the obstacle using the formula: Distance = [ ( start_time – stop_time ) / 147 ] ( inches )
Send the calculated distance to the master controller using CAN Bus.
Repeat the steps 2 to 8

Plot of Sensor Readings on Bus Master

Sensor Readings Graph

Testing & Technical Challenges

Interference between sensors

Issue: Due to the placement of front, left and right sensors in close proximity to each other, we observed that there were inconsistencies in sensor readings on the detection of an obstacle. This was checked by monitoring sensor messages on BusMaster.

Solution: We were able to reduce the impact of interference by avoiding overlap of ranging time of sensors. To achieve this, the sensors with non-overlapping ranging areas are being triggered at a time and enough time is provided for the sensors to complete their ranging before the next set of sensors are triggered.

Blind spots to the front of the car

Issue: On putting the permanent sensor mounts in place and after subsequent testing, it was observed that there were blind spots at the front end of the car such that obstacles falling in some areas weren't being detected effectively.

Solution: To overcome the issue, we isolated the sensing area of each sensor based on their respective beam angles and adjusted the sensor positions. As a result, we were able to minimize the blind spots towards the front of the car with least interference. The tradeoff that we had to make was leaving the extreme left and right sides of the car vulnerable to collision with obstacles.

Motor & I/O Controller

Group Members

Joshua Skow
Saurabh Badenkal

Design & Implementation

The motor controller controls the motors of the car and enables the car to move forward or reverse with given speed and turn left or right with given angle. It helps adjust the speed according to terrain or attain desired speed using a PID control loop. The motor controller receives messages from all other control units and displays the status of the car on an LCD interfaced to it.

Electronic Speed Controller (ESC)

Titan DC Motor

Traxxas Servo Motor

RPM Sensor

TFT Display

Electronic Speed Controller (ESC)

This ESC is the Traxxas provided speed controller for the DC motor. This controller takes in the 7V DC from the LiPo car battery and provides it to the DC Motor to drive the rear wheels. The ESC is programmable and has 3 modes of operation(Training/Race/Sport). These modes can be configured by long sequenced press of the ESC power button. The ESC is sophisticated and has a EMF shield in order to protect the system from any back EMF. The ESC uses the 7V DC from battery and gives 3 connecting wires. One for motor speed control PWM signal, other 2 for 5V DC and GND.

DC Motor

This motor is responsible for driving the rear wheels. The current flows from positive terminal to negative terminal of the motor for the forward movement of the wheels. Whereas, for the reverse movement the current flows from negative terminal to positive terminal. This speed control is achieved by sending appropriate PWM signal with required duty cycle to the PWM signal wire of the ESC controller. The ESC requires a 100Hz PWM signal with varied duty cycle options : 10-15% to drive the motor in reverse and 15-20% drives the motor forward.

Servo Motor

This motor is responsible for turning the two front wheels left and right. The servo operates on the same PWM frequency 100Hz and same duty cycle as the driver motor; 10-15% duty cycle turns the wheels left, 15-20% duty cycle turns the wheels right. The servo motor is controlled directly from the SJOne micro-controller board.

RPM Sensor

The RPM sensor is a small magnet attached to an internal gear on the Traxxas slash. There is a housing that holds a hall sensor, and when the gear with the magnet spins it induces a pulse to the SJOne. The sensor is powered using the 5 volts power supply from the power bank.

Display Module

The module used to display the key diagnostics of the car is a 3.2" TFT Display from 4D Systems. Apart from adding to the aesthetics of the car, it serves as an effective tool for debugging by displaying crucial car diagnostics data collected from the sensor controller, the motor controller and the geographical controller that play an important role in guiding the car from source to destination with a significant level of efficiency.

Hardware Design

The Traxxas Slash receiver box contains 3 pin connectors for signal, the input voltage (VCC) and ground. There are 4 3 pin connectors that come on the Traxxas Slash receiver - 3 of which are used for the car (Servo motor, Driver motor, and RPM sensor). The VCC of each connector is shorted together, and tied to the car battery. The grounds are all shorted as well and connected to the PCB of everything on the car. See the Hardware Interface section for more detail on the Traxxas motor connections.

The RPM sensor is connected physically to the gearbox, with a small magnet attached to the largest gear. There is a small hall sensor mounted next to this large gear, and every time the gear makes a revolution the hall sensor provides a high pulse indicating the rotation. The RPM sensor signal is tied to a GPIO on the SJOne board, and requires a 3.3V pull up resistor.

The display module from 4D Systems is connected to the TX and RX pins of UART 3 communication channel, on the SJOne board, to display the status of the car on the move.

Motor Controller Interface

Hardware Interface

The motor controller contains the following interfaces to the SJOne board:

PWM to the Driver motor (P2.1)
PWM to the Servo motor (P2.2)
GPIO to the RPM sensor (P2.0)
ADC for battery voltage monitoring (P1.31)
UART to the display module (TXD3/RXD3)

Motor Connections

Driver/Servo Motor

The driver and servo motor PWM requirements were determined by plugging an oscilloscope probe into the receiver signal for each motor. Using a remote control provided by Traxxas to drive the car, we intercepted the PWM from the remote control in order to reverse engineer how to drive the car with the SJOne.

Oscilloscope capture of motor PWM from the Traxxas provided remote control

Battery Voltage Monitor

The battery voltage monitor is a pin out from the Traxxas 8V car battery to an ADC on the SJOne (P1.31, ADC5). The battery voltage needs to be dropped down below 3.3V in order for the ADC to successfully capture the appropriate battery voltage value. A resistor divider was used to drop the 8V battery (max) down below 3.3V.

Battery Voltage Circuit

Display Module

The 4D Systems LCD is interfaced to the motor controller using UART communication protocol. It uses a power supply of 5V. The LCD can be programmed using the 4D Workshop4 IDE software tool. It can be connected to the PC using the accompanying 4D programming cable. To program the LCD, the compiled project file, for the GUI design, generated from the development environment is loaded on to an SD card and inserted into the card slot on the LCD. The motor controller can then send data serially to the LCD and it is displayed on the GUI for easy interpretation and debugging.

LCD Interface

The TX and RX pins of LCD are connected to RXD3 and TXD3 pins of SJOne board respectively. There is a common ground established between the SJone board and the LCD in addition to a 5V supply provided to power up the LCD.

Software Design

The software design of the motor controller and the display module are explained in detail below. Two major functions handled in motor controller is to control the speed and turning angle of the wheels of the car and also update the LCD with the values from other nodes. Additional functions handled by this module includes calculating voltage level of the car battery and also controls the headlights and indicators on the car.

Motor Software Flow

Motor Controller

The motor is abstracted as a C++ class. The motor class is able to set the Driver motor and the Servo motor.

The motor class is also responsible for taking in a desired speed, and making sure the car is driving at that speed. The motor class interprets the RPM sensor output, determines the current car speed compared to the desired car speed, and drives the motor to make the current car speed as close to the desired speed as possible.

Software Design

Display Module

The below flowchart explains how the display module receives and transmits data.

LCD Flowchart

The UART 3 communication channel is initialized at a baud rate of 9600 bps. The diagnostics data is received at the motor controller from corresponding nodes via CAN bus. The data is then populated into the LCD-specific frame format and sent to the LCD in the 1 Hz periodic task. On receiving the frame, the LCD displays the data and sends an acknowledgment back to the motor controller. Thus, the data on LCD is updated every 1 s.

Implementation

The motor controller node encompasses two main functions: driving and steering the motor, and sending data to the LCD.

Motor Controller

The motor used a PID (proportional, integral, derivative) based control algorithm to keep the actual motor speed as close as possible to the desired speed. The tuning was done with the car mounted on a platform. The PID was tuned with the following method:

1. Select a proportional coefficient and change it until the motor feedback has a minimal oscillation.

2. Increase the derivative coefficient until there are no more oscillations.

3. Increase the integral coefficient until the speed increases fast enough and there is no oscillations.

The PID control loop logic takes the error, read speed and desired speed and calculates a new speed to give to the motor in order to reach the desired speed.

Program flow of driver motor speed control

Display Module

The LCD graphical user interface is designed using the 4D Workshop4 IDE. A screen dedicated to each controller is created using suitable objects or strings to interpret the critical car data like sensor readings, speed, GPS coordinates, distance to destination and compass data. Some of the objects used on the LCD are:

Gauges: For displaying sensor data and battery status
Meter: For displaying motor speed
Angularmeter: For displaying compass direction
LEDDigits: For displaying compass readings

In addition, strings are used to display attributes like GPS coordinates, distance to destination, motor speed, and sensor readings.

Transmission of data to LCD

The LCD expects the data, received over UART, in a specific message format depending on whether an object or string would be used to display the same.

The message format for writing to an object is as shown below.

Write Object Message Format

To display any data using an object, the host controller transmits the 1-byte command code 0x01 followed by the object ID byte and the object index byte. The object ID is a value assigned to each object type to differentiate one from the other and the object index is its unique number. Both these values can be determined by referring to the quick guide provided on 4D Systems website and from the 4D Systems development environment. After sending the object index, the MSB and LSB of the data are sent. The checksum byte is calculated by XOR’ing all bytes in the message from (and including) command byte to the last parameter byte. The result is appended to the message.

The message format for writing to a string is as shown below.

Write String Message Format

For writing to string, the host controller transmits the 1-byte command code 0x02 followed by the unique string index byte. The actual data is sent as a character array of 1-byte values preceded by its length and followed by the checksum.

For every message corresponding to a 'write object' or 'write string' received by the LCD, it sends an acknowledgment ACK = 0x06 to the host controller.

LCD Screens

The screens displaying the car diagnostics corresponding to each controller are as shown below.

Startup Screen

Menu Screen

Sensor Screen

Motor Screen

GPS Screen

Compass Screen

Testing & Technical Challenges

The basics of controlling the motor are relatively easy - send a PWM to the driver motor and servo motor. The difficulty comes in driving the motor to a specific speed and in reading an accurate speed.

Measuring motor speed accurately

Issue: In order to measure the speed of the motor, the hall sensor pulses need to be interpreted to determine how many revolutions the wheel makes per second.

Solution: There are two ways to use the hall sensor pulses:

1. Wait a known amount of time, and record the number of pulses received.

2. Wait until a certain number of pulses are received, then calculate the delta in time.

RPM sensor reading

We chose option number 2. Option number 1 is flawed in that you must determine the MINIMUM time to measure for pulses. And if you only capture half a pulse, then your RPM reading will swing back and forth wildly. With an inconsistent RPM reading, maintaining a consistent speed becomes impossible. By choosing option 2, the hall sensor pulse will never happen in the middle of an arbitrary time window. Thus, option 2 provides more stability and accuracy for reading the speed of the car.

Knowing when the car has stopped

Issue: When you use a hall sensor to detect if a wheel is moving, you cannot detect if the wheel has stopped. In order to appropriately control the speed of the car, you need to be able to know when the car has stopped, but there is no way to know if the car has slowed down to a very slow speed or if it is no longer moving without a very long time window.

Solution: In order to determine if the car is stopped, we calculated the minimum speed supported by the car and found out how long it would take for the wheel to rotate for that speed.

Thus, the car supports a minimum speed of 0.5 meters per second, and any speed slower than that is not guaranteed to be supported or have smooth operation. This is because if there is no wheel rotation after the expected time for a 0.5 mps speed, then the motor controller assumes the car is no longer moving.

Attaining desired speed

Issue: When the car is reading a speed from the RPM sensor that is not the same as the desired speed, the motor controller must try to change it's current speed to match the desired speed.

Solution: In order to make the error between desired speed and read speed as close to zero as possible, we used a PID (Proportional, Integral and Derivative) control loop. This PID loop serves to keep the error factor as close to zero as possible. Tuning the PID loop required much testing, and the method to tune the PID loop is detailed above.

PID Tuning

Issue: In order for the motor speed to reach a stable value, quickly, and with no oscillations, the PID control loop needs to have the correct coefficients so that the motor responds to disturbances appropriately. Finding these correct coefficients is called "tuning" the PID.

Solution: By propping the car up in the air and adding a PID tuning CLI to the SJOne console, the PID was tuned as in the steps listed in the Software Implementation. Tuning the PID requires taking time to test the car at different speeds, with different disturbances, and with different PID coefficients until the driver motor reacts as desired.

Geographical Controller

Group Members

Abhilash Tuse
Vishal Shrivastava

Design & Implementation

The Geographical Controller is in place for navigation purpose. It has two essential parts, namely GPS and compass. It provides direction to the car, by calculating the heading angle and the distance between the coordinates, based on GPS and compass readings. To calculate heading angle, we need a compass bearing angle and angle between the line joining the two coordinates and the true north (bearing angle for GPS).

Heading angle calculation

GPS Bearing angle calculation

With the reference to the figure, the bearing angle for GPS is the angle between the line joining the two coordinates and the true north. To calculate it graphically, draw a vector pointing towards the destination coordinates from the start point coordinate and measure the angle between the vector and the true north. Use the below formula to calculate the angle mathematically.

 Bearing angle(α) = atan2(sin Δλ ⋅ cos φ2 , cos φ1 ⋅ sin φ2 − sin φ1 ⋅ cos φ2 ⋅ cos Δλ)
 where,
       φ1 = Latitude of 1st Coordinate
       φ2 = Latitude of 2nd Coordinate
       λ1 = Longitude of 1st Coordinate
       λ2 = Longitude of 2nd Coordinate
       Δλ = λ2 - λ1

Heading angle calculation

The heading angle is the angle between the compass vector and the vector drawn for calculating GPS bearing angle.

 Heading angle(γ) = α – β
 where, 
       α = Angle between the line joining the two coordinates and the true north
       β = Angle between compass vector and the true north (Compass bearing angle)

If heading angle is positive the car turns right or else turns left.

Distance between the two coordinates calculation

The distance between the two coordinates can be calculated using the Haversine formula.

 a = sin²(Δφ/2) + cos φ1 ⋅ cos φ2 ⋅ sin²(Δλ/2)
 c = 2 ⋅ atan2(√a, √(1−a))
 d = R ⋅ c
 where,
       φ1 = Latitude of 1st Coordinate
       φ2 = Latitude of 2nd Coordinate
       λ1 = Longitude of 1st Coordinate
       λ2 = Longitude of 2nd Coordinate
       Δφ = φ2 - φ1
       Δλ = λ2 - λ1
       d  = distance between the two coordinates
       R  = earth’s radius (mean radius = 6,371km)
 Note: All the angles should be in radians.

Hardware Design

The diagram below shows the h/w interfacing of SJ One board with GPS module and Compass module. The GPS module and the Compass module is communicating over UART3 and I2C respectively with SJ One board.

Hardware Design

Pin mapping of GPS module with SJ One board:

GPS Module Pins	SJ One Board Pins
Vin	3.3v
GND	GND
TX	RXD3
RX	TXD3

Pin mapping of Compass module with SJ One board:

Compass Module Pins	SJ One Board Pins
GND	GND
SDA	SDA
SCL	SCL

Compass module requires an external power supply of 5V.

Hardware Interface

The hardware interface details of GPS and compass with SJOne board are given below:

GPS Module

Ublox NEO M8N GPS Module

GPS is communicating over UART with SJ One board. The data from the GPS is updated at 5 Hz frequency. The most important part is GPS configuration. It is configured using FTDI cable and Ucenter software. We are using the below shown settings for GPS configuration in Ucenter software :

GPS Configuration Table
Config Parameter	Value
Baud Rate	38400
Refresh Rate	5Hz
Navigation Mode	Pedestrian

To filter out GPGGA string, other messages are disabled in 'Messages view'. The results can be seen in the text console image.

Ucenter GPS Configuration

Ucenter GPS Text Console

 GPGGA Message Structure: $GPGGA,hhmmss.ss,llll.ll,a,yyyyy.yy,a,x,xx,x.x,x.x,M,x.x,M,x.x,xxxx

 Example GPGGA string: $GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47
 Where:
      GGA          Global Positioning System Fix Data
      123519       Fix taken at 12:35:19 UTC
      4807.038,N   Latitude 48 deg 07.038' N
      01131.000,E  Longitude 11 deg 31.000' E
      1            Fix quality:   0 = invalid, 1 = GPS fix (SPS), 2 = DGPS fix, 3 = PPS fix, 4 = Real Time Kinematic, 5 = Float RTK,
                                  6 = estimated (dead reckoning) (2.3 feature), 7 = Manual input mode, 8 = Simulation mode
      08           Number of satellites being tracked
      0.9          Horizontal dilution of position
      545.4,M      Altitude, Meters, above mean sea level
      46.9,M       Height of geoid (mean sea level) above WGS84 ellipsoid
      (empty field) time in seconds since last DGPS update
      (empty field) DGPS station ID number
      *47          the checksum data, always begins with *

Compass Module

CMPS11 Compass Module

Compass is communicating over I2C with SJ One board. The register 2 and 3 of the compass provide the compass bearing angle (0- 360 range). Calibrating the compass is an important part. We are calibrating it on ‘horizontal calibration mode’, it works for us because the compass has tilt calibration.

Calibration process: First of all, you need to enter the calibration mode by sending a 3-byte sequence of 0xF0,0xF5 and then 0xF7 to the command register, these MUST be sent in 3 separate I2C frames. There MUST be a minimum of 20ms between each I2C frame.

The LED will then extinguish and the CMPS11 should now be rotated in all directions on a horizontal plane, if a new maximum for any of the sensors is detected then the LED will flash, when you cannot get any further LED flashes in any direction then exit the calibration mode with a command of 0xF8.

Note: Please make sure that the CMPS11 is not located near to ferrous objects as this will distort the magnetic field and induce errors in the reading. While calibrating rotate the compass slowly. Only the X and Y magnetometer axis is calibrated in this mode.

We are sending 3-byte sequence command of 0xF0,0xF5 and then 0xF7 on 4th switch press and 0xF8 command on 2nd switch press of the SJ One board. You can always restore factory calibration mode by sending the 3-byte sequence command of 0x20,0x2A,0x60. We are using switch 3 to restore factory calibration.

Software Design

Software design consists of three main classes, GeoController, GeoGPS and GeoCompass. GeoController is the top level class which calls GeoGPS and GeoCompass class methods to calculate distance and heading angle. These values are then sent to master controller to navigate the car. Below is the class diagram for detailed reference.

Class Diagram

CAN Communication

The following table lists the CAN messages used for communication with the Geographical controller.

GEO Controller CAN messages Table
Message Number	Sender	Destination	Message Name
0x100	Master	Geo	MASTER_CONTROL
0x150	Bridge	Geo	BRIDGE_START_STOP
0x250	Geo	Master, Motor	GEO_DATA
0x400	Geo	Bridge, Motor	UPDATE_CURRENT_LOCATION
0x450	Geo	Motor	UPDATE_COMPASS_BEARING
0x520	Geo	Master	GEO_HB

Implementation

Flow chart

In 1 Hz periodic call back function
- Reset CAN Bus if bus off
- Send heartbeat signal to Master
- Send compass reading to Motor controller

In 10 Hz periodic call back function
- Read the compass bearing angle from Compass module
- Read the GPS data string from the GPS module
- Parse the GPS string and send the current location coordinates to Bridge controller and Motor controller
- Calculate and send distance to immediate checkpoint, heading angle, and a flag to indicate final destination reached to Master controller and Motor controller
- Display the distance to immediate checkpoint on 7 segment displays on the Geo controller’s SJ one board
- Toggle the LED 4 on Geo controller’s SJ one board to indicate the GPS fix

In 100 Hz periodic call back function
- Compass calibration routine called here
- Receive the checkpoint coordinates from the Bridge controller

Testing & Technical Challenges

GPS doesn’t retain configuration settings

Issue: Every time the GPS is powered down it forgets the configuration settings after 4-5 hours and it has to be configured again.

Solution: It could retain the configuration for some time (after powering down) because of a supercapacitor. We replaced the supercapacitor with a 3.3v battery and now it retains the configuration after it is powered down.

Compass frequently losing calibration

Issue: Compass was losing calibration because of the magnetic interference from the motors.

Solution: We wrapped the acrylic sheet (on which our compass was placed) with aluminum foil that acts as a magnetic shield for the compass. To ease the calibration process, we came up with an idea to do it on a switch press.

Unable to send complete GPS coordinates on CAN bus (with 6 decimal digits)

Issue: GPS coordinates require double data type and current python script doesn't handle it.

Solution: So we had to make changes to Python script. Reference: F16: Titans Team

Communication Controller (Bridge)

Group Members

Akinfemi Akin-Aluko

Design & Implementation

User communicates with the car via the communication bridge controller. The hardware and software design details of this module are given below.

Hardware Design

Hardware Components:

SJ-One Board Features Summary :

LPC1758
512K ROM, 64K(96K) RAM, 1M(2M) SPI Flash, and Micro-SD card slot.
Temperature, Acceleration, Infra Red, and Light.
GPIO, SPI, UART, I2C.
2 digit LED display
5V Power Supply
Highly efficient software framework with many peripheral drivers.
Nordic wireless with mesh network software stack

SJ-One Board Picture

XBee Bluetooth.

-80dBm sensitivity.
Up to +4dBm RF transmit power.
Fully Qualified Bluetooth V2.0+EDR 3Mbps Modulation.
Low Power 1.8V Operation, 1.8 to 3.6V I/O.
UART interface.
Integrated PCB antenna.
xBee compatible headers.

XBee Bluetooth

Hardware Interface

Bluetooth chip communicates to SJOne board using UART interface. Pins P 0.1 and 0.0 of the SJOne board is connected to TXD and RXD pins of the CAN transceiver respectively. The CANH and CANL of the transceiver is connected to the CANH and CANL of the CAN BUS wire which is terminated with 120 ohm resistor.

Comm HW Interface

Software Design

The Communication Controller's role in the car is to make communication possible between the user via an Android application and the car. The Communication Controller (bridge) receives data transmitted over the UART from the Android app. With pre-agreed "opcodes", the bridge parses the data and sends the respective information to the CAN bus. The opposite direction of the flow happens when the GPS gets a lock and the current location of the car is displayed on the app at real time. The Flow Chart below shows how this process happens at a high level.

Communications Controller Flow Diagram

Implementation

Activity Diagram

Period Init

CAN Init
CAN Reset
Create FreeRTOS Queue
UART Init

Period 1Hz

Reset CAN if off
Send Controller Heartbeat to CAN Bus

Period 10hz

FreeRTOS QueueRecieve
Parse and Send App data to CAN Bus
Receive Car Location from Geo Node over CAN

Period 100hz

Read App data over UART
Send data to FreeRTOS queue

Testing & Technical Challenges

Gibberish values while transmitting data from the app

Issue: Even though the website says the default xBee baud rate is 38400, it wasn't. It took a couple of days to figure why we had gibberish values.

Solution: UART speed should be accounted for when transmitting data from the app.

Dummy Bluetooth App for Communication development testing

Issue: Dependence on App for testing, since the development of the App and the communication controller happens in parallel.

Solution: Serial Communication Bluetooth App on Play Store for connectivity and baud rate testing. Android Studio with MapActivity template to test coordinates parsing.

UART

Issue: Data from the App is greater than the default UART queue size.

Solution: Dig into the source code and increase it.

Issue: Data loss after large transmission.

Solution: Soft reboot (at the right time).

Android Application

Design & Implementation

The app plays a crucial role in the project since it provides the checkpoints for the car's route. The app was designed for Android 7.0 (Nougat; API level 24) and requires Android 4.4 (KitKat; API level 19) or higher (up to Android 8.1, Oreo; API level 27). Google Play Services 11.0.0 or higher is required to use the Google Maps portion (for selecting the destination).

Software Design

The GUI uses fragments since it is easier to load screens within the main activity instead of moving from one activity to another. For example, there is one fragment for obstacle avoidance and another fragment for vehicle navigation (they can be accessed using the navigation drawer). We had planned to add a wireless CAN bus monitor in a third fragment but this could not be completed due to time restrictions.

The class locationPoint is user-defined and it represents each location on the map (the vehicle, the destination, and each checkpoint).

activity_main.xml

This layout is displayed after the app is launched. The parent layout uses DrawerLayout which contains a ListView (both are needed for a navigation drawer). There is also a FrameLayout for the fragments.

fragment_main.xml

This fragment is used for obstacle avoidance. This layout uses a ConstraintLayout with an ImageView, TextView, and Button. Below the ImageView and TextView is a Button used to start or stop the car manually (start will only enable obstacle avoidance mode).

The ImageView and TextView are for displaying the Bluetooth connection status on the top left-hand side of the screen. Both of these components change based on the following conditions:

Bluetooth is disabled or enabled.
The app is trying to connect to a Bluetooth module.
The app is connected to a Bluetooth module on the bridge.
The app is not connected to a Bluetooth module.

The user is asked to enable Bluetooth

The device is not connected

Connecting to the module

Connected to the module

The vehicle's location (in green), the destination (in red), and the checkpoints (in purple)

fragment_nav.xml

This fragment is used for navigation mode and only contains a child fragment for the map (the parent layout is LinearLayout).

The navigation drawer will display a button on the top right (within the ActionBar) when this fragment is loaded. This button is used to set the destination and put the vehicle in self-driving mode (if the user has already tapped on a location on the map).

The map shows the location of the vehicle using a green marker and a red marker is used to show the destination (if applicable). All of the checkpoints on the route are shown with a purple marker.

drawer_list_item.xml

This layout file simply defines the customized appearance of the fragment names within the navigation drawer using a TextView.

build.gradle (app)

This Gradle build file contains the Play Services version requirement (11.0.0), the target SDK version (Android API level 24), minimum SDK version (Android API level 19), the key information for generating the release version of the .apk file, the compiled SDK version (Android API level 27), and the build tools version (27.0.2).

AndroidManifest.xml

The manifest file contains the permission to access the device's Bluetooth and the key for using the Google Maps Android API (the key is required to display the Google Map within the MapView component of the fragment_main.xml layout).

strings.xml

This file stores all of the strings used in the app including the key for the Google Maps Directions API.

MainActivity.java

This is the only activity in the app and it is first loaded when the app is started. It loads the activity_main.xml layout which holds a FrameLayout. The FrameLayout is used for loading fragments.

When the app has first launched the method onCreate runs. The TTS (Text-to-Speech) object, the navigation drawer, the Bluetooth adapter, and the main fragment are created and initialized. If the device supports Bluetooth, then the monitorBluetooth method is called.

The monitorBluetooth method runs a TimerTask every 1 second to check the Bluetooth connection. If Bluetooth is disabled, then the user is asked once to enable it again. If Bluetooth is enabled, then we try to connect by running the method setupBluetooth (if we aren't connected or are trying to connect already). The ImageView and TextView are updated depending on what happens here.

The method setupBluetooth checks for a paired Bluetooth device with the hard-coded Bluetooth MAC address. If a matching device is found, then a Thread runs (our ConnectThread class).

The ConnectThread class uses a Bluetooth socket for the Bluetooth connection. Once a connection is established, then another thread executes to handle the data transfer (our class ConnectedThread). This is similar to the BluetoothChat example app that is provided by Google on the Android Developers site (and one of the examples in Android Studio).

The ConnectedThread class is used for writing data (the checkpoints) or reading data (the vehicle's location) to or from the bridge controller. When data is received it is sent to the main thread (as long as the data transfer follows a specific format).

The button in the ActionBar on the top-right of the screen will execute a FetchItemsTask object (it is only displayed when the Navigation fragment is visible). The FetchItemsTask is a user-defined class with a superclass of AsyncTask. This is where the request to get the directions is sent to Google using the Google Maps Directions API. We also manually create more checkpoints to improve the accuracy of navigation (if the checkpoints are too far then the vehicle can, but not definitely will get off course). The checkpoints are then sent over Bluetooth to the bridge with the sendCheckpoints method.

Other user-defined methods in this file include:

writeStartStop: sends the command to manually start (for obstacle avoidance mode only) or stop the vehicle.

sendLatLong: sends the latitude and longitude of a locationPoint object.

sendCheckpoints: sends each checkpoint (this utilizes sendLatLong).

getDistanceFromLatLongInM: calculates the distance between two coordinates using double values. The calculation follows the Haversine formula (as described in the Geo controller section).

When the app is closed onDestroy executes and we close the Bluetooth socket.

MainFragment.java

This is the fragment that is loaded first. This fragment contains the ImageView and TextView objects for the Bluetooth connection status and the button for starting and stopping the vehicle (starting is for obstacle avoidance only).

After onAttach runs, onCreateView executes. All of the components of fragment_main.xml are initialized and set up in onCreateView (including a click listener for the button).

The method updateStartStopButton uses the main thread to change the Button while the method updateBluetoothConnectionStatus uses the main thread to change the TextView and ImageView.

The Callbacks interface is used to call methods between the activity and the fragments.

NavFragment.java

This fragment contains the map which is initialized and set up in onCreateView.

When onResume runs (i.e. when the app is in the foreground again after being in the background), the marker for the vehicle is drawn on the map using the user-defined method addMarkerVehicle (it is redrawn if a previous marker was already set. This is done in order to get the latest data on the vehicle's location).

onMapReady runs once after the MapView is first loaded and adds the marker for the vehicle (if applicable). The click listener is also set up here so that whenever the user taps on the map the destination is set (this only happens if the car is not already on a route or the vehicle has been manually stopped).

Other user-defined methods in this file include:

setLatLongDestination: sets the latitude and longitude for the destination (represented by a locationPoint object).

addMarkerVehicle: adds the green marker on the map for the vehicle.

addMarkersForCheckpoints: adds purple markers for each checkpoint used on the route.

locationPoint.java

This is a user-defined class for each location that is used in the app (each of the checkpoints, the vehicle, and the destination). The class contains a String and double field for the latitude and corresponding fields for the longitude (there are also byte array fields for both of these coordinates).

The method processLatLong() processes the latitude and longitude so that each coordinate has six decimal places. This method also calculates the byte array versions of the latitude and longitude.

The String and double coordinates are assigned using the setLatLong(double latitude, double longitude) method, which also calls processLatLong() to get the byte array versions.

The methods getMessageNumberOfBytesLatitude() and getMessageNumberOfBytesLongitude() return the number of bytes for the coordinate in the byte array format.

Implementation

This section explains the implementation of the key components of the app such as establishing the Bluetooth connection, the map (Google Maps), and the directions (using the Google Maps Directions API).

Bluetooth connection

We used Bluetooth sockets to connect the app and bridge controller.

First, we get a list of all of the paired Bluetooth connections on the Android device (these are stored temporarily in the app using the Java Set interface). Second, we check each Bluetooth connection to find a paired device that has the same Bluetooth MAC address of the module on the bridge controller (if applicable). If there is a match, then a thread (using our class ConnectThread) is created for connecting over Bluetooth.

The thread will first call the method for updating the ImageView and TextView to alert the user that we are trying to connect. Next, the thread uses the BluetoothDevice class' method getUuids to get a UUID to pass to the createInsecureRfcommSocketToServiceRecord (this is part of the same BluetoothDevice class). If the RFCOMM Bluetooth socket was created successfully, then we call the BluetoothSocket class' connect method.

If the BluetoothSocket connection was successful, then we create a new thread (using our class ConnectedThread) for handling the data transfer. The ConnectedThread creates an input stream for receiving data from the bridge and an output stream for sending data to the bridge. The run method for this class runs a while(true) loop. In this loop the InputStream class' method read is called and the loop waits until data is received.

Data transfer

The data is transferred to and from the app and bridge controller using specific formats.

Once data is received in the while loop of the ConnectedThread's run method, then we look for the termination char 'e'. If the data received is a specific length that matches what the bridge should be sending for the vehicle's location and the char 'e' was the third-to-last char in the data, then the data is sent to the main thread using a Handler.

The Handler parses the message for the number of bytes for the latitude, the number of bytes for the longitude, the latitude, and the longitude. If there is an error when converting from String to double for any of these values, then the message is discarded. If there were no errors, then we check if the vehicle is 2 m or less from the destination, we set the latitude and longitude for the vehicle's locationPoint object, and we add the new marker for the vehicle on the map. If the vehicle is 2 m or less from the destination, then the TTS (Text-To-Speech) object alerts the user with the audio "the destination has been reached".

The checkpoints are sent to the bridge in the following format (it is similar to a message received from the bridge):

Header:

The opcode ('c')
The number of checkpoints

Checkpoint 1:

The number of bytes for the latitude
The number of bytes for the longitude
The latitude
The longitude

Checkpoint 2-n:

The opcode ('c')
The number of bytes for the latitude
The number of bytes for the longitude
The latitude
The longitude

Google Maps Android API

A key has to be generated in the Google API Console to use Google Maps in an Android app. This key is copied into the AndroidManifest.xml file.

Google Maps Directions API

In order to get direction, a key has to be generated in the Google API Console for the Google Maps Directions API. A request is sent to Google using a String with the following values (in the same order shown and a comma between the latitude and longitude values):

https://maps.googleapis.com/maps/api/directions/json?units=imperial&mode=walking&origin=
vehicle's latitude
vehicle's longitude
&destination
destination's latitude
destination's longitude
&key=
Google Maps Directions API key

Testing & Technical Challenges

Most of the basic concepts for Android development were already familiar from past experience (i.e. CMPE 277). The main challenge was establishing the Bluetooth connection and handling the data that is received over Bluetooth (we came up with specific formats for messages between the bridge and app).

Bluetooth connection

One of the initial challenges was finding out how to connect to the module over Bluetooth. A Bluetooth connection requires a UUID and the easiest way to get a UUID is to get one from the Bluetooth radio itself (the device name refers to the BluetoothDevice object instance that we are using):

device.getUuids()[0].getUuid()

JSON

The directions can be returned by Google in a JSON object (the alternative option is XML). It can be difficult to parse JSON objects if you aren't familiar with doing this task but there are resources online that are helpful (including the Google Maps Directions API website/guide).

Conclusion

This project served as a great source of learning as it was challenging to develop and integrate the features of the self-driving car. It gave us a great sense of achievement in having completed the project by working together as a team.

By completing this project we all learned how to use an important version control tool in development-Git. Git allowed us to keep track of changes to the master branch as well as branches for each of the controllers and the Android application. We also got hands-on experience with the CAN bus protocol which is useful for any embedded system in the automotive industry as well as the DBC file format and the BusMaster CAN tracing tool. We were required to complete unit testing for each of the controllers. Learning Test Driven Development (TDD) was a challenge but overall it was a great experience for us because developing this way reduced time spent on debugging.

Project Video

https://www.youtube.com/watch?v=YiA8Qv2gooY&feature=youtu.be

Project Source Code

References

Acknowledgement

We would like to express our gratitude to Professor Preetpal Kang for generously sharing his time and knowledge with us and guiding us through the completion of this project. We would also like to thank the ISA team for their valuable advice and constructive feedback.

References Used

PID Control

LCD

Connecting LCD to Host

Android GUI

Bluetooth

Google Maps

Datasheets

[1] XL-MaxSonar-EZ4 Ultrasonic Sensor
[2] Parallax Ping Sensor
[3] 4D Systems LCD
[4] CAN Transceiver
[5] GPS Module
[6] Compass Module

@@ Line 1: / Line 1: @@
+==Rolling Thunder self-driving car==
+This is our creation, The Rolling Thunder !!
+[[File:CmpE243_F17_Rolling_Thunder_car.jpeg|900px|thumb|center|Rolling Thunder]]
 ==Legend==
 {| class="wikitable"
@@ Line 33: / Line 40: @@
 <font color="teal"> Teal </font color>
 |
-Android Application
+Android App
 |-
 !
@@ Line 45: / Line 52: @@
 ** Akil Khan
 ** Jerry John
+*  <font color="blue"> Sensor Controller </font color>
+** Sona Bhasin
+** Thrishna Palissery
+*  <font color="green"> Motor and I/O Controller </font color>
+** Saurabh Ravindra Badenkal
+** Joshua Skow
 *  <font color="red"> Geographical Controller </font color>
 ** Abhilash Tuse
@@ Line 50: / Line 63: @@
 *  <font color="indigo"> Communication Controller (Bridge) </font color>
 ** Akinfemi Akin-Aluko
-*  <font color="green"> Motor and I/O Controller </font color>
-** Saurabh Ravindra Badenkal
-** Joshua Skow
-** Sona Bhasin
-*  <font color="blue"> Sensor Controller </font color>
-** Sona Bhasin
-** Thrishna Palissery
 *  <font color="teal"> Android Application </font color>
 ** Johnny Nigh
@@ Line 64: / Line 70: @@
 == Abstract ==
-A self-driving car navigates to a destination while avoiding obstacles. The car is a modified RC (remote control) car. The destination is set using an Android app.
+The project aims at building a self-navigating RC car. The car uses five Control Units (CU), each responsible for a specific functionality, and the concept of sensor fusion to steer around obstacles to a destination set from an Android application. The CUs include a master controller, sensor controller, motor controller, geographical controller, and a communication controller. SJOne programming board is used for implementing the firmware for each CU. The CUs communicate with each other via CAN bus using their respective message formats predefined in a DBC file. The sensor controller detects the presence of obstacles, the motor controller controls the motors of the car, the geographical controller determines the navigation course of the car based on GPS coordinates, compass data and the information on the route to destination, conveyed by the communication controller, from the Android application. The master controller is the intelligent node that takes decisions based on the data received from other nodes and autonomously drives the car to its destination.
+== Objectives & Introduction ==
+With several versions of the idea being prototyped and tested extensively, self-driving cars are the imminent future of transportation industry. Through this project, we enhanced a remote-controlled RC car with the capability to autonomously navigate to a destination, provided by an Android application, while avoiding obstacles. There are five Control Units (CUs) that coordinate with each other to achieve this functionality, namely:
+'''Sensor Controller:''' This unit has four ultrasonic sensors interface to it covering the front, left, right and rear of the car. The readings from the four sensors help in detecting potential obstacles on the navigation path of the car and subsequently steer clear of them.
+'''Motor and I/O Controller:''' This unit is responsible for controlling the motors of the car and enable the car to move forward or reverse; turn left or right, and adjust or attain desired speed using a PID control loop. It also has an LCD interfaced to it to display the car diagnostics in real time.
+'''Geographical Controller:''' This unit has a compass and GPS module interfaced to it. The compass readings help to ensure that the car is heading in the right direction. It also provides the distance between the current position of the car and the GPS coordinates of the nearest checkpoint.
+'''Communication Controller (Bridge):''' This unit is responsible for making the checkpoints from the Android application available to the car. It also provides the start and stop commands to the car.
+'''Master Controller:''' This unit is the sole intelligent node that oversees the functioning of the car. The node receives data from other nodes based on which the navigation course of the car is adjusted to drive the car to the destination.
+[[File:CmpE243_F17_Rolling_Thunder_system_architecture.PNG|1000px|thumb|center|System Architecture]]
+The primary objectives of the project are:
+*to be able to navigate to a destination as set by the Android application
+*to be able to steer clear of obstacles on the path
+*to be able to follow the route to destination with the help of compass and GPS
+*to be able to attain the desired speed, maintain it as well as adjust the speed depending on the terrain
+With this project, we also aim:
+*to learn the use of CAN bus in automotive industry
+*to learn the basics of version control system - Git
+*to learn unit testing of functionality of each control unit and their integration
+*to learn periodic scheduling in RTOS
+*to learn to work as a team
 == Schedule ==
@@ Line 255: / Line 293: @@
 * Create the semester long project activity video and upload to YouTube.
 * Update and finalize wiki.
-| In Progress
+| Completed
-|
+| 12/20/2017
 |-
 ! scope="row"|
@@ Line 262: / Line 300: @@
 | DEMO: Final Project
 SUBMISSION: Final Project Wiki
-|
+| Completed
-|
+| 12/20/2017
 |-
 |}
@@ Line 363: / Line 401: @@
 |-
 ! scope="row"| 15
-| CAN Transceiver
+| CAN Transceiver (MCP 2551)
 | [http://www.microchip.com/wwwproducts/en/en010405 Microchip]
 | 10
@@ Line 382: / Line 420: @@
 |}
-'''Total cost:''' $1,269.87
+'''<font color="Red"> Total cost: </font color> $1,269.87'''
+== DBC File Implementation ==
+The DBC file describes the format of messages broadcast over the Controller Area Network (CAN) bus. The format of each message, corresponding to a control unit, comprises of a distinct message id assigned based on priority for bus arbitration. It also specifies the source and destination of the message, length of the message, datatype of different data fields within the message, their offset, scaling factor and minimum and maximum value the data field can hold.
+The DBC file used for the project is as shown below.
+ VERSION ""
+ NS_ :
+        BA_
+        BA_DEF_
+        BA_DEF_DEF_
+        BA_DEF_DEF_REL_
+        BA_DEF_REL_
+        BA_DEF_SGTYPE_
+        BA_REL_
+        BA_SGTYPE_
+        BO_TX_BU_
+        BU_BO_REL_
+        BU_EV_REL_
+        BU_SG_REL_
+        CAT_
+        CAT_DEF_
+        CM_
+        ENVVAR_DATA_
+        EV_DATA_
+        FILTER
+        NS_DESC_
+        SGTYPE_
+        SGTYPE_VAL_
+        SG_MUL_VAL_
+        SIGTYPE_VALTYPE_
+        SIG_GROUP_
+        SIG_TYPE_REF_
+        SIG_VALTYPE_
+        VAL_
+        VAL_TABLE_
+ BS_:
+ BU_: MASTER GEO BRIDGE MOTOR SENSOR
+ BO_ 100 MASTER_CONTROL: 1 MASTER
+ SG_ MASTER_CONTROL_cmd : 0|1@1+ (1,0) [0|0] "" SENSOR,GEO,MOTOR,BRIDGE
+ BO_ 150 BRIDGE_START_STOP: 8 BRIDGE
+ SG_ BRIDGE_START_STOP_cmd : 0|1@1+ (1,0) [0|0] "cmd" GEO,MASTER
+ SG_ BRIDGE_CHECKPOINT_latitude : 1|28@1+ (0.000001,-90.000000) [-90|90] "" GEO,MASTER
+ SG_ BRIDGE_CHECKPOINT_longitude : 29|29@1+ (0.000001,-180.000000) [-180|180] "" GEO,MASTER
+ SG_ BRIDGE_FINAL_COORDINATE : 58|1@1+ (1,0) [0|0] "" GEO,MASTER
+ BO_ 200 SENSOR_DATA: 5 SENSOR
+ SG_ SENSOR_left_sensor : 0|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+ SG_ SENSOR_middle_sensor : 8|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+ SG_ SENSOR_right_sensor : 17|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+ SG_ SENSOR_back_sensor : 25|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+ BO_ 250 GEO_DATA: 4 GEO
+ SG_ GEO_bearing_angle : 0|9@1- (1,0) [-180|180] "degrees" MASTER,MOTOR
+ SG_ GEO_distance_to_checkpoint : 9|16@1+ (0.01,0) [0|500] "meters" MASTER,MOTOR
+ SG_ GEO_destination_reached : 25|1@1+ (1,0) [0|0] "" MASTER,MOTOR
+ BO_ 300 MOTOR_UPDATE: 2 MASTER
+ SG_ MOTOR_speed : 0|10@1+ (0.1,-34) [-34.0|34.0] "mps" MOTOR
+ SG_ MOTOR_turn_angle : 10|6@1- (1,0) [-30|30] "" MOTOR
+ BO_ 350 MOTOR_FEEDBACK: 2 MOTOR
+ SG_ MOTOR_actual_speed : 0|10@1+ (0.1,-34) [-34.0|34.0] "mps" BRIDGE,MASTER
+ SG_ sensed_battery_voltage : 10|6@1+ (0.5,0) [0|5] "volts" BRIDGE,MASTER
+ BO_ 400 UPDATE_CURRENT_LOCATION: 8 GEO
+ SG_ UPDATE_calculated_latitude : 0|28@1+ (0.000001,-90.000000) [-90|90] "" BRIDGE,MOTOR
+ SG_ UPDATE_calculated_longitude : 28|29@1+ (0.000001,-180.000000) [-180|180] "" BRIDGE,MOTOR
+ BO_ 450 UPDATE_COMPASS_BEARING: 2 GEO
+ SG_ COMPASS_bearing_angle : 0|9@1+ (1,0) [0|360] "degrees" MOTOR
+ BO_ 500 BRIDGE_HB: 1 BRIDGE
+ SG_ BRIDGE_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER
+ BO_ 510 SENSOR_HB: 1 SENSOR
+ SG_ SENSOR_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER
+ BO_ 520 GEO_HB: 1 GEO
+ SG_ GEO_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER
+ BO_ 530 MOTOR_HB: 1 MOTOR
+ SG_ MOTOR_heartbeat : 0|2@1+ (1,0) [0|0] "" MASTER
+ CM_ BU_ MASTER  "The Master controller driving the car";
+ CM_ BU_ MOTOR   "The Motor controller of the car";
+ CM_ BU_ SENSOR  "The Sensor controller of the car";
+ CM_ BU_ BRIDGE  "The Bridge controller (Bluetooth module) of the car";
+ CM_ BU_ GEO     "The GEO (GPS + Compass) controller of the car";
+ BA_DEF_ "BusType" STRING ;
+ BA_DEF_ BO_ "GenMsgCycleTime" INT 0 0;
+ BA_DEF_ SG_ "FieldType" STRING ;
+ BA_DEF_DEF_ "BusType" "CAN";
+ BA_DEF_DEF_ "FieldType" "";
+ BA_DEF_DEF_ "GenMsgCycleTime" 0;
+ BA_ "GenMsgCycleTime" BO_ 150 100;
+ BA_ "GenMsgCycleTime" BO_ 100 100;
+ BA_ "GenMsgCycleTime" BO_ 200 100;
+ BA_ "GenMsgCycleTime" BO_ 400 100;
+ BA_ "GenMsgCycleTime" BO_ 250 100;
+ BA_ "FieldType" SG_ 100 MASTER_CONTROL_cmd "MASTER_CONTROL_cmd";
+ VAL_ 100 MASTER_CONTROL_cmd 1 "DRIVER_HEARTBEAT_cmd_START" 0 "DRIVER_HEARTBEAT_cmd_RESET" ;
+==PCB Design==
+[[File:CmpE243_F17_Rolling_Thunder_PCB.jpeg|650px|thumb|left|PCB]]
+[[File:CmpE243_F17_Rolling_Thunder_car_design.jpeg|650px|thumb|center|Hardware setup]]
 == Master Controller ==
+==== Group Members ====
+* '''Jerry John'''
+* '''Akil Khan'''
 === Design & Implementation ===
@@ Line 392: / Line 549: @@
 Master controller does not need any other additional hardware to be connected/interfaced to it as it is responsible for implementing the obstacle avoidance and directing the car to the destination. Hence, the hardware design of master controller only consists of the node being connected to the CAN bus via CAN transceiver module. The figure shows the hardware design of the master.
-[[File:master_interface.PNG|600px|thumb|center|Master controller Interface]]
+[[File:CmpE243_F17_Rolling_Thunder_master_interface1.PNG|600px|thumb|center|Master controller Interface]]
 *Below is the pin connection table of the master controller to the CAN bus
 {| class="wikitable"
 |-
 ! align="center"|S.R.
-! align="center"|CAN Transiever Pins
+! align="center"|CAN Transceiver Pins
 ! align="center"|SJOne Board Pins
 |-
 ! scope="row" align="center"|1
-| scope="row" align="center"|Vdd
-| scope="row" align="center"|3.3v
-|-
-! scope="row" align="center"|2
 | scope="row" align="center"|GND
 | scope="row" align="center"|GND
 |-
-! scope="row" align="center"|3
+! scope="row" align="center"|2
 | scope="row" align="center"|RXD
 | scope="row" align="center"|P0.1 (RXD3)
 |-
-! scope="row" align="center"|4
+! scope="row" align="center"|3
 | scope="row" align="center"|TXD
 | scope="row" align="center"|P0.0 (TXD3)
@@ Line 419: / Line 571: @@
 |}
-=== Software Design ===
+=== Software Design and Implementation ===
-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.
+=== Heartbeat messages ===
+To ensure operability of all nodes on the car, all slave nodes are configured to automatically transmit a 1 byte heartbeat message to the master. In this way, the system achieves network monitoring. If the master doesn't receive the heartbeat message for couple of seconds, it raise a flag and simply asks the corresponding node to restart again.
+[[File:CmpE243_F17_Rolling_Thunder_heartbeat.PNG|800px|thumb|center|Heartbeat mechanism]]
+=== Communication and driving algorithm ===
+From the power cycle, every node starts sending out its intended CAN messages on the bus. Once the user has set the destination, the app calculates the list of checkpoints and sends it to the bridge node via UART. Bridge node then decodes these checkpoints and sends it to the geo node via the CAN bus. Geo then takes one checkpoint at a time and guides/navigates the master to navigate the car towards the checkpoint. During this operation, whenever an obstacle is encountered, master tries to avoid obstacle ignoring the geo navigation information till the time the obstacle has been avoided. Internally, the priority of CAN messages plays a vital role in achieving this algorithm. In master, all the processing has been done in the 100Hz task. For example: if the left sensor detects an obstacle in the 100Hz, it straight away sends a right turn command to the motor. This helps for faster processing and greater accuracy and precision.
+The following flowchart shows the entire operation of the car.
+[[File:CmpE243_F17_Rolling_Thunder_flow.PNG|800px|thumb|center|Control Flow]]
-=== Implementation ===
+In order to avoid the obstacle successfully, we had placed a higher priority on the sensor data message. Also, we were taking into account what direction is the destination so that the car doesn't take a longer route to get to the destination after avoiding the obstacle. Even the direction of reversing the car was controlled by the destination/checkpoint bearing angle.
-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.
+For the navigation of the car, we divided the received bearing angle from the GEO node by 6 and fed it to motor without any additional calculations. The received bearing angle was in the range of -180 to +180. The valid turn angles for the motor were -30 to +30 degrees. Dividing by 6 would give a more smoother navigation operation and hence we decided to stick with that.
 === 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?
+Testing is the single-most important task of this project. Unit testing got rid of some of the bugs, but it was on-field testing which picked up a lot of bugs.
-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:
+*Test individual algorithms first (Obstacle avoidance, navigation) and then integrate the two and test the integrated mechanism.
+*Test the car for an approaching obstacle at every possible angle.
+*Test the car for straight paths and then move onto testing complex shaped paths.
+*Test the car during different times of the day.
+*Testing different types of checkpoint strategies and finalizing on the most efficient one.
-==== <Bug/issue name> ====
+Some of technical issues that we faced during the course of this project are as follows:
-Discuss the issue and resolution.
+==== Messages not being received due to small CAN RX Queue size ====
+'''''Issue:''''' Initially, master controller node had 20 as the RX Queue size. We observed that some CAN messages were visible on the Busmaster, but in the firmware, they weren't being received.
+'''''Solution:''''' The RX Queue size was increased on all nodes in order to overcome this issue.
+==== Car taking time to reverse ====
+'''''Issue:''''' Initially, direct negative speed was being sent to the motor controller. Motor took a lot of time to reverse, as it had to break from its PID loop.
+'''''Solution:''''' We fixed this issue by sending a '0' speed before giving the negative speed. We took the feedback from the motor, when the motor reached zero speed, it would then issue the negative speed to reverse.
 == Sensor Controller ==
+==== Group Members ====
+* '''Thrishna Palissery'''
+* '''Sona Bhasin'''
 === Design & Implementation ===
-[[File:CmpE243_F17_Rolling_Thunder_maxbotix.JPG|130px|thumb|right|XL-Maxbotix-ez4 Sensor]]
+[[File:CmpE243_F17_Rolling_Thunder_maxbotix.JPG|130px|thumb|right|XL-MaxSonar-EZ4 Sensor]]
 The sensor controller oversees the functioning of ultrasonic sensors for the purpose of obstacle avoidance. The sensor controller comprises of four ultrasonic sensors interfaced to an SJOne board. XL-Maxbotix-ez4 sensors are installed on the front and back of the car respectively and Parallax ping sensors are placed to guard the sides of the car from obstacles. Based on the beam angle of each sensor, they have been mounted to protect the front and rear of the car from hitting obstacles.
-====XL-Maxbotix-ez4====
+====XL-MaxSonar-EZ4====
-The XL-Maxbotix-ez4 sensor can detect obstacles up to 7.65 meters and works between a supply voltage range of 3.3 V to 5.5 V. The sensor operates at 42 KHz and is equipped with inbuilt acoustic and electrical noise filtering.
+The XL-Maxbotix-ez4 sensor can detect obstacles up to 7.65 meters and works between a supply voltage range of 3.3 V to 5.5 V. The sensor operates at 42 KHz and is equipped with inbuilt acoustic and electrical noise filtering. It has the highest noise tolerance compared to other Maxbotix sensors. It has low power consumption and can also detect small objects, This sensor has a dead zone between 0cm - 20cm, wherein the objects cannot be accurately detected.
 [[File:CmpE243_F17_Rolling_Thunder_parallax.JPG|130px|thumb|right|Parallax Ping Sensor]]
 ====Parallax ping====
-The Parallax ping sensor requires a supply voltage of 5 V. It can measure the distance of obstacles within a range of 3 cm to 3 m. An LED indicator on the sensor shows that the measurement is in progress. A single General-purpose input/output(GPIO) pin is used to trigger the sensor (to send an ultrasonic burst) as well as to listen for the echo pulse that is returned.
+The Parallax ping sensor requires a supply voltage of 5 V. It can measure the distance of obstacles within a range of 3 cm to 3 m. An LED indicator on the sensor shows that the measurement is in progress. A single General-purpose input/output(GPIO) pin is used to trigger the sensor (to send an ultrasonic burst) as well as to listen for the echo pulse that is returned. The distance to the target can be calculated by measuring the width of the echo pulse.The sensor won’t be able to accurately measure the distance to an obstacle in the following scenarios:
+*If the object is at a distance of more than 3 meters
+*If the object is too small
+*The sound gets reflected off the floor if the sensor is mounted low on the device
+*If the sound is reflected at a shallow angle ( < 45 °), it won’t be reflected back to the sensor
 === Hardware Design ===
-The sensors are interfaced to the SJOne board on port 2 pins. The ultrasonic sensor triggering and ranging is implemented with the help of GPIO and external interrupts.
-[[File:CmpE243_F17_Rolling_Thunder_Sensor_Interface.PNG|750px|thumb|center|Sensor Controller Interface]]
-====Maxbotix Ultrasonic Sensor====
+The sensors are interfaced to the SJOne board on port 2 pins. The ultrasonic sensor triggering and ranging is implemented with the help of GPIO and external interrupts. All sensors and CAN transceiver (MCP 2551) requires a supply voltage of 5V. An external power supply is provided to SJOne board. Port 0 pins are configured as CAN receiver and transmitter. A 120 ohm resistor is used as terminating resistor for CAN bus.
-{| class="wikitable"
+[[File:CmpE243_F17_Rolling_Thunder_Sensor_Interface.PNG|650px|thumb|left|Sensor Controller Interface]]
+[[File:CmpE243_F17_Rolling_Thunder_Sensor_Position.PNG|650px|thumb|center|Sensor Positioning]]
+{|class="wikitable"
+|+ Maxbotix Ultrasonic Sensor
 |-
 ! align="center"|Position
@@ Line 478: / Line 669: @@
 |}
-====Parallax Ping Ultrasonic Sensor====
+{| class="wikitable"
+|+ Parallax Ping Ultrasonic Sensor
-{| class="wikitable"
 |-
 ! align="center"|Position
@@ Line 498: / Line 688: @@
 === 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.
+#Pin 2.1 of SJOne board is configured as GPIO and is connected to the RX pin (Pin 4) of Front Sensor(Maxbotix sensor)
+#Pin 2.0 of SJOne board is configured as GPIO connected to the RX pin (Pin 4) of Back Sensor (Maxbotix sensor)
+#Pin 2.3 of SJOne board is configured as GPIO and external interrupt is enabled for rising and falling edge. This pin is connected to the PWM (Pin 2) pin of Front Sensor (Maxbotix sensor)
+#Pin 2.5 of SJOne board is configured as GPIO and external interrupt is enabled for rising and falling edge. This pin is connected to the PWM pin (Pin 2) of Back Sensor (Maxbotix sensor)
+#Pin 2.4 of SJOne board is configured as GPIO and external interrupt for both rising and falling edge is also enabled. It is connected to SIG pin of left sensor (Parallax ping)
+#Pin 2.2 of SJOne board is configured as GPIO and external interrupt for both rising and falling edge is also enabled. It is connected to SIG pin of right sensor (Parallax ping)
+#Pin 0.0 of SJOne board is configured as RD1 and is connected to RXD pin (Pin 4) of MCP 2551 (can transceiver). Messages from other nodes are received via this pin.
+#Pin 0.1 of SJOne board is configured as TD1 and is connected to TXD pin (Pin 1) of MCP 2551 (can transceiver). The sensor values are tranmitted over the CAN BUS via this pin.
+   '''CAN DBC Message: sensor node'''
+   <font color = "Jet"> BO_ 200 SENSOR_DATA: 5 SENSOR
+    SG_ SENSOR_left_sensor : 0|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+    SG_ SENSOR_middle_sensor : 8|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+    SG_ SENSOR_right_sensor : 17|8@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR
+    SG_ SENSOR_back_sensor : 25|9@1+ (1,0) [0|0] "Inches" MASTER,BRIDGE,MOTOR </font color>
+'''''CAN 1 of sensor controller (SJOne board) is configured and used for transmitting all sensor values (distance to obstacles) to the master controller.'''''
 === Software Design ===
-[[File:CmpE243_F17_Rolling_Thunder_sensor_flow_chart.PNG|800px|thumb|center|Flow chart]]
+[[File:CmpE243_F17_Rolling_Thunder_sensor_flow_chart.PNG|800px|thumb|left|Flow chart]]
+[[File:CmpE243_F17_Rolling_Thunder_sensor_pseudo_code_100hz.PNG|450px|thumb|right|Pseudo code - 100 Hz task]]
 The front and the back sensors (Maxbotix sensors) are triggered first by driving their respective Rx pin (Pin 4 of the sensors) high for around 25 microseconds. The PW (Pin 2 of the sensors) pin is set high after the Rx pin is triggered and will be set to low if an object is detected. The PW pin will be held high for 44.4 milliseconds(ms) in case if no obstacle is detected. The front and back sensors are triggered at 10 ms,100ms,200ms, 300ms… and so on.
 The left and right sensors (parallax ping sensors) are triggered after 50ms is elapsed from the time the Maxbotix sensors are triggered. This is to minimize the effect of reflected waves from the maxbotix interfere with parallax ping which results in erroneous values. The SIG pin of the parallax ping sensors is set high for around 5us to send the trigger pulse. The sensor emits a short 40 kHz (ultrasonic) burst. The same pin is used for listening the echo pulse that is returned from obstacle in parallax ping. The SIG pin is set high after the trigger pulse is sent from the host microcontroller and will be set low if an obstacle is detected. The PW pin will be held high for 18 milliseconds(ms) approximately in case if no obstacle is detected. The left and right sensors are triggered at 60ms, 160ms, 260ms, 360ms… and so on.
-All the four sensor values will be available at every 90ms and will be transmitted over the CAN bus at 90ms, 190ms, 290ms, 390ms and so on… The triggering as well as the transmitting the sensor values over the CAN bus is handled in 100Hz task with proper elapsed time count check.
+All the four sensor values will be available at every 90ms and will be transmitted over the CAN bus at 90ms, 190ms, 290ms, 390ms and so on… Triggering as well as transmission of the sensor values over the CAN bus is handled in 100Hz periodic task with proper elapsed time count check. A heartbeat message is transmitted to master controller using 1Hz periodic task
+=== Implementation ===
+[[File:CmpE243_F17_Rolling_Thunder_maxbotix_flowchart.PNG|350px|thumb|left|Flow chart - Maxbotix]]
+[[File:CmpE243_F17_Rolling_Thunder_parallax_flowchart.PNG|330px|thumb|middle|Flow chart - Parallax ping]]
+[[File:CmpE243_F17_Rolling_Thunder_distance_pseudo_code.PNG|310px|thumb|center|Pseudo Code - Distance Calculation]]
-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 pseudocode and fragments of code.  Keep in mind that you are showing DESIGN of your software, not the inner workings of it.
+====Steps for triggering and distance calculation for Maxbotix sensors:====
-=== Implementation ===
+# Configure the micro-controller pin which is connected to the RX pin of the sensor as output
-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.
+# Configure the micro-controller pin which is connected to the PWM pin of the sensor as input
+# Enable external interrupts for rising and falling edge for the pin connected to PWM pin of sensor
+# Trigger the RX pin by sending a clean high pulse through host micro-controller
+## Set GPIO pin connected to RX as low (for a clean high pulse)
+## Give delay of ~2us
+## Set GPIO pin connected to RX as high
+## Give delay of ~25us
+## Set GPIO pin connected to RX as low
+#Get the time at which rising edge interrupt occurs on micro-controller pin connected to PWM (start time)
+#Get the time at which falling edge interrupt occurs on micro-controller pin connected to PWM(stop time )
+#Calculate the distance in inches to the obstacle using the formula: <font color="Indigo"> '''Distance''' </font color> '''=''' [ (<font color="Office Green"> '''start_time''' </font color> '''–''' <font color="Red"> '''stop_time''' </font color>) '''/''' <font color="Bronze"> '''147''' </font color>] ( <font color="Olive"> '''inches''' </font color>)
+#Send the calculated distance to the master controller using CAN Bus.
+#Repeat the steps 4 to 8
-=== Testing & Technical Challenges ===
+====Steps for triggering and distance calculation for Parallax ping sensors:====
-Describe the challenges of your project.  What advise would you give yourself or someone else if your project can be started from scratch again?
+#Enable external interrupts for rising and falling edge for the pin connected to PWM pin of sensor
-Make a smooth transition to testing section and described what it took to test your project.
+#Configure the micro-controller pin which is connected to the SIG pin of the sensor as output
+#Trigger the SIG pin by sending a clean high pulse through host micro-controller
+##Set GPIO pin connected to SIG as low (for a clean high pulse)
+##Give delay of ~2us
+##Set GPIO pin connected to SIG as high
+##Give delay of ~5us
+##Set GPIO pin connected to SIG as low
+#Configure the micro-controller pin which is connected to the SIG pin of the sensor as input
+#Get the time at which rising edge interrupt occurs on microcontroller pin connected to SIG (start time)
+#Get the time at which falling edge interrupt occurs on microcontroller pin connected to SIG (stop time)
+#Calculate the distance in inches to the obstacle using the formula: <font color="Indigo"> '''Distance''' </font color> '''=''' [ (<font color="Office Green"> '''start_time''' </font color> '''–''' <font color="Red"> '''stop_time''' </font color>) '''/''' <font color="Bronze"> '''147''' </font color>] ( <font color="Olive"> '''inches''' </font color>)
+#Send the calculated distance to the master controller using CAN Bus.
+#Repeat the steps 2 to 8
-Include sub-sections that list out a problem and solution, such as:
+====Plot of Sensor Readings on Bus Master====
+[[File:CmpE243_F17_Rolling_Thunder_sensor_graph.PNG|800px|thumb|center|Sensor Readings Graph]]
+=== Testing & Technical Challenges ===
 ==== Interference between sensors ====
-Due to the placement of front, left and right sensors in close proximity to each other, we observed that there were inconsistencies in sensor readings on the detection of an obstacle. This was checked by monitoring sensor messages on BusMaster.
+'''''Issue:''''' Due to the placement of front, left and right sensors in close proximity to each other, we observed that there were inconsistencies in sensor readings on the detection of an obstacle. This was checked by monitoring sensor messages on BusMaster.
+'''''Solution:''''' We were able to reduce the impact of interference by avoiding overlap of ranging time of sensors. To achieve this, the sensors with non-overlapping ranging areas are being triggered at a time and enough time is provided for the sensors to complete their ranging before the next set of sensors are triggered.
-We were able to reduce the impact of interference by avoiding overlap of ranging time of sensors. To achieve this, the sensors with non-overlapping ranging areas are being triggered at a time and enough time is provided for the sensors to complete their ranging before the next set of sensors are triggered.
 ==== Blind spots to the front of the car ====
+'''''Issue:''''' On putting the permanent sensor mounts in place and after subsequent testing, it was observed that there were blind spots at the front end of the car such that obstacles falling in some areas weren't being detected effectively.
-On putting the permanent sensor mounts in place and after subsequent testing, it was observed that there were blind spots at the front end of the car such that obstacles falling in some areas weren't being detected effectively.
+'''''Solution:''''' To overcome the issue, we isolated the sensing area of each sensor based on their respective beam angles and adjusted the sensor positions. As a result, we were able to minimize the blind spots towards the front of the car with least interference. The tradeoff that we had to make was leaving the extreme left and right sides of the car vulnerable to collision with obstacles.
-To overcome the issue, we isolated the sensing area of each sensor based on their respective beam angles and adjusted the sensor positions. As a result, we were able to minimize the blind spots towards the front of the car with least interference. The tradeoff that we had to make was leaving the extreme left and right sides of the car vulnerable to collision with obstacles.
+== Motor & I/O Controller ==
-== Motor & I/O Controller ==
+==== Group Members ====
+* '''Joshua Skow'''
+* '''Saurabh Badenkal'''
 === Design & Implementation ===
+The motor controller controls the motors of the car and enables the car to move forward or reverse with given speed and turn left or right with given angle. It helps adjust the speed according to terrain or attain desired speed using a PID control loop. The motor controller receives messages from all other control units and displays the status of the car on an LCD interfaced to it.
+[[File:CmpE243_F17_Rolling_Thunder_traxxas_ESC.jpg|thumb|120px|right|Electronic Speed Controller (ESC)]]
+[[File:CmpE243_F17_Rolling_Thunder_traxxas_driver_motor.jpg|thumb|120px|right|Titan DC Motor]]
+[[File:CmpE243_F17_Rolling_Thunder_traxxas_servo_motor.jpg|thumb|120px|right|Traxxas Servo Motor]]
+[[File:CmpE243_F17_Rolling_Thunder_rpm_sensor_cable.jpg|thumb|120px|right|RPM Sensor]]
+[[File:CmpE243_F17_Rolling_Thunder_LCD.png|thumb|140px|right|TFT Display]]
+====Electronic Speed Controller (ESC)====
+This ESC is the Traxxas provided speed controller for the DC motor. This controller takes in the 7V DC from the LiPo car battery and provides it to the DC Motor to drive the rear wheels. The ESC is programmable and has 3 modes of operation(Training/Race/Sport). These modes can be configured by long sequenced press of the ESC power button. The ESC is sophisticated and has a EMF shield in order to protect the system from any back EMF. The ESC uses the 7V DC from battery and gives 3 connecting wires. One for motor speed control PWM signal, other 2 for 5V DC and GND.
+====DC Motor====
+This motor is responsible for driving the rear wheels. The current flows from positive terminal to negative terminal of the motor for the forward movement of the wheels. Whereas, for the reverse movement the current flows from negative terminal to positive terminal. This speed control is achieved by sending appropriate PWM signal with required duty cycle to the PWM signal wire of the ESC controller. The ESC requires a 100Hz PWM signal with varied duty cycle options : 10-15% to drive the motor in reverse and 15-20% drives the motor forward.
+====Servo Motor====
-[[File:traxxas_driver_motor.jpg|thumb|100px|right|Titan 12-turn 550 Modified Motor]]
+This motor is responsible for turning the two front wheels left and right. The servo operates on the same PWM frequency 100Hz and same duty cycle as the driver motor; 10-15% duty cycle turns the wheels left, 15-20% duty cycle turns the wheels right. The servo motor is controlled directly from the SJOne micro-controller board.
-The Traxxas Slash is a 2 wheel drive car makes use of two motors.
-====Titan 12-turn 550 Modified Motor====
+====RPM Sensor====
-This motor is responsible for driving the rear wheels.  This motor takes in a 100Hz duty cycle - 10-15% drives the motor in reverse, 15-20% drives the motor forward.
+The RPM sensor is a small magnet attached to an internal gear on the Traxxas slash. There is a housing that holds a hall sensor, and when the gear with the magnet spins it induces a pulse to the SJOne. The sensor is powered using the 5 volts power supply from the power bank.
-[[File:traxxas_servo_motor.jpg|thumb|100px|right|Traxxas 2075 Servo Motor]]
-====Traxxas 2075 Waterproof Servo Motor====
-This motor is responsible for turning the two front wheels left and right. The servo operates on the same duty cycle as the driver motor; 10-15% duty cycle turns the wheels left, 15-20% duty cycle turns the wheels right.
+====Display Module====
+The module used to display the key diagnostics of the car is a 3.2" TFT Display from 4D Systems. Apart from adding to the aesthetics of the car, it serves as an effective tool for debugging by displaying crucial car diagnostics data collected from the sensor controller, the motor controller and the geographical controller that play an important role in guiding the car from source to destination with a significant level of efficiency.
 === Hardware Design ===
-The schematic of the motor controller is:
+The Traxxas Slash receiver box contains 3 pin connectors for signal, the input voltage (VCC) and ground.  There are 4 3 pin connectors that come on the Traxxas Slash receiver - 3 of which are used for the car (Servo motor, Driver motor, and  RPM sensor).  The VCC of each connector is shorted together, and tied to the car battery.  The grounds are all shorted as well and connected to the PCB of everything on the car.  See the Hardware Interface section for more detail on the Traxxas motor connections.
-The Traxxas Slash receiver box contains 3 pin connectors for signal, input voltage (VCC) and ground.  There are 4 3 pin connectors that come on the Traxxas Slash receiver - 3 of which are used for the car (Servo motor, Driver motor, and  RPM sensor).  The VCC of each connector is shorted together, and tied to the car battery.  The grounds are all shorted as well and connected to the PCB of everything on the car.
+The RPM sensor is connected physically to the gearbox, with a small magnet attached to the largest gear.  There is a small hall sensor mounted next to this large gear, and every time the gear makes a revolution the hall sensor provides a high pulse indicating the rotation.  The RPM sensor signal is tied to a GPIO on the SJOne board, and requires a 3.3V pull up resistor.
-The RPM sensor is connected physically to the gearbox, with a small magnet attached to the largest gear.  There is a small hall sensor mounted next to this large gear, and every time the gear makes a revolution the hall sensor provides a high pulse indicating the a rotation.  The RPM sensor signal is tied to a GPIO on the SJOne board.
+The display module from 4D Systems is connected to the TX and RX pins of UART 3 communication channel, on the SJOne board, to display the status of the car on the move.
+[[File:CmpE243_F17_Rolling_Thunder_motor_interface2.png|thumb|1000px|center|Motor Controller Interface]]
 === Hardware Interface ===
-The motor controller contains the following interfaces to the SJOne:
+The motor controller contains the following interfaces to the SJOne board:
-*PWM to the Driver motor
+*PWM to the Driver motor (P2.1)
-*PWM to the Servo motor
+*PWM to the Servo motor (P2.2)
-*GPIO to the RPM sensor
+*GPIO to the RPM sensor (P2.0)
-*GPIO to the ADC for battery voltage monitoring
+*ADC for battery voltage monitoring (P1.31)
+*UART to the display module (TXD3/RXD3)
+[[File:CmpE243 F17 Rolling Thunder revised_motor connections.png|thumb|700px|center|Motor Connections]]
+==== Driver/Servo Motor ====
+The driver and servo motor PWM requirements were determined by plugging an oscilloscope probe into the receiver signal for each motor.  Using a remote control provided by Traxxas to drive the car, we intercepted the PWM from the remote control in order to reverse engineer how to drive the car with the SJOne.
+[[File:CmpE243_F17_Rolling_Thunder_motor_scope.png|thumb|450px|center|Oscilloscope capture of motor PWM from the Traxxas provided remote control]]
+==== Battery Voltage Monitor ====
+The battery voltage monitor is a pin out from the Traxxas 8V car battery to an ADC on the SJOne (P1.31, ADC5).  The battery voltage needs to be dropped down below 3.3V in order for the ADC to successfully capture the appropriate battery voltage value.  A resistor divider was used to drop the 8V battery (max) down below 3.3V.
+[[File:CmpE243_F17_Rolling_Thunder_Vbat_res_div.png|thumb|550px|center|Battery Voltage Circuit]]
-==== I/O Module ====
+==== Display Module ====
-[[File:CmpE243_F17_Rolling_Thunder_LCD_interface1.PNG|thumb|1080px|center|LCD Interface]]
+The 4D Systems LCD is interfaced to the motor controller using UART communication protocol. It uses a power supply of 5V. The LCD can be programmed using the 4D Workshop4 IDE software tool. It can be connected to the PC using the accompanying 4D programming cable. To program the LCD, the compiled project file, for the GUI design, generated from the development environment is loaded on to an SD card and inserted into the card slot on the LCD. The motor controller can then send data serially to the LCD and it is displayed on the GUI for easy interpretation and debugging.
+[[File:CmpE243_F17_Rolling_Thunder_LCD_interface2.PNG|thumb|700px|center|LCD Interface]]
+The TX and RX pins of LCD are connected to RXD3 and TXD3 pins of SJOne board respectively. There is a common ground established between the SJone board and the LCD in addition to a 5V supply provided to power up the LCD.
 === Software Design ===
+The software design of the motor controller and the display module are  explained in detail below. Two major functions handled in motor controller is to control the speed and turning angle of the wheels of the car and also update the LCD with the values from other nodes. Additional functions handled by this module includes calculating voltage level of the car battery and also controls the headlights and indicators on the car.
+[[File:CmpE243_F17_Rolling_Thunder_motor_sw_flow.png|thumb|250px|center|Motor Software Flow]]
+==== Motor Controller ====
 The motor is abstracted as a C++ class.  The motor class is able to set the Driver motor and the Servo motor.
 The motor class is also responsible for taking in a desired speed, and making sure the car is driving at that speed.  The motor class interprets the RPM sensor output, determines the current car speed compared to the desired car speed, and drives the motor to make the current car speed as close to the desired speed as possible.
+[[File:CmpE243_F17_Rolling_Thunder_motor_software_design.PNG|thumb|900px|center|Software Design]]
+==== Display Module ====
+The below flowchart explains how the display module receives and transmits data.
+[[File:CmpE243_F17_Rolling_Thunder_LCD_flowchart.PNG|thumb|450px|center|LCD Flowchart]]
+The UART 3 communication channel is initialized at a baud rate of 9600 bps. The diagnostics data is received at the motor controller from corresponding nodes via CAN bus. The data is then populated into the LCD-specific frame format and sent to the LCD in the 1 Hz periodic task. On receiving the frame, the LCD displays the data and sends an acknowledgment back to the motor controller. Thus, the data on LCD is updated every 1 s.
+=== Implementation ===
+The motor controller node encompasses two main functions: driving and steering the motor, and sending data to the LCD.
+==== Motor Controller ====
 The motor used a PID (proportional, integral, derivative) based control algorithm to keep the actual motor speed as close as possible to the desired speed.  The tuning was done with the car mounted on a platform.  The PID was tuned with the following method:
 . Select a proportional coefficient and change it until the motor feedback has a minimal oscillation.
 . Increase the derivative coefficient until there are no more oscillations.
 . Increase the integral coefficient until the speed increases fast enough and there is no oscillations.
-==== I/O Module ====
+The PID control loop logic takes the error, read speed and desired speed and calculates a new speed to give to the motor in order to reach the desired speed.
+[[File:CmpE243_F17_Rolling_Thunder_PID_loop.png|thumb|500px|center|Program flow of driver motor speed control]]
+==== Display Module ====
+The LCD graphical user interface is designed using the 4D Workshop4 IDE. A screen dedicated to each controller is created using suitable objects or strings to interpret the critical car data like sensor readings, speed, GPS coordinates, distance to destination and compass data. Some of the objects used on the LCD are:
-[[File:CmpE243_F17_Rolling_Thunder_LCD_flowchart.PNG|thumb|450px|center|LCD Flowchart]]
+*Gauges: For displaying sensor data and battery status
+*Meter: For displaying motor speed
+*Angularmeter: For displaying compass direction
+*LEDDigits: For displaying compass readings
+In addition, strings are used to display attributes like GPS coordinates, distance to destination, motor speed, and sensor readings.
+===== Transmission of data to LCD =====
+The LCD expects the data, received over UART, in a specific message format depending on whether an object or string would be used to display the same.
+The message format for writing to an object is as shown below.
+[[File:CmpE243_F17_Rolling_Thunder_LCD_write_obj.JPG|thumb|580px|center|Write Object Message Format]]
+To display any data using an object, the host controller transmits the 1-byte command code 0x01 followed by the object ID byte and the object index byte. The object ID is a value assigned to each object type to differentiate one from the other and the object index is its unique number. Both these values can be determined by referring to the quick guide provided on 4D Systems website and from the 4D Systems development environment. After sending the object index, the MSB and LSB of the data are sent. The checksum byte is calculated by XOR’ing all bytes in the message from (and including) command byte to the last parameter byte. The result is appended to the message.
+The message format for writing to a string is as shown below.
+[[File:CmpE243_F17_Rolling_Thunder_LCD_write_str.JPG|thumb|650px|center|Write String Message Format]]
+For writing to string, the host controller transmits the 1-byte command code 0x02 followed by the unique string index byte. The actual data is sent as a character array of 1-byte values preceded by its length and followed by the checksum.
-=== Implementation ===
+For every message corresponding to a 'write object' or 'write string' received by the LCD, it sends an acknowledgment ACK = 0x06 to the host controller.
-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.
-==== I/O Module ====
 ===== LCD Screens =====
+The screens displaying the car diagnostics corresponding to each controller are as shown below.
 {|
 |[[File:CmpE243_F17_Rolling_Thunder_main_screen.JPG|thumb|300px|left|Startup Screen]]
@@ Line 602: / Line 968: @@
 === 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?
+The basics of controlling the motor are relatively easy - send a PWM to the driver motor and servo motor.  The difficulty comes in driving the motor to a specific speed and in reading an accurate speed.
-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:
+==== Measuring motor speed accurately====
-==== <Bug/issue name> ====
+'''''Issue:''''' In order to measure the speed of the motor, the hall sensor pulses need to be interpreted to determine how many revolutions the wheel makes per second.
-Problems faced by motor:
-*Measure the motor speed accurately (measure for # of pulses vs. time between pulses)
+'''''Solution:''''' There are two ways to use the hall sensor pulses:
-*How to know when the car is stopped
-*How to make the car be the desired speed (steps vs PID)
+. Wait a known amount of time, and record the number of pulses received.
-*Tuning the PID loop
+. Wait until a certain number of pulses are received, then calculate the delta in time.
+[[File:CmpE243_F17_Rolling_Thunder_rpm_sensor.png|thumb|300px|center|RPM sensor reading]]
+We chose option number 2.  Option number 1 is flawed in that you must determine the MINIMUM time to measure for pulses.  And if you only capture half a pulse, then your RPM reading
+will swing back and forth wildly.  With an inconsistent RPM reading, maintaining a consistent speed becomes impossible.  By choosing option 2, the hall sensor pulse will never happen in the
+middle of an arbitrary time window.  Thus, option 2 provides more stability and accuracy for reading the speed of the car.
+==== Knowing when the car has stopped====
+'''''Issue:''''' When you use a hall sensor to detect if a wheel is moving, you cannot detect if the wheel has stopped.  In order to appropriately control the speed of the car, you need to be able
+to know when the car has stopped, but there is no way to know if the car has slowed down to a very slow speed or if it is no longer moving without a very long time window.
+'''''Solution:''''' In order to determine if the car is stopped, we calculated the minimum speed supported by the car and found out how long it would take for the wheel to rotate for that speed.
+Thus, the car supports a minimum speed of 0.5 meters per second, and any speed slower than that is not guaranteed to be supported or have smooth operation.  This is because if there is no
+wheel rotation after the expected time for a 0.5 mps speed, then the motor controller assumes the car is no longer moving.
+==== Attaining desired speed ====
+'''''Issue:'''''  When the car is reading a speed from the RPM sensor that is not the same as the desired speed, the motor controller must try to change it's current speed to match the desired speed.
+'''''Solution:''''' In order to make the error between desired speed and read speed as close to zero as possible, we used a PID (Proportional, Integral and Derivative) control loop.  This PID loop
+serves to keep the error factor as close to zero as possible.  Tuning the PID loop required much testing, and the method to tune the PID loop is detailed above.
+==== PID Tuning====
+'''''Issue:'''''  In order for the motor speed to reach a stable value, quickly, and with no oscillations, the PID control loop needs to have the correct coefficients so that the motor responds to disturbances appropriately.  Finding these correct coefficients is called "tuning" the PID.
+'''''Solution:''''' By propping the car up in the air and adding a PID tuning CLI to the SJOne console, the PID was tuned as in the steps listed in the Software Implementation.  Tuning the PID requires taking time to test the car at different speeds, with different disturbances, and with different PID coefficients until the driver motor reacts as desired.
 == Geographical Controller ==
@@ Line 669: / Line 1,063: @@
 The diagram below shows the h/w interfacing of SJ One board with GPS module and Compass module. The GPS module and the Compass module is communicating over UART3 and I2C respectively with SJ One board.
-[[File:CmpE243 F17 Rolling Thunder GEO hw interface.PNG|600px|thumb|center|Hardware Interface ]]
+[[File:CmpE243 F17 Rolling Thunder GEO hw design.PNG|600px|thumb|center|Hardware Design ]]
 Pin mapping of GPS module with SJ One board:
@@ Line 711: / Line 1,105: @@
 === Hardware Interface ===
+The hardware interface details of GPS and compass with SJOne board are given below:
 ==== GPS Module ====
 [[File:CmpE243 F17 Rolling Thunder GEO gps.jpg|right|220px|thumb|Ublox NEO M8N GPS Module ]]
-Gps is communication over UART with SJ One board. The data from the GPS is updated at a 5Hz frequency.
-The most important part is GPS configuration. It is configured using FTDI cable and Ublox software kit. We are using settings for GPS configuration in Ublox as shown below:
+GPS is communicating over UART with SJ One board. The data from the GPS is updated at 5 Hz frequency.
+The most important part is GPS configuration. It is configured using FTDI cable and Ucenter software. We are using the below shown settings for GPS configuration in Ucenter software :
+{| class="wikitable"
+|+ GPS Configuration Table
+|-
+! align="center"|Config Parameter
+! align="center"|Value
+|-
+| scope="row" align="center"|Baud Rate
+| scope="row" align="center"|38400
+|-
+| scope="row" align="center"|Refresh Rate
+| scope="row" align="center"|5Hz
+|-
+| scope="row" align="center"|Navigation Mode
+| scope="row" align="center"|Pedestrian
+|-
+|}
+To filter out GPGGA string, other messages are disabled in 'Messages view'. The results can be seen in the text console image.
+[[File:CmpE243 F17 Rolling Thunder GEO ucenter configuration.png |800px|thumb|left|Ucenter GPS Configuration ]]
+[[File:CmpE243 F17 Rolling Thunder GEO ucenter gps strings.png |800px|thumb|left|Ucenter GPS Text Console ]]
+<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>
+<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>
+  GPGGA Message Structure: '''''$GPGGA,hhmmss.ss,llll.ll,a,yyyyy.yy,a,x,xx,x.x,x.x,M,x.x,M,x.x,xxxx'''''<br/>
+  Example GPGGA string: '''''$GPGGA,123519,4807.038,N,01131.000,E,1,08,0.9,545.4,M,46.9,M,,*47'''''
+  Where:
+       GGA          Global Positioning System Fix Data
+       Fix taken at 12:35:19 UTC
+.038,N   Latitude 48 deg 07.038' N
+.000,E  Longitude 11 deg 31.000' E
+            Fix quality:   0 = invalid, 1 = GPS fix (SPS), 2 = DGPS fix, 3 = PPS fix, 4 = Real Time Kinematic, 5 = Float RTK,
+= estimated (dead reckoning) (2.3 feature), 7 = Manual input mode, 8 = Simulation mode
+           Number of satellites being tracked
+.9          Horizontal dilution of position
+.4,M      Altitude, Meters, above mean sea level
+.9,M       Height of geoid (mean sea level) above WGS84 ellipsoid
+       (empty field) time in seconds since last DGPS update
+       (empty field) DGPS station ID number
+       *47          the checksum data, always begins with *
 ==== Compass Module ====
@@ Line 733: / Line 1,169: @@
 === 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 pseudocode and fragments of code.  Keep in mind that you are showing DESIGN of your software, not the inner workings of it.
+Software design consists of three main classes, GeoController, GeoGPS and GeoCompass. GeoController is the top level class which calls GeoGPS and GeoCompass class methods to calculate distance and heading angle. These values are then sent to master controller to navigate the car. Below is the class diagram for detailed reference.
+[[File:CmpE243 F17 Rolling Thunder GEO Class Diagram.png|800px|thumb|center|Class Diagram ]]
+====CAN Communication====
+The following table lists the CAN messages used for communication with the Geographical controller.
+{| class="wikitable"
+|+ GEO Controller CAN messages Table
+|-
+! scope="col"| Message Number
+! scope="col"| Sender
+! scope="col"| Destination
+! scope="col"| Message Name
+|-
+| 0x100
+| Master
+| Geo
+| MASTER_CONTROL
+|-
+| 0x150
+| Bridge
+| Geo
+| BRIDGE_START_STOP
+|-
+| 0x250
+| Geo
+| Master, Motor
+| GEO_DATA
+|-
+| 0x400
+| Geo
+| Bridge, Motor
+| UPDATE_CURRENT_LOCATION
+|-
+| 0x450
+| Geo
+| Motor
+| UPDATE_COMPASS_BEARING
+|-
+| 0x520
+| Geo
+| Master
+| GEO_HB
+|-
+|}
 === 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.
+[[File:CmpE243_F17_Rolling_Thunder_GEO_flowchart.PNG |700px|thumb|right|Flow chart ]]
+* '''In 1 Hz periodic call back function'''
+** Reset CAN Bus if bus off
+** Send heartbeat signal to Master
+** Send compass reading to Motor controller
+<br/>
+* '''In 10 Hz periodic call back function'''
+** Read the compass bearing angle from Compass module
+** Read the GPS data string from the GPS module
+** Parse the GPS string and send the current location coordinates to Bridge controller and Motor controller
+** Calculate and send distance to immediate checkpoint, heading angle, and a flag to indicate final destination reached to Master controller and Motor controller
+** Display the distance to immediate checkpoint on 7 segment displays on the Geo controller’s SJ one board
+** Toggle the LED 4 on Geo controller’s SJ one board to indicate the GPS fix
+<br/>
+* '''In 100 Hz periodic call back function'''
+** Compass calibration routine called here
+** Receive the checkpoint coordinates from the Bridge controller
+<br/><br/><br/><br/><br/><br/>
 === Testing & Technical Challenges ===
 ==== GPS doesn’t retain configuration settings ====
-Every time the GPS is powered down it forgets the configuration settings after 4-5 hours and it has to be configured again. It could retain the configuration for some time (after powering down) because of a super capacitor. We replaced the super capacitor with a 3.3v battery and now it retains the configuration after it is powered down
+'''''Issue:''''' Every time the GPS is powered down it forgets the configuration settings after 4-5 hours and it has to be configured again.
+'''''Solution:''''' It could retain the configuration for some time (after powering down) because of a supercapacitor. We replaced the supercapacitor with a 3.3v battery and now it retains the configuration after it is powered down.
 ==== Compass frequently losing calibration ====
-Compass was losing calibration because of the magnetic interference from the motors. We wrapped the acrylic sheet (on which our compass was placed) with aluminum foil that acts as a magnetic shield for the compass. To ease the calibration process, we came up with an idea to do it on a switch press.
+'''''Issue:''''' Compass was losing calibration because of the magnetic interference from the motors.
+'''''Solution:''''' We wrapped the acrylic sheet (on which our compass was placed) with aluminum foil that acts as a magnetic shield for the compass. To ease the calibration process, we came up with an idea to do it on a switch press.
 ==== Unable to send complete GPS coordinates on CAN bus (with 6 decimal digits) ====
-GPS coordinates require double data type and current python script doesn't handle it. So we had to make changes to Python script. Reference: [http://www.socialledge.com/sjsu/index.php?title=F16:_Titans#Changes_to_Python_Script F16: Titans Team]
+'''''Issue:''''' GPS coordinates require double data type and current python script doesn't handle it.
+'''''Solution:''''' So we had to make changes to Python script. Reference: [http://www.socialledge.com/sjsu/index.php?title=F16:_Titans#Changes_to_Python_Script F16: Titans Team]
 == Communication Controller (Bridge) ==
@@ Line 755: / Line 1,259: @@
 === 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.
+User communicates with the car via the communication bridge controller. The hardware and software design details of this module are given below.
 === Hardware Design ===
-=== Hardware Components: ===
+'''Hardware Components:'''
 {| style="width:800px;" |
@@ Line 792: / Line 1,296: @@
 === 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.
+Bluetooth chip communicates to SJOne board using UART interface. Pins P 0.1 and 0.0 of the SJOne board is connected to TXD and RXD pins of the CAN transceiver respectively. The CANH and CANL of the transceiver is connected to the CANH and CANL of the CAN BUS wire which is terminated with 120 ohm resistor.
+[[File:CMPE243_F17_Rolling_Thunder_Comm_Layout.png|700px|thumb|center|Comm HW Interface]]
 === 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.
+The Communication Controller's role in the car is to make communication possible between the user via an Android application and the car. The Communication Controller (bridge) receives data transmitted over the UART from the Android app. With pre-agreed "opcodes", the bridge parses the data and sends the respective information to the CAN bus. The opposite direction of the flow happens when the GPS gets a lock and the current location of the car is displayed on the app at real time. The Flow Chart below shows how this process happens at a high level.
+[[File:CMPE243 Rolling Thunder Comm Contrl Flow.png|thumb|center|500px|Communications Controller Flow Diagram]]
 === 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.
+{| style="width:900px;" |
+|
+[[File:CMPE243 Rolling Thunder Comm Contrl Activity.png|thumb|right|500px|Activity Diagram]]
+'''Period Init'''
+*CAN Init
+*CAN Reset
+*Create FreeRTOS Queue
+*UART Init
+'''Period 1Hz'''
+*Reset CAN if off
+*Send Controller Heartbeat to CAN Bus
+'''Period 10hz'''
+*FreeRTOS QueueRecieve
+*Parse and Send App data to CAN Bus
+*Receive Car Location from Geo Node over CAN
+'''Period 100hz'''
+*Read App data over UART
+*Send data to FreeRTOS queue
+|
+|}
 === 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:
+====Gibberish values while transmitting data from the app====
-==== <Bug/issue name> ====
+'''''Issue:''''' Even though the website says the default xBee baud rate is 38400, it wasn't. It took a couple of days to figure why we had gibberish values.
-Discuss the issue and resolution.
-== <font color="teal"> Android Application </font color> ==
+'''''Solution:''''' UART speed should be accounted for when transmitting data from the app.
+====Dummy Bluetooth App for Communication development testing====
+'''''Issue:''''' Dependence on App for testing, since the development of the App and the communication controller happens in parallel.
+'''''Solution:''''' Serial Communication Bluetooth App on Play Store for connectivity and baud rate testing. Android Studio with MapActivity template to test coordinates parsing.
+====UART====
+'''''Issue:''''' Data from the App is greater than the default UART queue size.
+'''''Solution:''''' Dig into the source code and increase it.
+'''''Issue:''''' Data loss after large transmission.
+'''''Solution:''''' Soft reboot (at the right time).
+== Android Application ==
 === Design & Implementation ===
-The app was designed for Android 8.0 (Oreo; API level 26) and requires Android 4.4 (KitKat; API level 19) or higher. Google Play Services 11.0.0 or higher is required to use the Google Maps portion of the app (to select the destination).
+The app plays a crucial role in the project since it provides the checkpoints for the car's route. The app was designed for Android 7.0 (Nougat; API level 24) and requires Android 4.4 (KitKat; API level 19) or higher (up to Android 8.1, Oreo; API level 27). Google Play Services 11.0.0 or higher is required to use the Google Maps portion (for selecting the destination).
-The app plays a crucial role in the project since it provides the checkpoints for the car's route.
+==== Software Design ====
+The GUI uses fragments since it is easier to load screens within the main activity instead of moving from one activity to another. For example, there is one fragment for obstacle avoidance and another fragment for vehicle navigation (they can be accessed using the navigation drawer). We had planned to add a wireless CAN bus monitor in a third fragment but this could not be completed due to time restrictions.
-==== Software Design (GUI) ====
+The class locationPoint is user-defined and it represents each location on the map (the vehicle, the destination, and each checkpoint).
-The GUI uses a fragment instead of activities to make it easier to add more features such as a wireless CAN bus monitor (which we did not have time to complete).
 ===== activity_main.xml =====
-This layout is displayed after the app is launched. The parent layout uses RelativeLayout and it contains a FrameLayout for loading fragments.
+This layout is displayed after the app is launched. The parent layout uses DrawerLayout which contains a ListView (both are needed for a navigation drawer). There is also a FrameLayout for the fragments.
 ===== fragment_main.xml =====
-This is the only fragment in the app. This layout uses a RelativeLayout with a child layout that uses ConstraintLayout and a child MapView.
+This fragment is used for obstacle avoidance. This layout uses a ConstraintLayout with an ImageView, TextView, and Button. Below the ImageView and TextView is a Button used to start or stop the car manually (start will only enable obstacle avoidance mode).
-The ConstraintLayout contains an ImageView, TextView, and Button. The ImageView and TextView are for displaying the Bluetooth connection status on the top left-hand side of the screen. Both of these components change based on the following conditions:
+The ImageView and TextView are for displaying the Bluetooth connection status on the top left-hand side of the screen. Both of these components change based on the following conditions:
-*Bluetooth is disabled.
+*Bluetooth is disabled or enabled.
-*The app is connected to the Bluetooth module on the communication controller (the bridge).
+*The app is trying to connect to a Bluetooth module.
-*The app is not connected to the Bluetooth module.
+*The app is connected to a Bluetooth module on the bridge.
-*The app is trying to connect to the Bluetooth module.
+*The app is not connected to a Bluetooth module.
-To the right of the Bluetooth status is a Button used to set the destination and put the vehicle in self-driving mode (if the user has already tapped on a location on the map) or to stop the car manually (if the vehicle is in self-driving mode).
+{|
+|[[File:Cmpe243_F17_Rolling_Thunder_Bluetooth_Ask_To_Enable.png|200px|thumb|The user is asked to enable Bluetooth]]
+|[[File:Cmpe243_F17_Rolling_Thunder_Bluetooth_Not_Connected.png|200px|thumb|The device is not connected]]
+|[[File:Cmpe243_F17_Rolling_Thunder_Bluetooth_Connecting_Obstacle_Avoidance.png|200px|thumb|Connecting to the module]]
+|[[File:Cmpe243_F17_Rolling_Thunder_Bluetooth_Connected_Obstacle_Avoidance.png|200px|thumb|Connected to the module]]
+|[[File:Cmpe243_F17_Rolling_Thunder_Bluetooth_Connected_Navigation.png|200px|thumb|The vehicle's location (in green), the destination (in red), and the checkpoints (in purple)]]
+|}
-The rest of the screen is the MapView. The map shows the location of the vehicle using a green marker and a red marker is used to show the destination (if applicable).
+===== fragment_nav.xml =====
+This fragment is used for navigation mode and only contains a child fragment for the map (the parent layout is LinearLayout).
-==== Implementation ====
+The navigation drawer will display a button on the top right (within the ActionBar) when this fragment is loaded. This button is used to set the destination and put the vehicle in self-driving mode (if the user has already tapped on a location on the map).
+The map shows the location of the vehicle using a green marker and a red marker is used to show the destination (if applicable). All of the checkpoints on the route are shown with a purple marker.
+===== drawer_list_item.xml =====
+This layout file simply defines the customized appearance of the fragment names within the navigation drawer using a TextView.
 ===== build.gradle (app) =====
-This particular Gradle build file (which is different than the Gradle build file for the project) has the Play Services version requirement, the target SDK version (Android API level 26), minimum SDK version (Android API level 19), and the key information for generating the .apk file.
+This Gradle build file contains the Play Services version requirement (11.0.0), the target SDK version (Android API level 24), minimum SDK version (Android API level 19), the key information for generating the release version of the .apk file, the compiled SDK version (Android API level 27), and the build tools version (27.0.2).
 ===== AndroidManifest.xml =====
-The manifest file contains the permission to access the device's Bluetooth and the key for using the Google Maps Android API (this is required to display the Google Map within the MapView component of the fragment_main.xml layout).
+The manifest file contains the permission to access the device's Bluetooth and the key for using the Google Maps Android API (the key is required to display the Google Map within the MapView component of the fragment_main.xml layout).
 ===== strings.xml =====
-This file stores all of the strings used in the app.
+This file stores all of the strings used in the app including the key for the Google Maps Directions API.
 ===== MainActivity.java =====
+This is the only activity in the app and it is first loaded when the app is started. It loads the activity_main.xml layout which holds a FrameLayout. The FrameLayout is used for loading fragments.
+When the app has first launched the method onCreate runs. The TTS (Text-to-Speech) object, the navigation drawer, the Bluetooth adapter, and the main fragment are created and initialized. If the device supports Bluetooth, then the monitorBluetooth method is called.
+The monitorBluetooth method runs a TimerTask every 1 second to check the Bluetooth connection. If Bluetooth is disabled, then the user is asked once to enable it again. If Bluetooth is enabled, then we try to connect by running the method setupBluetooth (if we aren't connected or are trying to connect already). The ImageView and TextView are updated depending on what happens here.
+The method setupBluetooth checks for a paired Bluetooth device with the hard-coded Bluetooth MAC address. If a matching device is found, then a Thread runs (our ConnectThread class).
+The ConnectThread class uses a Bluetooth socket for the Bluetooth connection. Once a connection is established, then another thread executes to handle the data transfer (our class ConnectedThread). This is similar to the BluetoothChat example app that is provided by Google on the Android Developers site (and one of the examples in Android Studio).
+The ConnectedThread class is used for writing data (the checkpoints) or reading data (the vehicle's location) to or from the bridge controller. When data is received it is sent to the main thread (as long as the data transfer follows a specific format).
+The button in the ActionBar on the top-right of the screen will execute a FetchItemsTask object (it is only displayed when the Navigation fragment is visible). The FetchItemsTask is a user-defined class with a superclass of AsyncTask. This is where the request to get the directions is sent to Google using the Google Maps Directions API. We also manually create more checkpoints to improve the accuracy of navigation (if the checkpoints are too far then the vehicle can, but not definitely will get off course). The checkpoints are then sent over Bluetooth to the bridge with the sendCheckpoints method.
+Other user-defined methods in this file include:
+* writeStartStop: sends the command to manually start (for obstacle avoidance mode only) or stop the vehicle.
+* sendLatLong: sends the latitude and longitude of a locationPoint object.
+* sendCheckpoints: sends each checkpoint (this utilizes sendLatLong).
+* getDistanceFromLatLongInM: calculates the distance between two coordinates using double values. The calculation follows the Haversine formula (as described in the Geo controller section).
-This is the only activity in the app and it is first loaded when the app is started. It loads the activity_main.xml layout which holds a FrameLayout. The FrameLayout is used for loading fragments.
+When the app is closed onDestroy executes and we close the Bluetooth socket.
 ===== MainFragment.java =====
+This is the fragment that is loaded first. This fragment contains the ImageView and TextView objects for the Bluetooth connection status and the button for starting and stopping the vehicle (starting is for obstacle avoidance only).
+After onAttach runs, onCreateView executes. All of the components of fragment_main.xml are initialized and set up in onCreateView (including a click listener for the button).
+The method updateStartStopButton uses the main thread to change the Button while the method updateBluetoothConnectionStatus uses the main thread to change the TextView and ImageView.
+The Callbacks interface is used to call methods between the activity and the fragments.
+===== NavFragment.java =====
+This fragment contains the map which is initialized and set up in onCreateView.
-This is the only fragment in the app and contains the ImageView and TextView objects for the Bluetooth connection status, the button for setting the destination and stopping the vehicle, and the (Google) MapView.
+When onResume runs (i.e. when the app is in the foreground again after being in the background), the marker for the vehicle is drawn on the map using the user-defined method addMarkerVehicle (it is redrawn if a previous marker was already set. This is done in order to get the latest data on the vehicle's location).
+onMapReady runs once after the MapView is first loaded and adds the marker for the vehicle (if applicable). The click listener is also set up here so that whenever the user taps on the map the destination is set (this only happens if the car is not already on a route or the vehicle has been manually stopped).
+Other user-defined methods in this file include:
+* setLatLongDestination: sets the latitude and longitude for the destination (represented by a locationPoint object).
+* addMarkerVehicle: adds the green marker on the map for the vehicle.
+* addMarkersForCheckpoints: adds purple markers for each checkpoint used on the route.
 ===== locationPoint.java =====
 This is a user-defined class for each location that is used in the app (each of the checkpoints, the vehicle, and the destination). The class contains a String and double field for the latitude and corresponding fields for the longitude (there are also byte array fields for both of these coordinates).
@@ Line 864: / Line 1,466: @@
 The methods getMessageNumberOfBytesLatitude() and getMessageNumberOfBytesLongitude() return the number of bytes for the coordinate in the byte array format.
+==== Implementation ====
+This section explains the implementation of the key components of the app such as establishing the Bluetooth connection, the map (Google Maps), and the directions (using the Google Maps Directions API).
+===== Bluetooth connection =====
+We used Bluetooth sockets to connect the app and bridge controller.
+First, we get a list of all of the paired Bluetooth connections on the Android device (these are stored temporarily in the app using the Java Set interface). Second, we check each Bluetooth connection to find a paired device that has the same Bluetooth MAC address of the module on the bridge controller (if applicable). If there is a match, then a thread (using our class ConnectThread) is created for connecting over Bluetooth.
+The thread will first call the method for updating the ImageView and TextView to alert the user that we are trying to connect. Next, the thread uses the BluetoothDevice class' method getUuids to get a UUID to pass to the createInsecureRfcommSocketToServiceRecord (this is part of the same BluetoothDevice class). If the RFCOMM Bluetooth socket was created successfully, then we call the BluetoothSocket class' connect method.
+If the BluetoothSocket connection was successful, then we create a new thread (using our class ConnectedThread) for handling the data transfer. The ConnectedThread creates an input stream for receiving data from the bridge and an output stream for sending data to the bridge. The run method for this class runs a while(true) loop. In this loop the InputStream class' method read is called and the loop waits until data is received.
+===== Data transfer =====
+The data is transferred to and from the app and bridge controller using specific formats.
+Once data is received in the while loop of the ConnectedThread's run method, then we look for the termination char 'e'. If the data received is a specific length that matches what the bridge should be sending for the vehicle's location and the char 'e' was the third-to-last char in the data, then the data is sent to the main thread using a Handler.
+The Handler parses the message for the number of bytes for the latitude, the number of bytes for the longitude, the latitude, and the longitude. If there is an error when converting from String to double for any of these values, then the message is discarded. If there were no errors, then we check if the vehicle is 2 m or less from the destination, we set the latitude and longitude for the vehicle's locationPoint object, and we add the new marker for the vehicle on the map. If the vehicle is 2 m or less from the destination, then the TTS (Text-To-Speech) object alerts the user with the audio "the destination has been reached".
+The checkpoints are sent to the bridge in the following format (it is similar to a message received from the bridge):
+Header:
+* The opcode ('c')
+* The number of checkpoints
+Checkpoint 1:
+* The number of bytes for the latitude
+* The number of bytes for the longitude
+* The latitude
+* The longitude
+Checkpoint 2-n:
+* The opcode ('c')
+* The number of bytes for the latitude
+* The number of bytes for the longitude
+* The latitude
+* The longitude
+===== Google Maps Android API =====
+A key has to be generated in the Google API Console to use Google Maps in an Android app. This key is copied into the AndroidManifest.xml file.
+===== Google Maps Directions API =====
+In order to get direction, a key has to be generated in the Google API Console for the Google Maps Directions API. A request is sent to Google using a String with the following values (in the same order shown and a comma between the latitude and longitude values):
+* https://maps.googleapis.com/maps/api/directions/json?units=imperial&mode=walking&origin=
+* vehicle's latitude
+* vehicle's longitude
+* &destination
+* destination's latitude
+* destination's longitude
+* &key=
+* Google Maps Directions API key
 === Testing & Technical Challenges ===
+Most of the basic concepts for Android development were already familiar from past experience (i.e. CMPE 277). The main challenge was establishing the Bluetooth connection and handling the data that is received over Bluetooth (we came up with specific formats for messages between the bridge and app).
+==== Bluetooth connection ====
+One of the initial challenges was finding out how to connect to the module over Bluetooth. A Bluetooth connection requires a UUID and the easiest way to get a UUID is to get one from the Bluetooth radio itself (the device name refers to the BluetoothDevice object instance that we are using):
+device.getUuids()[0].getUuid()
+==== JSON ====
+The directions can be returned by Google in a JSON object (the alternative option is XML). It can be difficult to parse JSON objects if you aren't familiar with doing this task but there are resources online that are helpful (including the Google Maps Directions API website/guide).
 == Conclusion ==
-By completing this project we all learned how to use a very important and necessary tool in development-Git (if we did not have experience with it previously). Git allowed us to keep track of changes to the master branch as well as branches for each of the controllers and the app.
-We also got hands-on experience with the CAN bus protocol which is useful for any embedded system in the automotive industry. This includes learning how to use the DBC format and the BusMaster CAN tracing tool.
+This project served as a great source of learning as it was challenging to develop and integrate the features of the self-driving car. It gave us a great sense of achievement in having completed the project by working together as a team.
-We were required to complete unit testing for each of the controllers. Learning TDD (Test-Driven-Development) was a challenge but overall it was a great experience for us because developing this way reduces time spent on debugging.
+By completing this project we all learned how to use an important version control tool in development-Git. Git allowed us to keep track of changes to the master branch as well as branches for each of the controllers and the Android application. We also got hands-on experience with the CAN bus protocol which is useful for any embedded system in the automotive industry as well as the DBC file format and the BusMaster CAN tracing tool. We were required to complete unit testing for each of the controllers. Learning Test Driven Development (TDD) was a challenge but overall it was a great experience for us because developing this way reduced time spent on debugging.
 === Project Video ===
+https://www.youtube.com/watch?v=YiA8Qv2gooY&feature=youtu.be
 === Project Source Code ===
 *  [https://gitlab.com/RollingThunder/rolling-thunder-rc-car GitLab Source Code Link for the controllers]
-*  [https://gitlab.com/RollingThunder/Rc-car-Android GitLab Source Code Link for the Android app]
+*  [https://gitlab.com/RollingThunder/Android GitLab Source Code Link for the Android app]
 == References ==
 === Acknowledgement ===
+We would like to express our gratitude to Professor Preetpal Kang for generously sharing his time and knowledge with us and guiding us through the completion of this project.
+We would also like to thank the ISA team for their valuable advice and constructive feedback.
 === References Used ===
-===== <font color="teal">Android app</font color> =====
+====== PID Control ======
-*  [https://developer.android.com/guide/topics/connectivity/bluetooth.html Bluetooth|Android Developers]
+* [http://ctms.engin.umich.edu/CTMS/index.php?example=Introduction&section=ControlPID PID Controller Design]
-*  [https://github.com/googlesamples/android-BluetoothChat/ googlesamples/android-BluetoothChat]
+* [https://robotics.stackexchange.com/questions/167/what-are-good-strategies-for-tuning-pid-loops  Good Strategies for PID Tuning]
+====== LCD ======
+* [http://www.4dsystems.com.au/downloads/Application-Notes/4D-AN-00017_R_1_01.pdf Connecting LCD to Host]
+====== Android GUI ======
+*  [https://developer.android.com/studio/write/image-asset-studio.html Create App Icons with Image Asset Studio]
+*  [https://developer.android.com/training/basics/fragments/index.html Building a Dynamic UI with Fragments]
+====== Bluetooth ======
+* [https://developer.android.com/guide/topics/connectivity/bluetooth.html Bluetooth|Android Developers]
+* [https://github.com/googlesamples/android-BluetoothChat/ googlesamples/android-BluetoothChat]
+====== Google Maps ======
+* [https://developer.android.com/training/maps/index.html Adding Maps]
+* [https://developers.google.com/maps/documentation/android-api/marker Markers]
+* [https://developers.google.com/maps/documentation/directions/?authuser=1 Google Maps Directions API]
+==== Datasheets ====
-=== Appendix ===
+ [1] [https://www.maxbotix.com/documents/XL-MaxSonar-EZ_Datasheet.pdf XL-MaxSonar-EZ4 Ultrasonic Sensor]
+ [2] [https://www.parallax.com/sites/default/files/downloads/28015-PING-Sensor-Product-Guide-v2.0.pdf Parallax Ping Sensor]
+ [3] [http://www.4dsystems.com.au/productpages/uLCD-32PTU/downloads/uLCD-32PTU_datasheet_R_2_2.pdf 4D Systems LCD]
+ [4] [https://www.sparkfun.com/datasheets/DevTools/Arduino/MCP2551.pdf CAN Transceiver]
+ [5] [https://www.u-blox.com/sites/default/files/NEO-M8-FW3_DataSheet_%28UBX-15031086%29.pdf GPS Module]
+ [6] [http://www.pishrobot.com/files/products/datasheets/cmps11.pdf Compass Module]

Difference between revisions of "F17: Rolling Thunder"

Latest revision as of 21:39, 22 December 2017

Contents

Rolling Thunder self-driving car

Legend

Team Members & Responsibilities

Abstract

Objectives & Introduction

Schedule

Parts List & Cost

DBC File Implementation

PCB Design

Master Controller

Group Members

Design & Implementation

Hardware Design & Interface

Software Design and Implementation

Heartbeat messages

Communication and driving algorithm

Testing & Technical Challenges

Messages not being received due to small CAN RX Queue size

Car taking time to reverse

Sensor Controller

Group Members

Design & Implementation

XL-MaxSonar-EZ4

Parallax ping

Hardware Design

Hardware Interface

Software Design

Implementation

Steps for triggering and distance calculation for Maxbotix sensors:

Steps for triggering and distance calculation for Parallax ping sensors:

Plot of Sensor Readings on Bus Master

Testing & Technical Challenges

Interference between sensors

Blind spots to the front of the car

Motor & I/O Controller

Group Members

Design & Implementation

Electronic Speed Controller (ESC)

DC Motor

Servo Motor

RPM Sensor

Display Module

Hardware Design

Hardware Interface

Driver/Servo Motor

Battery Voltage Monitor

Display Module

Software Design

Motor Controller

Display Module

Implementation

Motor Controller

Display Module

Transmission of data to LCD

LCD Screens

Testing & Technical Challenges

Measuring motor speed accurately

Knowing when the car has stopped

Attaining desired speed

PID Tuning

Geographical Controller

Group Members

Design & Implementation

GPS Bearing angle calculation

Heading angle calculation

Distance between the two coordinates calculation

Hardware Design

Hardware Interface

GPS Module

Compass Module

Software Design

CAN Communication

Implementation

Testing & Technical Challenges

GPS doesn’t retain configuration settings

Compass frequently losing calibration

Unable to send complete GPS coordinates on CAN bus (with 6 decimal digits)