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 /**
32  * \addtogroup sensortag-cc26xx-peripherals
33  * @{
34  *
35  * \defgroup sensortag-cc26xx-buzzer SensorTag 2.0 Buzzer
36  * @{
37  *
38  * \file
39  * Header file for the Sensortag Buzzer
40  */
41 /*---------------------------------------------------------------------------*/
42 #ifndef BUZZER_H_
43 #define BUZZER_H_
44 /*---------------------------------------------------------------------------*/
45 #include <stdint.h>
46 /*---------------------------------------------------------------------------*/
47 /**
48  * \brief Initialise the buzzer
49  */
50 void buzzer_init(void);
51 
52 /**
53  * \brief Start the buzzer
54  * \param freq The buzzer frequency
55  */
56 void buzzer_start(int freq);
57 
58 /**
59  * \brief Stop the buzzer
60  */
61 void buzzer_stop(void);
62 
63 /**
64  * \brief Retrieve the buzzer state
65  * \return 1: on, 0: off
66  */
67 uint8_t buzzer_state(void);
68 /*---------------------------------------------------------------------------*/
69 #endif /* BUZZER_H_ */
70 /*---------------------------------------------------------------------------*/
71 /**
72  * @}
73  * @}
74  */
void buzzer_stop()
Stop the buzzer.
Definition: buzzer.c:106
void buzzer_start(int freq)
Start the buzzer.
Definition: buzzer.c:64
void buzzer_init()
Initialise the buzzer.
Definition: buzzer.c:52
uint8_t buzzer_state()
Retrieve the buzzer state.
Definition: buzzer.c:58