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

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/ina132/CMakeLists.txt
View File

@ -1,5 +1,5 @@
set (libname "ina132")
set (libdescription "Ina132 differential amplifier sensor module")
set (libdescription "Differential Amplifier")
set (module_src ${libname}.cxx)
set (module_hpp ${libname}.hpp)
upm_module_init(mraa)

11
src/ina132/ina132.hpp
View File

@ -35,21 +35,22 @@ namespace upm {
/**
* @library ina132
* @sensor ina132
* @comname Grove Differential Amplifier
* @comname Differential Amplifier
* @altname INA132
* @type electric
* @man seeed
* @con analog
* @web http://wiki.seeed.cc/Grove-Differential_Amplifier_v1.2/
*
* @brief API for the INA132 Differential Amplifier Sensor
*
*
* The INA132 Differential Amplifier Sensor is designed
* for precise differential-input amplification.
*
*
* This sensor was tested amplifying the signal
* from a Weight Sensor (Load Cell) 0-500g
*
* @image html ina132.jpg
*
* @image html ina132.jpg
* @snippet ina132.cxx Interesting
*/
class INA132 {