Contiki-NG
relay.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Zolertia - http://www.zolertia.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 Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  */
32 /*---------------------------------------------------------------------------*/
33 /**
34  * \addtogroup zoul-sensors
35  * @{
36  *
37  * \defgroup zoul-relay Generic relay driver
38  *
39  * Driver for a generic relay driver
40  * @{
41  *
42  * \file
43  * Header file for the generic relay driver
44  */
45 /*---------------------------------------------------------------------------*/
46 #ifndef RELAY_H_
47 #define RELAY_H_
48 /* -------------------------------------------------------------------------- */
49 /**
50  * \name Relay default pin and port
51  * @{
52  */
53 #ifdef RELAY_CONF_PIN
54 #define RELAY_PIN RELAY_CONF_PIN
55 #else
56 #define RELAY_PIN 5
57 #endif
58 #ifdef RELAY_CONF_PORT
59 #define RELAY_PORT RELAY_CONF_PORT
60 #else
61 #define RELAY_PORT GPIO_A_NUM
62 #endif
63 /** @} */
64 /* -------------------------------------------------------------------------- */
65 /**
66  * \name Relay available commands
67  * @{
68  */
69 #define RELAY_OFF 0x00
70 #define RELAY_ON 0x01
71 #define RELAY_TOGGLE 0x02
72 /** @} */
73 /* -------------------------------------------------------------------------- */
74 /**
75  * \name Relay return types
76  * @{
77  */
78 #define RELAY_ERROR (-1)
79 #define RELAY_SUCCESS 0x00
80 /** @} */
81 /* -------------------------------------------------------------------------- */
82 #define RELAY_ACTUATOR "Generic Relay"
83 /* -------------------------------------------------------------------------- */
84 extern const struct sensors_sensor relay;
85 /* -------------------------------------------------------------------------- */
86 /* -------------------------------------------------------------------------- */
87 #endif /* RELAY_H_ */
88 /* -------------------------------------------------------------------------- */
89 /**
90  * @}
91  * @}
92  */