LoBeep.h

Go to the documentation of this file.
00001 /**
00002    \file  Robots/LoBot/irccm/LoBeep.h
00003    \brief Some quick functions to have the iRobot Create make some noise.
00004 
00005    This file defines an API for making some sounds using the iRobot
00006    Create's on-board speaker. These functions can be useful debugging
00007    aids and also provide auditory feedback while the control program
00008    runs.
00009 */
00010 
00011 /*
00012  ************************************************************************
00013  * The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   *
00014  * by the University of Southern California (USC) and the iLab at USC.  *
00015  * See http://iLab.usc.edu for information about this project.          *
00016  *                                                                      *
00017  * Major portions of the iLab Neuromorphic Vision Toolkit are protected *
00018  * under the U.S. patent ``Computation of Intrinsic Perceptual Saliency *
00019  * in Visual Environments, and Applications'' by Christof Koch and      *
00020  * Laurent Itti, California Institute of Technology, 2001 (patent       *
00021  * pending; application number 09/912,225 filed July 23, 2001; see      *
00022  * http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     *
00023  ************************************************************************
00024  * This file is part of the iLab Neuromorphic Vision C++ Toolkit.       *
00025  *                                                                      *
00026  * The iLab Neuromorphic Vision C++ Toolkit is free software; you can   *
00027  * redistribute it and/or modify it under the terms of the GNU General  *
00028  * Public License as published by the Free Software Foundation; either  *
00029  * version 2 of the License, or (at your option) any later version.     *
00030  *                                                                      *
00031  * The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  *
00032  * that it will be useful, but WITHOUT ANY WARRANTY; without even the   *
00033  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      *
00034  * PURPOSE.  See the GNU General Public License for more details.       *
00035  *                                                                      *
00036  * You should have received a copy of the GNU General Public License    *
00037  * along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   *
00038  * to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   *
00039  * Boston, MA 02111-1307 USA.                                           *
00040  ************************************************************************
00041 */
00042 
00043 /*
00044    Primary maintainer for this file: Manu Viswanathan mviswana usc edu
00045    $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Robots/LoBot/irccm/LoBeep.h $
00046    $Id: LoBeep.h 12838 2010-02-14 14:28:03Z mviswana $
00047 */
00048 
00049 #ifndef LOBOT_IRCCM_BEEP_DOT_H
00050 #define LOBOT_IRCCM_BEEP_DOT_H
00051 
00052 /*----------------------------- CONSTANTS -----------------------------*/
00053 
00054 /// The different sound sequences supported by the control program.
00055 enum {
00056    LOBOT_BEEP_STARTUP,
00057    LOBOT_BEEP_HEARTBEAT,
00058    LOBOT_BEEP_QUITTING,
00059 } ;
00060 
00061 /*-------------------------- INITIALIZATION ---------------------------*/
00062 
00063 /// Initialize the different sound sequences supported by the control
00064 /// program.
00065 void lo_init_beeps(void) ;
00066 
00067 /*----------------------------- SONGS API -----------------------------*/
00068 
00069 /// Play one of the supported beeps given its ID.
00070 void lo_beep(char beep_id) ;
00071 
00072 /*---------------------------------------------------------------------*/
00073 
00074 #endif
Generated on Sun May 8 08:41:30 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3