Added alt tags and missing images to grove sensors

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

BIN
docs/images/gprs.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

BIN
docs/images/grovegprs.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 159 KiB

BIN
docs/images/groveo2.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

View File

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 8.7 KiB

View File

@ -47,7 +47,7 @@ namespace upm {
* collision movement or vibration happens.
* It outputs a low pulse signal when vibration is detected.
*
* @image html grovecollision.jpg
* @image html collision.jpg
* @snippet collision.cxx Interesting
*/
class Collision {

View File

@ -36,7 +36,8 @@ namespace upm {
/**
* @library emg
* @sensor emg
* @comname Grove EMG Sensor
* @comname EMG Sensor
* @altname Grove EMG Sensor
* @type electric
* @man seeed
* @con analog
@ -46,7 +47,7 @@ namespace upm {
* Grove EMG muscle signal reader gathers small muscle signals,
* then processes them, and returns the result
*
* @image html emg.jpg
* @image html emg.jpg
* @snippet emg.cxx Interesting
*/
class EMG {

View File

@ -40,7 +40,7 @@
namespace upm {
/**
* @brief GPRS Module library
* @brief GPRS Module library
* @defgroup gprs libupm-gprs
* @ingroup seeed uart wifi
*/
@ -48,13 +48,14 @@ namespace upm {
/**
* @library gprs
* @sensor gprs
* @comname GPRS Module
* @comname GPRS Module
* @altname Grove GPRS Module
* @type wifi
* @man seeed
* @con uart
* @web http://www.seeedstudio.com/wiki/GPRS_Shield_V2.0
*
* @brief API for the GPRS Module
* @brief API for the GPRS Module
*
* The driver was tested with the GPRS Module, V2. It's a
* GSM GPRS module based on the SIM900. This module uses a

View File

@ -45,7 +45,7 @@ namespace upm {
*
* The Grove O2 Oxygen Gas sensor measures the oxygen concentration in the air
*
* @image html groveo2.jpg
* @image html groveo2.jpg
* @snippet groveo2.cxx Interesting
*/
class GroveO2 {

View File

@ -31,6 +31,11 @@
#include "led.hpp"
namespace upm {
/**
* @brief Led Sensor library
* @defgroup led libupm-led
* @ingroup seeed gpio led gsk
*/
/**
* @library led

View File

@ -28,23 +28,24 @@
namespace upm {
/**
* @brief Line Finder Sensor library
* @brief Line Finder Sensor library
* @defgroup linefinder libupm-linefinder
* @ingroup seeed gpio color robok
* @ingroup seeed dfrobot gpio color robok
*/
/**
* @library linefinder
* @sensor linefinder
* @comname Line Finder
* @comname Line Finder
* @altname Grove Line Finder, DFRobot Line Tracking sensor
* @type color
* @man seeed
* @man seeed, dfrobot
* @con gpio
* @kit robok
*
* @brief API for the Line Finder Sensor
*
* UPM module for the Line Finder sensor. It outputs a
* UPM module for the Line Finder sensor. It outputs a
* digital signal indicating whether it is detecting black on a
* white background, or white on a black background.
*

View File

@ -43,6 +43,7 @@ namespace upm {
* @library md
* @sensor md
* @comname I2C Motor Driver
* @altname Grove Motor Driver
* @type motor
* @man seeed
* @con i2c

View File

@ -52,7 +52,7 @@ namespace upm {
* Note: this sensor is not designed to be left in soil
* nor to be used outdoors.
*
* @image html grovemoisture.jpg
* @image html moisture.jpg
* @snippet moisture.cxx Interesting
*/
class Moisture {

View File

@ -36,7 +36,8 @@ namespace upm {
/**
* @library o2
* @sensor o2
* @comname Grove O2 Sensor
* @comname O2 Sensor
* @altname Grove O2 Sensor
* @type gaseous
* @man seeed
* @con analog
@ -45,7 +46,7 @@ namespace upm {
*
* The Grove O2 Oxygen Gas sensor measures the oxygen concentration in the air
*
* @image html o2.jpg
* @image html o2.jpg
* @snippet o2.cxx Interesting
*/
class O2 {

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;
};
};
}

View File

@ -55,8 +55,9 @@ namespace upm {
/**
* @library scam
* @sensor scam
* @comname Serial Camera
* @sensor scam
* @comname Serial Camera
* @altname Grove Serial Camera
* @type other
* @man seeed
* @con uart
@ -70,7 +71,7 @@ namespace upm {
* sketch.
*
* It is connected via a UART at 115,200 baud.
*
*
* @image html scam.jpg
* @snippet scam.cxx Interesting
*/

View File

@ -30,23 +30,29 @@
#include <mraa/aio.hpp>
namespace upm {
/**
* @brief Slide Sensor library
* @defgroup slide libupm-slide
* @ingroup seeed analog ainput
*/
/**
* @library slide
* @sensor slide
* @comname Slide Potentiometer
* @type ainput
* @man seeed
* @con analog
*
* @brief API for the Slide Potentiometer
*
* Basic UPM module for the slide potentiometer on analog that
* returns either a raw value or a scaled voltage value.
*
* @image html slide.jpeg
* @snippet slide.cxx Interesting
*/
/**
* @library slide
* @sensor slide
* @comname Slide Potentiometer
* @altname Grove Slide
* @type ainput
* @man seeed
* @con analog
*
* @brief API for the Slide Potentiometer
*
* Basic UPM module for the slide potentiometer on analog that
* returns either a raw value or a scaled voltage value.
*
* @image html slide.jpg
* @snippet slide.cxx Interesting
*/
class Slide {
public:
/**

View File

@ -32,11 +32,7 @@
#define LOW 0
namespace upm {
/**
* @brief Speaker library
* @defgroup speaker libupm-speaker
* @ingroup seeed gpio sound hak
*/
typedef struct
{
int delayTimeLow;
@ -46,10 +42,18 @@ typedef struct
int delayTimeHigh;
int delayTimeHighSharp;
} NoteData;
/**
* @brief Speaker library
* @defgroup speaker libupm-speaker
* @ingroup seeed gpio sound hak
*/
/**
* @library speaker
* @sensor speaker libupm-speaker
* @comname Speaker
* @altname Grove Speaker
* @type sound
* @man seeed
* @con gpio
@ -60,8 +64,8 @@ typedef struct
* UPM module for the Speaker.
* This sensor can generate different tones and sounds depending on the
* frequency of the input signal.
*
* @image html speaker.jpg
*
* @image html speaker.jpg
* @snippet speaker.cxx Interesting
*/
class Speaker {

View File

@ -45,6 +45,7 @@ namespace upm {
* @library vdiv
* @sensor vdiv
* @comname Voltage Divider
* @altname Grove Voltage Divider
* @type electric
* @man seeed
* @con analog

View File

@ -39,7 +39,8 @@ namespace upm {
/**
* @library wfs
* @sensor wfs
* @comname Grove Water Flow Sensor
* @comname Water Flow Sensor
* @altname Grove Water Flow Sensor
* @type liquid
* @man seeed
* @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor