Final Project files for mBed development.

Dependencies:   m3pi mbed

project.h

Committer:
lsaristo
Date:
2014-11-12
Revision:
3:d744a6e2c4c0
Parent:
2:c2764165a23d
Child:
5:01882c3de2dc

File content as of revision 3:d744a6e2c4c0:

/**
 * @file    project.h
 * @brief   Main header file for includes and whatnot 
 *          for the other project files.
 * @author  John Wilkey
 */
 
#ifndef _PROJECT_H
#define _PROJECT_H

#include <stdio.h>
#include "m3pi.h"

/**
 * @brief Driver forward.
 *
 * @param[in]   amt     Amount to drive forward.
 * @param[in]   spd     Drive speed.
 * @return              Distance driven.
 */
float foward(float amt, float spd);

/**
 * @brief Drive backward.
 *
 * @param[in]   amt     Amount to drive backward.
 * @param[in]   spd     Drive speed.
 * @return              Distance driven.
 */
float backward(float amt);

/**
 * @brief Turn right.
 *
 * @param[in]   deg     Desired final turn angle from starting position.
 * @param[in]   spd     Desired turning speed.
 * @return              0 if successful, or an error condition.
 */
int right(float deg);

/**
 * @brief Turn left.
 *
 * @param[in]   deg     Desired final turn angle from starting position.
 * @param[in]   spd     Desired turning speed.
 * @return              0 if successful, or an error condition.
 */
int left (float def);

/**
 * @brief Controller decision logic.
 *
 * Decide what to do next based on the status of the drawing so far.
 *
 */
 void next_action();

#endif