alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added alt tags and missing images to grove sensors

Browse Source 
Signed-off-by: Sisinty Sasmita Patra <sisinty.s.patra@intel.com>
This commit is contained in:
Sisinty Sasmita Patra
2016-09-16 12:43:34 -07:00
parent 14ede63192
commit 5d4fc3cbf5
20 changed files with 93 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/relay/relay.hpp
View File

@ -30,28 +30,34 @@
#include <mraa/gpio.hpp>
namespace upm {
/**
* @brief relay sensor library
* @defgroup relay libupm-relay
* @ingroup seeed gpio relay gsk eak hak
*/
/**
* @library relay
* @defgroup relay libupm-relay
* @sensor relay
* @comname Grove Relay
* @type relay
* @man seeed
* @con gpio
* @kit gsk eak hak
*
* @brief API for the Relay
*
* UPM module for the relay switch. The relay is a
* digital normally-open switch that uses low voltage or current to
* control a higher voltage and/or higher current. When closed,
* the indicator LED lights up and current is allowed to flow.
*
* @image html relay.jpg
* @snippet relay.cxx Interesting
*/
class Relay{
/**
* @library relay
* @sensor relay
* @comname Relay
* @altname Grove Relay
* @type relay
* @man seeed
* @con gpio
* @kit gsk eak hak
*
* @brief API for the Relay
*
* UPM module for the relay switch. The relay is a
* digital normally-open switch that uses low voltage or current to
* control a higher voltage and/or higher current. When closed,
* the indicator LED lights up and current is allowed to flow.
*
* @image html relay.jpg
* @snippet relay.cxx Interesting
*/
class Relay{
public:
/**
* relay constructor
@ -92,5 +98,5 @@ class Relay{
std::string name(){ return "Relay Switch";}
private:
mraa_gpio_context m_gpio;
};
};
}