mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 21:17:29 +03:00
94 lines
2.4 KiB
C
94 lines
2.4 KiB
C
/*
|
|
* Author: Sisinty Sasmita Patra <sisinty.s.patra@intel.com>
|
|
*
|
|
* Copyright (c) 2016 Intel Corporation.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef RELAY_H_
|
|
#define RELAY_H_
|
|
|
|
#pragma once
|
|
#include <stdlib.h>
|
|
#include <unistd.h>
|
|
|
|
#include "upm.h"
|
|
#include <mraa/gpio.h>
|
|
|
|
/**
|
|
* @file relay.h
|
|
* @library relay
|
|
* @brief C API for Relays
|
|
*
|
|
* @include relay.c
|
|
*/
|
|
|
|
/**
|
|
* device context
|
|
*/
|
|
typedef struct _relay_context{
|
|
mraa_gpio_context gpio;
|
|
} *relay_context;
|
|
|
|
/**
|
|
* relay init function
|
|
*
|
|
* @param pin Pin to use
|
|
*/
|
|
relay_context relay_init(int pin);
|
|
|
|
/**
|
|
* relay destructor
|
|
*/
|
|
void relay_close(relay_context dev);
|
|
|
|
/**
|
|
* Sets the relay switch to on (closed circuit). This allows current
|
|
* to flow and lights up the indicator LED.
|
|
*
|
|
* @return result of the operation
|
|
*/
|
|
upm_result_t relay_on(relay_context dev);
|
|
|
|
/**
|
|
* Sets the relay switch to off (open circuit). This stops current
|
|
* from flowing and the indicator LED is not lit.
|
|
*
|
|
* @return result of the operation
|
|
*/
|
|
upm_result_t relay_off(relay_context dev);
|
|
|
|
/**
|
|
* Checks whether the relay switch is closed.
|
|
*
|
|
* @return True if the switch is on (closed), false otherwise
|
|
*/
|
|
bool relay_is_on(relay_context dev);
|
|
|
|
/**
|
|
* Checks whether the relay switch is open.
|
|
*
|
|
* @return True if the switch is off (open), false otherwise
|
|
*/
|
|
bool relay_is_off(relay_context dev);
|
|
|
|
#endif /* RELAY_H_ */
|