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

doc: Scrubbed ALL sensor library descriptions

Browse Source 
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.

Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.

    * Tested/updated/added @web tags
    * Added/updated invalid sensor images
    * Added/updated @man tags, added missing manufacturers

Signed-off-by: Noel Eck <noel.eck@intel.com>
This commit is contained in:
Noel Eck
2016-12-15 15:15:21 -08:00
parent 7a5c8a6cb3
commit 283fce619e
416 changed files with 793 additions and 675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/lcd/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "i2clcd")
set (libdescription "Lcd/oled displays")
set (libdescription "LCD and OLED Display Library")
set (module_src lcd.cxx lcm1602.cxx jhd1313m1.cxx ssd1308.cxx eboled.cxx ssd1327.cxx sainsmartks.cxx ssd1306.cxx)
set (module_hpp lcd.hpp lcm1602.hpp jhd1313m1.hpp ssd1308.hpp eboled.hpp ssd1327.hpp ssd.hpp sainsmartks.hpp ssd1306.hpp)
upm_module_init(mraa)

2
src/lcd/eboled.hpp
View File

@ -56,7 +56,7 @@ namespace upm
/**
* @library i2clcd
* @sensor eboled
* @comname Sparkfun Edison Block OLED Display
* @comname SparkFun Block for Intel Edison - OLED
* @altname ssd1306
* @type display
* @man sparkfun

2
src/lcd/jhd1313m1.hpp
View File

@ -33,7 +33,7 @@ namespace upm
/**
* @library i2clcd
* @sensor jhd1313m1
* @comname JHD1313M1 Display
* @comname RGB Backlight 16x2 LCD Display
* @altname Grove RGB LCD
* @type display
* @man seeed adafruit sparkfun

2
src/lcd/lcm1602.hpp
View File

@ -45,7 +45,7 @@ namespace upm
/**
* @library i2clcd
* @sensor lcm1602
* @comname LCM1602 Display
* @comname 16x2 and 20x4 LCD Display
* @type display
* @man adafruit sparkfun seeed
* @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf

2
src/lcd/sainsmartks.hpp
View File

@ -32,7 +32,7 @@ namespace upm
/**
* @library i2clcd
* @sensor sainsmartks
* @comname SainSmart LCD Keypad Shield
* @comname LCD Keypad Shield
* @type display
* @man sainsmart dfrobot sparkfun
* @web http://www.sainsmart.com/sainsmart-1602-lcd-keypad-shield-for-arduino-duemilanove-uno-mega2560-mega1280.html

2
src/lcd/ssd1306.hpp
View File

@ -87,7 +87,7 @@ const uint8_t SSD1306_LCDHEIGHT = 64;
/**
* @library i2clcd
* @sensor ssd1306
* @comname SSD1306 OLED Display
* @comname OLED Display
* @altname Adafruit SSD1306 OLED Display 0.96"
* @type display
* @man adafruit

4
src/lcd/ssd1308.hpp
View File

@ -36,11 +36,11 @@ const uint8_t DISPLAY_CMD_SET_NORMAL_1308 = 0xA6;
/**
* @library i2clcd
* @sensor ssd1308
* @comname SSD1308 OLED Display
* @comname OLED Display
* @altname Grove OLED Display 0.96"
* @type display
* @man seeed adafruit
* @web http://garden.seeedstudio.com/images/4/46/SSD1308_1.0.pdf
* @web http://wiki.seeed.cc/Grove-OLED_Display_0.96inch/
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_0.96%22
* @con i2c
*

5
src/lcd/ssd1327.hpp
View File

@ -36,12 +36,11 @@ const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
/**
* @library i2clcd
* @sensor ssd1327
* @comname SSD1327 OLED Display
* @comname OLED Display
* @altname Grove OLED Display 1.12"
* @type display
* @man seeed adafruit
* @web http://garden.seeedstudio.com/images/8/82/SSD1327_datasheet.pdf
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22
* @web http://wiki.seeed.cc/Grove-OLED_Display_1.12inch/
* @con i2c
*
* @brief API for SSD1327 I2C-controlled OLED displays