buzzerled.h File Reference

Generic library to handle buzzers and leds. More...

#include <cpu/attr.h>
#include <hw.h>
#include <CPU_HEADER(buzzerled)>

Go to the source code of this file.

Defines
#define	bld_set(device, enable)   bld_hw_set(device, enable)
	Set or reset a device.
Functions
void	bld_init (void)
	Include hw.h.
void	bld_beep (enum BLD_DEVICE device, uint16_t duration)
	Enable a device for a certain interval of time.
void	bld_beep_and_wait (enum BLD_DEVICE device, uint16_t duration)
	Enable a device for a certain interval of time and wait.

---

Detailed Description

Generic library to handle buzzers and leds.

Version:

Id

buzzerled.h 930 2007-10-23 14:48:48Z batt

Author:

Giovanni Bajo <rasky@develer.com>

Definition in file buzzerled.h.

---

Define Documentation

#define bld_set	(	device,
		enable		)	bld_hw_set(device, enable)

Set or reset a device.

Parameters:

	device	Device to be set
	enable	Enable/disable status

Definition at line 72 of file buzzerled.h.

---

Function Documentation

void bld_beep	(	enum BLD_DEVICE	device,
		uint16_t	duration
	)

Enable a device for a certain interval of time.

Parameters:

	device	Device to be enabled
	duration	Number of milliseconds the device must be enabled

Note:

This function is non-blocking, so it will return immediately.

Definition at line 106 of file buzzerled.c.

void bld_beep_and_wait	(	enum BLD_DEVICE	device,
		uint16_t	duration
	)

Enable a device for a certain interval of time and wait.

Parameters:

	device	Device to be enabled
	duration	Number of milliseconds the device must be enabled

Note:

This function is blocking, so it will return after the specified period of time.

Definition at line 117 of file buzzerled.c.

void bld_init

(

void

)

Include hw.h.

We expect hw.h to define enum BLD_DEVICE, which must contain an enumarator for each device, plus a special symbol NUM_BLDS containing the number of devices. Initialize the buzzerled library.

Note:

This function must be called before any other function in the library.

Definition at line 101 of file buzzerled.c.