Main Page | Modules | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Examples

Beeper interface
[The ESB Embedded Sensor Board]


Files

file  beep.h
 Interface to the beeper.

Defines

#define BEEP_ON   1
#define BEEP_OFF   0
#define BEEP_ALARM1   1
#define BEEP_ALARM2   2

Functions

void beep_beep (int len)
 Beep for a specified time.
void beep_alarm (int alarmmode, int len)
 Beep an alarm for a specified time.
void beep (void)
 Produces a quick click-like beep.
void beep_down (int len)
 A beep with a pitch-bend down.
void beep_on (void)
 Turn the beeper on.
void beep_off (void)
 Turn the beeper off.
void beep_spinup (void)
 Produce a sound similar to a hard-drive spinup.
void beep_long (clock_time_t len)
 Beep for a long time (seconds).


Function Documentation

void beep void   ) 
 

Produces a quick click-like beep.

This function produces a short beep that sounds like a click.

void beep_alarm int  alarmmode,
int  len
 

Beep an alarm for a specified time.

This function causes the beeper to beep for the specified time. The time is measured in the same units as for the clock_delay() function.

Note:
This function will hang the CPU during the beep.

This function will stop any beep that was on previously when this function ends.

If the beeper is turned off with beep_off() this call will still take the same time, though it will be silent.

Parameters:
alarmmode The alarm mode (BEEP_ALARM1,BEEP_ALARM2)
len The length of the beep.

void beep_beep int  len  ) 
 

Beep for a specified time.

This function causes the beeper to beep for the specified time. The time is measured in the same units as for the clock_delay() function.

Note:
This function will hang the CPU during the beep.

This function will stop any beep that was on previously when this function ends.

If the beeper is turned off with beep_off() this call will still take the same time, though it will be silent.

Parameters:
len The length of the beep.

Referenced by PT_THREAD().

void beep_down int  len  ) 
 

A beep with a pitch-bend down.

This function produces a pitch-bend sound with deecreasing frequency.

Parameters:
len The length of the pitch-bend.

void beep_long clock_time_t  len  ) 
 

Beep for a long time (seconds).

This function produces a beep with the specified length and will not return until the beep is complete. The length of the beep is specified using CLOCK_SECOND: a two second beep is CLOCK_SECOND * 2, and a quarter second beep is CLOCK_SECOND / 4.

Note:
If the beeper is turned off with beep_off() this call will still take the same time, though it will be silent.
Parameters:
len The length of the beep, measured in units of CLOCK_SECOND

void beep_off void   ) 
 

Turn the beeper off.

This function turns the beeper off after it has been turned on with beep_on().

void beep_on void   ) 
 

Turn the beeper on.

This function turns on the beeper. The beeper is turned off with the beep_off() function.

void beep_spinup void   ) 
 

Produce a sound similar to a hard-drive spinup.

This function produces a sound that is intended to be similar to the sound a hard-drive makes when it starts.


Generated on Thu Jun 22 17:45:43 2006 for Contiki 2.x by  doxygen 1.4.4