upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
relay.h
Go to the documentation of this file.
1 /*
2  * Author: Sisinty Sasmita Patra <sisinty.s.patra@intel.com>
3  *
4  * Copyright (c) 2016 Intel Corporation.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining
7  * a copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sublicense, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be
15  * included in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25 
26 #ifndef RELAY_H_
27 #define RELAY_H_
28 
29 #pragma once
30 #include <stdlib.h>
31 #include <unistd.h>
32 
33 #include "upm.h"
34 #include <mraa/gpio.h>
35 
47 typedef struct _relay_context{
48  mraa_gpio_context gpio;
49 } *relay_context;
50 
56 relay_context relay_init(int pin);
57 
61 void relay_close(relay_context dev);
62 
69 upm_result_t relay_on(relay_context dev);
70 
77 upm_result_t relay_off(relay_context dev);
78 
84 bool relay_is_on(relay_context dev);
85 
91 bool relay_is_off(relay_context dev);
92 
93 #endif /* RELAY_H_ */
upm_result_t relay_on(relay_context dev)
Definition: relay.c:52
upm_result_t relay_off(relay_context dev)
Definition: relay.c:58
struct _relay_context * relay_context
relay_context relay_init(int pin)
Definition: relay.c:28
Definition: relay.h:47
bool relay_is_off(relay_context dev)
Definition: relay.c:74
bool relay_is_on(relay_context dev)
Definition: relay.c:64
void relay_close(relay_context dev)
Definition: relay.c:45