Contiki-NG
buzzer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014, Texas Instruments Incorporated - http://www.ti.com/
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 /**
31  * \addtogroup sensortag-peripherals
32  * @{
33  *
34  * \defgroup sensortag-buzzer SensorTag Buzzer
35  * @{
36  *
37  * \file
38  * Header file for the Sensortag Buzzer.
39  * \author
40  * Edvard Pettersen <e.pettersen@ti.com>.
41  */
42 /*---------------------------------------------------------------------------*/
43 #ifndef BUZZER_H_
44 #define BUZZER_H_
45 /*---------------------------------------------------------------------------*/
46 #include <stdint.h>
47 #include <stdbool.h>
48 /*---------------------------------------------------------------------------*/
49 /**
50  * \brief Initialise the buzzer
51  */
52 bool buzzer_init(void);
53 
54 /**
55  * \brief Start the buzzer.
56  * \param freq The buzzer frequency in Hz.
57  */
58 bool buzzer_start(uint32_t freq);
59 
60 /**
61  * \brief Stop the buzzer.
62  */
63 void buzzer_stop(void);
64 
65 /**
66  * \brief Retrieve the buzzer state.
67  * \return Running status of the buzzer.
68  * \retval 0 Buzzer is off
69  * \retval 1 Buzzer is on
70  */
71 bool buzzer_running(void);
72 /*---------------------------------------------------------------------------*/
73 #endif /* BUZZER_H_ */
74 /*---------------------------------------------------------------------------*/
75 /**
76  * @}
77  * @}
78  */
void buzzer_stop()
Stop the buzzer.
Definition: buzzer.c:140
bool buzzer_init()
Initialise the buzzer.
Definition: buzzer.c:75
bool buzzer_running()
Retrieve the buzzer state.
Definition: buzzer.c:100
bool buzzer_start(uint32_t freq)
Start the buzzer.
Definition: buzzer.c:106