irobot.h

00001 /** \file irobot.h
00002  *
00003  * Top-level driver for the iRobot Create.
00004  * Implements irobotOpen() and irobotClose()
00005  *
00006  * \author Jeff C. Jensen
00007  * \date 2013-10-17
00008  * \copyright Copyright (C) 2013, Jeff C. Jensen, Edward A. Lee, and Sanjit A. Seshia.
00009  *            This software accompanies An Introductory Lab in Embedded and Cyber-Physical Systems
00010  *            and is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0
00011  *            Unported License. See http://leeseshia.org/lab.
00012  */
00013 
00014 #ifndef _IROBOT_H
00015 #define _IROBOT_H
00016 
00017 #include "irobotUART.h"
00018 #include "irobotSensor.h"
00019 #include "irobotSensorPoll.h"
00020 #include "irobotSensorStream.h"
00021 #include "irobotActuator.h"
00022 #include "irobotCommand.h"
00023 #include <stdio.h>
00024 #include <stdlib.h>
00025 #include <time.h>
00026 
00027 /// Open UART serial port and initialize iRobot.
00028 /// \return error code
00029 int32_t irobotOpen(
00030     const irobotUARTPort_t  port        ///< [in] UART port
00031 );
00032 
00033 /// Close a session with an iRobot
00034 /// \return error code
00035 int32_t irobotClose(
00036     const irobotUARTPort_t  port        ///< [in] UART port
00037 );
00038 
00039 
00040 #endif  // _IROBOT_H