EE149 / Mbed 2 deprecated FinalProject

Final Project files for mBed development.

Dependencies:   m3pi mbed

project.h@1:7e0243c27ecb, 2014-11-11 (annotated)

Committer:
lsaristo
Date:
Tue Nov 11 19:32:20 2014 +0000
Revision:
1:7e0243c27ecb
Child:
2:c2764165a23d
Added super basic skeleton for project files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
lsaristo 1:7e0243c27ecb 1 /**
lsaristo 1:7e0243c27ecb 2 * @file project.h
lsaristo 1:7e0243c27ecb 3 * @brief Main header file for includes and whatnot
lsaristo 1:7e0243c27ecb 4 * for the other project files.
lsaristo 1:7e0243c27ecb 5 * @author John Wilkey
lsaristo 1:7e0243c27ecb 6 */
lsaristo 1:7e0243c27ecb 7
lsaristo 1:7e0243c27ecb 8 #ifndef _PROJECT_H
lsaristo 1:7e0243c27ecb 9 #define _PROJECT_H
lsaristo 1:7e0243c27ecb 10
lsaristo 1:7e0243c27ecb 11 #include <stdio.h>
lsaristo 1:7e0243c27ecb 12
lsaristo 1:7e0243c27ecb 13 /**
lsaristo 1:7e0243c27ecb 14 * @brief Driver forward.
lsaristo 1:7e0243c27ecb 15 *
lsaristo 1:7e0243c27ecb 16 * @param[in] amt Amount to drive forward.
lsaristo 1:7e0243c27ecb 17 * @param[in] spd Drive speed.
lsaristo 1:7e0243c27ecb 18 * @return Distance driven.
lsaristo 1:7e0243c27ecb 19 */
lsaristo 1:7e0243c27ecb 20 float foward(float amt, float spd);
lsaristo 1:7e0243c27ecb 21
lsaristo 1:7e0243c27ecb 22 /**
lsaristo 1:7e0243c27ecb 23 * @brief Drive backward.
lsaristo 1:7e0243c27ecb 24 *
lsaristo 1:7e0243c27ecb 25 * @param[in] amt Amount to drive backward.
lsaristo 1:7e0243c27ecb 26 * @param[in] spd Drive speed.
lsaristo 1:7e0243c27ecb 27 * @return Distance driven.
lsaristo 1:7e0243c27ecb 28 */
lsaristo 1:7e0243c27ecb 29 float backward(float amt);
lsaristo 1:7e0243c27ecb 30
lsaristo 1:7e0243c27ecb 31 /**
lsaristo 1:7e0243c27ecb 32 * @brief Turn right.
lsaristo 1:7e0243c27ecb 33 *
lsaristo 1:7e0243c27ecb 34 * @param[in] deg Desired final turn angle from starting position.
lsaristo 1:7e0243c27ecb 35 * @param[in] spd Desired turning speed.
lsaristo 1:7e0243c27ecb 36 * @return 0 if successful, or an error condition.
lsaristo 1:7e0243c27ecb 37 */
lsaristo 1:7e0243c27ecb 38 int right(float deg);
lsaristo 1:7e0243c27ecb 39
lsaristo 1:7e0243c27ecb 40 /**
lsaristo 1:7e0243c27ecb 41 * @brief Turn left.
lsaristo 1:7e0243c27ecb 42 *
lsaristo 1:7e0243c27ecb 43 * @param[in] deg Desired final turn angle from starting position.
lsaristo 1:7e0243c27ecb 44 * @param[in] spd Desired turning speed.
lsaristo 1:7e0243c27ecb 45 * @return 0 if successful, or an error condition.
lsaristo 1:7e0243c27ecb 46 */
lsaristo 1:7e0243c27ecb 47 int left (float def);
lsaristo 1:7e0243c27ecb 48
lsaristo 1:7e0243c27ecb 49 /**
lsaristo 1:7e0243c27ecb 50 * #brief Controller decision logic.
lsaristo 1:7e0243c27ecb 51 *
lsaristo 1:7e0243c27ecb 52 * Decide what to do next based on the status of the drawing so far.
lsaristo 1:7e0243c27ecb 53 *
lsaristo 1:7e0243c27ecb 54 */
lsaristo 1:7e0243c27ecb 55 void next_action();
lsaristo 1:7e0243c27ecb 56
lsaristo 1:7e0243c27ecb 57 #endif