mirror of
https://github.com/eclipse/upm.git
synced 2025-10-29 06:05:04 +03:00
doc: Scrubbed ALL sensor library descriptions
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:
@@ -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)
|
||||
|
||||
@@ -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 {
|
||||
|
||||
Reference in New Issue
Block a user