LoBeep.h

Go to the documentation of this file.

/**
   \file  Robots/LoBot/irccm/LoBeep.h
   \brief Some quick functions to have the iRobot Create make some noise.

   This file defines an API for making some sounds using the iRobot
   Create's on-board speaker. These functions can be useful debugging
   aids and also provide auditory feedback while the control program
   runs.
*/

/*
 ************************************************************************
 * The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   *
 * by the University of Southern California (USC) and the iLab at USC.  *
 * See http://iLab.usc.edu for information about this project.          *
 *                                                                      *
 * Major portions of the iLab Neuromorphic Vision Toolkit are protected *
 * under the U.S. patent ``Computation of Intrinsic Perceptual Saliency *
 * in Visual Environments, and Applications'' by Christof Koch and      *
 * Laurent Itti, California Institute of Technology, 2001 (patent       *
 * pending; application number 09/912,225 filed July 23, 2001; see      *
 * http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     *
 ************************************************************************
 * This file is part of the iLab Neuromorphic Vision C++ Toolkit.       *
 *                                                                      *
 * The iLab Neuromorphic Vision C++ Toolkit is free software; you can   *
 * redistribute it and/or modify it under the terms of the GNU General  *
 * Public License as published by the Free Software Foundation; either  *
 * version 2 of the License, or (at your option) any later version.     *
 *                                                                      *
 * The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  *
 * that it will be useful, but WITHOUT ANY WARRANTY; without even the   *
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      *
 * PURPOSE.  See the GNU General Public License for more details.       *
 *                                                                      *
 * You should have received a copy of the GNU General Public License    *
 * along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   *
 * to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   *
 * Boston, MA 02111-1307 USA.                                           *
 ************************************************************************
*/

/*
   Primary maintainer for this file: Manu Viswanathan mviswana usc edu
   $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Robots/LoBot/irccm/LoBeep.h $
   $Id: LoBeep.h 12838 2010-02-14 14:28:03Z mviswana $
*/

#ifndef LOBOT_IRCCM_BEEP_DOT_H
#define LOBOT_IRCCM_BEEP_DOT_H

/*----------------------------- CONSTANTS -----------------------------*/

/// The different sound sequences supported by the control program.
enum {
   LOBOT_BEEP_STARTUP,
   LOBOT_BEEP_HEARTBEAT,
   LOBOT_BEEP_QUITTING,
} ;

/*-------------------------- INITIALIZATION ---------------------------*/

/// Initialize the different sound sequences supported by the control
/// program.
void lo_init_beeps(void) ;

/*----------------------------- SONGS API -----------------------------*/

/// Play one of the supported beeps given its ID.
void lo_beep(char beep_id) ;

/*---------------------------------------------------------------------*/

#endif