docs: added new sensor images

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2016-02-09 08:49:15 -08:00
parent ab15d1e98f
commit 7d64e5458f
32 changed files with 36 additions and 5 deletions

BIN
docs/images/adxrs610.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

BIN
docs/images/bma220.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

BIN
docs/images/dfrph.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/images/eboled.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

BIN
docs/images/keypadlcd.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

BIN
docs/images/lm35.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

BIN
docs/images/lsm9ds0.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

BIN
docs/images/mg811.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

BIN
docs/images/mpu60x0.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

BIN
docs/images/mpu9250.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/images/pn532.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

BIN
docs/images/urm37.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

BIN
docs/images/xbee.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 176 KiB

View File

@ -65,6 +65,7 @@ namespace upm {
* *
* This driver was developed using the DFRobot ADXRS610 Gyro Beakout board. * This driver was developed using the DFRobot ADXRS610 Gyro Beakout board.
* *
* @image html adxrs610.jpg
* @snippet adxrs610.cxx Interesting * @snippet adxrs610.cxx Interesting
*/ */

View File

@ -63,6 +63,7 @@ namespace upm {
* *
* This driver was developed on a DFRobot BMA (Tiny). * This driver was developed on a DFRobot BMA (Tiny).
* *
* @image html bma220.jpg
* @snippet bma220.cxx Interesting * @snippet bma220.cxx Interesting
*/ */

View File

@ -83,6 +83,7 @@ namespace upm {
* this calibration, you can measure the pH value of an alkaline * this calibration, you can measure the pH value of an alkaline
* solution. * solution.
* *
* @image html dfrph.jpg
* @snippet dfrph.cxx Interesting * @snippet dfrph.cxx Interesting
*/ */

View File

@ -57,6 +57,7 @@ namespace upm {
* to 4 m (13'1.5") and works best when the object is within a 30 degree angle * to 4 m (13'1.5") and works best when the object is within a 30 degree angle
* relative to the sensor. * relative to the sensor.
* *
* @image html groveultrasonic.jpg
* @snippet groveultrasonic.cxx Interesting * @snippet groveultrasonic.cxx Interesting
*/ */
class GroveUltraSonic { class GroveUltraSonic {

View File

@ -52,6 +52,7 @@ namespace upm {
* *
* This module defines the HC-SR04 interface for libhcsr04 * This module defines the HC-SR04 interface for libhcsr04
* *
* @image html groveultrasonic.jpg
* @snippet hcsr04.cxx Interesting * @snippet hcsr04.cxx Interesting
*/ */
class HCSR04 { class HCSR04 {

View File

@ -66,6 +66,11 @@ namespace upm
* standard GPIO -- this driver only concerns itself with the * standard GPIO -- this driver only concerns itself with the
* display. * display.
* *
* @image html eboled.jpg
* <br><em>OLED Sensor image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
* @snippet eboled.cxx Interesting * @snippet eboled.cxx Interesting
*/ */

View File

@ -32,7 +32,7 @@ namespace upm
/** /**
* @brief I2C LCD Display library * @brief I2C LCD Display library
* @defgroup i2clcd libupm-i2clcd * @defgroup i2clcd libupm-i2clcd
* @ingroup seeed sparkfun adafruit i2c gpio display gsk * @ingroup dfrobot sainsmart seeed sparkfun adafruit i2c gpio display gsk
*/ */
class LCD class LCD
{ {

View File

@ -34,16 +34,20 @@ namespace upm
* @sensor sainsmartks * @sensor sainsmartks
* @comname SainSmart LCD Keypad Shield * @comname SainSmart LCD Keypad Shield
* @type display * @type display
* @man sainsmart * @man sainsmart dfrobot sparkfun
* @web http://www.sainsmart.com/sainsmart-1602-lcd-keypad-shield-for-arduino-duemilanove-uno-mega2560-mega1280.html * @web http://www.sainsmart.com/sainsmart-1602-lcd-keypad-shield-for-arduino-duemilanove-uno-mega2560-mega1280.html
* @web http://www.dfrobot.com/index.php?route=product/product&product_id=51
* @web https://www.sparkfun.com/products/13293
* @con gpio analog * @con gpio analog
* *
* @brief API for Sainsmart LCD Keypad Shield * @brief API for Sainsmart LCD Keypad Shield
* *
* The Sainsmart LCD Keypad Shield uses 6 digital outputs and 1 * The Sainsmart LCD Keypad Shield uses 6 digital outputs and 1 analog input
* analog input (for the keypad). The outputs are used to drive an * (for the keypad). The outputs are used to drive an attached LCM1602 LCD
* attached LCM1602 LCD controller. * controller. This driver should also be compatible with the similar LCD
* keypad shields from DFRobot and Sparkfun.
* *
* @image keypadlcd.jpg
* @snippet sainsmartks.cxx Interesting * @snippet sainsmartks.cxx Interesting
*/ */
class SAINSMARTKS : public Lcm1602 class SAINSMARTKS : public Lcm1602

View File

@ -54,6 +54,7 @@ namespace upm {
* This driver was developed using the DFRobot LM35 Linear * This driver was developed using the DFRobot LM35 Linear
* Temperature Sensor * Temperature Sensor
* *
* @image html lm35.jpg
* @snippet lm35.cxx Interesting * @snippet lm35.cxx Interesting
*/ */

View File

@ -68,6 +68,11 @@ namespace upm {
* *
* This driver was developed on a Sparkfun 9DOF edison block. * This driver was developed on a Sparkfun 9DOF edison block.
* *
* @image html lsm9ds0.jpg
* <br><em>LSM9DS0 Sensor image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
* @snippet lsm9ds0.cxx Interesting * @snippet lsm9ds0.cxx Interesting
*/ */

View File

@ -64,6 +64,7 @@ namespace upm {
* on the sensor will light, and the digital pin will be driven * on the sensor will light, and the digital pin will be driven
* high. * high.
* *
* @image html mg811.jpg
* @snippet mg811.cxx Interesting * @snippet mg811.cxx Interesting
*/ */

View File

@ -55,6 +55,7 @@ namespace upm {
* should allow an end user to implement whatever features are * should allow an end user to implement whatever features are
* required. * required.
* *
* @image html mpu60x0.jpg
* @snippet mpu60x0.cxx Interesting * @snippet mpu60x0.cxx Interesting
*/ */
class MPU60X0 { class MPU60X0 {

View File

@ -46,6 +46,7 @@ namespace upm {
* *
* This module defines the MPU9250 interface for libmpu9150 * This module defines the MPU9250 interface for libmpu9150
* *
* @image html mpu9250.jpg
* @snippet mpu9250.cxx Interesting * @snippet mpu9250.cxx Interesting
*/ */

View File

@ -66,6 +66,7 @@ namespace upm {
* *
* @brief API for the PN532 based NFC/RFID reader/writer * @brief API for the PN532 based NFC/RFID reader/writer
* *
* @image html pn532.jpg
* Identify a card and print out basic info * Identify a card and print out basic info
* @snippet pn532.cxx Interesting * @snippet pn532.cxx Interesting
* Add a URI to an already NDEF formatted ultralight or NTAG2XX tag * Add a URI to an already NDEF formatted ultralight or NTAG2XX tag

View File

@ -74,6 +74,7 @@ namespace upm {
* *
* (https://www.dfrobot.com/wiki/index.php?title=URM37_V4.0_Ultrasonic_Sensor_%28SKU:SEN0001%29) * (https://www.dfrobot.com/wiki/index.php?title=URM37_V4.0_Ultrasonic_Sensor_%28SKU:SEN0001%29)
* *
* @image html urm37.jpg
* An example using analog mode * An example using analog mode
* @snippet urm37.cxx Interesting * @snippet urm37.cxx Interesting
* An example using UART mode * An example using UART mode

View File

@ -59,6 +59,7 @@ namespace upm {
* correlate the number of counts to a time period for calculating * correlate the number of counts to a time period for calculating
* an RPM or other value as needed. * an RPM or other value as needed.
* *
* @image html wheelencoder.jpg
* @snippet wheelencoder.cxx Interesting * @snippet wheelencoder.cxx Interesting
*/ */
class WheelEncoder { class WheelEncoder {

View File

@ -70,6 +70,11 @@ namespace upm {
* windows software, however it is possible of course to configure * windows software, however it is possible of course to configure
* them manually using AT commands. See the examples. * them manually using AT commands. See the examples.
* *
* @image html xbee.jpg
* <br><em>XBee Sensor image provided by SparkFun* under
* <a href=https://creativecommons.org/licenses/by-nc-sa/3.0/>
* CC BY-NC-SA-3.0</a>.</em>
*
* @snippet xbee.cxx Interesting * @snippet xbee.cxx Interesting
*/ */