From 283fce619e4c27c67667fd4a922a81508a30387f Mon Sep 17 00:00:00 2001 From: Noel Eck Date: Thu, 15 Dec 2016 15:15:21 -0800 Subject: [PATCH] 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 --- docs/documentation.md | 11 +- docs/images/es9257.jpg | Bin 0 -> 25778 bytes src/a110x/CMakeLists.txt | 2 +- src/a110x/a110x.hpp | 2 +- src/ad8232/CMakeLists.txt | 2 +- src/ad8232/ad8232.hpp | 2 +- src/adafruitms1438/adafruitms1438.hpp | 2 +- src/adafruitss/CMakeLists.txt | 2 +- src/adc121c021/CMakeLists.txt | 2 +- src/adc121c021/adc121c021.hpp | 2 +- src/adis16448/CMakeLists.txt | 2 +- src/adis16448/adis16448.hpp | 2 +- src/ads1x15/CMakeLists.txt | 2 +- src/ads1x15/ads1015.hpp | 4 +- src/ads1x15/ads1115.hpp | 2 +- src/adxl335/CMakeLists.txt | 2 +- src/adxl335/adxl335.hpp | 3 +- src/adxl345/CMakeLists.txt | 2 +- src/adxl345/adxl345.hpp | 3 +- src/adxrs610/CMakeLists.txt | 2 +- src/adxrs610/adxrs610.hpp | 2 +- src/am2315/CMakeLists.txt | 2 +- src/am2315/am2315.hpp | 2 +- src/apa102/CMakeLists.txt | 2 +- src/apa102/apa102.hpp | 3 +- src/apds9002/CMakeLists.txt | 2 +- src/apds9002/apds9002.hpp | 13 +- src/apds9930/CMakeLists.txt | 2 +- src/apds9930/apds9930.hpp | 5 +- src/at42qt1070/CMakeLists.txt | 2 +- src/at42qt1070/at42qt1070.hpp | 3 +- src/bacnetmstp/CMakeLists.txt | 2 +- src/bacnetmstp/bacnetmstp.hpp | 2 +- src/bacnetmstp/bacnetutil.hpp | 2 +- src/bh1750/CMakeLists.txt | 2 +- src/bh1750/bh1750.hpp | 2 +- src/biss0001/CMakeLists.txt | 2 +- src/biss0001/biss0001.hpp | 2 +- src/bma220/CMakeLists.txt | 2 +- src/bma220/bma220.hpp | 2 +- src/bmi160/CMakeLists.txt | 2 +- src/bmi160/bmi160.hpp | 4 +- src/bmp280/CMakeLists.txt | 2 +- src/bmp280/bme280.hpp | 2 +- src/bmp280/bmp280.hpp | 2 +- src/bmpx8x/CMakeLists.txt | 2 +- src/bmpx8x/bmpx8x.hpp | 3 + src/bmx055/CMakeLists.txt | 2 +- src/bmx055/bma250e.hpp | 5 +- src/bmx055/bmc150.hpp | 6 +- src/bmx055/bmg160.hpp | 5 +- src/bmx055/bmi055.hpp | 6 +- src/bmx055/bmm150.hpp | 3 +- src/bmx055/bmx055.hpp | 6 +- src/bno055/CMakeLists.txt | 2 +- src/bno055/bno055.hpp | 2 +- src/button/CMakeLists.txt | 2 +- src/buzzer/buzzer.hpp | 2 +- src/cjq4435/CMakeLists.txt | 2 +- src/cjq4435/cjq4435.hpp | 2 +- src/collision/CMakeLists.txt | 2 +- src/curieimu/CMakeLists.txt | 2 +- src/curieimu/curieimu.hpp | 2 +- src/cwlsxxa/CMakeLists.txt | 2 +- src/cwlsxxa/cwlsxxa.hpp | 2 +- src/dfrec/CMakeLists.txt | 2 +- src/dfrec/dfrec.hpp | 2 +- src/dfrorp/CMakeLists.txt | 2 +- src/dfrorp/dfrorp.hpp | 2 +- src/dfrph/CMakeLists.txt | 2 +- src/dfrph/dfrph.hpp | 2 +- src/ds1307/CMakeLists.txt | 2 +- src/ds1307/ds1307.hpp | 3 +- src/ds1808lc/CMakeLists.txt | 2 +- src/ds1808lc/ds1808lc.hpp | 2 +- src/ds18b20/CMakeLists.txt | 2 +- src/ds18b20/ds18b20.hpp | 2 +- src/ds2413/CMakeLists.txt | 2 +- src/ds2413/ds2413.hpp | 2 +- src/e50hx/CMakeLists.txt | 2 +- src/e50hx/e50hx.hpp | 2 +- src/ecezo/CMakeLists.txt | 2 +- src/ecezo/ecezo.hpp | 2 +- src/ecs1030/CMakeLists.txt | 2 +- src/ecs1030/ecs1030.hpp | 2 +- src/ehr/CMakeLists.txt | 2 +- src/ehr/ehr.hpp | 2 +- src/eldriver/CMakeLists.txt | 2 +- src/eldriver/eldriver.hpp | 2 +- src/electromagnet/CMakeLists.txt | 2 +- src/electromagnet/electromagnet.hpp | 2 +- src/emg/CMakeLists.txt | 2 +- src/emg/emg.hpp | 2 +- src/enc03r/CMakeLists.txt | 2 +- src/enc03r/enc03r.hpp | 151 +++++++++--------- src/flex/CMakeLists.txt | 2 +- src/flex/flex.hpp | 2 +- src/gas/CMakeLists.txt | 2 +- src/gas/mq2.hpp | 3 +- src/gas/mq3.hpp | 3 +- src/gas/mq4.hpp | 3 +- src/gas/mq5.hpp | 3 +- src/gas/mq6.hpp | 3 +- src/gas/mq7.hpp | 3 +- src/gas/mq8.hpp | 3 +- src/gas/mq9.hpp | 3 +- src/gas/tp401.hpp | 3 +- src/gp2y0a/CMakeLists.txt | 2 +- src/gp2y0a/gp2y0a.hpp | 3 +- src/gprs/CMakeLists.txt | 2 +- src/gprs/gprs.hpp | 2 +- src/groups.md | 50 +++++- src/grove/CMakeLists.txt | 2 +- src/grove/grovebutton.hpp | 2 +- src/grove/groveled.hpp | 2 +- src/grove/grovelight.hpp | 2 +- src/grove/groverelay.hpp | 2 +- src/grove/groverotary.hpp | 4 +- src/grove/groveslide.hpp | 4 +- src/grove/grovetemp.hpp | 2 +- src/grovecollision/CMakeLists.txt | 2 +- src/grovecollision/grovecollision.hpp | 2 +- src/groveehr/CMakeLists.txt | 2 +- src/groveehr/groveehr.hpp | 2 +- src/groveeldriver/CMakeLists.txt | 2 +- src/groveeldriver/groveeldriver.hpp | 2 +- src/groveelectromagnet/CMakeLists.txt | 2 +- src/groveelectromagnet/groveelectromagnet.hpp | 2 +- src/groveemg/CMakeLists.txt | 2 +- src/groveemg/groveemg.hpp | 6 +- src/grovegprs/CMakeLists.txt | 2 +- src/grovegprs/grovegprs.hpp | 4 +- src/grovegsr/CMakeLists.txt | 2 +- src/grovegsr/grovegsr.hpp | 4 +- src/grovelinefinder/CMakeLists.txt | 2 +- src/grovelinefinder/grovelinefinder.hpp | 2 +- src/grovemd/CMakeLists.txt | 2 +- src/grovemd/grovemd.hpp | 2 +- src/grovemoisture/CMakeLists.txt | 2 +- src/grovemoisture/grovemoisture.hpp | 2 +- src/groveo2/CMakeLists.txt | 2 +- src/groveo2/groveo2.hpp | 2 +- src/grovescam/CMakeLists.txt | 2 +- src/grovescam/grovescam.hpp | 2 +- src/grovespeaker/CMakeLists.txt | 2 +- src/grovespeaker/grovespeaker.hpp | 2 +- src/groveultrasonic/CMakeLists.txt | 2 +- src/groveultrasonic/groveultrasonic.hpp | 2 +- src/grovevdiv/CMakeLists.txt | 2 +- src/grovevdiv/grovevdiv.hpp | 2 +- src/grovewater/CMakeLists.txt | 2 +- src/grovewater/grovewater.hpp | 4 +- src/grovewfs/CMakeLists.txt | 2 +- src/grovewfs/grovewfs.hpp | 4 +- src/gsr/CMakeLists.txt | 2 +- src/gsr/gsr.hpp | 2 +- src/guvas12d/CMakeLists.txt | 2 +- src/guvas12d/guvas12d.hpp | 3 +- src/h3lis331dl/CMakeLists.txt | 2 +- src/h3lis331dl/h3lis331dl.hpp | 2 +- src/h803x/h803x.hpp | 2 +- src/hcsr04/CMakeLists.txt | 2 +- src/hcsr04/hcsr04.hpp | 3 +- src/hdxxvxta/CMakeLists.txt | 2 +- src/hdxxvxta/hdxxvxta.hpp | 2 +- src/hka5/CMakeLists.txt | 2 +- src/hka5/hka5.hpp | 3 +- src/hlg150h/CMakeLists.txt | 2 +- src/hlg150h/hlg150h.hpp | 3 +- src/hm11/CMakeLists.txt | 2 +- src/hm11/hm11.hpp | 4 +- src/hmc5883l/hmc5883l.hpp | 104 ++++++------ src/hmtrp/CMakeLists.txt | 2 +- src/hmtrp/hmtrp.hpp | 3 +- src/hp20x/CMakeLists.txt | 2 +- src/hp20x/hp20x.hpp | 2 +- src/ht9170/CMakeLists.txt | 2 +- src/ht9170/ht9170.hpp | 2 +- src/htu21d/CMakeLists.txt | 2 +- src/htu21d/htu21d.hpp | 2 +- src/hx711/CMakeLists.txt | 2 +- src/hx711/hx711.hpp | 2 +- src/ili9341/CMakeLists.txt | 2 +- src/ili9341/ili9341.hpp | 2 +- src/ims/CMakeLists.txt | 2 +- src/ims/ims.hpp | 2 +- src/ina132/CMakeLists.txt | 2 +- src/ina132/ina132.hpp | 11 +- src/interfaces/CMakeLists.txt | 2 +- src/isd1820/CMakeLists.txt | 2 +- src/isd1820/isd1820.hpp | 3 +- src/itg3200/CMakeLists.txt | 2 +- src/itg3200/itg3200.hpp | 3 +- src/jhd1313m1/CMakeLists.txt | 2 +- src/jhd1313m1/jhd1313m1.hpp | 2 +- src/joystick12/CMakeLists.txt | 2 +- src/joystick12/joystick12.hpp | 2 +- src/kxcjk1013/CMakeLists.txt | 2 +- src/kxcjk1013/kxcjk1013.hpp | 5 +- src/l298/CMakeLists.txt | 2 +- src/l298/l298.hpp | 2 +- src/l3gd20/CMakeLists.txt | 2 +- src/l3gd20/l3gd20.hpp | 3 +- src/lcd/CMakeLists.txt | 2 +- src/lcd/eboled.hpp | 2 +- src/lcd/jhd1313m1.hpp | 2 +- src/lcd/lcm1602.hpp | 2 +- src/lcd/sainsmartks.hpp | 2 +- src/lcd/ssd1306.hpp | 2 +- src/lcd/ssd1308.hpp | 4 +- src/lcd/ssd1327.hpp | 5 +- src/lcm1602/CMakeLists.txt | 2 +- src/lcm1602/lcm1602.hpp | 2 +- src/ldt0028/CMakeLists.txt | 2 +- src/ldt0028/ldt0028.hpp | 3 +- src/led/CMakeLists.txt | 2 +- src/led/led.hpp | 2 +- src/light/CMakeLists.txt | 2 +- src/light/light.hpp | 2 +- src/linefinder/CMakeLists.txt | 2 +- src/linefinder/linefinder.hpp | 4 +- src/lm35/CMakeLists.txt | 2 +- src/lm35/lm35.hpp | 2 +- src/lol/CMakeLists.txt | 2 +- src/lol/lol.hpp | 2 +- src/loudness/CMakeLists.txt | 2 +- src/lp8860/CMakeLists.txt | 2 +- src/lp8860/lp8860.hpp | 3 +- src/lpd8806/CMakeLists.txt | 2 +- src/lpd8806/lpd8806.hpp | 3 +- src/lsm303/CMakeLists.txt | 2 +- src/lsm303/lsm303.hpp | 2 +- src/lsm9ds0/CMakeLists.txt | 2 +- src/lsm9ds0/lsm9ds0.hpp | 2 +- src/m24lr64e/CMakeLists.txt | 2 +- src/m24lr64e/m24lr64e.hpp | 2 +- src/max30100/CMakeLists.txt | 2 +- src/max31723/CMakeLists.txt | 2 +- src/max31723/max31723.hpp | 3 +- src/max31855/CMakeLists.txt | 2 +- src/max31855/max31855.hpp | 3 +- src/max44000/CMakeLists.txt | 2 +- src/max44000/max44000.hpp | 3 +- src/max44009/CMakeLists.txt | 2 +- src/max44009/max44009.hpp | 3 +- src/max5487/CMakeLists.txt | 2 +- src/max5487/max5487.hpp | 3 +- src/maxds3231m/CMakeLists.txt | 2 +- src/maxds3231m/maxds3231m.hpp | 3 +- src/maxsonarez/CMakeLists.txt | 2 +- src/mb704x/mb704x.hpp | 2 +- src/mcp2515/CMakeLists.txt | 2 +- src/mcp2515/mcp2515.hpp | 2 +- src/mcp9808/CMakeLists.txt | 2 +- src/mcp9808/mcp9808.hpp | 2 +- src/md/CMakeLists.txt | 2 +- src/md/md.hpp | 1 + src/mg811/CMakeLists.txt | 2 +- src/mg811/mg811.hpp | 2 +- src/mhz16/CMakeLists.txt | 2 +- src/mhz16/mhz16.hpp | 3 +- src/mic/CMakeLists.txt | 2 +- src/mic/mic.hpp | 2 +- src/micsv89/CMakeLists.txt | 2 +- src/micsv89/micsv89.hpp | 2 +- src/mlx90614/CMakeLists.txt | 2 +- src/mlx90614/mlx90614.hpp | 3 +- src/mma7361/CMakeLists.txt | 2 +- src/mma7361/mma7361.hpp | 2 +- src/mma7455/CMakeLists.txt | 2 +- src/mma7455/mma7455.hpp | 3 +- src/mma7660/mma7660.hpp | 3 +- src/moisture/CMakeLists.txt | 2 +- src/moisture/moisture.hpp | 2 +- src/mpl3115a2/CMakeLists.txt | 2 +- src/mpl3115a2/mpl3115a2.hpp | 2 +- src/mpr121/CMakeLists.txt | 2 +- src/mpr121/mpr121.hpp | 2 +- src/mpu9150/CMakeLists.txt | 2 +- src/mpu9150/ak8975.hpp | 19 +-- src/mpu9150/mpu60x0.hpp | 33 ++-- src/mpu9150/mpu9150.hpp | 2 +- src/mpu9150/mpu9250.hpp | 2 +- src/mq303a/CMakeLists.txt | 2 +- src/mq303a/mq303a.hpp | 2 +- src/ms5611/CMakeLists.txt | 2 +- src/ms5611/ms5611.hpp | 3 +- src/ms5803/CMakeLists.txt | 2 +- src/ms5803/ms5803.hpp | 2 +- src/my9221/CMakeLists.txt | 2 +- src/my9221/grovecircularled.hpp | 2 +- src/my9221/groveledbar.hpp | 2 +- src/nlgpio16/CMakeLists.txt | 2 +- src/nlgpio16/nlgpio16.hpp | 2 +- src/nmea_gps/CMakeLists.txt | 2 +- src/nmea_gps/nmea_gps.hpp | 4 +- src/nrf24l01/CMakeLists.txt | 2 +- src/nrf24l01/nrf24l01.hpp | 2 +- src/nrf8001/CMakeLists.txt | 2 +- src/nrf8001/nrf8001.hpp | 2 +- src/nunchuck/CMakeLists.txt | 2 +- src/o2/CMakeLists.txt | 2 +- src/o2/o2.hpp | 3 +- src/otp538u/CMakeLists.txt | 2 +- src/otp538u/otp538u.hpp | 3 +- src/ozw/CMakeLists.txt | 2 +- src/ozw/aeotecdsb09104.hpp | 4 + src/ozw/aeotecdw2e.hpp | 4 + src/ozw/aeotecsdg2.hpp | 4 + src/ozw/aeotecss6.hpp | 4 + src/ozw/ozw.hpp | 2 +- src/ozw/ozwdump.hpp | 2 +- src/ozw/tzemt400.hpp | 2 + src/pca9685/CMakeLists.txt | 2 +- src/pca9685/pca9685.hpp | 2 +- src/pn532/CMakeLists.txt | 2 +- src/pn532/pn532.hpp | 2 +- src/ppd42ns/CMakeLists.txt | 2 +- src/ppd42ns/ppd42ns.hpp | 2 +- src/pulsensor/CMakeLists.txt | 2 +- src/pulsensor/pulsensor.hpp | 2 +- src/relay/CMakeLists.txt | 2 +- src/rf22/CMakeLists.txt | 2 +- src/rf22/rf22.hpp | 2 +- src/rfr359f/CMakeLists.txt | 2 +- src/rfr359f/rfr359f.hpp | 4 +- src/rgbringcoder/CMakeLists.txt | 2 +- src/rgbringcoder/rgbringcoder.hpp | 2 +- src/rhusb/CMakeLists.txt | 2 +- src/rotary/CMakeLists.txt | 2 +- src/rotary/rotary.hpp | 1 + src/rotaryencoder/CMakeLists.txt | 2 +- src/rotaryencoder/rotaryencoder.hpp | 2 +- src/rpr220/CMakeLists.txt | 2 +- src/rpr220/rpr220.hpp | 2 +- src/scam/CMakeLists.txt | 2 +- src/servo/CMakeLists.txt | 2 +- src/servo/es08a.hpp | 4 +- src/servo/es9257.hpp | 4 +- src/sht1x/CMakeLists.txt | 2 +- src/sht1x/sht1x.hpp | 3 +- src/si1132/CMakeLists.txt | 2 +- src/si1132/si1132.hpp | 3 +- src/si114x/CMakeLists.txt | 2 +- src/si114x/si114x.hpp | 2 +- src/si7005/CMakeLists.txt | 2 +- src/si7005/si7005.hpp | 3 +- src/slide/CMakeLists.txt | 2 +- src/slide/slide.hpp | 7 +- src/sm130/CMakeLists.txt | 2 +- src/sm130/sm130.hpp | 2 +- src/smartdrive/CMakeLists.txt | 2 +- src/smartdrive/smartdrive.hpp | 2 +- src/speaker/CMakeLists.txt | 2 +- src/ssd1351/CMakeLists.txt | 2 +- src/ssd1351/ssd1351.hpp | 2 +- src/st7735/CMakeLists.txt | 2 +- src/st7735/st7735.hpp | 2 +- src/stepmotor/CMakeLists.txt | 2 +- src/sx1276/CMakeLists.txt | 2 +- src/sx1276/sx1276.hpp | 2 +- src/sx6119/CMakeLists.txt | 2 +- src/sx6119/sx6119.hpp | 3 +- src/t3311/CMakeLists.txt | 2 +- src/t3311/t3311.hpp | 2 +- src/t6713/CMakeLists.txt | 2 +- src/t6713/t6713.hpp | 3 +- src/t8100/CMakeLists.txt | 2 +- src/t8100/t8100.hpp | 2 +- src/ta12200/CMakeLists.txt | 2 +- src/ta12200/ta12200.hpp | 2 +- src/tb7300/CMakeLists.txt | 2 +- src/tb7300/tb7300.hpp | 2 +- src/tcs3414cs/CMakeLists.txt | 2 +- src/tcs3414cs/tcs3414cs.hpp | 2 +- src/teams/CMakeLists.txt | 2 +- src/temperature/CMakeLists.txt | 2 +- src/temperature/temperature.hpp | 3 +- src/tex00/CMakeLists.txt | 2 +- src/tex00/tex00.hpp | 2 +- src/th02/th02.hpp | 2 +- src/tm1637/CMakeLists.txt | 2 +- src/tm1637/tm1637.hpp | 3 +- src/tsl2561/CMakeLists.txt | 2 +- src/tsl2561/tsl2561.hpp | 2 +- src/ttp223/CMakeLists.txt | 2 +- src/ttp223/ttp223.hpp | 2 +- src/uartat/CMakeLists.txt | 2 +- src/uartat/uartat.hpp | 2 +- src/uln200xa/CMakeLists.txt | 2 +- src/uln200xa/uln200xa.hpp | 2 +- src/ultrasonic/CMakeLists.txt | 2 +- src/ultrasonic/ultrasonic.hpp | 3 +- src/urm37/CMakeLists.txt | 2 +- src/urm37/urm37.hpp | 2 +- src/utilities/CMakeLists.txt | 2 +- src/vcap/CMakeLists.txt | 2 +- src/vcap/vcap.hpp | 2 +- src/vdiv/CMakeLists.txt | 2 +- src/vdiv/vdiv.hpp | 2 +- src/water/CMakeLists.txt | 2 +- src/water/water.hpp | 2 +- src/waterlevel/CMakeLists.txt | 2 +- src/waterlevel/waterlevel.hpp | 2 +- src/wfs/CMakeLists.txt | 2 +- src/wfs/wfs.hpp | 142 ++++++++-------- src/wheelencoder/CMakeLists.txt | 2 +- src/wheelencoder/wheelencoder.hpp | 2 +- src/wt5001/CMakeLists.txt | 2 +- src/wt5001/wt5001.hpp | 2 +- src/xbee/CMakeLists.txt | 2 +- src/xbee/xbee.hpp | 2 +- src/yg1006/CMakeLists.txt | 2 +- src/yg1006/yg1006.hpp | 2 +- src/zfm20/CMakeLists.txt | 2 +- src/zfm20/zfm20.hpp | 3 +- 416 files changed, 793 insertions(+), 675 deletions(-) create mode 100644 docs/images/es9257.jpg diff --git a/docs/documentation.md b/docs/documentation.md index 4ceb79ad..01459ba5 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -4,7 +4,7 @@ Writing sensor documentation {#documentation} It is highly encouraged to provide at least some basic documentation for the sensors that you want to add to UPM: -- If you don't add documentation, the code review will take very long and +- If you don't add documentation, the code review will take very long and your contribution could be rejected. - Try to have no warnings in doxygen, this is generally fairly easy. - Have the specific sensor manufacturer/model & version that you used, if you @@ -15,7 +15,7 @@ sensors that you want to add to UPM: ####The sensor block -This is added just before the class declaration in your header(.h) file and has +This is added just before the class declaration in your header(.h) file and has mandatory fields. For single sensor libraries, this block will actually follow immediately after the library block. If you have multiple physical sensors, add this to every one. @@ -36,7 +36,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code): * @kit * * @brief Short class/sensor description - * + * * Then add a longer * description here. * @@ -52,8 +52,9 @@ Here's an example (disregard the "@verbatim" tags in your actual code): - `` Usually the chip number used by the sensor. When this is not available or relevant, use a unique descriptor that makes sense. Must match class name. *Mandatory* -- `` A short name for your sensor, try to avoid including the - manufacturer's name here. *Mandatory* +- `` Title Case descriptive name for your sensor, try to avoid + including the manufacturer's name here. Examples: Digital Pressure Sensor, + Serial MP3 Module, etc... *Mandatory* - `` Alternative names that your sensor driver might have. This may include manufacturer's name. *Optional* - `` Alternative chip-ids that your sensor driver supports. *Optional* diff --git a/docs/images/es9257.jpg b/docs/images/es9257.jpg new file mode 100644 index 0000000000000000000000000000000000000000..24e4b47d2fd2fd54d32e3e95bff3bff2072c03ba GIT binary patch literal 25778 zcmZ5|b9^ODx9*N@+qP}n)`SyJtVw2KV`5LNo$T10*tTuknVa|h&OP^>yZ-2|sxTHB-2blo-?_g%05n*@6j&()7#aW^ z4GaPe>~9}{2ml5Eg8~Bs1N^tZd_EgAEI1h4r<&kX0S@s$wE(bxo*f$I?+O4B;!}wV zfeHYCU2gq%^?wuK3p8koEeh)GI_m|5TFFoUTMGc7#v&&n6de@_#cIvhh((^h5|)XZ z3r4pvj>-PV6be1>2u*Lo>738l|DO`5cIA-rxy5@Q5>|cO{;q|NNwTz2e^E3+Bb+#^ z7QUE+#7=QTO2YWozHjLN*uzfkJ~?3hPOBH|1Ea&e$Upn15Ulvrjqf!17{s<|Ha;G9 zIlpnWpUHM@X(DkzuPca81}I6NB`Wx;{bFSpcEtNx0n!1MTvd{}%(nb{_+phF(2PCx z$UEborqCvsCah*JzZ};HI$X2fjpv_ux@N_kSJfSm3H{WV;cw?FnSDkDJV^z+$?o}E z_4oD?xv* z%02JcBqOzTaE)nQ4+@)55ZdGyCK3IohnQF{F8=X(COxjH^lLQ!+qydv4%KnVR!n+*ZQVs^#k_pZIekmAV7-rOlP6?9SlJCw&1nbn~UXPL@X(6b@=2CTgA4bOcI|#1Fu`J!&0wT7vx5L zm%?bR)2j*d4&59M!h*G_6rSpHUC-wxnc1UO;V_|+MAPm#`=tZZo2^*)@81vY#!X#k zX+VoPd}|R5bKW57rhTFx8x%Q5JfpYOc*m=&zg0ML431#_pyUEzk9IL_wHoA&Zz>D+ z90uET3y3OQs2i12_Z^JX-F=_ViW_G2F)izMI=KzQmS^Ics!xlD$L~3+((ZK~Vx{Rj zl%MYZ0@yo-mCbr*4t{dnZBCg;-AvHUJUrC*cX(g?1z5iROw?1BeQ9}?(P^VR9ebSF z{+8}mPIvb?wwTIBd}(D0eo=BO-c}umQg%ow_X%T?F0jz3ItN^{RGm( zVU#vCQAq+By6p{Dx{H+EQ8eBrD2JOon{LFRIg&mqL~+qsk5S)Knnh$TCc^ypAM@wj zJUCi~mKVPboOdW&eE;rS`*m`BnI(wMS8MKbzyV11Z>JT{5#@>rIVAIzF4y_UVLZbOB$7?;i*ZFGIFedq$Wx+{7EY<&thd& zOI+?}j}URlU(#wqdlfG6pZTleTH5Ta>N?1o&d{hY5c|J!DJZPqJ%a43jUT$09_m5g zh}E`vs5o~tqM|&;6gRriZv9Ghk6o$$0wnhR4e4x7*WAHJH%GV_;xSt6d?Cc~HOv6^KylOvlbEmh6` zz7W8btlO1H24h46e>z@z6+6lO#sdfCyY^C{c~hju%s8{n!PKq!?!`fDTTR^dUPUBb zHOFB7TBe!L2m78C7yjNplk&rGRjS|mUSHaa{vgN9-TvEJ^77VP#vV0`LnyFI^mEt% z_{V(%VO)o`8#GjGjgkkmemcrGp8N#abY9k%IA z`xxdRdKci%NHHP?*sIcEtoVGeWJ!(9{*Nl)5WI#LOYP;@Eu8&cH+F?%MkETo;w*|0 z_Flrjl^a#0bf}eW^zHunBmYMrhL0e&%`*S^M&x1l6BZZZSXX{$Qs5X?Y~rA?mnxFF zVRWbdzqbFmdkIQT>qCX_r-KU1(slxD*pq5**@RTL>_4NGJd_8Y(&r1|}IRmZ&NzIRzUwCA*l!C-B35Is{-);BRv9 zY&<6o?X{w^+2e*0I|Uuc&GOs{M6E`?pQuZ%#jb_9oA40P znu?uoL}L+PB6#>kZFH9yj02JQdHfoqNTF`KZ#&KiEY5z3ckR;yzfbDnGnX^gZTH4O z67e8$zT!DFWRBP$hC~S)@G~6*fY&! zV(~gvS^aa`MuRE?Lr?jD8^bdvAo{3NP0~u}WJmf3vPWJ6D3G7`BHEn+u?|RXjFccd zc$#YM@lo!;W70g-i8B-S>6zpXU6c2I>u)^&CiB{c dCRnQGqiPV3(eJHi{zQg-| z|Dxc@Qdc}UcnyeK%Uzv8KVvYF*c>WIw?Wh^38R8K+)dW0j*L{WlW7~wr}jne2E~MC zzV8(yi!G%3o1`#>;n}w)V;{}w@g{dmN&Y-jNs5^GGy2-j9iqUGj!bV%L9V3bz0w&b zMm>trC~}5Fc=jxI8IVj2JdO(5@|(|HjtYl0h{z}ws67_R>7=7U-%7G%Y=3_j)6`kh zM$g07_jr1-Uo?lcG{9>AjzKE*dtpg`c8_nG5n_5mx)2mv%WQaoW+~%LpLHlp;d+8j z5S;|U+~jQRl>ok^t;IeEg;_|tp*3EJAY9CbRn?FtAY`ISUX=B*sAntgYW6n3S`hme z;Ooq`VM_9D?(N#}63#yAXJ9?d2i<8DU)FGxEZe!%!x_V;iWqjX`8#(&04HgX4|g>? zkbu#Kr+Ef_);y><1KGgyH*VV#?lqI84J?8I`d#zvKY2lV`0dp@ zCyVICBPsPO^%2k5lwM*CN#3UDs?pr)(Immr^Nc znY0K|&BReUHD^(V4>!E?!^+EE<-XE_mR_s$EFYeoB{dSd(pbA9@`g)rZyfnTZamu3^n3#qV)-hHe=^n5DK!Z9FK~- zc3iZp_h20%)g)3LK9k_)8X1!4xv@T~kq0c>z8G6=p#ub}3ssImfoi44Aqi)h^EQmx z`rhQQhdnmK&@qHdbY5DllB=D&?(Q&T^|I27FRw@CGAfr2DFV|4c}-G|0U<2fskuTb zK7gfhSvw~Wf9LC&x&Fn$U%+hUZ-eX%A-S^S*sR7EJaVO?>bp>|bW*R!YKIkWm9kD+ zBg)Qz9zwEUF9?Rjoa$?Eyh3!tVRmFc;S%kI3VjmwpElqw5B`N#>KmgVDy}z%_;p*g zLkj~1c-5W-yJ+r)3WtqB==c5#=o4E_BTCUqCrwKJMm5pNWG{aH_ib zATBibeYQTGVmb(2U{DWFn+uCu63LfSN@m9?=c^xD9gsQwC`%8S{zcsB!nd^Y&+C>3 zAvP9prf)3@KVU{T)JYqIW`EXYaB#zOb7Gw77J?=tBNW@lcPPQf41b|A>kQOm` z1=-Trme(21DsWH?;OZ`XKzNi; zPHUeo;xxMPC(*0bvQvA@rPRkWhPYNKl=!fSe~(HUzEa$kiRC>Xpt*T$F+BVdY(uqh z*WELKg4X^6*0~_0okp2WgHj4J)E?iPf~A$^VfyEQ{EvysAKF^uP4QwNiDC@B@T?yc zah@@Rnb3uFXoqYQ{D`c(SMy+<=}8_nxWlhwceIAB;= zVCl5WFqp`V?dHOJdY+#?M6jGIkswmS0=2)p%7v*{;J`)R&43AKC&E4GJ9T-7-~ujUF@M7?iH{`o@5P;d_QV|~t9qYnkqEh<{AU5#Th%q4g%1M$C`&+5Xvj10l zojVPIcZCYLo1fKBktgkom^YzzC@zeH)n;02ig4q_TXiBsX!B;rTZWgKw>+6hjxl;) z*=DEjnvNDZ+k7e%Z4W97QzDdYdUvlM*aZ4BT;Em(9YuVFqh<(6G+mpXNt(i%B%z-C zBF31`c0+DF#U1g;_R>QIcnn-h+z@SCtE?`tRmYh$Dle%2xFF2fu-k4C_;+S8ENCU+ zhlT}p?WHGlav*kGz+@CN7bnej-Kln6*B4b@avYU^nHw?K25*vzPo-w%5woVda*;Hs zF3!6ze4@AKmWdm|(y}Dt(KNbv_SK@|1-gpjeXGB&O^dX-fpJjlS$?^8w;+Lv#k0s1 z7(}q?ZA1sc?9hg_m?kr?pR)N#kDizt5Tp*axKzHEA@PD z1;jTJwpTiv2FF_P5g1D^2ACWHM43A+POIOQyRIpu9NU8*mG28EAF`>12{7_70q`Ru z+~9?#FcSKP1yS^^u&u*QJC!QpW*hi)rHYx#`%*!?j|ShmBBLP8q4q?6{;(556lmSp zd(*3V)Frr7f02iNjGHo&I0mFIKo*}Gp(eb-Cse|b%n5jfAaR3ASUmm$ph84ILQ5WQ)|t(D!6nwu#;0QH1)qAwSbsQ2otjyzUs-S(nI1N#G#b zFx#V|w@tHZb4%{6);)e3TW9I>wTApLPYLqI$dIJ0Hl9nx0=B3TJHfXZD;!A}a(n*~ zRH`BF5jhEs-$q?ZNv`}59zM{>!)UdtxXiU_Ggbgc%YRn;|TDo|^q`C!gpx6lv9N%|$jQ<5lS_-Pg^FB0A z6CkYN^8$Ui)p>Xuo)UZ4fM&ijoWDEQ!;^+a6LksN#At`)M61t4(?+0Aspsr56R(J% zW3XH8pcbHN`kt|(N4;g*P8ybPJj8X|po%9C6k!n`#B?#+<(}8W;2JS{d!DNtG6{I}0Rk z*1us+%*`~EBqZ2hFdx+A-&ruQU6B@7x3IIWLoG*Eo zcs_tZ1+F+ikmjO2a7>;+$zmm5I$_>sc^-b zoO6sG`9Pwhr^{2$DDqs(M<&t+Vsiv}_a_CJS2 zCAS@p;AitukG$t@6#3;GL_;Yk&NgdY-E6`aXD5Si;Kb%kL;}-f;kO&C;MhsF1xT1x zdJdtZlDtB)bEl;QELPi?!M;LTX|cDoxu2vBuythnsQ`0vHxA$VCa2+xcmH_OdnqWJ z^N>sqbM1Kb1)Vg<2;CE(1QrORUUaIT`~@J+BgL&Na1`?2AT#mPGQ99{b+3A&B<8A5 zEI1a}*Pd{~T`;y#pTKb}N3PHvujBO-M+MJujWfP39P~Zk>1pexXYu?@18^H*16gX%X|afe;;mUb>OmGK2zZ zNQ*T^fWVDRT{B|0f3d2I#um$-w71E zV|u%R)UcV3gLJKw!|7pgUg(h@7<%m9dpKPB$HVjLXRHewcMf7&;$J}JWJ1E8L7C>& zKKq8~Z{7YgAf>kl#x%Et0IXt6#S+~q1SfvdV`^p+&fVR*E|H-&qxf(kQj-#dOO|6g z!EgI{6={mO6Yp!9Ei0;Y#)C1O51+gqtG@uJW%h{lfS9#nR#sh?Ov^s0%ZoB(T7xs7 zjHUS7f^E5D&*D9l(k}F#;plns&Kb*C6Ot zx>JOD$F+Wpt97pa5Kizc=hklQ(DPQ;Ysa!OBAOxEe0#Ir?78Yjt8J%gcJ6Au{BA7) z@n!*6YS&4Xi^|HvWgQ;(o}zwO;>dy?Er@oBgXTm|&(^$*ym-zgwIdC?!c&ry;0sR$ z#`23G@ZL?6#F&t|WazJ^?=X)l;9uAu9V0;18gq>-?u-+^PKO}rBnXO&_!8@PI%W$T z6dXBSTosfe$EFdQfj-DpZ@-=*v^uf6@vO7_3@a+K*0D4kaS$`<&3flGe~)Z$@Gz5e zx@=!Ji_Qs~a*_>s_PHeX=q!zep-oZO)I=dA-FM(U=X-N!zphGJ#Q5tkXyAymaaclR zHhTbzt-_2l^X2ABbKOd$ROFXBUIWX083J?egiF#j246~TK-3)5I!a+j&GsHqXs;`O z0U;)pL1n5^DStLat1IX?WE&JX%<;>BL@Z6z)y+%P(;e9$q(qDH`7jeHPQ+iUU#W){ zc$iJzwJ@xRpu*^FY2?bLsHJfk1%Snd%qY}wBxsK$5dA&htD}HXleFRP>-^K~BPnUa z)aLCJ-*Qrc1!LztZelhyYJ)KgDq&|2u3WTZJ>Qjh^w`=IOljvVvM7y5Y!pNHxjx-j z6>);{rb{Z@(unDH`SHP4I;V@ijVsngnX+a$HypO9cB;7R&NRoKkdW3=^m_B4?u zR#B^fYGFhjp;uD!H=8=89_kZ(PkA?0jYhH(AMyBzc*`~nxA(}&XPV&?AbsbNW)^R% z)p(a^MRmD%0yCEuCZ%n^3!nN_sz-LMorF}_kArn#bZ%|uwW^wi)#g&0-KZYHcPRqP zMYFOa38eM18*N=|sIU*BpDz?Y`$11KpOdfBCv6E10Ri*5a|#Ou`44gVnFT|tp_P)$jiE~!JV2XjPvs?POQxfcDXvz(hI<-_ zaK6t{a+C4Z{z`igm$8xB_)GD(s?E!nRCHBeDKoVaO^Y?7qM|-pT1I%3AI-48Qzzn9 z8m)f@4~`#5RV}kf8AEeKd2z=-B=?}d6!YzsoTDckeNdWU+00QHWwVNRVBC`zm6B0l z5rhqC&_1s{zVj;$-%XTi&W(5@u-5rqj@R*E$?k&B$>p za&aWm&?U(do)#hLI0jjF;hy>-dbX&-rWi%1hTr2JQNCce`ee3Ao_7 z)_eM~|I(WHYEwWP6jtmmRhFu3O&qI-!~Oe6!gS(0JzKJ;PA*8bDV3daVXFL0B){-# zbsZsPSSvZDTSNK~t9P8ZS%Q&FrSqk9)uuz9no9A>QCW|tr5IagAAdVV-4;(=6(yhU z?m=H4^WzO;Al}xTzO9)Ig!TtZ^e~Yljt}Hb(6b(&lbz}gNV1`tORVMKP{Nu8 zxhKzhE#fWf*v8Iqd6sBGZ*cOThChXuwiBW-A#L?WrVZTy4LaOIdsHHA;9V&ufqMEy z2b|My;@78vRyQtlL+_Tc$;5QMonTngm;r?(v_@rS!2~~aML6k_$dxI8!q>i*_x+p)BA%=Kd3`QGU#U$mc=M) z`KjK7oHH_Q*0MRdSY*1zF(y_}Fpb0fXNieS;d6$usn~0wO7NA&yZ!>WpL$|2$9mxl z&N9O(2=dr3vK*Cn-#_$|*~n9@uwLf6q&r^>zi*3MSw7b%*vDY1+LxlDJbC%qbgR%Q z+-t|1X&be;WvQ=-`{hUrXipBVVV?QzJyBpYfN51+ z=UR?WD_d@}2I`n*44f1vg3|2VxGOh7^puvTA+}%l6^^XafVI0y{28o9Ww+_{*qbk^ zZX+IpLuc`=wK`!xZLDKIz>f_`j7Ktmuu3@o~szEce`Fj^Gg8@*h z&S!XV!<0o4bEvw!XC2?dQDuP8R;y=6wKiqrB>7t*4+rb?K`aY5btsqtRxMwpx`omx z1F*083b1vED1Om;p+19@pU6KfRw zz6ZIq8Ha_r4Cl5bQ>F4M`uoH+dtB$bCGs3KT4%!@rx-X+g1-Q^v+yR)eSDRKWU29j zwhgl`N=gKI9Zf_{%@H_Y1R)3PP=tUWs+1B=;m@~hXr8~xnWeQ4GN82^o96k5|)mI zv^At>i2Y2+2^9P8kcUblz5L zFZ+Hk7c$Wwyt=n)a#T1MSVg_5o};A#-?w)=(~aKv!h^16LEflJOa3$_&*fm$@SxV7 zhRkq?(NPw(dJ`Sh1F1`Y$SM!9bJC?&GD9aolyBa4^vcp4Pek@pQezd-l_mpT}zNcHw zb@|^*X;A(J6y639=gHcdxfkkrd)HGn(8+@sD&sR95R^e=YM$P~t+ygvy7ECsTyRyI z7opVizGvm$Ek)7VsBSvf!EO3ft66IxY1HIwDr=V5f+0!9<>$760_QLS&}f}T=_axz zR^+XR8}xj}GHOzAatr%@6Y|Mi4z5G+gU{g4Sv_~X=UV!;4F1i`aWuVD#@fVbd5Y4U zhz+yXXB>7sy%g)<)+c<@G&4t|+IrH_jP1|N+*?Jt8Cv3D;3AI(xq>Ha`i6f2tmyol3BLJ}Rc(W< z2z4xZ>DoG3Hgh`(uyuWz-BoUQ-r7lxBQo+KHjDU=Z+5a|{i~F72zSz>!)y~YM%75; z+${PNec?>y2REcgawW$1**_+vW1|w*8yUovffxQgGi4D)RFc)5KyaL|#;g!U!;f9Z z`xoL~K$78#VX9QiKa&S#VrsS_KI7L6bgBz}Mr7cHG)9MRRK*GCN$|)Qib-5}$v+us zW>rJebhNEBNgs=U_2zB{Wxi4qTefAo>D$}aGbr!Eb|ya*qjw2H3>7kQL1R&_+y*q* zWQToqV`JV;F9v-jkv%1nBSs}iu_m?CuG_o=>JQ1Q(-#o}P|Fmf@?(KF0fT=5xQ}TX zv5aMQTn3R`l-H49O4nxroGZ&xRn#-7-UK6d%BY)1tEWg~#j-+2NtugABVn}=9yHSK zqZ-*!+(1Up9=%it4U{U#sL3BkihbwlW$mh22H!$whvZ`beQ5_NbH&w~CsGD5t4de! z+Tf*#?SE$Kytos$vGvJUG^{~$&xZWgY$g6u(D8&3BwX)r?RxBn4D_7btg&z2KLl57{G&H`I9nP=vhyLM0Cd^dMLr@5P zWGe=m!1{ejr-M$N_=%tDf_53jM8?D!piikzn5NC4pmDlYpzGowH>2qM5 zK&uX?>%ogt0AG@ZrNWE?{i(C20X{YJi(VK_wt^xZ6m&^%3s;U#UA1`mDt#>JLA_;AsAy#(>)VpVnYjkDl-G9$F60BZ z>#UXxCV5kEt+fU*t&_qvE9K}@Qo3Eecn=E>;!KeB(;7P)^Xd{Aemqz0vnBmrSSv65 z2^RuZhR7}OCyWl%BND8UVp;EgwqiG_(8mBByVlxCJtLATe+m<@0A&59>wUhOhv_+m=ZRa5Wxl+ zF0{1F=-*>9cQ*vZe*6NZ&PUy=R-C@r}YBlnFUo)o#e z1lX%!McPg1P`8Tk(zsW&`z0c^=1wVWLs3!7d$O=!Ya*n%irRNGqe3rLgVBCC&*ULB z%BYdbs7eh-Q=k-EvR4%yhZ>BJ74Za{sKQ-FDdX!vBFe3iuOQoOmzuwCk)1=Gm{^*? zj*m3u3YMRoP(*9h9~OrnQzysmFYytkr#o@>O2}Ce4{!1(VuUks@qE>o4Xh0w4D^72T3T6r$~H&!1a#;=vtXxJNMB*}Wmw*dt@2tm6O98C5MceAgg;Ky<>M zQF_k5y<8&LK0LL?dJn5OJ6xND9PIECc|g6PfXK7ptlFZOYOAgS)fH5Ua!lMzYhL83 z-$wWJ#~^Y7-RDXQh=~sY#sVJ{m4oXj@4)w#C73uK!`-zeb(l)v7~FoJ z+NBTFhN4ih(xs(doeY0Mj+T@;qM=?f*(5dm3s#Q+arlWrBQ~yI5&DuO-hFtr;wmx{63Hpq)LK&~Wz?EM@1%%lZotY? zJ15Oug{5=bqk=T1`YX6?@+YJrNu$=67pRpAAb+r?8t^d0D>#e6iUO0${n5tulC8uF zwAw6DgOQ9xFBsTx|=YRcbO;c>;a8smS?SzxDXnf3JO2`Px~4m=%1lWA+_ z#t_#gRY3CbBpXN`7-fUCc+C6Yt5@Yqw^3jqmZkJ+zZ@y`?AGEaxoLuPk=SeDdc;F5 zV8n0eS!N zR+<`{dr&;6qwg4&Y|US~cobI+4$dQw5N!sK#}dBngcu~sbw$Qm$na)+)ZZ{t?{SO3 z{sn}ku4CzLh3f~@eFbp!GV(3Ux>!4RlaTSLO{F5bD0c>1FtWL^9?b^(kQJwjR zPcccOO~uA)b!Hi-7~X13T`4qr?()OkvI@KqN)yfKNo%8UCym*G@F5%4 z%Sa6P#Us(g7ovrk$cR|5^lGVTV&#s-rw>7}$)nO4nIoj;uiclZt3AD`TB#vOgX5Zx zi|~m=iOogAp&Pu;A%Z8Pu@x)o^WKy<%c5luQpyQ&cE7%28o5@WLj&w0OWiIB z?4)n~FTl}(K}P1t@)elF>^`2{A84>Pg^=7!`RZI?H?Zn=G~CTpal8RDUQ&5D&-dmUml)5700xb=<%W?|K(B}~b&Px-CV zg6F?D5DwXCs;KKc_iq(ly)Dx5I2J{Z4y zQ}+jLa7IayDX$x8<_Yg&f;|72g0K^PdpB%I*Y;7qN_9(S~ie7C^u-V|fSqmJ|;F|KI>;vi&J5 z&^i*(;45f0;)sg#9bNP;5yp70$8ul4I(WA}yYRi6g^44vrtCF4edZW&I1tTxQkH zu&A%kFbUYcLG_^ZC7ACq66MlS^kM)>Rs0Ke1qwah=`|$1kLR}p z9IYRIk25?WnS(reUmg6h6-purMk_z$S88m2?}q#ND}ol*z}54hgL2(KAdcmC<`_e7 zo!xC;&24ynYVFVsex(vbmMEr32f;WZHz{5dd|HtR`DPcg2#>kbN_;Z70fMX%QX#%b zf_|homBlCDOvc(!4R!lGGV&5aVL6Eic=?d6o`YH!2MR2OH}YWBsBqT2dUXsFPHhY& zdBTRprbIT{^{N$qpHhNdDZb@oI zw53w69aX-STm|RV2N&@Ggs(JIxUsPs35}H~Bclj3e7R@(QJ2Z)^@<(S(BRxh#yjIE z8@6J>SzkvYu~6ml(s^PfsB8m6il51J~xTFQCY7@ zMOCM_|FcW#P5WdJg;hL}Dso^BuZM z-m1|iEY-XLF6W5t`e= zO4So$?aZw$oV619G&>JVK6j9Xy=trcJHo^r!{FMw-F?QI;byJHR}VVRm&I8R73mPz zNPGgamKJs9MdIJ`cX^Nt_>Isa?mhO?Y>dH7Lr3a!h$GuA!{>LZTi>_^A|5oarncw` zuzy@r|A|N;2)JJ=7L`rDnPfUK+_|r_o0R4)8<~jfTRFk@&E$B@39Jy3^SG|k$LlG! z;&ZG?E2Q1E1hB+)4(tC}OjGjF1TEivfxVWe%-NeGOLo(gGp(Xis?s2k$a2H=3w<%F zbH_xqv7t$^hV-Z8ddWroBOMNu2+IsObv>zjv!kLiYC4-c%Y0q`ICX zOoDfBYv%va^i!2+>nek6CEsE$1v3K@CN+mkjd|t-DuXFa^_z}RePZFJ5 zW=6cIv-AV}1beAL7)72{K^K(m|Hs`XBNgk6I$NS&@TDnrWVVLALuT;IQBAznU{L)P z$%Jt%R{F3-cb`r?Y5}$%&HBFVFCd9QQ}lBkY+1IH;e%5Y8~dtSa&?6S=vOj1cEzME z8f-fKs_1O81$|vDtOj*q>O=qgrz@-BkD_Hp#s_caxk;MN3z_60IqRkHqTDTe# zgGdrmD2(OTR#j%Uua0nGd^XUU7~nNN>Es#~ zn!#)GJt(kyxPbX$S+vG+)SC9v)=2Tl@WZ80c6Ri;;uXDW!o)kH0Y+%8FZ3{otuOYW zJ8uUWa;UsZQk!4pQ=`FXEpZ4d{-D5@9|y*JNix@25zMc9&+q3+@~9d$C~j z1#FZk`;br*zS+LPGLEZ*vM~2nl_;cwFWWy#Utt}8NhxE+%2ZE}7ACmLY}rUJZ0{7E zpK4SRr#XA>m-A^9TL5NR%bon(&a3L|GHn4t%7|>cli&y!TxC7L zfv7I=MJpUz*!$S_FQ9>Q{1v|;^GrHrr3=^EPC{+P*s9i|%#C03FJNH%mzHSMb;TSQ z6LXa4F=lJupFTrYxKcxjA5@;0M2w_SuwAq9nIM^D{d?r^Umt97Lm(8}>%{RTb?}bp z67DPx@=~BKlrTXO#GTY%RAm&POnE6S)l|U}n2uT2+$wzl$vWa0Hkij6c7Fk(NH$WI zy~|qerPV_6EfG_g+ccZO;Lj#r#pZ!#yi&kxaSQMd3cTdNQS*$*eH-wZEC}tqB}W)N zJGUb&t6;DqRp^ry`W5Y5L&r7Pb04`KmR2H!o>vV>!+2&%CMl}=Kw7yGA`r4Dy%<>$ zE%Qi3_DCQFU5bw5Xyhe?C{zHLToyKBQ`&XsITA-tM~EW>EiI)ZtG7`p$kJsF;A~44 z#4Jl0kXE-mt}sFdfLc{Yj@WclfmLJV4sczT06~4LuG|#BT&!>ZfsZ1a@*TQH1cN>~ zA}Y-RizZk#mef7$rcm)^C)eapb2exrLCvT3TQ`>#vjV2l?4#krI#8Tzwnhnr<)%Vu zr@_pkR$I-C+W_8gnEJz~z zIeAd_6oMok#LrWsVT~dpt4CUBd_*1cY(*E4*f$R@Tv(1<8T5H~iVr5fFfOwOVi(c5 z81ytSNE=Hp?LUqL!_u=EgA>jl1o=D2>SdYzmN2WCg^?%MzviN@)TJS~KrTF`eZ(AHXY=_2`Hg?>sX| z3c)ot6HE5K?wSq3&KLW)vhbB2%yAkX7BrjbCq9?78ho zxf5=-e8E%WU{Z&a0?-?Iwv35=*TaV%kvc~fEzbL13{n`^t~#m5D)c!I?^@nL%C>l; z$ZOJp*omGpCyXari*HL4zrSfqE+_^PUs9#@b?ofWm zO1;*2Ft-J$lC)bQwNS`nA9F4wCb-kd@X~(uax@i@1nZ{RV1MZ{;}9?YWvZyW-%ym4UWSQECJ{2q z{LK%jji+hrzFOX{$=R}=>0T-=%s4;u%UOQEt3b4-Na-`Er*lvrVVL8Jw_>OM!jrbR^RB9GnY#p2q-D}Gz?N51D z0Wlme5Vp67sd}Kta+eVURatzj+y-5lq(TE(LQx$(DuP`EJR}`6lh!3n3g!jpj} zi3)34x_A)yLqFSpAXT(X3u+BE6@fBQ`zLIP0%EUBT_o#LEn|jL;T-}2f84bG^%f#< zCmD~5KgfaUwm~R*pso6CY9j@>?J-#FGY5{8d^4Rkr!V}J13B=gdK&dNJ?0-V-`I6;_N1hw0{)h-2{L|Z3Mk|k5SFTDNobT=e^9eOEPT7i=s^Mm!4O&CdLL3CF=7wC22CBx-sm!77JT`TjkEAKe>UY`O%nB9`t8@cT*+qbvpVIUm~MKs!?Qm zcy+=HwX_MxBzg3Tfr-v4PK4#a^<&ii+L(YyRqkD9lvi<#@}u$)nQbP@Zo4XT2g^=>-=k!}fRbVqHDAlkz;E34!`8 zl2nQ~<2<=%t_yQFDez46R=&WJKQEO2R=3pA4g2@k^+j9uabZM2If*1XzEHKXJRs%! zdJ^pbdYp6F?13y!kM-#qYwEgASvm;H=si9ad0n%A99%KYl$v<_1ThgLvXk4TRNMuqLEAeUfDfX%QNq*`Y#`Bc#0Z_g9^g+vT~?uu3Y|S2gYJd z9NNt6#ayG}2zJNR*brI%n=J}$^CA>kcI$xjtgVUrQfwPm1+vxG3{0+_P#rCIqaR7I z@7PmzlnmJNgR|JBB36)vs!lWICV_-;1?ZZmTQsx|2oIUlSGZcqn1C^7tg5Lq8}+)3 zuwqr5<2y2C#Ta&2;WG63Hl*Jhv^+*jF#1j=K4kWxC0vwn)?ZFLBxt!}N~sYThO3}x zr~f#($$VXwQqtz-hn_F9FH550b*y?><BVNK7+mcnJYh@EA|9>5~azF0EDtbWjnebjepM*+T%1{O`!O61&HRwz0>}v+Io` ze*v)#k+%}Ir(&?{Iq*Re8WIyb6!G=_NbsT%Y)WD%aF0SK%dqxlyz}L;^SCgW#raV( zMZ|}Z-~j&ul8*Syn|Gvh{n4oadNB8Lv?4Jjk%>H)EoB?9Z9Sg904}$~UPJE!&~GWK z^k2x0x$!d3w1e^{&+;f=3v8FH#kYRDnc(FjDq%F7!SCjM5N4c9dJrVFiXN-^GUqLk zaG6H64(x)&#~I7Arod+6SC3T0sg{VuY?^Rt8x+g$wnU=HT!Le#Xpk7|Nd=I{iS>x( zDNu{LV^-vucZ}uwq^;tqN)FARTt%h2b0Ng@qomBA<}v_Uu=KiXA@}RDg$@%DqvTH; zUWJR8vO*JfaIiDMKPey`;)@5$Bsg^;f1-Rw`TYCQ0>D4PLZ9C)_+Nq+`*~RY|C4D9 zmjBblS%yW`wQqlhZiepe9+1wVk?t0Tk`Q$0kQll{0SQrJNC9aHiJ=8)5D)=}29cC5 z-?{JS{U6V>KI~(y-;NLKIQCw9UDtJ<@c$qXe$l@jDGwz1r9JIGePBNFUj%qQw~GhW zg`x)-@nbOfKk(J6bOr$LUzNU2{BSRt;4q9~*`EG$4glc1Q2rWM1i)Y}ol=#Z!~2(M zBN7UONr5eKLu!I-NRSEo`P6t%t`i9RW6dJlHYD;A0C8xxGMJQ`h|?ypf-fK8o0WmS z6|bC~IcnH(iTpuS#;b&Q9ExT@`@pL6RC8tK#_Cr^Z>h%MXomS|CY|e+wSlUq2t!GM zAB9E$@a57%X^9T!qsI`ccR}EP5N_(uiDU#Fh%j#1kbj;39|X{@ck&iDehk41^b_n= z`S&saW5eRL9}z2rGmh}ZuHnCz0m57e*^vp9a4S5J&Gdf|h5>5^5E!Kl$okLtpCcCg zxHCYD6|RH&F9QaQMB+UU|6%{>V*N8^|81E61Z2q2MZ0LhD;Dnm8C?JYWaxkl2py3DqeC*RhUnt4wPVPC z0y6(dML^d&;#7O!pABRlt7rkz>6*O=>n`_+<|eph0C zXxg?g`WU;0{>xVOL3$95&#&|*903h?(yF>J4fB(W|$a|*w zfhjjht@KJLPrHlzmCMx{Od#53kdc&u{;6&VX+`L z<44At1#I<4wGNr81ZA~L9|u&u&EYde4{e%0g{nvULs1OT&TRwh9+H@@(HvDpnTs=ELanWA;(N!Gf-qDi)#fFR6 zT4{v{3|nfj5VN=PYkS|O_$u7N{J4+BU-!W9NDHxh5xAiH%48`)UdOHJhgNQ;lZx_; zUwdewz6|cX)7#9Y45HOZ&C3TS?oP~D*rUX7XB;lmVdAIN;wgmy0kvsf|GQ_r`9pD2 zNgdUDzRG_%1aE#;-u&j%&7SW*VeJxb`KTbMsuGvQeG>rGj85K8Sq%4YlQ=?p?V%2Ar+pfk4dlnQA z_pU}*oCv^}Rw6_k4Qc(|&J<6I$EPoqz{!MfNhjx}cHgd)8l{UsxFzKDd$cMscFSzK zJTq)wxA=Q~|54*mv(giod&$-KTTZqxh}x#DYA&4!t7~QA)w4rIb<$PAo7%Y~%&(7L zrpkp{p!Q|z-{>q6%^aCCZFskcK7y(8X3-xScmF{sq*7N|JkP-5%Hqp&d&X@{6(AHmI5*zf(v6rGZVXHQ{~<@RDLHA|W)F zxsM}|r<8~mpUZXv_tMHn0Q;tE3J@eN$)yNZ$FQ-d&qCwJNn&HfS>GD4kE|#)MEshM2IL{`I4GEt%Om%=RyRfh;aG4eN zc!a;|q77p++HdyLarNBR5!t&>WJuN~ek8=xY}EG^+;fD$dYx#p>&jMKJiBG`K-vfTG%lnk8kHYPbV}eJvd^UoW%q1#QLI#HUM!i5O;>qDcVAsc3 z+^O{6@0Ki2BMd$DSTqdXORXw8dp|F``dHU8vGaP*gNzbz92KN3h#vK7DK73R7}QME z-uI^7F`RUXXs$ju^2*EX`h;$eBrm#!yWqGP9=cpYQKm1BWD6|C>|p#aLT%nid0qP#ya)fjr_n6N z9--C{Nw-KW4IYkU8p>#+gCZ}B-{isRb=T!)QHq$cQv;7hY)#o$H;ml}1DwX2aAcpy zG&8?^p}^i1v#{&GPsQ^2P1?CNVI@N%m$88R!4lB(`Wx2IKMS3^Ep5~NSFvn7FEaUO(o}n=#87*j4;I+#@|aOnGWP6bLPGHv(JZN< z0@3iX*3Av^zMEs?Zq{yE_4Lt?eEjPcNNXT~{pVMW;-J%B6~m;v0kvkcYo-5NJ^*Md zC$x>ye-@ViEFVT72k&Xt$XC6`U`TPpn&E#{A0Tw5{*i>tz&1tJIoDUENhT*6%B{e( znQ%w9pO#!YGe%i${f7d-4XFov=Y*KHpPkwVWdy1#`R2*o`fontJF>8-qg*S%n@9Y? zlo2@9{L#?&&|~S8^C(Z}7D)L7v8wQtq<$>0Ov$yg`0cjUFZ<>aQ|skjtzz6^tA{;c_kp=b<)LK(IGh**$x<%q-N$TATe_FuO5B1OA?Vbg=AP-& z)N19FX- z4I+mW7RG?UocOpU?VMyHT?La>pvPph?u7Gbk0;F zVWW$^0ZVnMh*c0{;c}CY`&{oi#f;^3&#TV@q)OKpR(iQ(Yk2T>^_!K?1Loc?V?i!i z+CSf9Uh&~v)#~|d&=bV)X-ADKaJAV|x24e1(!6h#9AeP@c6V(!uMGduWGqMxl5Gp# z6METm0yh5;k^**8Dc)PJD>K5W(@4w;M)$v?d-!YC11!tY`?18-I8<}!1VS@ooU7$bMmVo^qbtKpap*D zn22D*Yw(JiisFt}111RkX|9C`ER@Pd)m+30m7hk{&lo2=>@>cUJMm$d6Q13AwZO*M z{NA#=XEDV{^hxVk{1^ZQ_D4mA@0=SiEL_WsH2iYF8>c}yV~Sz^(q`obS1!5t3#W$r zq%DSdq;j~e6?6{n{E_}HfqV$jG10L8DdUOc2xe$`sZN(>)V%YliT0g_<44=($QZ`c zHm%aqAfE6SURzvsKNgac#G9)=X5?W)DiJRzIOt{n0 z=p;jj0KUcL`00lnSjD8F#nv05W3-bB zn2>is`cH6H@9Fm^ zcLkpZY<*)s*nB7dgl~B#(O#4G6ndym_l9?C?@(31I#cAgzfPBn;kh5{h12IxtJv+v z<(Zr`0K|)D360cJSyWHiNCN9hL96!7urY&7kr~eRT#AfdP~Yp<=`|``JN!AWTQ!aa zlA#k%RC=HBUt(QEz9zQ2A9-#@6F(N=jT2uqLyJZCg1-#6yRmwj--2+%C`FB!`&iDP z6>fYAPiFVXwjX9^CE`V7s483WnBQ|jZVB>EMrG|0nytU23G~>g`p(0ha3a41gdB`o zB-Cq9c3Np_kdDchlNnF`tkFRSS}cY9vZZgu<$4nBz&V3-?~`30nJs7u@XZ>{1sC|# zw8lqnuB?hNe{xvKogri<9{w%7bu4YlpC-#4A){w2uG^DReW}_hPsJjSAg-KOk{Jlt z0I#Q_?Sl%0zJ0sV=_@#4Lkh1rFy zDk&y%m-^9@@s`t7Go9Ki<0a2;zqNtNsL*F5tlaFYulm>|TBk1BUu|^1sK#=*$iX*6 z9k)%6WUl)8c?K1dBYOzl;s9B27SB$x^rZbgTT2#{vGia%_RqMr-V;%1M6`EM<3q_Y z>2Y?c>P#|&xs(LpXAGMDB3sB%DTJO#M3n<6D`$z7FPTiun3h0Km%R$@X zp}+S3lez_giyI)ltcKIaCu{#-PJ-SkpdGC|sU|n)#9kljAH97P1rLYmK04jM@x}|} zX2}sr_0hY+AD)&o3=is_yjh=G(hT7z4b(rhYRqQ6Rtusa!kK!wv7Zw4e$o|arNkBm z-S5Yb!idfU3^SF=NL(Xz$}x=(G&Ns4MbL~9dKt*Vg!NNx`EcDyPOW*P%FGVvIayfN z)EZlQVoU`9Vx-1#10C%Y8r9kx7n9S6xuyIZnhla3OS`M^NLjShkQ zRA*B-goRjpa7mdHg3fXGR`boD;Hp`($7AGU2}5&Lk9k4vhb#}_jVEE`(}ZMBIIIjf ziKw#8_Oe&@MrylhfO^z+2Zk~JxpiJg&r zu7Y{$9D(B`lJlTPBeEam!v*bGy3mPYTig+irp$sDj=Bt`1~kGSE9lr^tnW5YuSpE^ znj#lbbpndGmZ-zrm(AyLn_;k@io7)K2K*P@-cDpVodbAjB(rVEsxyd3`RwJMkJ(PF zMWjNx)QVd|9Uf+tWsA0w#2oEyUz`ps{3kar|3HwF5n(^opSP8OESr*d!QNH?QljW< z89Ah#8Wz5qzUH|ct44{eS}^04>2G@xZ3EApMEJfbYg?|c>nU{+b~srQl24H9L+pM5 zfW@3HVNOfqJEak?V?z4D_#vnfF!z|8Vak5FIvdNuk!RB(ZX4?MtBCh3;t{oQsoeLZ z+G^WKHb427r?-PiB=37@2UvOj=wy=7`R)2u`cC;8pEa(@7HNr#=Om^|jW-I2D_*{h zIQgCcE|tBXF7t!BfBFk>`>`PX`EaddDfNBK!1)LFX6j?%xxj?f35&2&mgfWu#x!7{ zh~=;!XzmQ7^FEgx!dg^m$Y7u;u3fH|0;h<^n)0JjsI#?3QPd;#i}gPNFQ4`QLI0<8 z1jy&!A6eO~cx*RJ*NRd*GT7rVEsAnza*@(GbPDNVc+%utta~L!#jZEMY>oA~W6!D+ zXz>bbOWUZR4<*qzi~(0vlG=;{9e+Wo%z|xh+Fjuc!Tv>ZT1@SbMXUaW8tUWVaqU9s zBD|jz`8hakdJxXH)`7Pg6sdTAGw(NtWGgAVxvpsk4-ju^mFow$MrN~$eay0prLEV4 z=A7Y3<5|q|Y;Qn#gk?eMoRQ%J5vAl~v%qF5;)37f-u;qrRdewx_r2bZTy;KK(}FbY z?3rk9<-yHDo*MdS&$RlxmiVHB>FlDtPTtjLMcrw^rmWg4Tiu~;oUX{3 zb9?E`7qgQr(o#n-hNuU zx8fBBJeE^0bMi#&I$9Ijcu%~PTOwj9ChvN|*|fmXc6CQ@CR`^u>%Ltw5=}=w1#W^W zQ`nlJM#6G_iOOmmJG~U>R9IEhkVi(jbO_(WO^R04(S8F1X)8#MN$C(=h!|1bVYKDi zcfLjW8yhFJqY{mi%J0+mcAzAe{to=AhmUEjck+;w|%+_ccSi zZ5%}a77E3+b0&ARkB@diQiwp_SFmVP!xdW z6c!RJ+K*d+1ER@RC(VL#nXSsTt{3W?ze?73SXMP)OEG2)M%;^KvBG|G9Faj2O2+P=fJZ#UpfDygf?Tc`o z#QhF0HjuLe5L6S@Nq?)Ph#5@jQgMY!`cI5#X4~!ei}SmP|6%mAhD)t%#Tr~DPD@HYzmK@}&I@21<=yA=ZM_ew6uV{Mp zO|gL@t~^->9@!HNNfhzF^9vb`=%b?r4&O~J`_jBdY{4ve6}}GSTlj@)GzLzN=p5ZU zdWbP!1&Ou1#^(T;O#iOZ{Yb2yOVW4~)80y~j zq*aW>^N5FB-2Py1D|Z8!FAZi~`;f3x-&A5m;jpHl*0X92C4B*2&c0ibAo5rIGvwTx@WcrYpXQOdL!Vt@)ZV^l3?~FZO#fksAMEIhbA{ z%~c=ENpHj_j5JMY4CNBf5QCKWTU(%|)7b74rRh*ColSvO@}8*Z*iVy;P>f8Rhwny; zx@1V8*#=bvScVf!qEe?(kIWM{^Qg#%iD4XXGTX{NKcljMzYPa--FtH}QDv(BLf$3v zA~%;iYJ;p;P9e{$^&896ECtVui17QO;Pid9Mp#T4%yGEO=ILQ|w*x@2*aH>dXh*Nd ztu7f^rhoL{6mi0W^0`gvlhOvS-A=4YDE+yGZ$j?$C?{I+fafS72UR=814Thy&V*-n zwX|^BTE3>uiJn!r8tlnT6M`@ku{tYAFm7xC_y8Bujv537pyuBd#wvg<$*VMBgaphPiLWyJXYl2Zce@bbdjEUeg zuM$b9y?96LgIM{BErZq>+VW5v`2H1v1&`FPiy9L>T)862&cp;#-3izif`|k zQg`d`wH=L(zzv|GP}<`kuchFO;Xh~;>cgjgVbu)|3ut6ic<6}_zd!i|&nn$WXEFG6-KU>P$gqOjDeXu%s&{B<p)RtQ!5nw|YA-e(ek}9!1gxZ`TL4N<O>t4$MgvjR{Es)> zoW$h#p}2Tjv@EMe2r4E?HoZrRD~>d7e*th+MNM0Znh$}iWIu-R%q$5v0vsYS2EQ>} zpTb5><(nYdghXNa#8(lQk$b!y9~E#nBMg0}a>40mCh{AV$0*2G zuY}|VizbPd@+G}%ZPc&WSueE0ajb8HE1yR9&npW7?n=@>Ip%fV`K1OJVQVP0V^oiWOf4bUPUQ+%3!urBa^$3qysId$P!>FSZ5%53wDDDu<+?yFPjR{VPInXN!3-rDx zPYTOm+?gzLBT#P`OBKNYQ*>0BnR{nOf`191{sJt^6YD-1D`4xZ`B+;omrzaN!2K{K zKVRwlD2rc*Z4~>Gbk*Ja`~^s#Lp+`bFuC`p(Q`m}q*yAiM(;>GcmBZr4I6mD86@Y< zdEYyd@>ycPnz?G#e;s1$KEEpzi$?1J#2=EN_6oS6fpCd+7DZ`hb(BxVWeqE=GX8t4 zWBnUvuefW@4c^dls)pwTHd2V1GHk}jEp@cgc({k7yQG0k1pvM&nLcl-VRq9MV#d!7 zxU1FAI<95uw)U9=?y!PL;Ky!*)AmEPo&CgJ0A;AAZD3AUVB#Dtal_o&0-5jkGo!Z} zMVeaDr?yW7J74~Bs(FOB@|^JrXkQ=mYURnNbYaaOZ$UYA5HNj3VG5rd*1V{iaRc|) z^hLp$B5Zdg0PV+4-eLi-!;+8&W0JcLMaaB{G6_y$rbmk>%3goLHcVQIJYr%XpGfly zdKnfxEQ_a%^Xf%A!R*$ltJB^R8 zaWQTU^#%s&xt+GzR>;t5Uk(pFjlDEmBQ{cesEy*Xy1@`B|*646A!Nh<6kMyC6 zdTEzh2r7l*YCN#;U z=u6_!Zgw<*oiMGAqY8SqV>yri*tm73t6ADx9icN%45%wW*Rw(Nav#Y$%>{o--q7TQ zV$ahrHqD>UH|k@d*_oPzIIZLotvD}F;SH6%`AvIv{j3pt4F-~$RtkvpnK^jfbg zF~4QH*sYrc}C8>=`d%?;3Qx^K`LK#FA8W0q@xkHz)kRrs#etome?m((1z-U zuj0a*=_xT9eYq5Ln(?Me`tg$+3XdUmqo+O6Lcp9xB2NwzDGsLd4**60b3>58$5am^ z?>+sgp@t&2IZC;etC`G$h|_{47egspVCAy4F$d=VJs1E=lI-{jkt7HC1?m7GDa zdalYGx&YhV0g)l6b;0wm@w*sr9c1CxU@H;YE8zjL)!P7^#O z0w3-@I1IeN$w7_QVySzc%cqf-%>NYK36>|HfmjVKYjW?0zpt0g_wJ#c4U~ewuXCXx zPEBZesd3dY}s$$mg_HFjdnFoJ5=^ zltm82CQLT>UB_p%tjB=WD}*>~w*dff5=^ctack>nBh^l0F;MfI#1F}`!MSJ36AOli z?c!gga(`E>EF;fihu{DlT@y`dV6W1oa@BHxLx19;ROGOF=wmYL45Z~=XE7(FpmDm> z{nVz{+Sd7%s3tkU|Ju<}0B7ns-1|-}h4t|Ih(t=>uA-nTgl3B{-gBzRBygC1bP>vd z%Ub-Um8XwVbYW7!?!?3v_Oj0|Q#C{D{8_@#>oTGK)&ZUz1xX5GBHG|ZOiRc-HtzI+^#qfG$LYxAzkoNy6<^s} z9S~dbxnzi(oS7qTZK=cU(v;nayvfMcKQX&&&rYx6(;M5gIrV5AY75V{>d*=13E@Gg zydA8Jiqa$)A3wiPr-w1cC?v7kgO`PyRW5;qYk}5;J~=i1-UUA(W1_d{FW{0&?3rF~ zSDXy#YbF6rv%Z-v(hkLGTeybCRbuTg8lxW@W%KSrI=;p zEah=aGZ9Uer?iv5d4;r_tR$%dx)^S@hNM`20075LDTc_jkv)V79$muK5NQs@%-%H` zlRzWTuXJv!Troxlx)Lv5P#H$i=sT@K#XH^X-S_pSJikKFhEonz(TIGfcB-vEF#{y& JHxYlo|3AMUe>VUC literal 0 HcmV?d00001 diff --git a/src/a110x/CMakeLists.txt b/src/a110x/CMakeLists.txt index ececb466..6d06dc6e 100644 --- a/src/a110x/CMakeLists.txt +++ b/src/a110x/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME a110x - DESCRIPTION "Hall effect sensor" + DESCRIPTION "Hall Effect Sensor" C_HDR a110x.h C_SRC a110x.c CPP_HDR a110x.hpp diff --git a/src/a110x/a110x.hpp b/src/a110x/a110x.hpp index d833a379..68cbdba2 100644 --- a/src/a110x/a110x.hpp +++ b/src/a110x/a110x.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library a110x * @sensor a110x - * @comname A110X Hall Effect Sensor + * @comname Hall Effect Sensor * @altname Grove Hall Sensor * @altid A1101, A1102, A1103, A1004, A1106 * @type electric diff --git a/src/ad8232/CMakeLists.txt b/src/ad8232/CMakeLists.txt index 5d644c93..b571bf6b 100644 --- a/src/ad8232/CMakeLists.txt +++ b/src/ad8232/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ad8232 - DESCRIPTION "Single lead heart rate monitor" + DESCRIPTION "Single Lead Heart Rate Monitor" C_HDR ad8232.h C_SRC ad8232.c CPP_HDR ad8232.hpp diff --git a/src/ad8232/ad8232.hpp b/src/ad8232/ad8232.hpp index 35f32d1f..ce67a419 100644 --- a/src/ad8232/ad8232.hpp +++ b/src/ad8232/ad8232.hpp @@ -43,7 +43,7 @@ namespace upm { /** * @library ad8232 * @sensor ad8232 - * @comname AD8232 Heart Rate Monitor + * @comname Single Lead Heart Rate Monitor * @type medical * @man sparkfun * @web https://www.sparkfun.com/products/12650 diff --git a/src/adafruitms1438/adafruitms1438.hpp b/src/adafruitms1438/adafruitms1438.hpp index 05c4326e..a950c01a 100644 --- a/src/adafruitms1438/adafruitms1438.hpp +++ b/src/adafruitms1438/adafruitms1438.hpp @@ -46,7 +46,7 @@ namespace upm { /** * @library adafruitms1438 * @sensor adafruitms1438 - * @comname Adafruit Motor Shield + * @comname Module for the Adafruit Motor Shield 1438 * @type motor * @man adafruit * @web http://www.adafruit.com/products/1438 diff --git a/src/adafruitss/CMakeLists.txt b/src/adafruitss/CMakeLists.txt index 7e44544c..0dd89077 100644 --- a/src/adafruitss/CMakeLists.txt +++ b/src/adafruitss/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "adafruitss") -set (libdescription "Adafruit pca9685 based 16-channel servo shield") +set (libdescription "Adafruit Servo Shield") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/adc121c021/CMakeLists.txt b/src/adc121c021/CMakeLists.txt index d95f1953..4ede6b32 100644 --- a/src/adc121c021/CMakeLists.txt +++ b/src/adc121c021/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "adc121c021") -set (libdescription "Adc121c021 I2C ADC converter module") +set (libdescription "I2C 12-bit Analog to Digital Converter with Alert Pin") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/adc121c021/adc121c021.hpp b/src/adc121c021/adc121c021.hpp index 8a2519db..7585f2f9 100644 --- a/src/adc121c021/adc121c021.hpp +++ b/src/adc121c021/adc121c021.hpp @@ -72,7 +72,7 @@ namespace upm { /** * @library adc121c021 * @sensor adc121c021 - * @comname ADC121C021 Analog-to-Digital Converter + * @comname I2C 12-bit Analog to Digital Converter with Alert Pin * @altname Grove I2C ADC * @type electric * @man seeed diff --git a/src/adis16448/CMakeLists.txt b/src/adis16448/CMakeLists.txt index a818f569..45e72c9a 100644 --- a/src/adis16448/CMakeLists.txt +++ b/src/adis16448/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "adis16448") -set (libdescription "High-Precision IMU") +set (libdescription "Industrial Grade Ten Degrees of Freedom Inertial Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/adis16448/adis16448.hpp b/src/adis16448/adis16448.hpp index 3227ee5b..bd277dc1 100644 --- a/src/adis16448/adis16448.hpp +++ b/src/adis16448/adis16448.hpp @@ -92,7 +92,7 @@ namespace upm { /** * @library adis16448 * @sensor adis16448 - * @comname ADIS16448 Accelerometer + * @comname Industrial Grade Ten Degrees of Freedom Inertial Sensor * @type accelerometer * @man generic * @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html diff --git a/src/ads1x15/CMakeLists.txt b/src/ads1x15/CMakeLists.txt index d42f851b..cce80b43 100644 --- a/src/ads1x15/CMakeLists.txt +++ b/src/ads1x15/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ads1x15") -set (libdescription "Analog to digital converter") +set (libdescription "Texas Instruments I2C ADC Library") set (module_src ${libname}.cxx ads1115.cxx ads1015.cxx) set (module_hpp ${libname}.hpp ads1115.hpp ads1015.hpp) upm_module_init(interfaces mraa) diff --git a/src/ads1x15/ads1015.hpp b/src/ads1x15/ads1015.hpp index 8cfcb93b..1876c35a 100644 --- a/src/ads1x15/ads1015.hpp +++ b/src/ads1x15/ads1015.hpp @@ -57,11 +57,11 @@ namespace upm { /** * @library ads1x15 * @sensor ADS1015 - * @comname ADS1015 ADC + * @comname 12-bit ADC with Integrated MUX, PGA, Comparator, Oscillator, and Reference * @type electric * @man ti adafruit * @con i2c - * @web web http://www.ti.com/lit/ds/symlink/ads1015.pdf + * @web http://www.ti.com/lit/ds/symlink/ads1015.pdf * * @brief API for ADS1015 * diff --git a/src/ads1x15/ads1115.hpp b/src/ads1x15/ads1115.hpp index 44e9af50..bd90828a 100644 --- a/src/ads1x15/ads1115.hpp +++ b/src/ads1x15/ads1115.hpp @@ -57,7 +57,7 @@ namespace upm { /** * @library ads1x15 * @sensor ADS1115 - * @comname ADS1115 ADC + * @comname 16-bit ADC with Integrated MUX, PGA, Comparator, Oscillator, and Reference * @type electric * @man ti adafruit * @con i2c diff --git a/src/adxl335/CMakeLists.txt b/src/adxl335/CMakeLists.txt index 71101616..20adad74 100644 --- a/src/adxl335/CMakeLists.txt +++ b/src/adxl335/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "adxl335") -set (libdescription "Adxl335 grove 3-axis anaolog accelerometer") +set (libdescription "Low-power, 3-axis +/- 3 g Accelerometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/adxl335/adxl335.hpp b/src/adxl335/adxl335.hpp index e7671da2..879962cf 100644 --- a/src/adxl335/adxl335.hpp +++ b/src/adxl335/adxl335.hpp @@ -43,11 +43,12 @@ namespace upm { /** * @library adxl335 * @sensor adxl335 - * @comname ADXL335 3-Axis Analog Accelerometer + * @comname Low-power, 3-axis +/- 3 g Accelerometer * @altname Grove 3-Axis Analog Accelerometer * @type accelerometer * @man seeed * @con analog + * @web http://www.analog.com/en/products/mems/accelerometers/adxl335.html * * @brief API for the ADXL335 3-Axis Analog Accelerometer * diff --git a/src/adxl345/CMakeLists.txt b/src/adxl345/CMakeLists.txt index 452b72c7..e3066786 100644 --- a/src/adxl345/CMakeLists.txt +++ b/src/adxl345/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "adxl345") -set (libdescription "Digital Accelerometer") +set (libdescription "3-axis, +/- 2/4/8/16 g Digital Accelerometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/adxl345/adxl345.hpp b/src/adxl345/adxl345.hpp index aa18c1bd..0a4965da 100644 --- a/src/adxl345/adxl345.hpp +++ b/src/adxl345/adxl345.hpp @@ -38,11 +38,12 @@ namespace upm { /** * @library adxl345 * @sensor adxl345 - * @comname ADXL345 3-Axis Digital Accelerometer + * @comname 3-axis, +/- 2/4/8/16 g Digital Accelerometer * @altname Grove 3-Axis Digital Accelerometer (16g) * @type accelerometer * @man seeed * @con i2c + * @web http://www.analog.com/media/en/technical-documentation/data-sheets/ADXL345.pdf * * @brief API for the ADXL345 3-Axis Digital Accelerometer * diff --git a/src/adxrs610/CMakeLists.txt b/src/adxrs610/CMakeLists.txt index 6cfc8f5f..57c8b99d 100644 --- a/src/adxrs610/CMakeLists.txt +++ b/src/adxrs610/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "adxrs610") -set (libdescription "ADXRS610 gyroscope") +set (libdescription "Gyro Breakout Board (300 Degrees/second)") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/adxrs610/adxrs610.hpp b/src/adxrs610/adxrs610.hpp index 6145d5e9..ad2b0af2 100644 --- a/src/adxrs610/adxrs610.hpp +++ b/src/adxrs610/adxrs610.hpp @@ -46,7 +46,7 @@ namespace upm { /** * @library adxrs610 * @sensor adxrs610 - * @comname DFRobot ADXRS610 Gyro Breakout Board + * @comname Gyro Breakout Board (300 Degrees/second) * @altname ADXRS610 * @type compass * @man dfrobot diff --git a/src/am2315/CMakeLists.txt b/src/am2315/CMakeLists.txt index c5deaa7e..0915f3c7 100644 --- a/src/am2315/CMakeLists.txt +++ b/src/am2315/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "am2315") -set (libdescription "Humidity Sensor") +set (libdescription "Digital Temperature and Humidity Sensor") set (module_src ${libname}.cpp) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/am2315/am2315.hpp b/src/am2315/am2315.hpp index 39441503..616861c8 100644 --- a/src/am2315/am2315.hpp +++ b/src/am2315/am2315.hpp @@ -58,7 +58,7 @@ namespace upm { /** * @library am2315 * @sensor am2315 - * @comname AM2315 Temperature & Humidity Sensor + * @comname Digital Temperature and Humidity Sensor * @type temp * @man adafruit * @web http://www.adafruit.com/products/1293 diff --git a/src/apa102/CMakeLists.txt b/src/apa102/CMakeLists.txt index ec1a1c49..eb0726d3 100644 --- a/src/apa102/CMakeLists.txt +++ b/src/apa102/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME apa102 - DESCRIPTION "RGB LED with integrated driver" + DESCRIPTION "LED Strip" C_HDR apa102.h C_SRC apa102.c CPP_HDR apa102.hpp diff --git a/src/apa102/apa102.hpp b/src/apa102/apa102.hpp index 24437306..856e434f 100644 --- a/src/apa102/apa102.hpp +++ b/src/apa102/apa102.hpp @@ -41,10 +41,11 @@ namespace upm /** * @library apa102 * @sensor apa102 - * @comname APA102/DotStar LED Strip + * @comname LED Strip * @type led * @man adafruit * @con spi + * @web https://www.adafruit.com/product/2343 * * @brief API for controlling APA102/DotStar RGB LED Strips * diff --git a/src/apds9002/CMakeLists.txt b/src/apds9002/CMakeLists.txt index 50484b0e..ed8ed567 100644 --- a/src/apds9002/CMakeLists.txt +++ b/src/apds9002/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "apds9002") -set (libdescription "Apds9002 luminance module") +set (libdescription "Ambient Light Photo Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/apds9002/apds9002.hpp b/src/apds9002/apds9002.hpp index 0c3a3d5e..5346579b 100644 --- a/src/apds9002/apds9002.hpp +++ b/src/apds9002/apds9002.hpp @@ -26,22 +26,23 @@ #include #include -namespace upm { +namespace upm { /** * @brief APDS-9002 Luminance Sensor library * @defgroup apds9002 libupm-apds9002 * @ingroup seeed analog light - */ - + */ + /** * @library apds9002 * @sensor apds9002 - * @comname APDS-9002 Luminance Sensor + * @comname Ambient Light Photo Sensor * @altname Grove Luminance Sensor * @type light * @man seeed * @con analog - * + * @web https://www.seeedstudio.com/Grove-Luminance-Sensor-p-1941.html + * * @brief UPM module for the APDS-9002 Luminance Sensor * * This sensor transforms luminous intensity to output analog values. @@ -50,7 +51,7 @@ namespace upm { * @image html apds9002.jpg * @snippet apds9002.cxx Interesting */ - + class APDS9002 { public: /** diff --git a/src/apds9930/CMakeLists.txt b/src/apds9930/CMakeLists.txt index c9cb0063..cc950d04 100755 --- a/src/apds9930/CMakeLists.txt +++ b/src/apds9930/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "apds9930") -set (libdescription "Apds9930 sensor module") +set (libdescription "Digital Ambient Light and Proximity Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/apds9930/apds9930.hpp b/src/apds9930/apds9930.hpp index db6efbee..8fc02d2a 100644 --- a/src/apds9930/apds9930.hpp +++ b/src/apds9930/apds9930.hpp @@ -37,10 +37,11 @@ namespace upm /** * @library apds9930 * @sensor apds9930 - * @comname APDS9930 Digital Proximity and Ambient Light Sensor + * @comname Digital Ambient Light and Proximity Sensor * @type light proximity - * @man Avago Technologies + * @man avago * @con iio i2c + * @web https://www.broadcom.com/products/optical-sensors/integrated-ambient-light-proximity-sensors/apds-9930 * * @brief APDS9930 Digital Proximity and Ambient Light Sensor * diff --git a/src/at42qt1070/CMakeLists.txt b/src/at42qt1070/CMakeLists.txt index aedd3702..b4ea7263 100644 --- a/src/at42qt1070/CMakeLists.txt +++ b/src/at42qt1070/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "at42qt1070") -set (libdescription "Module for the Atmel AT42QT1070 QTouch sensor") +set (libdescription "Seven-channel QTouch Touch Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/at42qt1070/at42qt1070.hpp b/src/at42qt1070/at42qt1070.hpp index 935a4bd3..18971fa2 100644 --- a/src/at42qt1070/at42qt1070.hpp +++ b/src/at42qt1070/at42qt1070.hpp @@ -43,11 +43,12 @@ namespace upm /** * @library at42qt1070 * @sensor at42qt1070 - * @comname AT42QT1070 QTouch Sensor + * @comname Seven-channel QTouch Touch Sensor * @altname Grove QTouch Sensor * @type touch * @man seeed * @con i2c + * @web http://wiki.seeed.cc/Grove-Q_Touch_Sensor/ * * @brief API for the Atmel AT42QT1070 QTouch Sensor * diff --git a/src/bacnetmstp/CMakeLists.txt b/src/bacnetmstp/CMakeLists.txt index 6e70a014..5e27df03 100644 --- a/src/bacnetmstp/CMakeLists.txt +++ b/src/bacnetmstp/CMakeLists.txt @@ -1,6 +1,6 @@ if (BACNET_FOUND) set (libname "bacnetmstp") - set (libdescription "Driver module for BACnet MS/TP devices") + set (libdescription "Driver Module for BACnet MS/TP Devices") set (module_src ${libname}.cxx device-client.c bacnetutil.cxx) set (module_hpp ${libname}.hpp bacnetutil.hpp device.h) diff --git a/src/bacnetmstp/bacnetmstp.hpp b/src/bacnetmstp/bacnetmstp.hpp index 1a748a69..9d8c3221 100644 --- a/src/bacnetmstp/bacnetmstp.hpp +++ b/src/bacnetmstp/bacnetmstp.hpp @@ -59,7 +59,7 @@ namespace upm { /** * @library bacnetmstp * @sensor bacnetmstp - * @comname UPM API for BACNET MS/TP communications + * @comname UPM API for BACNET MS/TP Communications * @con uart * @web http://bacnet.sourceforge.net/ * @brief UPM API for BACNETMSTP diff --git a/src/bacnetmstp/bacnetutil.hpp b/src/bacnetmstp/bacnetutil.hpp index 463d1d89..3c405265 100644 --- a/src/bacnetmstp/bacnetutil.hpp +++ b/src/bacnetmstp/bacnetutil.hpp @@ -33,7 +33,7 @@ namespace upm { /** * @library bacnetmstp - * @comname UPM Utility API for BACnet + * @comname Utility API for BACnet * @con uart * * @brief UPM Utility API for BACnet diff --git a/src/bh1750/CMakeLists.txt b/src/bh1750/CMakeLists.txt index dd985eb6..f22c7c57 100644 --- a/src/bh1750/CMakeLists.txt +++ b/src/bh1750/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME bh1750 - DESCRIPTION "Digital light sensor" + DESCRIPTION "Digital Light Sensor" C_HDR bh1750.h C_SRC bh1750.c CPP_HDR bh1750.hpp diff --git a/src/bh1750/bh1750.hpp b/src/bh1750/bh1750.hpp index 0014b4cc..391a44fa 100644 --- a/src/bh1750/bh1750.hpp +++ b/src/bh1750/bh1750.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library bh1750 * @sensor bh1750 - * @comname DFRobot Light Sensor + * @comname Digital Light Sensor * @type light * @man dfrobot * @con i2c diff --git a/src/biss0001/CMakeLists.txt b/src/biss0001/CMakeLists.txt index 10c3b5c5..c07b7f52 100644 --- a/src/biss0001/CMakeLists.txt +++ b/src/biss0001/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME biss0001 - DESCRIPTION "Passive Infrared (PIR) motion sensor" + DESCRIPTION "Passive Infrared (PIR) Motion Sensor" C_HDR biss0001.h C_SRC biss0001.c CPP_HDR biss0001.hpp diff --git a/src/biss0001/biss0001.hpp b/src/biss0001/biss0001.hpp index 7a82dccd..7176bb24 100644 --- a/src/biss0001/biss0001.hpp +++ b/src/biss0001/biss0001.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library biss0001 * @sensor biss0001 - * @comname BISS0001 Motion Sensor + * @comname Passive Infrared (PIR) Motion Sensor * @altname Grove PIR Motion Sensor * @type light * @man seeed diff --git a/src/bma220/CMakeLists.txt b/src/bma220/CMakeLists.txt index fcdc00b9..0946db07 100644 --- a/src/bma220/CMakeLists.txt +++ b/src/bma220/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "bma220") -set (libdescription "Accelerometer sensor based on bma220") +set (libdescription "Digital Triaxial Acceleration Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/bma220/bma220.hpp b/src/bma220/bma220.hpp index e361d486..f8f360ea 100644 --- a/src/bma220/bma220.hpp +++ b/src/bma220/bma220.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library bma220 * @sensor bma220 - * @comname BMA220 3-axis Accelerometer + * @comname Digital Triaxial Acceleration Sensor * @type accelerometer * @man dfrobot * @con i2c gpio diff --git a/src/bmi160/CMakeLists.txt b/src/bmi160/CMakeLists.txt index 7207eb29..8e342b74 100644 --- a/src/bmi160/CMakeLists.txt +++ b/src/bmi160/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME bmi160 - DESCRIPTION "Bosch Sensortec IMU (triaxial accelerometer, triaxial gyroscope and magnetometer interface)" + DESCRIPTION "Bosch Sensortec IMU (triaxial Accelerometer, Triaxial Gyroscope and Magnetometer Interface)" C_HDR bmi160.h bosch_bmi160.h C_SRC bmi160.c bosch_bmi160.c CPP_HDR bmi160.hpp diff --git a/src/bmi160/bmi160.hpp b/src/bmi160/bmi160.hpp index e28bed7a..8685d545 100644 --- a/src/bmi160/bmi160.hpp +++ b/src/bmi160/bmi160.hpp @@ -40,12 +40,12 @@ namespace upm { /** * @library bmi160 * @sensor bmi160 - * @comname BMI160 3-axis Accelerometer, Gyroscope + * @comname Low-power IMU (triaxial Accelerometer and Triaxial Gyroscope) * and Magnetometer * @type accelerometer compass * @man mouser * @con i2c - * @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB2187/?qs=sGAEpiMZZMvi6wO7nhr1L9JELKA6cYRX60mAGNTn0fQ%3d + * @web https://www.bosch-sensortec.com/bst/products/all_products/bmi160 * * @brief UPM API for the BMI160 3-axis Accelerometer, Gyroscope and * Magnetometer diff --git a/src/bmp280/CMakeLists.txt b/src/bmp280/CMakeLists.txt index 7fb9e7cd..64fec167 100644 --- a/src/bmp280/CMakeLists.txt +++ b/src/bmp280/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "bmp280") -set (libdescription "Bosch bmp280 Pressure sensor and bme280 humidity sensor") +set (libdescription "Bosch Atmospheric Sensor Library (bmp280 and Bme280)") set (module_src ${libname}.cxx bme280.cxx) set (module_hpp ${libname}.hpp bme280.hpp) upm_module_init(interfaces mraa) diff --git a/src/bmp280/bme280.hpp b/src/bmp280/bme280.hpp index 5865d826..3414d00c 100644 --- a/src/bmp280/bme280.hpp +++ b/src/bmp280/bme280.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library bmp280 * @sensor bme280 - * @comname BME280 Digital Humidity, Pressure, and Temperature Sensor + * @comname Digital Humidity, Pressure, and Temperature Sensor * @type pressure humidity * @man adafruit * @con i2c spi gpio diff --git a/src/bmp280/bmp280.hpp b/src/bmp280/bmp280.hpp index 2d159632..2eda9fed 100644 --- a/src/bmp280/bmp280.hpp +++ b/src/bmp280/bmp280.hpp @@ -47,7 +47,7 @@ namespace upm { /** * @library bmp280 * @sensor bmp280 - * @comname BMP280 Digital Pressure Sensor + * @comname Digital Pressure Sensor * @type pressure * @man adafruit * @con i2c spi gpio diff --git a/src/bmpx8x/CMakeLists.txt b/src/bmpx8x/CMakeLists.txt index 4e5474b3..1b75a6f4 100644 --- a/src/bmpx8x/CMakeLists.txt +++ b/src/bmpx8x/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "bmpx8x") -set (libdescription "Bosch BMP & GY65 atmospheric pressure sensor library") +set (libdescription "Bosch BMP & GY65 Atmospheric Pressure Sensor Library") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/bmpx8x/bmpx8x.hpp b/src/bmpx8x/bmpx8x.hpp index 6b9b7034..0065d93c 100644 --- a/src/bmpx8x/bmpx8x.hpp +++ b/src/bmpx8x/bmpx8x.hpp @@ -77,6 +77,9 @@ namespace upm { * @type pressure * @man seeed adafruit sparkfun * @con i2c + * @web https://www.sparkfun.com/datasheets/Components/General/BST-BMP085-DS000-05.pdf + * @web https://www.bosch-sensortec.com/bst/products/all_products/bmp180 + * @web https://cdn-shop.adafruit.com/datasheets/1900_BMP183.pdf * * @brief API for the GY65/BMP085 and BMP180 Atmospheric Pressure Sensors * diff --git a/src/bmx055/CMakeLists.txt b/src/bmx055/CMakeLists.txt index bd5b7fad..d0a90991 100644 --- a/src/bmx055/CMakeLists.txt +++ b/src/bmx055/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "bmx055") -set (libdescription "Bosch bmx055, bmi055, bma250e, bmc150, bmg160, bmm150") +set (libdescription "Bosch IMU Sensor Library") set (module_src ${libname}.cxx bma250e.cxx bmg160.cxx bmm150.cxx bmc150.cxx bmi055.cxx) set (module_hpp ${libname}.hpp bma250e.hpp bmg160.hpp bmm150.hpp bmc150.cxx bmi055.hpp) upm_module_init(mraa) diff --git a/src/bmx055/bma250e.hpp b/src/bmx055/bma250e.hpp index 227d2858..0362313e 100644 --- a/src/bmx055/bma250e.hpp +++ b/src/bmx055/bma250e.hpp @@ -38,12 +38,13 @@ namespace upm { /** * @library bmx050 * @sensor bma250e - * @comname BMA250E 10 bit Trixial Accelerometer + * @comname Digital Triaxial Acceleration Sensor * @type accelerometer * @man bosch * @con i2c spi gpio + * @web https://www.bosch-sensortec.com/bst/products/all_products/bma250e * - * @brief API for the BMA250E 10 bit Trixial Accelerometer + * @brief API for the BMA250E 10 bit Triaxial Accelerometer * * The BMA250E is a triaxial, low-g acceleration sensor with digital * output for consumer applications. It allows measurements of diff --git a/src/bmx055/bmc150.hpp b/src/bmx055/bmc150.hpp index 9992b6df..40464868 100644 --- a/src/bmx055/bmc150.hpp +++ b/src/bmx055/bmc150.hpp @@ -37,11 +37,11 @@ namespace upm { /** * @library bmx055 * @sensor bmc150 - * @comname BMC150 6-axis eCompass + * @comname 6-axis Ecompass * @type accelerometer compass - * @man mouser + * @man bosch * @con i2c gpio spi - * @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB0156/?qs=sGAEpiMZZMsrChSOYEGTCd8nwjostN1SWavW0HYOOXw%3d + * @web http://www.bosch-sensortec.com/en/bst/products/all_products/homepage_1_ohne_marginalspalte_52 * * @brief API for the BMC150 6-axis eCompass * diff --git a/src/bmx055/bmg160.hpp b/src/bmx055/bmg160.hpp index ca68e343..2ce81b62 100644 --- a/src/bmx055/bmg160.hpp +++ b/src/bmx055/bmg160.hpp @@ -38,12 +38,13 @@ namespace upm { /** * @library bmx050 * @sensor bmg160 - * @comname BMG160 16 bit Trixial Gyroscope + * @comname 3-axis Gyroscope Sensor * @type gyro * @man bosch * @con i2c spi gpio + * @web https://www.bosch-sensortec.com/bst/products/all_products/bmg160 * - * @brief API for the BMG160 16 bit Trixial Gyroscope + * @brief API for the BMG160 16 bit Triaxial Gyroscope * * The BMG160 is a 3-axis angular rate sensor that is made of a * surface micro machined sensing element and an evaluation ASIC. diff --git a/src/bmx055/bmi055.hpp b/src/bmx055/bmi055.hpp index 5075b829..0f68f244 100644 --- a/src/bmx055/bmi055.hpp +++ b/src/bmx055/bmi055.hpp @@ -33,11 +33,11 @@ namespace upm { /** * @library bmx055 * @sensor bmi055 - * @comname BMI055 6-axis Sensor Module + * @comname 6DoF Sensor Module * @type accelerometer compass - * @man mouser + * @man bosch * @con i2c gpio spi - * @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB0134/?qs=sGAEpiMZZMsrChSOYEGTCVIRbo47L7ys6GxSnxRPEhU%3d + * @web https://www.bosch-sensortec.com/bst/products/all_products/bmi055 * * @brief API for the BMI055 6-axis Sensor Module * diff --git a/src/bmx055/bmm150.hpp b/src/bmx055/bmm150.hpp index e692a833..c918bc7a 100644 --- a/src/bmx055/bmm150.hpp +++ b/src/bmx055/bmm150.hpp @@ -38,11 +38,12 @@ namespace upm { /** * @library bmx050 * @sensor bmm150 - * @comname BMM150 3-Axis Geomagnetic Sensor + * @comname 3-axis Geomagnetic Sensor * @altname bmm050 * @type compass * @man bosch * @con i2c spi gpio + * @web https://www.bosch-sensortec.com/bst/products/all_products/bmm150 * * @brief API for the BMM150 3-Axis Geomagnetic Sensor * diff --git a/src/bmx055/bmx055.hpp b/src/bmx055/bmx055.hpp index 7addfd9c..4d280e5c 100644 --- a/src/bmx055/bmx055.hpp +++ b/src/bmx055/bmx055.hpp @@ -40,11 +40,11 @@ namespace upm { /** * @library bmx055 * @sensor bmx055 - * @comname BMX055 9-axis Sensor Module + * @comname 9-axis Sensor Module * @type accelerometer compass - * @man mouser + * @man bosch * @con i2c gpio spi - * @web http://www.mouser.com/ProductDetail/Bosch-Sensortec/0330SB0179/?qs=sGAEpiMZZMsrChSOYEGTCZo8d3KRE6KPUk8gVuWS2Ho%3d + * @web https://www.bosch-sensortec.com/bst/products/all_products/bmx055 * * @brief API for the BMX055 9-axis Sensor Module * diff --git a/src/bno055/CMakeLists.txt b/src/bno055/CMakeLists.txt index 80368fc2..9408416d 100644 --- a/src/bno055/CMakeLists.txt +++ b/src/bno055/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "bno055") -set (libdescription "Bosch bno055 intelligent orientation sensor 9dof fusion") +set (libdescription "Intelligent 9-axis Absolute Orientation Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/bno055/bno055.hpp b/src/bno055/bno055.hpp index d974aa60..f22a016f 100644 --- a/src/bno055/bno055.hpp +++ b/src/bno055/bno055.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library bno055 * @sensor bno055 - * @comname BNO055 Absolute Orientation 9DOF Fusion Hub + * @comname Intelligent 9-axis Absolute Orientation Sensor * @type accelerometer compass * @man adafruit * @con i2c gpio diff --git a/src/button/CMakeLists.txt b/src/button/CMakeLists.txt index 25bbeba7..7881c80e 100644 --- a/src/button/CMakeLists.txt +++ b/src/button/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME button - DESCRIPTION "Momentary on/off button" + DESCRIPTION "Button" C_HDR button.h C_SRC button.c CPP_HDR button.hpp diff --git a/src/buzzer/buzzer.hpp b/src/buzzer/buzzer.hpp index 2364b904..0778e5ea 100644 --- a/src/buzzer/buzzer.hpp +++ b/src/buzzer/buzzer.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library buzzer * @sensor buzzer - * @comname Grove Buzzer + * @comname Buzzer * @type sound * @man seeed * @con pwm diff --git a/src/cjq4435/CMakeLists.txt b/src/cjq4435/CMakeLists.txt index 9ebcda4a..b61a9b8d 100644 --- a/src/cjq4435/CMakeLists.txt +++ b/src/cjq4435/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME cjq4435 - DESCRIPTION "MOSFET module" + DESCRIPTION "MOSFET" C_HDR cjq4435.h C_SRC cjq4435.c CPP_HDR cjq4435.hpp diff --git a/src/cjq4435/cjq4435.hpp b/src/cjq4435/cjq4435.hpp index 955c35d1..f32f3a63 100644 --- a/src/cjq4435/cjq4435.hpp +++ b/src/cjq4435/cjq4435.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library cjq4435 * @sensor cjq4435 - * @comname Grove MOSFET + * @comname MOSFET * @altname CJQ4435 * @type electric * @man seeed diff --git a/src/collision/CMakeLists.txt b/src/collision/CMakeLists.txt index 45119223..fe3d712b 100644 --- a/src/collision/CMakeLists.txt +++ b/src/collision/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME collision - DESCRIPTION "Collision sensor" + DESCRIPTION "Collision Sensor" C_HDR collision.h C_SRC collision.c CPP_HDR collision.hpp diff --git a/src/curieimu/CMakeLists.txt b/src/curieimu/CMakeLists.txt index dcb7665b..92248faf 100644 --- a/src/curieimu/CMakeLists.txt +++ b/src/curieimu/CMakeLists.txt @@ -4,7 +4,7 @@ include (CheckIncludeFiles) check_library_exists (${MRAA_LIBRARIES} mraa_firmata_init "" HAVE_FIRMATA) if (HAVE_FIRMATA) set (libname "curieimu") - set (libdescription "Curie IMU via Firmata") + set (libdescription "Curie IMU Sensor using Firmata") set (module_src ${libname}.cpp) set (module_hpp ${libname}.hpp) upm_module_init (mraa) diff --git a/src/curieimu/curieimu.hpp b/src/curieimu/curieimu.hpp index 35b27bca..14cf182e 100644 --- a/src/curieimu/curieimu.hpp +++ b/src/curieimu/curieimu.hpp @@ -58,7 +58,7 @@ struct IMUDataItem { /** * @library curieimu * @sensor curieimu - * @comname Curie IMU Sensor with Firmata + * @comname Curie IMU Sensor using Firmata * @altname Curie IMU Sensor for Arduino/Genuino 101 running Firmata * @type accelerometer compass * @man bosch diff --git a/src/cwlsxxa/CMakeLists.txt b/src/cwlsxxa/CMakeLists.txt index 4fa56da7..9dcfe7f9 100644 --- a/src/cwlsxxa/CMakeLists.txt +++ b/src/cwlsxxa/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "cwlsxxa") -set (libdescription "Veris CWLSXXA CO2/Temperature/Humidity transmitter") +set (libdescription "Veris CWLSXXA CO2/Temperature/Humidity Transmitter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/cwlsxxa/cwlsxxa.hpp b/src/cwlsxxa/cwlsxxa.hpp index 596c64ae..a390a139 100644 --- a/src/cwlsxxa/cwlsxxa.hpp +++ b/src/cwlsxxa/cwlsxxa.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library cwlsxxa * @sensor cwlsxxa - * @comname Veris CWLSXXA CO2 Sensor Family + * @comname CO2/temperature/humidity Transmitter * @type temp gaseous * @man veris * @con ainput diff --git a/src/dfrec/CMakeLists.txt b/src/dfrec/CMakeLists.txt index 06c4bee4..b106ae40 100644 --- a/src/dfrec/CMakeLists.txt +++ b/src/dfrec/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME dfrec - DESCRIPTION "DFRobot analog electrical conductivity (EC) sensor" + DESCRIPTION "Analog Electrical Conductivity (EC) Sensor" C_HDR dfrec.h C_SRC dfrec.c CPP_HDR dfrec.hpp diff --git a/src/dfrec/dfrec.hpp b/src/dfrec/dfrec.hpp index a8879b7c..e98664fa 100644 --- a/src/dfrec/dfrec.hpp +++ b/src/dfrec/dfrec.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library dfrec * @sensor dfrec - * @comname DFRobot EC Meter + * @comname Analog Electrical Conductivity (EC) Sensor * @type liquid * @man dfrobot * @con ainput uart diff --git a/src/dfrorp/CMakeLists.txt b/src/dfrorp/CMakeLists.txt index 91de3dc1..d24071bf 100644 --- a/src/dfrorp/CMakeLists.txt +++ b/src/dfrorp/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME dfrorp - DESCRIPTION "DFRobot analog oxidation reduction potential (ORP) sensor" + DESCRIPTION "Analog Oxidation Reduction Potential (ORP) Sensor" C_HDR dfrorp.h C_SRC dfrorp.c CPP_HDR dfrorp.hpp diff --git a/src/dfrorp/dfrorp.hpp b/src/dfrorp/dfrorp.hpp index 35df83a3..5165c479 100644 --- a/src/dfrorp/dfrorp.hpp +++ b/src/dfrorp/dfrorp.hpp @@ -43,7 +43,7 @@ namespace upm { /** * @library dfrorp * @sensor dfrorp - * @comname DFRobot ORP (Oxidation/Reduction Potential) Sensor + * @comname Analog Oxidation Reduction Potential (ORP) Sensor * @type liquid * @man dfrobot * @con ainput diff --git a/src/dfrph/CMakeLists.txt b/src/dfrph/CMakeLists.txt index c7328f12..8017429d 100644 --- a/src/dfrph/CMakeLists.txt +++ b/src/dfrph/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME dfrph - DESCRIPTION "DFRobot pH sensor" + DESCRIPTION "Analog pH Sensor" C_HDR dfrph.h C_SRC dfrph.c CPP_HDR dfrph.hpp diff --git a/src/dfrph/dfrph.hpp b/src/dfrph/dfrph.hpp index 765d3eb5..bce9c775 100644 --- a/src/dfrph/dfrph.hpp +++ b/src/dfrph/dfrph.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library dfrph * @sensor dfrph - * @comname DFRobot pH Sensors + * @comname Analog pH Sensor * @type liquid * @man dfrobot * @web http://www.dfrobot.com/index.php?route=product/product&product_id=1110 diff --git a/src/ds1307/CMakeLists.txt b/src/ds1307/CMakeLists.txt index 3d527b65..a5f08c31 100644 --- a/src/ds1307/CMakeLists.txt +++ b/src/ds1307/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ds1307") -set (libdescription "Real time clock (RTC) module") +set (libdescription "Real Time Clock (RTC) Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/ds1307/ds1307.hpp b/src/ds1307/ds1307.hpp index 40618663..8b120e12 100644 --- a/src/ds1307/ds1307.hpp +++ b/src/ds1307/ds1307.hpp @@ -51,11 +51,12 @@ namespace upm { /** * @library ds1307 * @sensor ds1307 - * @comname Grove RTC (Real-Time Clock) + * @comname Real Time Clock (RTC) Module * @altname DS1307 RTC * @type time * @man seeed * @con i2c + * @web https://www.maximintegrated.com/en/products/digital/real-time-clocks/DS1307.html * * @brief API for the DS1307 Real-Time CLock * diff --git a/src/ds1808lc/CMakeLists.txt b/src/ds1808lc/CMakeLists.txt index 1f15ce96..70cf93b5 100644 --- a/src/ds1808lc/CMakeLists.txt +++ b/src/ds1808lc/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ds1808lc") -set (libdescription "DS1808 lighting controller") +set (libdescription "Lighting Controller") set (module_src ${libname}.cxx mraa-utils.cxx) set (module_hpp ${libname}.hpp) upm_module_init(interfaces mraa) diff --git a/src/ds1808lc/ds1808lc.hpp b/src/ds1808lc/ds1808lc.hpp index 1d855654..5ae9d1c3 100644 --- a/src/ds1808lc/ds1808lc.hpp +++ b/src/ds1808lc/ds1808lc.hpp @@ -43,7 +43,7 @@ namespace upm * * @library ds1808lc * @sensor ds1808lc - * @comname Maxim DS1808 as lighting controller + * @comname Lighting Controller * @altname DS1808LC * @type light * @man maxim diff --git a/src/ds18b20/CMakeLists.txt b/src/ds18b20/CMakeLists.txt index 916ac0a3..570189a8 100644 --- a/src/ds18b20/CMakeLists.txt +++ b/src/ds18b20/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ds18b20 - DESCRIPTION "Programmable resolution DS 1-wire digital thermometer" + DESCRIPTION "Programmable Resolution 1-Wire Digital Thermometer" C_HDR ds18b20.h ds18b20_defs.h C_SRC ds18b20.c CPP_HDR ds18b20.hpp diff --git a/src/ds18b20/ds18b20.hpp b/src/ds18b20/ds18b20.hpp index a7e5dfc3..5b10fa00 100644 --- a/src/ds18b20/ds18b20.hpp +++ b/src/ds18b20/ds18b20.hpp @@ -48,7 +48,7 @@ namespace upm { /** * @library ds18b20 * @sensor ds18b20 - * @comname DS18B20 1-Wire Temperature Sensor + * @comname Programmable Resolution 1-Wire Digital Thermometer * @type uart * @man maxim * @con uart diff --git a/src/ds2413/CMakeLists.txt b/src/ds2413/CMakeLists.txt index 292d7fff..812f584b 100644 --- a/src/ds2413/CMakeLists.txt +++ b/src/ds2413/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ds2413") -set (libdescription "DS2413 1-wire Dual Channel Addressable Switch module") +set (libdescription "1-Wire Dual Channel Addressable Switch") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/ds2413/ds2413.hpp b/src/ds2413/ds2413.hpp index fb0da3af..3e9e0d4c 100644 --- a/src/ds2413/ds2413.hpp +++ b/src/ds2413/ds2413.hpp @@ -46,7 +46,7 @@ namespace upm { /** * @library ds2413 * @sensor ds2413 - * @comname DS2413 1-Wire Dual Channel Addressable Switch + * @comname 1-Wire Dual Channel Addressable Switch * @type gpio * @man maxim * @con uart diff --git a/src/e50hx/CMakeLists.txt b/src/e50hx/CMakeLists.txt index f6afd26d..2d8dccdd 100644 --- a/src/e50hx/CMakeLists.txt +++ b/src/e50hx/CMakeLists.txt @@ -1,6 +1,6 @@ if (BACNET_FOUND) set (libname "e50hx") - set (libdescription "Module for the Veris E50HX (E50H2/E50H5)Energy Meters") + set (libdescription "Veris E50HX (E50H2/E50H5) Energy Meter Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) diff --git a/src/e50hx/e50hx.hpp b/src/e50hx/e50hx.hpp index 0fe8776d..b628285f 100644 --- a/src/e50hx/e50hx.hpp +++ b/src/e50hx/e50hx.hpp @@ -40,7 +40,7 @@ namespace upm { /** * @library e50hx * @sensor e50hx - * @comname Veris E50HX Energy Meters + * @comname Veris E50HX (E50H2/E50H5) Energy Meter Module * @type electic * @man veris * @con uart diff --git a/src/ecezo/CMakeLists.txt b/src/ecezo/CMakeLists.txt index 1fbd8783..24222ace 100644 --- a/src/ecezo/CMakeLists.txt +++ b/src/ecezo/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ecezo - DESCRIPTION "EC EZO Atlas Scientific EC circuit" + DESCRIPTION "Electrical Conductivity (EC) Circuit" C_HDR ecezo.h ecezo_defs.h C_SRC ecezo.c CPP_HDR ecezo.hpp diff --git a/src/ecezo/ecezo.hpp b/src/ecezo/ecezo.hpp index 1750b3b3..76b93eba 100644 --- a/src/ecezo/ecezo.hpp +++ b/src/ecezo/ecezo.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library ecezo * @sensor ecezo - * @comname EC-EZO EC Sensor + * @comname Electrical Conductivity (EC) Circuit * @type liquid * @man sparkfun * @con uart i2c diff --git a/src/ecs1030/CMakeLists.txt b/src/ecs1030/CMakeLists.txt index 6298b663..1c071384 100644 --- a/src/ecs1030/CMakeLists.txt +++ b/src/ecs1030/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ecs1030") -set (libdescription "Non-invasive current sensor") +set (libdescription "Non-invasive Current Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/ecs1030/ecs1030.hpp b/src/ecs1030/ecs1030.hpp index dec1b982..ce18d564 100644 --- a/src/ecs1030/ecs1030.hpp +++ b/src/ecs1030/ecs1030.hpp @@ -50,7 +50,7 @@ namespace upm { /** * @library ecs1030 * @sensor ecs1030 - * @comname ECS1030 Non-Invasive Current Sensor + * @comname Non-invasive Current Sensor * @type electric * @man sparkfun * @web https://www.sparkfun.com/products/11005 diff --git a/src/ehr/CMakeLists.txt b/src/ehr/CMakeLists.txt index ba96d92e..5fc870d6 100644 --- a/src/ehr/CMakeLists.txt +++ b/src/ehr/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ehr - DESCRIPTION "Ear-clip heart rate sensor" + DESCRIPTION "Ear-clip Heart Rate Sensor" CPP_HDR ehr.hpp CPP_SRC ehr.cxx REQUIRES mraa) diff --git a/src/ehr/ehr.hpp b/src/ehr/ehr.hpp index d102952e..688e4654 100644 --- a/src/ehr/ehr.hpp +++ b/src/ehr/ehr.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library ehr * @sensor ehr - * @comname Ear-clip Heart Rate Sensor + * @comname Ear-clip Heart Rate Sensor * @type medical * @man seeed * @con gpio diff --git a/src/eldriver/CMakeLists.txt b/src/eldriver/CMakeLists.txt index 3e9913ce..11568852 100644 --- a/src/eldriver/CMakeLists.txt +++ b/src/eldriver/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME eldriver - DESCRIPTION "Electroluminescent wire (EL) driver" + DESCRIPTION "Electroluminescent Wire (EL) Driver" CPP_HDR eldriver.hpp CPP_SRC eldriver.cxx REQUIRES mraa) diff --git a/src/eldriver/eldriver.hpp b/src/eldriver/eldriver.hpp index 787b8492..95aeb48c 100644 --- a/src/eldriver/eldriver.hpp +++ b/src/eldriver/eldriver.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library eldriver * @sensor eldriver - * @comname EL Driver + * @comname Electroluminescent Wire (EL) Driver * @type electric * @man seeed * @con gpio diff --git a/src/electromagnet/CMakeLists.txt b/src/electromagnet/CMakeLists.txt index f0bc7d37..5dcebbbb 100644 --- a/src/electromagnet/CMakeLists.txt +++ b/src/electromagnet/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME electromagnet - DESCRIPTION "Electromagnet sensor" + DESCRIPTION "Electromagnet" CPP_HDR electromagnet.hpp CPP_SRC electromagnet.cxx REQUIRES mraa) diff --git a/src/electromagnet/electromagnet.hpp b/src/electromagnet/electromagnet.hpp index 53e8221d..200cf077 100644 --- a/src/electromagnet/electromagnet.hpp +++ b/src/electromagnet/electromagnet.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library electromagnet * @sensor electromagnet - * @comname Electromagnet + * @comname Electromagnet * @type electric * @man seeed * @con gpio diff --git a/src/emg/CMakeLists.txt b/src/emg/CMakeLists.txt index 9314b967..be9eca7f 100644 --- a/src/emg/CMakeLists.txt +++ b/src/emg/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME emg - DESCRIPTION "Electromyography (EMG) detector" + DESCRIPTION "Electromyography (EMG) Sensor" C_HDR emg.h C_SRC emg.c CPP_HDR emg.hpp diff --git a/src/emg/emg.hpp b/src/emg/emg.hpp index d65424a0..66be2779 100644 --- a/src/emg/emg.hpp +++ b/src/emg/emg.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library emg * @sensor emg - * @comname EMG Sensor + * @comname Electromyography (EMG) Sensor * @altname Grove EMG Sensor * @type electric * @man seeed diff --git a/src/enc03r/CMakeLists.txt b/src/enc03r/CMakeLists.txt index a67f844d..8fc2f412 100644 --- a/src/enc03r/CMakeLists.txt +++ b/src/enc03r/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME enc03r - DESCRIPTION "Single-axis Analog Gyroscope" + DESCRIPTION "Single-axis Analog Gyro Module" C_HDR enc03r.h C_SRC enc03r.c CPP_HDR enc03r.hpp diff --git a/src/enc03r/enc03r.hpp b/src/enc03r/enc03r.hpp index 2239dd76..364ce127 100644 --- a/src/enc03r/enc03r.hpp +++ b/src/enc03r/enc03r.hpp @@ -27,113 +27,112 @@ #include "enc03r.h" namespace upm { +/** + * @brief ENC03R Single Axis Gyro library + * @defgroup enc03r libupm-enc03r + * @ingroup seeed analog compass robok + */ - /** - * @brief ENC03R Single Axis Gyro library - * @defgroup enc03r libupm-enc03r - * @ingroup seeed analog compass robok - */ - - /** - * @library enc03r - * @sensor enc03r - * @comname ENC03R Single Axis Gyro - * @altname Grove Single Axis Analog Gyro - * @type compass - * @man seeed - * @con analog - * @kit robok - * - * @brief API for the ENC03R Single Axis Analog Gyro - * - * UPM module for the ENC03R single axis analog gyro. - * This gyroscope measures x-axis angular velocity, that is - * how fast the sensor is rotating around the x-axis. - * Calibration of the sensor is necessary for accurate readings. - * - * @image html enc03r.jpg - * @snippet enc03r.cxx Interesting - */ - class ENC03R { +/** + * @library enc03r + * @sensor enc03r + * @comname Single-axis Analog Gyro Module + * @altname Grove Single Axis Analog Gyro + * @type compass + * @man seeed + * @con analog + * @kit robok + * @web http://www.murata.com/en-us/products/productdetail?partno=ENC-03RC-R + * + * @brief API for the ENC03R Single Axis Analog Gyro + * + * UPM module for the ENC03R single axis analog gyro. + * This gyroscope measures x-axis angular velocity, that is + * how fast the sensor is rotating around the x-axis. + * Calibration of the sensor is necessary for accurate readings. + * + * @image html enc03r.jpg + * @snippet enc03r.cxx Interesting + */ +class ENC03R { public: - /** - * ENC03R sensor constructor - * - * @param pin Analog pin to use - * @param vref Reference voltage to use; default is 5.0 V - */ + * ENC03R sensor constructor + * + * @param pin Analog pin to use + * @param vref Reference voltage to use; default is 5.0 V + */ ENC03R(int pin, float aref=5.0); /** - * ENC03R destructor - */ + * ENC03R destructor + */ ~ENC03R(); /** - * Calibrates the sensor by determining an analog reading over many - * samples with no movement of the sensor. This must be done - * before attempting to use the sensor. - * - * @param samples Number of samples to use for calibration - */ + * Calibrates the sensor by determining an analog reading over many + * samples with no movement of the sensor. This must be done + * before attempting to use the sensor. + * + * @param samples Number of samples to use for calibration + */ void calibrate(unsigned int samples); /** - * Update the internal state with the current reading. This - * function must be called prior to calling - * angularVelocity(). - * - * @param dev Device context - */ + * Update the internal state with the current reading. This + * function must be called prior to calling + * angularVelocity(). + * + * @param dev Device context + */ void update(); /** - * Returns the currently stored calibration value - * - * @return Current calibration value - */ + * Returns the currently stored calibration value + * + * @return Current calibration value + */ float calibrationValue() { return enc03r_calibration_value(m_enc03r); }; /** - * Computes angular velocity based on the value and stored calibration - * reference. - * - * @param val Value to use to compute angular velocity - * @return Computed angular velocity - */ + * Computes angular velocity based on the value and stored calibration + * reference. + * + * @param val Value to use to compute angular velocity + * @return Computed angular velocity + */ float angularVelocity(); /** - * Set sensor offset. The offste is applied to the return value - * before scaling. Default is 0. - * - * @param scale Scale to apply to value - */ + * Set sensor offset. The offste is applied to the return value + * before scaling. Default is 0. + * + * @param scale Scale to apply to value + */ void setOffset(float offset); /** - * Set sensor scale. The return value is scaled by this value - * before the offset is applied. Default is 1.0. - * - * @param dev Device context - * @param scale Offset to apply to value - */ + * Set sensor scale. The return value is scaled by this value + * before the offset is applied. Default is 1.0. + * + * @param dev Device context + * @param scale Offset to apply to value + */ void setScale(float scale); /** - * Get a normalized ADC value from the sensor. The return - * value will be between 0.0 (indicating no voltage) and 1.0 - * indicating max voltage (aref). update() must be called - * prior to calling this function. - * - * @return The normalized reading from the ADC. - */ + * Get a normalized ADC value from the sensor. The return + * value will be between 0.0 (indicating no voltage) and 1.0 + * indicating max voltage (aref). update() must be called + * prior to calling this function. + * + * @return The normalized reading from the ADC. + */ float getNormalized(); protected: enc03r_context m_enc03r; private: - }; +}; } diff --git a/src/flex/CMakeLists.txt b/src/flex/CMakeLists.txt index e0a95a23..0b15dcba 100644 --- a/src/flex/CMakeLists.txt +++ b/src/flex/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME flex - DESCRIPTION "Resistive flex sensor" + DESCRIPTION "Resistive Flex Sensor" C_HDR flex.h C_SRC flex.c CPP_HDR flex.hpp diff --git a/src/flex/flex.hpp b/src/flex/flex.hpp index 7ac4ad16..a0b02f14 100644 --- a/src/flex/flex.hpp +++ b/src/flex/flex.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library flex * @sensor flex - * @comname Flex Sensor + * @comname Resistive Flex Sensor * @type flexfor * @man sparkfun * @web https://www.sparkfun.com/products/8606 diff --git a/src/gas/CMakeLists.txt b/src/gas/CMakeLists.txt index 50773426..4f93589a 100644 --- a/src/gas/CMakeLists.txt +++ b/src/gas/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME gas - DESCRIPTION "Generic gas detection sensor library" + DESCRIPTION "Generic Gas Detection Sensor Library" C_HDR mqx.h C_SRC mqx.c CPP_HDR gas.hpp mq2.hpp mq3.hpp mq4.hpp mq5.hpp mq6.hpp mq7.hpp mq8.hpp mq9.hpp tp401.hpp diff --git a/src/gas/mq2.hpp b/src/gas/mq2.hpp index 6126bdeb..f34cf12b 100644 --- a/src/gas/mq2.hpp +++ b/src/gas/mq2.hpp @@ -31,11 +31,12 @@ namespace upm { /** * @library gas * @sensor mq2 - * @comname Grove MQ2 Gas Sensor + * @comname MQ2 Methane, Butane, Liquefied Petroleum Gas (LPG), and Smoke Sensor * @type gaseous * @man seeed * @con analog * @kit hak + * @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ2/ * * @brief API for the Grove MQ2 Gas Sensor * diff --git a/src/gas/mq3.hpp b/src/gas/mq3.hpp index fb0af324..3ef69bc6 100644 --- a/src/gas/mq3.hpp +++ b/src/gas/mq3.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq3 - * @comname Grove MQ3 Gas Sensor + * @comname MQ3 Alcohol, Ethanol, Smoke Sensor * @type gaseous * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ3/ * * @brief API for the MQ3 Gas Sensor * diff --git a/src/gas/mq4.hpp b/src/gas/mq4.hpp index f06a229a..6bc8e8dd 100644 --- a/src/gas/mq4.hpp +++ b/src/gas/mq4.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq4 - * @comname DFRobot MQ4 Gas Sensor + * @comname MQ4 Methane and Connecticut Natural Gas (CNG) Sensor * @type gaseous * @man dfrobot * @con analog + * @web https://www.dfrobot.com/index.php?route=product/product&product_id=683 * * @brief API for the DFRobot MQ4 Gas Sensor * diff --git a/src/gas/mq5.hpp b/src/gas/mq5.hpp index 2218b091..4030050f 100644 --- a/src/gas/mq5.hpp +++ b/src/gas/mq5.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq5 - * @comname Grove MQ5 Gas Sensor + * @comname MQ5 Natural Gas and Liquefied Petroleum Gas (LPG) Sensor * @type gaseous * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ5/ * @kit eak * * @brief API for the MQ5 Gas Sensor diff --git a/src/gas/mq6.hpp b/src/gas/mq6.hpp index 7a77b093..88ccb9de 100644 --- a/src/gas/mq6.hpp +++ b/src/gas/mq6.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq6 - * @comname DFRobot MQ6 LPG Gas Sensor + * @comname MQ6 Liquefied Petroleum Gas (LPG) and Butane Sensor * @type gaseous * @man dfrobot * @con analog + * @web https://www.dfrobot.com/wiki/index.php/LPG_Gas_Sensor(MQ6)_(SKU:SEN0131) * * @brief API for the DFRobot MQ6 LPG Gas Sensor * diff --git a/src/gas/mq7.hpp b/src/gas/mq7.hpp index 4707c5b6..55517a10 100644 --- a/src/gas/mq7.hpp +++ b/src/gas/mq7.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq7 - * @comname DFRobot MQ7 CO Gas Sensor + * @comname MQ7 Carbon Monoxide Sensor * @type gaseous * @man dfrobot * @con analog + * @web https://www.dfrobot.com/wiki/index.php/Carbon_Monoxide_Gas_Sensor(MQ7)_(SKU:SEN0132) * * @brief API for the DFRobot MQ7 CO Gas Sensor * diff --git a/src/gas/mq8.hpp b/src/gas/mq8.hpp index 3f7f780d..1e158a8e 100644 --- a/src/gas/mq8.hpp +++ b/src/gas/mq8.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq8 - * @comname DFRobot MQ8 CO Gas Sensor + * @comname MQ8 Flammable (Hydrogen) Gas Sensor * @type gaseous * @man dfrobot * @con analog + * @web https://www.dfrobot.com/wiki/index.php/Hydrogen_Gas_Sensor(MQ8)_(SKU:SEN0133) * * @brief API for the DFRobot MQ8 Hydrogen (H2) Gas Sensor * diff --git a/src/gas/mq9.hpp b/src/gas/mq9.hpp index 41d87917..ced23d38 100644 --- a/src/gas/mq9.hpp +++ b/src/gas/mq9.hpp @@ -31,10 +31,11 @@ namespace upm { /** * @library gas * @sensor mq9 - * @comname Grove MQ9 Gas Sensor + * @comname MQ9 Carbon Monoxide (CO) and Flammable Gas Sensor * @type gaseous * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-Gas_Sensor-MQ9/ * * @brief API for the MQ9 Gas Sensor * diff --git a/src/gas/tp401.hpp b/src/gas/tp401.hpp index 14b15c03..1930924b 100644 --- a/src/gas/tp401.hpp +++ b/src/gas/tp401.hpp @@ -31,11 +31,12 @@ namespace upm { /** * @library gas * @sensor tp401 - * @comname Grove Air Quality Sensor + * @comname Air Quality Sensor * @altname TP401 Gas Sensor * @type gaseous * @man seeed * @con analog + * @web https://www.seeedstudio.com/Grove-Air-quality-sensor-p-1065.html * @kit hak * * @brief API for the Grove TP401 Air Quality Sensor diff --git a/src/gp2y0a/CMakeLists.txt b/src/gp2y0a/CMakeLists.txt index a8ec51df..80cc456e 100644 --- a/src/gp2y0a/CMakeLists.txt +++ b/src/gp2y0a/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME gp2y0a - DESCRIPTION "Analog Infrared (IR) based distance sensor" + DESCRIPTION "Analog Infrared (IR) Based Distance Sensor" C_HDR gp2y0a.h C_SRC gp2y0a.c CPP_HDR gp2y0a.hpp diff --git a/src/gp2y0a/gp2y0a.hpp b/src/gp2y0a/gp2y0a.hpp index d3d4213d..e8d0ed85 100644 --- a/src/gp2y0a/gp2y0a.hpp +++ b/src/gp2y0a/gp2y0a.hpp @@ -37,11 +37,12 @@ namespace upm { /** * @library gp2y0a * @sensor gp2y0a - * @comname GP2Y0A IR Proximity Sensor + * @comname Analog Infrared (IR) Based Distance Sensor * @altname Grove 80cm IR Proximity Sensor * @type light * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-80cm_Infrared_Proximity_Sensor/ * * @brief API for the GP2Y0A family of IR Proximity Sensors * diff --git a/src/gprs/CMakeLists.txt b/src/gprs/CMakeLists.txt index a52e5469..22b75c9b 100644 --- a/src/gprs/CMakeLists.txt +++ b/src/gprs/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME gprs - DESCRIPTION "General Packet Radio Service (GPRS) module" + DESCRIPTION "General Packet Radio Service (GPRS) Module" CPP_HDR gprs.hpp CPP_SRC gprs.cxx REQUIRES mraa) diff --git a/src/gprs/gprs.hpp b/src/gprs/gprs.hpp index ff05d035..e927aa99 100644 --- a/src/gprs/gprs.hpp +++ b/src/gprs/gprs.hpp @@ -48,7 +48,7 @@ namespace upm { /** * @library gprs * @sensor gprs - * @comname GPRS Module + * @comname General Packet Radio Service (GPRS) Module * @altname Grove GPRS Module * @type wifi * @man seeed diff --git a/src/groups.md b/src/groups.md index a8f03582..e35b0786 100644 --- a/src/groups.md +++ b/src/groups.md @@ -360,11 +360,6 @@ and is not meant to be installed anywhere. @brief Silicon Labs -@defgroup sparkfun Sparkfun -@ingroup byman -@brief Sparkfun - - @defgroup stmicro STMicroelectronics @ingroup byman @brief STMicroelectronics @@ -380,6 +375,51 @@ and is not meant to be installed anywhere. @brief Veris Industries +@defgroup aeon Aeon Labs +@ingroup byman +@brief Aeon Labs + + +@defgroup trane Trane +@ingroup byman +@brief Trane Incorporated + + +@defgroup avago Avago Technologies +@ingroup byman +@brief Avago Technologies + + +@defgroup catnip Catnip Electronics +@ingroup byman +@brief Catnip Electronics + + +@defgroup kionix Kionix Incorporated +@ingroup byman +@brief Kionix Incorporated + + +@defgroup maxbotix Maxbotix +@ingroup byman +@brief Maxbotix + + +@defgroup maxim Maxim Integrated +@ingroup byman +@brief Maxim Integrated + + +@defgroup sainsmart sainSMART +@ingroup byman +@brief sainSMART + + +@defgroup semtech Semtech Corporation +@ingroup byman +@brief Semtech Corporation + + ### Groups for the various Starter Kits ### diff --git a/src/grove/CMakeLists.txt b/src/grove/CMakeLists.txt index 9f8f43f6..9fb6b1c6 100644 --- a/src/grove/CMakeLists.txt +++ b/src/grove/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grove") -set (libdescription "Grove module") +set (libdescription "Grove Starter Kit Sensor Library") set (module_src grovebutton.cxx groveled.cxx grovelight.cxx groverelay.cxx groverotary.cxx groveslide.cxx grovetemp.cxx) set (module_hpp grovebutton.hpp groveled.hpp grovelight.hpp groverelay.hpp groverotary.hpp groveslide.hpp grovetemp.hpp grovebase.hpp grove.hpp) upm_module_init(mraa) diff --git a/src/grove/grovebutton.hpp b/src/grove/grovebutton.hpp index ec6d2cfd..4983de82 100644 --- a/src/grove/grovebutton.hpp +++ b/src/grove/grovebutton.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor grovebutton - * @comname Grove Button + * @comname Button * @altname Grove Touch Sensor * @type button touch * @man seeed diff --git a/src/grove/groveled.hpp b/src/grove/groveled.hpp index 665078cb..c0daf3d1 100644 --- a/src/grove/groveled.hpp +++ b/src/grove/groveled.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor groveled - * @comname Grove LED + * @comname LED * @type led * @man seeed * @con gpio diff --git a/src/grove/grovelight.hpp b/src/grove/grovelight.hpp index 154671af..a6bcc59d 100644 --- a/src/grove/grovelight.hpp +++ b/src/grove/grovelight.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor grovelight - * @comname Grove Light Sensor + * @comname Light Sensor * @type light * @man seeed * @con analog diff --git a/src/grove/groverelay.hpp b/src/grove/groverelay.hpp index 3a45c6f8..be6a314f 100644 --- a/src/grove/groverelay.hpp +++ b/src/grove/groverelay.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor groverelay - * @comname Grove Relay + * @comname Relay * @type relay * @man seeed * @con gpio diff --git a/src/grove/groverotary.hpp b/src/grove/groverotary.hpp index 31407cc8..12070485 100644 --- a/src/grove/groverotary.hpp +++ b/src/grove/groverotary.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor groverotary - * @comname Grove Rotary Angle Sensor + * @comname Rotary Angle Sensor * @altname Rotary Potentiometer * @type ainput * @man seeed @@ -50,7 +50,7 @@ namespace upm { * a set of functions to read the absolute pin value, degrees or radians, and another set * to do the same relative to the center of the knob's range. * - * @image html groverotary.jpeg + * @image html rotaryencoder.jpg * @snippet groverotary.cxx Interesting */ class GroveRotary: public Grove { diff --git a/src/grove/groveslide.hpp b/src/grove/groveslide.hpp index b583d199..b9f7f738 100644 --- a/src/grove/groveslide.hpp +++ b/src/grove/groveslide.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor groveslide - * @comname Grove Slide Potentiometer + * @comname Slide Potentiometer * @type ainput * @man seeed * @con analog @@ -47,7 +47,7 @@ namespace upm { * Basic UPM module for the Grove slide potentiometer on analog that * returns either a raw value or a scaled voltage value. * - * @image html groveslide.jpeg + * @image html slide.jpg * @snippet groveslide.cxx Interesting */ class GroveSlide: public Grove { diff --git a/src/grove/grovetemp.hpp b/src/grove/grovetemp.hpp index f786791e..b70eee62 100644 --- a/src/grove/grovetemp.hpp +++ b/src/grove/grovetemp.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library grove * @sensor grovetemp - * @comname Grove Temperature Sensor + * @comname Temperature Sensor * @type temp * @man seeed * @con analog diff --git a/src/grovecollision/CMakeLists.txt b/src/grovecollision/CMakeLists.txt index d43c5305..09b00fa1 100644 --- a/src/grovecollision/CMakeLists.txt +++ b/src/grovecollision/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovecollision") -set (libdescription "Grovecollision sensor module") +set (libdescription "Collision Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovecollision/grovecollision.hpp b/src/grovecollision/grovecollision.hpp index a3c84f99..ce27a21e 100644 --- a/src/grovecollision/grovecollision.hpp +++ b/src/grovecollision/grovecollision.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library grovecollision * @sensor grovecollision - * @comname Grove Collision Sensor + * @comname Collision Sensor * @type accelerometer * @man seeed * @con gpio diff --git a/src/groveehr/CMakeLists.txt b/src/groveehr/CMakeLists.txt index 758dedac..39250e56 100644 --- a/src/groveehr/CMakeLists.txt +++ b/src/groveehr/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "groveehr") -set (libdescription "Grove ear-clip heart rate sensor module") +set (libdescription "Ear-clip Heart Rate Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/groveehr/groveehr.hpp b/src/groveehr/groveehr.hpp index a5188797..5cbe58ca 100644 --- a/src/groveehr/groveehr.hpp +++ b/src/groveehr/groveehr.hpp @@ -39,7 +39,7 @@ namespace upm { /** * @library groveehr * @sensor groveehr - * @comname Grove Ear-clip Heart Rate Sensor + * @comname Ear-clip Heart Rate Sensor * @type medical * @man seeed * @con gpio diff --git a/src/groveeldriver/CMakeLists.txt b/src/groveeldriver/CMakeLists.txt index 7afc84be..0945bcc5 100644 --- a/src/groveeldriver/CMakeLists.txt +++ b/src/groveeldriver/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "groveeldriver") -set (libdescription "Groveeldriver sensor module") +set (libdescription "Electroluminescent (EL) Driver") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/groveeldriver/groveeldriver.hpp b/src/groveeldriver/groveeldriver.hpp index 119f40a8..a8181c3f 100644 --- a/src/groveeldriver/groveeldriver.hpp +++ b/src/groveeldriver/groveeldriver.hpp @@ -39,7 +39,7 @@ namespace upm { /** * @library groveeldriver * @sensor groveeldriver - * @comname Grove EL Driver + * @comname Electroluminescent (EL) Driver * @type electric * @man seeed * @con gpio diff --git a/src/groveelectromagnet/CMakeLists.txt b/src/groveelectromagnet/CMakeLists.txt index fab0fb2d..5353b63b 100644 --- a/src/groveelectromagnet/CMakeLists.txt +++ b/src/groveelectromagnet/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "groveelectromagnet") -set (libdescription "Groveelectromagnet sensor module") +set (libdescription "Electromagnet") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/groveelectromagnet/groveelectromagnet.hpp b/src/groveelectromagnet/groveelectromagnet.hpp index 12460c05..10d88034 100644 --- a/src/groveelectromagnet/groveelectromagnet.hpp +++ b/src/groveelectromagnet/groveelectromagnet.hpp @@ -39,7 +39,7 @@ namespace upm { /** * @library groveelectromagnet * @sensor groveelectromagnet - * @comname Grove Electromagnet + * @comname Electromagnet * @type electric * @man seeed * @con gpio diff --git a/src/groveemg/CMakeLists.txt b/src/groveemg/CMakeLists.txt index cb690cfa..c05d98c1 100644 --- a/src/groveemg/CMakeLists.txt +++ b/src/groveemg/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "groveemg") -set (libdescription "Groveemg muscle signal reader sensor module") +set (libdescription "Electromyography (EMG) Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/groveemg/groveemg.hpp b/src/groveemg/groveemg.hpp index 640fd3da..c94c0c8c 100644 --- a/src/groveemg/groveemg.hpp +++ b/src/groveemg/groveemg.hpp @@ -37,18 +37,18 @@ namespace upm { /** * @library groveemg * @sensor groveemg - * @comname Grove EMG Sensor + * @comname Electromyography (EMG) Sensor * @type electric * @man seeed * @con analog * @deprecated This class is being replaced by EMG * * @brief API for the Grove EMG Muscle Signal Reader - * + * * Grove EMG muscle signal reader gathers small muscle signals, * then processes them, and returns the result * - * @image html groveemg.jpg + * @image html emg.jpg * @snippet groveemg.cxx Interesting */ class GroveEMG { diff --git a/src/grovegprs/CMakeLists.txt b/src/grovegprs/CMakeLists.txt index b989d0d8..233d5cae 100644 --- a/src/grovegprs/CMakeLists.txt +++ b/src/grovegprs/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovegprs") -set (libdescription "Grove GPRS module") +set (libdescription "GPRS Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovegprs/grovegprs.hpp b/src/grovegprs/grovegprs.hpp index a91cb0f0..24dec4ba 100644 --- a/src/grovegprs/grovegprs.hpp +++ b/src/grovegprs/grovegprs.hpp @@ -49,7 +49,7 @@ namespace upm { /** * @library grovegprs * @sensor grovegprs - * @comname Grove GPRS Module + * @comname GPRS Module * @type wifi * @man seeed * @con uart @@ -67,7 +67,7 @@ namespace upm { * * It is connected via a UART at 19200 baud. * - * @image html grovegprs.jpg + * @image html gprs.jpg * @snippet grovegprs.cxx Interesting */ diff --git a/src/grovegsr/CMakeLists.txt b/src/grovegsr/CMakeLists.txt index 15c999e9..b4067436 100644 --- a/src/grovegsr/CMakeLists.txt +++ b/src/grovegsr/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovegsr") -set (libdescription "Grovegsr galvanic skin response sensor module") +set (libdescription "Galvanic Skin Response (GSR) Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovegsr/grovegsr.hpp b/src/grovegsr/grovegsr.hpp index a3737dca..5fe74248 100644 --- a/src/grovegsr/grovegsr.hpp +++ b/src/grovegsr/grovegsr.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library grovegsr * @sensor grovegsr - * @comname Grove GSR Sensor + * @comname Galvanic Skin Response (GSR) Sensor * @type electric * @man seeed * @con analog @@ -50,7 +50,7 @@ namespace upm { * In other words, it measures sweat on your fingers * as an indicator of strong emotional reactions. * - * @image html grovegsr.jpg + * @image html gsr.jpg * @snippet grovegsr.cxx Interesting */ class GroveGSR { diff --git a/src/grovelinefinder/CMakeLists.txt b/src/grovelinefinder/CMakeLists.txt index b301a1de..f2ed0893 100644 --- a/src/grovelinefinder/CMakeLists.txt +++ b/src/grovelinefinder/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovelinefinder") -set (libdescription "Grove line finder sensor module") +set (libdescription "Line Finder") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovelinefinder/grovelinefinder.hpp b/src/grovelinefinder/grovelinefinder.hpp index d617c2e4..b7026698 100644 --- a/src/grovelinefinder/grovelinefinder.hpp +++ b/src/grovelinefinder/grovelinefinder.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library grovelinefinder * @sensor grovelinefinder - * @comname Grove Line Finder + * @comname Line Finder * @type color * @man seeed * @con gpio diff --git a/src/grovemd/CMakeLists.txt b/src/grovemd/CMakeLists.txt index 46942cff..4885bceb 100644 --- a/src/grovemd/CMakeLists.txt +++ b/src/grovemd/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovemd") -set (libdescription "Grove i2c motor driver module") +set (libdescription "I2C Motor Driver") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovemd/grovemd.hpp b/src/grovemd/grovemd.hpp index b8269e50..4ff935e0 100644 --- a/src/grovemd/grovemd.hpp +++ b/src/grovemd/grovemd.hpp @@ -43,7 +43,7 @@ namespace upm { /** * @library grovemd * @sensor grovemd - * @comname Grove I2C Motor Driver + * @comname I2C Motor Driver * @type motor * @man seeed * @con i2c diff --git a/src/grovemoisture/CMakeLists.txt b/src/grovemoisture/CMakeLists.txt index a5523cb5..df307ab9 100644 --- a/src/grovemoisture/CMakeLists.txt +++ b/src/grovemoisture/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovemoisture") -set (libdescription "Grove moisture module") +set (libdescription "Moisture Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovemoisture/grovemoisture.hpp b/src/grovemoisture/grovemoisture.hpp index 6910c1aa..29bfdc89 100644 --- a/src/grovemoisture/grovemoisture.hpp +++ b/src/grovemoisture/grovemoisture.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library grovemoisture * @sensor grovemoisture - * @comname Grove Moisture Sensor + * @comname Moisture Sensor * @type liquid * @man seeed * @con analog diff --git a/src/groveo2/CMakeLists.txt b/src/groveo2/CMakeLists.txt index 09534a29..c83dd9cb 100644 --- a/src/groveo2/CMakeLists.txt +++ b/src/groveo2/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "groveo2") -set (libdescription "GroveO2 oxygen concentration sensor module") +set (libdescription "Oxygen (O2) Concentration Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/groveo2/groveo2.hpp b/src/groveo2/groveo2.hpp index b69fbd1b..de58e795 100644 --- a/src/groveo2/groveo2.hpp +++ b/src/groveo2/groveo2.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library groveo2 * @sensor groveo2 - * @comname Grove O2 Sensor + * @comname Oxygen (O2) Concentration Sensor * @type gaseous * @man seeed * @con analog diff --git a/src/grovescam/CMakeLists.txt b/src/grovescam/CMakeLists.txt index c5b462a9..0d4e7867 100644 --- a/src/grovescam/CMakeLists.txt +++ b/src/grovescam/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovescam") -set (libdescription "Grove serial camera module") +set (libdescription "Serial Camera Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovescam/grovescam.hpp b/src/grovescam/grovescam.hpp index b23705b8..8713adee 100644 --- a/src/grovescam/grovescam.hpp +++ b/src/grovescam/grovescam.hpp @@ -57,7 +57,7 @@ namespace upm { /** * @library grovescam * @sensor grovescam - * @comname Grove Serial Camera + * @comname Serial Camera Module * @type other * @man seeed * @con uart diff --git a/src/grovespeaker/CMakeLists.txt b/src/grovespeaker/CMakeLists.txt index 8a51b3a5..d8b07655 100644 --- a/src/grovespeaker/CMakeLists.txt +++ b/src/grovespeaker/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovespeaker") -set (libdescription "Grovespeaker speaker module") +set (libdescription "Speaker Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovespeaker/grovespeaker.hpp b/src/grovespeaker/grovespeaker.hpp index 06171664..848405d1 100644 --- a/src/grovespeaker/grovespeaker.hpp +++ b/src/grovespeaker/grovespeaker.hpp @@ -50,7 +50,7 @@ typedef struct /** * @library grovespeaker * @sensor grovespeaker - * @comname Grove Speaker + * @comname Speaker Module * @type sound * @man seeed * @con gpio diff --git a/src/groveultrasonic/CMakeLists.txt b/src/groveultrasonic/CMakeLists.txt index 7004d491..b4447f17 100644 --- a/src/groveultrasonic/CMakeLists.txt +++ b/src/groveultrasonic/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "groveultrasonic") -set (libdescription "Grove ultrasonic proximity sensor") +set (libdescription "Ultrasonic Proximity Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/groveultrasonic/groveultrasonic.hpp b/src/groveultrasonic/groveultrasonic.hpp index 2bd74610..314454b4 100644 --- a/src/groveultrasonic/groveultrasonic.hpp +++ b/src/groveultrasonic/groveultrasonic.hpp @@ -45,7 +45,7 @@ namespace upm { /** * @library groveultrasonic * @sensor groveultrasonic - * @comname Grove Ultrasonic Ranger + * @comname Ultrasonic Proximity Sensor * @type sound * @man seeed * @con gpio diff --git a/src/grovevdiv/CMakeLists.txt b/src/grovevdiv/CMakeLists.txt index 0e66cea5..b2508ec2 100644 --- a/src/grovevdiv/CMakeLists.txt +++ b/src/grovevdiv/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovevdiv") -set (libdescription "Grove voltage divider module") +set (libdescription "Voltage Divider") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovevdiv/grovevdiv.hpp b/src/grovevdiv/grovevdiv.hpp index 0ff4695e..ded27c4a 100644 --- a/src/grovevdiv/grovevdiv.hpp +++ b/src/grovevdiv/grovevdiv.hpp @@ -45,7 +45,7 @@ namespace upm { /** * @library grovevdiv * @sensor grovevdiv - * @comname Grove Voltage Divider + * @comname Voltage Divider * @type electric * @man seeed * @con analog diff --git a/src/grovewater/CMakeLists.txt b/src/grovewater/CMakeLists.txt index 5dd996d3..6fdc698a 100644 --- a/src/grovewater/CMakeLists.txt +++ b/src/grovewater/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovewater") -set (libdescription "Grove water module") +set (libdescription "Water Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovewater/grovewater.hpp b/src/grovewater/grovewater.hpp index 0a6bfba6..c4790685 100644 --- a/src/grovewater/grovewater.hpp +++ b/src/grovewater/grovewater.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library grovewater * @sensor grovewater - * @comname Grove Water Sensor + * @comname Water Sensor * @type liquid * @man seeed * @con gpio @@ -48,7 +48,7 @@ namespace upm { * * UPM module for the Grove Water sensor * - * @image html grovewater.jpg + * @image html water.jpg * @snippet grovewater.cxx Interesting */ class GroveWater { diff --git a/src/grovewfs/CMakeLists.txt b/src/grovewfs/CMakeLists.txt index 769a4077..89b1ac1f 100644 --- a/src/grovewfs/CMakeLists.txt +++ b/src/grovewfs/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "grovewfs") -set (libdescription "Grove water flow sensor module") +set (libdescription "Water Flow Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/grovewfs/grovewfs.hpp b/src/grovewfs/grovewfs.hpp index 7803b140..0624f90d 100644 --- a/src/grovewfs/grovewfs.hpp +++ b/src/grovewfs/grovewfs.hpp @@ -40,10 +40,10 @@ namespace upm { /** * @library grovewfs * @sensor grovewfs - * @comname Grove Water Flow Sensor + * @comname Water Flow Sensor * @type liquid * @man seeed - * @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor + * @web http://wiki.seeedstudio.com/wiki/G1/2_Water_Flow_sensor * @con gpio * @kit eak * @deprecated This class is being replaced by WFS diff --git a/src/gsr/CMakeLists.txt b/src/gsr/CMakeLists.txt index 88c59ce2..2b3ec8ad 100644 --- a/src/gsr/CMakeLists.txt +++ b/src/gsr/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME gsr - DESCRIPTION "Galvanic skin response (GSR) sensor" + DESCRIPTION "Galvanic Skin Response (GSR) Sensor" C_HDR gsr.h C_SRC gsr.c CPP_HDR gsr.hpp diff --git a/src/gsr/gsr.hpp b/src/gsr/gsr.hpp index fd55305e..6f1c70b4 100644 --- a/src/gsr/gsr.hpp +++ b/src/gsr/gsr.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library gsr * @sensor gsr - * @comname Grove GSR Sensor + * @comname Galvanic Skin Response (GSR) Sensor * @type electric * @man seeed * @con analog diff --git a/src/guvas12d/CMakeLists.txt b/src/guvas12d/CMakeLists.txt index 7ab99144..3b3501a2 100644 --- a/src/guvas12d/CMakeLists.txt +++ b/src/guvas12d/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME guvas12d - DESCRIPTION "Guvas12d analog UV sensor" + DESCRIPTION "Analog UV Sensor" C_HDR guvas12d.h C_SRC guvas12d.c CPP_HDR guvas12d.hpp diff --git a/src/guvas12d/guvas12d.hpp b/src/guvas12d/guvas12d.hpp index 0b5e7af5..5414edce 100644 --- a/src/guvas12d/guvas12d.hpp +++ b/src/guvas12d/guvas12d.hpp @@ -35,11 +35,12 @@ namespace upm { /** * @library guvas12d * @sensor guvas12d - * @comname Grove UV Sensor + * @comname Analog UV Sensor * @altname GUVA-S12D UV Sensor * @type light * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-UV_Sensor/ * @kit eak * * @brief API for the GUVA-S12D UV Sensor diff --git a/src/h3lis331dl/CMakeLists.txt b/src/h3lis331dl/CMakeLists.txt index 63387d30..db4c931d 100644 --- a/src/h3lis331dl/CMakeLists.txt +++ b/src/h3lis331dl/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "h3lis331dl") -set (libdescription "H3lis331dl I2c Accelerometer (400g)") +set (libdescription "I2C 3-axis Digital Accelerometer (400g)") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/h3lis331dl/h3lis331dl.hpp b/src/h3lis331dl/h3lis331dl.hpp index 5f49bbd7..83bbe38f 100644 --- a/src/h3lis331dl/h3lis331dl.hpp +++ b/src/h3lis331dl/h3lis331dl.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library h3lis331dl * @sensor h3lis331dl - * @comname H3LIS331DL 3-Axis Digital Accelerometer + * @comname I2C 3-axis Digital Accelerometer (400g) * @altname Grove 3-Axis Digital Accelerometer (400g) * @type accelerometer * @man seeed stmicro diff --git a/src/h803x/h803x.hpp b/src/h803x/h803x.hpp index 3fb4b830..a37cdfe7 100644 --- a/src/h803x/h803x.hpp +++ b/src/h803x/h803x.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library h803x * @sensor h803x - * @comname Veris H803X Energy Meter + * @comname Veris H803X Energy Meter Module * @type electic * @man veris * @con uart diff --git a/src/hcsr04/CMakeLists.txt b/src/hcsr04/CMakeLists.txt index 62466423..e60401f6 100644 --- a/src/hcsr04/CMakeLists.txt +++ b/src/hcsr04/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hcsr04") -set (libdescription "Proximity sensor") +set (libdescription "Ultrasonic Distance Measuring Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/hcsr04/hcsr04.hpp b/src/hcsr04/hcsr04.hpp index b77b9724..4ce688ce 100644 --- a/src/hcsr04/hcsr04.hpp +++ b/src/hcsr04/hcsr04.hpp @@ -43,10 +43,11 @@ namespace upm { /** * @library hcsr04 * @sensor hcsr04 - * @comname HC-SR04 Ultrasonic Sensor + * @comname Ultrasonic Distance Measuring Sensor * @type sound * @man generic * @con gpio + * @web https://www.sparkfun.com/products/13959 * * @brief API for the HC-SR04 Ultrasonic Sensor * diff --git a/src/hdxxvxta/CMakeLists.txt b/src/hdxxvxta/CMakeLists.txt index 52c4968c..794065e4 100644 --- a/src/hdxxvxta/CMakeLists.txt +++ b/src/hdxxvxta/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hdxxvxta") -set (libdescription "Veris HDXXVXTA Temperature/Humidity transmitter") +set (libdescription "Veris HDXXVXTA Temperature/Humidity Transmitter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/hdxxvxta/hdxxvxta.hpp b/src/hdxxvxta/hdxxvxta.hpp index 04da0642..007c7fcd 100644 --- a/src/hdxxvxta/hdxxvxta.hpp +++ b/src/hdxxvxta/hdxxvxta.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library hdxxvxta * @sensor hdxxvxta - * @comname Veris HDXXVXTA Humidity Transmitter family + * @comname Veris HDXXVXTA Temperature/humidity Transmitter * @type temp * @man veris * @con ainput diff --git a/src/hka5/CMakeLists.txt b/src/hka5/CMakeLists.txt index 3cc648bd..2d46ef2b 100644 --- a/src/hka5/CMakeLists.txt +++ b/src/hka5/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME hka5 - DESCRIPTION "DFRobot laser particulate matter (PM) sensor" + DESCRIPTION "Laser Particulate Matter (PM) Sensor" C_HDR hka5.h C_SRC hka5.c CPP_HDR hka5.hpp diff --git a/src/hka5/hka5.hpp b/src/hka5/hka5.hpp index 00139cd6..59b63ac2 100644 --- a/src/hka5/hka5.hpp +++ b/src/hka5/hka5.hpp @@ -41,10 +41,11 @@ namespace upm { /** * @library hka5 * @sensor hka5 - * @comname DFRobot Laser PM2.5 Sensor + * @comname Laser Particulate Matter (PM) Sensor * @type gaseous * @man dfrobot * @con uart gpio + * @web https://www.dfrobot.com/wiki/index.php/DFRobot_LM35_Linear_Temperature_Sensor_(SKU:DFR0023) * * @brief API for theDFRobot Laser PM2.5 Sensor * diff --git a/src/hlg150h/CMakeLists.txt b/src/hlg150h/CMakeLists.txt index 3bd16a12..ee975d4b 100644 --- a/src/hlg150h/CMakeLists.txt +++ b/src/hlg150h/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hlg150h") -set (libdescription "Lighting power supply") +set (libdescription "150W Constant Voltage/current LED Driver") set (module_src ${libname}.cxx mraa-utils.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/hlg150h/hlg150h.hpp b/src/hlg150h/hlg150h.hpp index 1b33b4bf..0fa0f314 100644 --- a/src/hlg150h/hlg150h.hpp +++ b/src/hlg150h/hlg150h.hpp @@ -44,10 +44,11 @@ namespace upm * * @library hlg150h * @sensor hlg150h - * @comname HLG150H lighting controller + * @comname 150W Constant Voltage/current LED Driver * @altname HLG150H * @type light * @con pwm + * @web https://www.meanwell-web.com/en/product-info/ac-dc-power-supply/led-driver/101-180-w-led-driver/hlg-150h/product/HLG-150H-24B * @if ilightcontroller */ diff --git a/src/hm11/CMakeLists.txt b/src/hm11/CMakeLists.txt index 9295e774..8f678b23 100644 --- a/src/hm11/CMakeLists.txt +++ b/src/hm11/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hm11") -set (libdescription "Grove hm11 bluetooth low energy module") +set (libdescription "Bluetooth Low Energy Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/hm11/hm11.hpp b/src/hm11/hm11.hpp index 29e43194..0836406d 100644 --- a/src/hm11/hm11.hpp +++ b/src/hm11/hm11.hpp @@ -55,13 +55,13 @@ namespace upm { /** * @library hm11 * @sensor hm11 - * @comname HM-11 Bluetooth Low Energy + * @comname Bluetooth Low Energy Module * @altname Grove BLE * @altid HM-10, HM-12 * @type wifi * @man seeed * @con uart - * @web http://www.seeedstudio.com/wiki/images/c/cd/Bluetooth4_en.pdf + * @web http://wiki.seeed.cc/Bluetooth_V4.0_HM_11_BLE_Module/ * * @brief API for the HM-11 4.0 Bluetooth Low Energy Module * diff --git a/src/hmc5883l/hmc5883l.hpp b/src/hmc5883l/hmc5883l.hpp index edbd5e89..46c0f57d 100644 --- a/src/hmc5883l/hmc5883l.hpp +++ b/src/hmc5883l/hmc5883l.hpp @@ -32,83 +32,83 @@ namespace upm { - /** - * @brief HMC5883L Magnometer library - * @defgroup hmc5883l libupm-hmc5883l - * @ingroup seeed i2c compass robok - */ +/** + * @brief HMC5883L Magnometer library + * @defgroup hmc5883l libupm-hmc5883l + * @ingroup seeed i2c compass robok + */ - /** - * @library hmc5883l - * @sensor hmc5883l - * @comname HMC5883L 3-Axis Digital Compass - * @altname Grove 3-Axis Digital Compass - * @type compass - * @man seeed - * @con i2c - * @kit robok - * - * @brief API for the HMC5883L 3-Axis Digital Compass - * - * Honeywell [HMC5883L] - * (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf) - * is a 3-axis digital compass. Communication with HMC5883L is - * simple and all done through an I2C interface. Different - * breakout boards are available. Typically, a 3V supply is all - * that is needed to power the sensor. - * - * @image html hmc5883l.jpeg - * @snippet hmc5883l.cxx Interesting - */ - class Hmc5883l { +/** + * @library hmc5883l + * @sensor hmc5883l + * @comname 3-axis Digital Compass + * @altname Grove 3-Axis Digital Compass + * @type compass + * @man seeed + * @con i2c + * @web http://wiki.seeed.cc/Grove-3-Axis_Compass_V1.0/ + * @kit robok + * + * @brief API for the HMC5883L 3-Axis Digital Compass + * + * Honeywell [HMC5883L] + * (http://www.adafruit.com/datasheets/HMC5883L_3-Axis_Digital_Compass_IC.pdf) + * is a 3-axis digital compass. Communication with HMC5883L is simple and + * all done through an I2C interface. Different breakout boards are available. + * Typically, a 3V supply is all that is needed to power the sensor. + * + * @image html hmc5883l.jpeg + * @snippet hmc5883l.cxx Interesting + */ +class Hmc5883l { public: /** - * Creates an Hmc5883l object. The I2C address cannot be - * changed, and is always 0x1e (7-bit). - * - * @param bus I2C bus number - */ + * Creates an Hmc5883l object. The I2C address cannot be + * changed, and is always 0x1e (7-bit). + * + * @param bus I2C bus number + */ Hmc5883l(int bus); /* - * Returns the direction - */ + * Returns the direction + */ float direction(); /* - * Returns the heading - */ + * Returns the heading + */ float heading(); /** - * Returns a pointer to an int[3] that contains the coordinates as ints - * - * @return *int to an int[3] - */ + * Returns a pointer to an int[3] that contains the coordinates as ints + * + * @return *int to an int[3] + */ const int16_t* coordinates(); /** - * Updates the values by reading from I2C - * - * @return 0 if successful - */ + * Updates the values by reading from I2C + * + * @return 0 if successful + */ upm_result_t update(); /** - * Sets the magnetic declination for better calibration - */ + * Sets the magnetic declination for better calibration + */ void set_declination(float dec); /** - * Gets the current magnetic declination value - * - * @return Magnetic declination as a floating-point value - */ + * Gets the current magnetic declination value + * + * @return Magnetic declination as a floating-point value + */ float get_declination(); protected: hmc5883l_context m_hmc5883l; private: - }; +}; } diff --git a/src/hmtrp/CMakeLists.txt b/src/hmtrp/CMakeLists.txt index 53e276dd..c7b8bf8c 100644 --- a/src/hmtrp/CMakeLists.txt +++ b/src/hmtrp/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hmtrp") -set (libdescription "Grove serial rf pro (hmtrp) module") +set (libdescription "Serial RF Pro Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/hmtrp/hmtrp.hpp b/src/hmtrp/hmtrp.hpp index c091a8f0..d477ecba 100644 --- a/src/hmtrp/hmtrp.hpp +++ b/src/hmtrp/hmtrp.hpp @@ -52,11 +52,12 @@ namespace upm { /** * @library hmtrp * @sensor hmtrp - * @comname Grove Serial RF Pro + * @comname Serial RF Pro Module * @altname HMTRP-433 HMTRP-470 HMTRP-868 HMTRP-915 * @type wifi * @man seeed * @con uart + * @web http://wiki.seeed.cc/Grove-Serial_RF_Pro/ * * @brief API for the HM-TRP Serial RF Pro transceiver * diff --git a/src/hp20x/CMakeLists.txt b/src/hp20x/CMakeLists.txt index 52a199bd..899d03b5 100644 --- a/src/hp20x/CMakeLists.txt +++ b/src/hp20x/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hp20x") -set (libdescription "Grove barometer (high efficiency)") +set (libdescription "High-accuracy Barometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/hp20x/hp20x.hpp b/src/hp20x/hp20x.hpp index 98313414..4c06f4e7 100644 --- a/src/hp20x/hp20x.hpp +++ b/src/hp20x/hp20x.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library hp20x * @sensor hp20x - * @comname Grove Barometer (High-Accuracy) + * @comname High-accuracy Barometer * @altname HP20X Barometer (High-Accuracy) * @type pressure * @man seeed diff --git a/src/ht9170/CMakeLists.txt b/src/ht9170/CMakeLists.txt index 93443748..08aeab2b 100644 --- a/src/ht9170/CMakeLists.txt +++ b/src/ht9170/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ht9170") -set (libdescription "Ht9170 DTMF decoder") +set (libdescription "Dual Tone Multi Frequency (DTMF) Decoder") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/ht9170/ht9170.hpp b/src/ht9170/ht9170.hpp index a16f6eac..0cca16b4 100644 --- a/src/ht9170/ht9170.hpp +++ b/src/ht9170/ht9170.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library ht9170 * @sensor ht9170 - * @comname HT9170 DTMF Decoder + * @comname Dual Tone Multi Frequency (DTMF) Decoder * @altname HT9170B, HT9170D * @type other * @man seeed diff --git a/src/htu21d/CMakeLists.txt b/src/htu21d/CMakeLists.txt index 77886390..35024786 100644 --- a/src/htu21d/CMakeLists.txt +++ b/src/htu21d/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "htu21d") -set (libdescription "Humidity Sensor") +set (libdescription "Digital Relative Humidity Sensor with Temperature") set (module_src ${libname}.cpp) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/htu21d/htu21d.hpp b/src/htu21d/htu21d.hpp index 55de56e4..b518d8e8 100644 --- a/src/htu21d/htu21d.hpp +++ b/src/htu21d/htu21d.hpp @@ -57,7 +57,7 @@ namespace upm { /** * @library htu21d * @sensor htu21d - * @comname HTU21D Temperature & Humidity Sensor + * @comname Digital Relative Humidity Sensor with Temperature * @type temp * @man seeed adafruit sparkfun * @web http://www.meas-spec.com/downloads/HTU21D.pdf diff --git a/src/hx711/CMakeLists.txt b/src/hx711/CMakeLists.txt index 1d80a8f3..abb2a295 100644 --- a/src/hx711/CMakeLists.txt +++ b/src/hx711/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "hx711") -set (libdescription "HX711 24bit ADC") +set (libdescription "24-bit Analog-to-digital Converter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/hx711/hx711.hpp b/src/hx711/hx711.hpp index b006bdbe..e1377969 100644 --- a/src/hx711/hx711.hpp +++ b/src/hx711/hx711.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library hx711 * @sensor hx711 - * @comname HX711 Analog-to-Digital Converter + * @comname 24-bit Analog-to-digital Converter * @type electric * @man generic * @web http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf diff --git a/src/ili9341/CMakeLists.txt b/src/ili9341/CMakeLists.txt index 04d838cd..7f8f7d1d 100644 --- a/src/ili9341/CMakeLists.txt +++ b/src/ili9341/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ili9341") -set (libdescription "ILI9341 SPI LCD") +set (libdescription "SPI Based LCD") set (module_src ili9341_gfx.cxx ili9341.cxx) set (module_hpp ili9341_gfx.hpp ili9341.hpp) upm_module_init(mraa) diff --git a/src/ili9341/ili9341.hpp b/src/ili9341/ili9341.hpp index 920adaaa..2cb3b3fd 100644 --- a/src/ili9341/ili9341.hpp +++ b/src/ili9341/ili9341.hpp @@ -136,7 +136,7 @@ namespace upm { /** * @library ili9341 * @sensor ili9341 - * @comname ILI9341 LCD + * @comname SPI Based LCD * @type display * @man adafruit * @web http://www.adafruit.com/product/2090 diff --git a/src/ims/CMakeLists.txt b/src/ims/CMakeLists.txt index f559602b..3765fa87 100644 --- a/src/ims/CMakeLists.txt +++ b/src/ims/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ims - DESCRIPTION "Catnip Electronics I2C moisture sensor" + DESCRIPTION "I2C Moisture Sensor" C_HDR ims.h C_SRC ims.c CPP_HDR ims.hpp diff --git a/src/ims/ims.hpp b/src/ims/ims.hpp index a9c1b299..d9910e29 100644 --- a/src/ims/ims.hpp +++ b/src/ims/ims.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library ims * @sensor ims - * @comname Catnip Electronics I2C moisture sensor + * @comname I2C Moisture Sensor * @type liquid light temp * @man catnip * @web https://www.tindie.com/products/miceuz/i2c-soil-moisture-sensor/ diff --git a/src/ina132/CMakeLists.txt b/src/ina132/CMakeLists.txt index 9f615af8..01d7c2ab 100644 --- a/src/ina132/CMakeLists.txt +++ b/src/ina132/CMakeLists.txt @@ -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) diff --git a/src/ina132/ina132.hpp b/src/ina132/ina132.hpp index 56d32d32..4c40398c 100644 --- a/src/ina132/ina132.hpp +++ b/src/ina132/ina132.hpp @@ -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 { diff --git a/src/interfaces/CMakeLists.txt b/src/interfaces/CMakeLists.txt index faa11148..e67c39f6 100644 --- a/src/interfaces/CMakeLists.txt +++ b/src/interfaces/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "interfaces") -set (libdescription "CXX interface library") +set (libdescription "CXX Interface Library") set (module_src ${libname}.cxx) upm_module_init() diff --git a/src/isd1820/CMakeLists.txt b/src/isd1820/CMakeLists.txt index 058edee2..c3ec768e 100644 --- a/src/isd1820/CMakeLists.txt +++ b/src/isd1820/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "isd1820") -set (libdescription "Grove recorder") +set (libdescription "Voice Recording and Playback Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/isd1820/isd1820.hpp b/src/isd1820/isd1820.hpp index 8e89511a..89f5d5b1 100644 --- a/src/isd1820/isd1820.hpp +++ b/src/isd1820/isd1820.hpp @@ -37,11 +37,12 @@ namespace upm { /** * @library isd1820 * @sensor isd1820 - * @comname Grove Recorder + * @comname Voice Recording and Playback Module * @altname ISD1820 Recorder * @type sound * @man seeed * @con gpio + * @web http://wiki.seeed.cc/Grove_Recorder/ * * @brief API support for the ISD1820-based Grove Voice Recorder * diff --git a/src/itg3200/CMakeLists.txt b/src/itg3200/CMakeLists.txt index 9549c1eb..c92d51ca 100644 --- a/src/itg3200/CMakeLists.txt +++ b/src/itg3200/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "itg3200") -set (libdescription "Digital Gyro") +set (libdescription "3-axis Digital Gyroscope") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/itg3200/itg3200.hpp b/src/itg3200/itg3200.hpp index 32ec1f6d..bef37cc2 100644 --- a/src/itg3200/itg3200.hpp +++ b/src/itg3200/itg3200.hpp @@ -38,11 +38,12 @@ namespace upm { /** * @library itg3200 * @sensor itg3200 - * @comname ITG-3200 3-Axis Digital Gyroscope + * @comname 3-axis Digital Gyroscope * @altname Grove 3-Axis Digital Gyroscope * @type compass * @man seeed * @con i2c + * @web http://wiki.seeed.cc/Grove-3-Axis_Digital_Gyro/ * * @brief API for the ITG-3200 3-Axis Digital Gyroscope * diff --git a/src/jhd1313m1/CMakeLists.txt b/src/jhd1313m1/CMakeLists.txt index e3012b5b..eaa7f00c 100644 --- a/src/jhd1313m1/CMakeLists.txt +++ b/src/jhd1313m1/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME jhd1313m1 - DESCRIPTION "LCD display driver for the JHD1313M1 controller for HD44780-based displays" + DESCRIPTION "LCD Display Driver for the JHD1313M1 Controller for HD44780-based Displays" C_HDR jhd1313m1.h C_SRC jhd1313m1.c CPP_HDR jhd1313m1.hpp diff --git a/src/jhd1313m1/jhd1313m1.hpp b/src/jhd1313m1/jhd1313m1.hpp index a1df9cbf..f36dd9ff 100644 --- a/src/jhd1313m1/jhd1313m1.hpp +++ b/src/jhd1313m1/jhd1313m1.hpp @@ -47,7 +47,7 @@ namespace upm /** * @library jhd1313m1 * @sensor jhd1313m1 - * @comname JHD1313M1 Display + * @comname LCD Display Driver for the JHD1313M1 Controller for HD44780-based Displays * @altname Grove RGB LCD * @type display * @man seeed adafruit sparkfun diff --git a/src/joystick12/CMakeLists.txt b/src/joystick12/CMakeLists.txt index fd7e3fae..335911a7 100644 --- a/src/joystick12/CMakeLists.txt +++ b/src/joystick12/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME joystick12 - DESCRIPTION "2-axis analog joystick" + DESCRIPTION "2-axis Analog Joystick" C_HDR joystick12.h C_SRC joystick12.c CPP_HDR joystick12.hpp diff --git a/src/joystick12/joystick12.hpp b/src/joystick12/joystick12.hpp index 2157fa67..969d6090 100644 --- a/src/joystick12/joystick12.hpp +++ b/src/joystick12/joystick12.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library joystick12 * @sensor joystick12 - * @comname Analog Joystick + * @comname 2-axis Analog Joystick * @type ainput * @man generic * @con analog diff --git a/src/kxcjk1013/CMakeLists.txt b/src/kxcjk1013/CMakeLists.txt index 5b50de9a..90a12fc2 100644 --- a/src/kxcjk1013/CMakeLists.txt +++ b/src/kxcjk1013/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "kxcjk1013") -set (libdescription "Kxcjk1013 sensor module") +set (libdescription "Tri-axis Digital Accelerometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/kxcjk1013/kxcjk1013.hpp b/src/kxcjk1013/kxcjk1013.hpp index 29be647c..0b1b4a1a 100644 --- a/src/kxcjk1013/kxcjk1013.hpp +++ b/src/kxcjk1013/kxcjk1013.hpp @@ -37,10 +37,11 @@ namespace upm /** * @library kxcjk1013 * @sensor kxcjk1013 - * @comname KXCJK1013 Tri-axis Digital Accelerometer + * @comname Tri-axis Digital Accelerometer * @type accelerometer - * @man Kionix + * @man kionix * @con iio i2c + * @web http://kionixfs.kionix.com/en/datasheet/KXCJK-1013%20Specifications%20Rev%202.pdf * * @brief KXCJK1013 Tri-axis Digital Accelerometer API * diff --git a/src/l298/CMakeLists.txt b/src/l298/CMakeLists.txt index e515af87..e3bab605 100644 --- a/src/l298/CMakeLists.txt +++ b/src/l298/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "l298") -set (libdescription "L298 dual h-bridge") +set (libdescription "Dual H-bridge Motor Driver") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/l298/l298.hpp b/src/l298/l298.hpp index 985a07cc..bb4a6d1b 100644 --- a/src/l298/l298.hpp +++ b/src/l298/l298.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library l298 * @sensor l298 - * @comname L298 Dual H-Bridge Motor Driver + * @comname Dual H-bridge Motor Driver * @type motor * @man seeed sparkfun * @web https://www.sparkfun.com/products/9670 diff --git a/src/l3gd20/CMakeLists.txt b/src/l3gd20/CMakeLists.txt index 5e5546f9..fbfa0db0 100644 --- a/src/l3gd20/CMakeLists.txt +++ b/src/l3gd20/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "l3gd20") -set (libdescription "L3gd20 sensor module") +set (libdescription "Tri-axis Digital Gyroscope") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/l3gd20/l3gd20.hpp b/src/l3gd20/l3gd20.hpp index c08c37bf..86442cac 100644 --- a/src/l3gd20/l3gd20.hpp +++ b/src/l3gd20/l3gd20.hpp @@ -49,10 +49,11 @@ namespace upm /** * @library l3gd20 * @sensor l3gd20 - * @comname L3GD20 Tri-axis Digital Gyroscope + * @comname Tri-axis Digital Gyroscope * @type gyroscope * @man stmicro * @con iio i2c + * @web http://www.st.com/en/mems-and-sensors/l3gd20.html * * @brief L3GD20 Tri-axis Digital Gyroscope API * diff --git a/src/lcd/CMakeLists.txt b/src/lcd/CMakeLists.txt index 737ec6b0..1192c99e 100644 --- a/src/lcd/CMakeLists.txt +++ b/src/lcd/CMakeLists.txt @@ -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) diff --git a/src/lcd/eboled.hpp b/src/lcd/eboled.hpp index 6ace07c2..11d42b69 100644 --- a/src/lcd/eboled.hpp +++ b/src/lcd/eboled.hpp @@ -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 diff --git a/src/lcd/jhd1313m1.hpp b/src/lcd/jhd1313m1.hpp index 335246a2..76f74770 100644 --- a/src/lcd/jhd1313m1.hpp +++ b/src/lcd/jhd1313m1.hpp @@ -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 diff --git a/src/lcd/lcm1602.hpp b/src/lcd/lcm1602.hpp index 49c20f7d..9f05d994 100644 --- a/src/lcd/lcm1602.hpp +++ b/src/lcd/lcm1602.hpp @@ -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 diff --git a/src/lcd/sainsmartks.hpp b/src/lcd/sainsmartks.hpp index 091ffeb4..6ce42fdd 100644 --- a/src/lcd/sainsmartks.hpp +++ b/src/lcd/sainsmartks.hpp @@ -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 diff --git a/src/lcd/ssd1306.hpp b/src/lcd/ssd1306.hpp index 52d226ea..d2fd15fe 100644 --- a/src/lcd/ssd1306.hpp +++ b/src/lcd/ssd1306.hpp @@ -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 diff --git a/src/lcd/ssd1308.hpp b/src/lcd/ssd1308.hpp index 13618da2..9ee90c05 100644 --- a/src/lcd/ssd1308.hpp +++ b/src/lcd/ssd1308.hpp @@ -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 * diff --git a/src/lcd/ssd1327.hpp b/src/lcd/ssd1327.hpp index 660b44ed..50157ed8 100644 --- a/src/lcd/ssd1327.hpp +++ b/src/lcd/ssd1327.hpp @@ -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 diff --git a/src/lcm1602/CMakeLists.txt b/src/lcm1602/CMakeLists.txt index ef24d663..954f8d1e 100644 --- a/src/lcm1602/CMakeLists.txt +++ b/src/lcm1602/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME lcm1602 - DESCRIPTION "LCD display driver for the LCM1602 controller for HD44780-based displays" + DESCRIPTION "LCD Display Driver for the LCM1602 Controller for HD44780-based Displays" C_HDR lcm1602.h C_SRC lcm1602.c CPP_HDR lcm1602.hpp diff --git a/src/lcm1602/lcm1602.hpp b/src/lcm1602/lcm1602.hpp index 5f017096..faae0d09 100644 --- a/src/lcm1602/lcm1602.hpp +++ b/src/lcm1602/lcm1602.hpp @@ -47,7 +47,7 @@ namespace upm /** * @library lcm1602 * @sensor lcm1602 - * @comname LCM1602 Display + * @comname LCD Display Driver for the LCM1602 Controller for HD44780-based Displays * @type display * @man adafruit sparkfun seeed * @web https://www.adafruit.com/datasheets/TC1602A-01T.pdf diff --git a/src/ldt0028/CMakeLists.txt b/src/ldt0028/CMakeLists.txt index e59db790..a077f77c 100644 --- a/src/ldt0028/CMakeLists.txt +++ b/src/ldt0028/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ldt0028 - DESCRIPTION "Piezo vibration sensor" + DESCRIPTION "Piezo Vibration Sensor" C_HDR ldt0028.h C_SRC ldt0028.c CPP_HDR ldt0028.hpp diff --git a/src/ldt0028/ldt0028.hpp b/src/ldt0028/ldt0028.hpp index 532d47f0..ac7c06b5 100644 --- a/src/ldt0028/ldt0028.hpp +++ b/src/ldt0028/ldt0028.hpp @@ -37,11 +37,12 @@ namespace upm { /** * @library ldt0028 * @sensor ldt0028 - * @comname LDT0-028 Piezo Vibration Sensor + * @comname Piezo Vibration Sensor * @altname Grove Piezo Vibration Sensor * @type flexfor * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-Piezo_Vibration_Sensor/ * * @brief API for LDT0-028 PZT film-based sensors, * such as a Grove Piezo Vibration sensor diff --git a/src/led/CMakeLists.txt b/src/led/CMakeLists.txt index d8a2346d..b627ec30 100644 --- a/src/led/CMakeLists.txt +++ b/src/led/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME led - DESCRIPTION "LED module" + DESCRIPTION "Light-emitting Diode (LED)" C_HDR led.h C_SRC led.c CPP_HDR led.hpp diff --git a/src/led/led.hpp b/src/led/led.hpp index 2fb92bd2..afc96baf 100644 --- a/src/led/led.hpp +++ b/src/led/led.hpp @@ -40,7 +40,7 @@ namespace upm { /** * @library ledlib * @sensor led - * @comname LED + * @comname Light-emitting Diode (LED) * @altname Grove LED * @type led * @man seeed diff --git a/src/light/CMakeLists.txt b/src/light/CMakeLists.txt index 6e2beb93..b6275ace 100644 --- a/src/light/CMakeLists.txt +++ b/src/light/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME light - DESCRIPTION "Analog light sensor" + DESCRIPTION "Analog Light Sensor" C_HDR light.h C_SRC light.c CPP_HDR light.hpp diff --git a/src/light/light.hpp b/src/light/light.hpp index 42efae24..4ba72354 100644 --- a/src/light/light.hpp +++ b/src/light/light.hpp @@ -34,7 +34,7 @@ namespace upm { /** * @library light * @sensor light - * @comname Light Sensor + * @comname Analog Light Sensor * @type light * @man seeed * @con analog diff --git a/src/linefinder/CMakeLists.txt b/src/linefinder/CMakeLists.txt index 96084829..193728f3 100644 --- a/src/linefinder/CMakeLists.txt +++ b/src/linefinder/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME linefinder - DESCRIPTION "Infrared (IR) based line finder" + DESCRIPTION "Infrared (IR) Based Line Finder" C_HDR linefinder.h C_SRC linefinder.c CPP_HDR linefinder.hpp diff --git a/src/linefinder/linefinder.hpp b/src/linefinder/linefinder.hpp index 44ef1dda..1751bbc4 100644 --- a/src/linefinder/linefinder.hpp +++ b/src/linefinder/linefinder.hpp @@ -35,10 +35,10 @@ namespace upm { /** * @library linefinder * @sensor linefinder - * @comname Line Finder + * @comname Infrared (IR) Based Line Finder * @altname Grove Line Finder, DFRobot Line Tracking sensor * @type color - * @man seeed, dfrobot + * @man seeed dfrobot * @con gpio * @kit robok * diff --git a/src/lm35/CMakeLists.txt b/src/lm35/CMakeLists.txt index 85c55a3c..8c653e5b 100644 --- a/src/lm35/CMakeLists.txt +++ b/src/lm35/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME lm35 - DESCRIPTION "Analog temperature sensor" + DESCRIPTION "Analog Temperature Sensor" C_HDR lm35.h C_SRC lm35.c CPP_HDR lm35.hpp diff --git a/src/lm35/lm35.hpp b/src/lm35/lm35.hpp index 438675ba..e891a483 100644 --- a/src/lm35/lm35.hpp +++ b/src/lm35/lm35.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library lm35 * @sensor lm35 - * @comname DFRobot LM35 Linear Temperature Sensor + * @comname Analog Temperature Sensor * @altname LM35 * @type temp * @man dfrobot diff --git a/src/lol/CMakeLists.txt b/src/lol/CMakeLists.txt index a71fa78a..44210d78 100644 --- a/src/lol/CMakeLists.txt +++ b/src/lol/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "lol") -set (libdescription "LoL Olimex LoL rev A") +set (libdescription "Lots of LEDs (LoL) Array Rev A") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/lol/lol.hpp b/src/lol/lol.hpp index a1ea32c8..8bd900cd 100644 --- a/src/lol/lol.hpp +++ b/src/lol/lol.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library lol * @sensor lol - * @comname Olimex LoL Array + * @comname Lots of LEDs (LoL) Array Rev A * @type display * @man adafruit * @con gpio diff --git a/src/loudness/CMakeLists.txt b/src/loudness/CMakeLists.txt index ea87cec2..35e5e466 100644 --- a/src/loudness/CMakeLists.txt +++ b/src/loudness/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME loudness - DESCRIPTION "Loudness sensor" + DESCRIPTION "Loudness Sensor" C_HDR loudness.h C_SRC loudness.c CPP_SRC loudness.cxx diff --git a/src/lp8860/CMakeLists.txt b/src/lp8860/CMakeLists.txt index 25f90387..2c1e4cf0 100644 --- a/src/lp8860/CMakeLists.txt +++ b/src/lp8860/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "lp8860") -set (libdescription "LED lighting controller") +set (libdescription "LED Lighting Controller") set (module_src ${libname}.cxx mraa-utils.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/lp8860/lp8860.hpp b/src/lp8860/lp8860.hpp index f563a38b..2991deea 100644 --- a/src/lp8860/lp8860.hpp +++ b/src/lp8860/lp8860.hpp @@ -42,11 +42,12 @@ namespace upm * * @library lp8860 * @sensor lp8860 - * @comname TI LP8860 LED lighting controller + * @comname LED Lighting Controller * @altname LP8860 * @type light * @man ti * @con i2c + * @web http://www.ti.com/product/LP8860-Q1 * @if ilightcontroller * */ diff --git a/src/lpd8806/CMakeLists.txt b/src/lpd8806/CMakeLists.txt index f7ed1780..e55c229d 100644 --- a/src/lpd8806/CMakeLists.txt +++ b/src/lpd8806/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "lpd8806") -set (libdescription "Digital RGB LED strip") +set (libdescription "Digital RGB LED Strip Controller") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/lpd8806/lpd8806.hpp b/src/lpd8806/lpd8806.hpp index 4fa57227..dd24c432 100644 --- a/src/lpd8806/lpd8806.hpp +++ b/src/lpd8806/lpd8806.hpp @@ -44,10 +44,11 @@ namespace upm { /** * @library lpd8806 * @sensor lpd8806 - * @comname LPD8806 RGB LED Strip Controller + * @comname Digital RGB LED Strip Controller * @type led * @man adafruit * @con spi + * @web https://www.adafruit.com/product/306 * * @brief API for the LPD8806 RGB LED Strip Controller * diff --git a/src/lsm303/CMakeLists.txt b/src/lsm303/CMakeLists.txt index 53b592f9..918f132e 100644 --- a/src/lsm303/CMakeLists.txt +++ b/src/lsm303/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "lsm303") -set (libdescription "Triaxial accelerometer/magnetometer") +set (libdescription "Triaxial Accelerometer/magnetometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/lsm303/lsm303.hpp b/src/lsm303/lsm303.hpp index adc1bfe5..b5ae6e70 100644 --- a/src/lsm303/lsm303.hpp +++ b/src/lsm303/lsm303.hpp @@ -69,7 +69,7 @@ namespace upm { /** * @library lsm303 * @sensor lsm303 - * @comname LSM303 Accelerometer & Compass + * @comname Triaxial Accelerometer/magnetometer * @altname Grove 6-Axis Accelerometer & Compass * @type accelerometer compass * @man seeed adafruit stmicro diff --git a/src/lsm9ds0/CMakeLists.txt b/src/lsm9ds0/CMakeLists.txt index 4cd3d831..e28488ee 100644 --- a/src/lsm9ds0/CMakeLists.txt +++ b/src/lsm9ds0/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "lsm9ds0") -set (libdescription "Gyro, accelerometer and magnometer sensor based on lsm9ds0") +set (libdescription "Triaxial Gyroscope/accelerometer/magnetometer Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/lsm9ds0/lsm9ds0.hpp b/src/lsm9ds0/lsm9ds0.hpp index 952a162c..b0454f6d 100644 --- a/src/lsm9ds0/lsm9ds0.hpp +++ b/src/lsm9ds0/lsm9ds0.hpp @@ -44,7 +44,7 @@ namespace upm { /** * @library lsm9ds0 * @sensor lsm9ds0 - * @comname LSM9DS0 3-axis Gyroscope, Accelerometer, and Magnetometer + * @comname Triaxial Gyroscope/accelerometer/magnetometer Sensor * @type accelerometer compass * @man sparkfun stmicro * @con i2c gpio diff --git a/src/m24lr64e/CMakeLists.txt b/src/m24lr64e/CMakeLists.txt index 3a740f8e..f7d4ec83 100644 --- a/src/m24lr64e/CMakeLists.txt +++ b/src/m24lr64e/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME m24lr64e - DESCRIPTION "Dynamic NFC/RFID tag module" + DESCRIPTION "Dynamic NFC/RFID Tag Module" C_HDR m24lr64e.h C_SRC m24lr64e.c CPP_HDR m24lr64e.hpp diff --git a/src/m24lr64e/m24lr64e.hpp b/src/m24lr64e/m24lr64e.hpp index ffdaf25b..c58af1e8 100644 --- a/src/m24lr64e/m24lr64e.hpp +++ b/src/m24lr64e/m24lr64e.hpp @@ -51,7 +51,7 @@ namespace upm { /** * @library m24lr64e * @sensor m24lr64e - * @comname Grove NFC Tag + * @comname Dynamic NFC/RFID Tag Module * @type other * @man seeed * @web http://www.seeedstudio.com/wiki/Grove_-_NFC_Tag diff --git a/src/max30100/CMakeLists.txt b/src/max30100/CMakeLists.txt index 7eb76482..31ff0c50 100644 --- a/src/max30100/CMakeLists.txt +++ b/src/max30100/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME max30100 - DESCRIPTION "Pulse oximeter and heart-rate sensor" + DESCRIPTION "Pulse Oximeter and Heart-rate Sensor" C_HDR max30100.h C_SRC max30100.c CPP_HDR max30100.hpp diff --git a/src/max31723/CMakeLists.txt b/src/max31723/CMakeLists.txt index 82462c3e..cdf7db74 100644 --- a/src/max31723/CMakeLists.txt +++ b/src/max31723/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "max31723") -set (libdescription "Very accurate temperature sensor") +set (libdescription "SPI/3-wire Digital Thermometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/max31723/max31723.hpp b/src/max31723/max31723.hpp index f71c4be6..2ce2b462 100644 --- a/src/max31723/max31723.hpp +++ b/src/max31723/max31723.hpp @@ -43,10 +43,11 @@ namespace upm { /** * @library max31723 * @sensor max31723 - * @comname MAX31723 Temperature Sensor + * @comname SPI/3-wire Digital Thermometer * @type temp * @man maxim * @con spi + * @web https://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/MAX31723.html * * @brief API for the MAX31723 Temperature Sensor * diff --git a/src/max31855/CMakeLists.txt b/src/max31855/CMakeLists.txt index d8ec0f79..9196e90f 100644 --- a/src/max31855/CMakeLists.txt +++ b/src/max31855/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "max31855") -set (libdescription "K type thermistor amplifier") +set (libdescription "Thermocouple-to-Digital Converter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/max31855/max31855.hpp b/src/max31855/max31855.hpp index bbd6af86..c895875e 100644 --- a/src/max31855/max31855.hpp +++ b/src/max31855/max31855.hpp @@ -37,10 +37,11 @@ namespace upm { /** * @library max31855 * @sensor max31855 - * @comname MAX31855 Thermocouple Amplifier + * @comname Thermocouple-to-Digital Converter * @type other * @man maxim adafruit * @con spi + * @web https://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/MAX31855.html * * @brief API for the MAX31855 Thermocouple Amplifier * diff --git a/src/max44000/CMakeLists.txt b/src/max44000/CMakeLists.txt index 35b17168..48a47020 100644 --- a/src/max44000/CMakeLists.txt +++ b/src/max44000/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "max44000") -set (libdescription "MAX44000") +set (libdescription "Ambient and Infrared Proximity Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/max44000/max44000.hpp b/src/max44000/max44000.hpp index fdd4e93a..f17d86d7 100644 --- a/src/max44000/max44000.hpp +++ b/src/max44000/max44000.hpp @@ -60,10 +60,11 @@ namespace upm { /** * @library max44000 * @sensor max44000 - * @comname MAX44000 Proximity Sensor + * @comname Ambient and Infrared Proximity Sensor * @type light * @man maxim * @con i2c + * @web https://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/MAX44000.html * * @brief API for the MAX44000 Ambient and Infrared Proximity Sensor * diff --git a/src/max44009/CMakeLists.txt b/src/max44009/CMakeLists.txt index 509be284..7ab5b1fa 100644 --- a/src/max44009/CMakeLists.txt +++ b/src/max44009/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "max44009") -set (libdescription "MAX44009") +set (libdescription "I2C Low-power Digital Ambient Light Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/max44009/max44009.hpp b/src/max44009/max44009.hpp index c0aaddb9..6574ab37 100644 --- a/src/max44009/max44009.hpp +++ b/src/max44009/max44009.hpp @@ -95,11 +95,12 @@ namespace upm { * * @library max44009 * @sensor max44009 - * @comname MAX44009 Ambient Light Sensor + * @comname I2C Low-power Digital Ambient Light Sensor * @altname MAX44009 * @type light * @man maxim * @con i2c + * @web https://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/MAX44009.html * @if ilightsensor * * @snippet iLightSensor.hpp Interesting diff --git a/src/max5487/CMakeLists.txt b/src/max5487/CMakeLists.txt index 16e21520..96fb4d38 100644 --- a/src/max5487/CMakeLists.txt +++ b/src/max5487/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "max5487") -set (libdescription "Digital potentiometer") +set (libdescription "Digital Potentiometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/max5487/max5487.hpp b/src/max5487/max5487.hpp index 287d30a4..4b906dce 100644 --- a/src/max5487/max5487.hpp +++ b/src/max5487/max5487.hpp @@ -42,10 +42,11 @@ namespace upm { /** * @library max5487 * @sensor max5487 - * @comname MAX5487 Digital Potentiometer + * @comname Digital Potentiometer * @type digipot * @man maxim * @con spi + * @web https://www.maximintegrated.com/en/products/analog/data-converters/digital-potentiometers/MAX5487.html * * @brief API for the MAX5487 SPI Digital Potentiometer * diff --git a/src/maxds3231m/CMakeLists.txt b/src/maxds3231m/CMakeLists.txt index d4b65e70..66f6e6f5 100644 --- a/src/maxds3231m/CMakeLists.txt +++ b/src/maxds3231m/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "maxds3231m") -set (libdescription "Realtime clock sensor from MAX family") +set (libdescription "Realtime Clock (RTC) Sensor Library") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/maxds3231m/maxds3231m.hpp b/src/maxds3231m/maxds3231m.hpp index 60dcf1e0..2a873127 100644 --- a/src/maxds3231m/maxds3231m.hpp +++ b/src/maxds3231m/maxds3231m.hpp @@ -70,10 +70,11 @@ struct Time3231 { /** * @library maxds3231m * @sensor maxds3231m - * @comname MAXDS3231M Real-Time Clock + * @comname Realtime Clock (RTC) Sensor Library * @type light * @man maxim * @con i2c + * @web https://www.maximintegrated.com/en/products/digital/real-time-clocks/DS3231.html * * @brief API for the MAXDS3231M I2C Real-Time Clock * diff --git a/src/maxsonarez/CMakeLists.txt b/src/maxsonarez/CMakeLists.txt index c85b7789..feae3914 100644 --- a/src/maxsonarez/CMakeLists.txt +++ b/src/maxsonarez/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "maxsonarez") -set (libdescription "MaxSonar EZ family of ultrasonic rangers") +set (libdescription "MaxSonar EZ Family of Ultrasonic Rangers") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mb704x/mb704x.hpp b/src/mb704x/mb704x.hpp index 138107c4..d648d236 100644 --- a/src/mb704x/mb704x.hpp +++ b/src/mb704x/mb704x.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library mb704x * @sensor mb704x - * @comname MB704x MaxSonar-WR Ultrasonic Ranger + * @comname I2C MaxSonar WR Ultrasonic Ranger * @altname MB7040 MB7047 MB7247 * @type sound * @man maxbotix diff --git a/src/mcp2515/CMakeLists.txt b/src/mcp2515/CMakeLists.txt index 92c40a45..4bd672c5 100644 --- a/src/mcp2515/CMakeLists.txt +++ b/src/mcp2515/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME mcp2515 - DESCRIPTION "CAN bus controller" + DESCRIPTION "CAN Bus Controller" C_HDR mcp2515.h mcp2515_regs.h C_SRC mcp2515.c CPP_HDR mcp2515.hpp diff --git a/src/mcp2515/mcp2515.hpp b/src/mcp2515/mcp2515.hpp index 49117e2d..d49ea19d 100644 --- a/src/mcp2515/mcp2515.hpp +++ b/src/mcp2515/mcp2515.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library mcp2515 * @sensor mcp2515 - * @comname MCP2515 CAN bus controller + * @comname CAN Bus Controller * @man seeed * @con spi gpio * @web https://www.seeedstudio.com/CANBUS-Shield-p-2256.html diff --git a/src/mcp9808/CMakeLists.txt b/src/mcp9808/CMakeLists.txt index 9e54e39f..306b1e83 100644 --- a/src/mcp9808/CMakeLists.txt +++ b/src/mcp9808/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mcp9808") -set (libdescription "Precision I2C temperature sensor") +set (libdescription "High Accuracy I2C Temperature Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mcp9808/mcp9808.hpp b/src/mcp9808/mcp9808.hpp index fba10262..3ccd4c22 100644 --- a/src/mcp9808/mcp9808.hpp +++ b/src/mcp9808/mcp9808.hpp @@ -50,7 +50,7 @@ namespace upm { /** * @library mcp9808 * @sensor MCP9808 - * @comname MCP9808 Temperature Sensor + * @comname High Accuracy I2C Temperature Sensor * @type temp * @man adafruit * @con i2c diff --git a/src/md/CMakeLists.txt b/src/md/CMakeLists.txt index 90f587b9..2cf99497 100644 --- a/src/md/CMakeLists.txt +++ b/src/md/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME md - DESCRIPTION "I2C motor driver" + DESCRIPTION "I2C Motor Driver" C_HDR md.h C_SRC md.c CPP_HDR md.hpp diff --git a/src/md/md.hpp b/src/md/md.hpp index f9bbf72d..ea77c23e 100644 --- a/src/md/md.hpp +++ b/src/md/md.hpp @@ -42,6 +42,7 @@ namespace upm { * @type motor * @man seeed * @con i2c + * @web http://wiki.seeed.cc/Grove-I2C_Motor_Driver_V1.3/ * @kit robok * * @brief API for the I2C Motor Driver diff --git a/src/mg811/CMakeLists.txt b/src/mg811/CMakeLists.txt index 8445ddde..1709499a 100644 --- a/src/mg811/CMakeLists.txt +++ b/src/mg811/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mg811") -set (libdescription "DFRobot CO2 sensor") +set (libdescription "CO2 Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mg811/mg811.hpp b/src/mg811/mg811.hpp index 7ded89d4..a629e822 100644 --- a/src/mg811/mg811.hpp +++ b/src/mg811/mg811.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library mg811 * @sensor mg811 - * @comname DFRobot CO2 Sensor + * @comname CO2 Sensor * @altname MG811 * @type gaseous * @man dfrobot diff --git a/src/mhz16/CMakeLists.txt b/src/mhz16/CMakeLists.txt index 1135d9bb..66373a61 100644 --- a/src/mhz16/CMakeLists.txt +++ b/src/mhz16/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mhz16") -set (libdescription "Grove CO2 sensor") +set (libdescription "CO2 Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mhz16/mhz16.hpp b/src/mhz16/mhz16.hpp index b23072c0..68ec14f6 100644 --- a/src/mhz16/mhz16.hpp +++ b/src/mhz16/mhz16.hpp @@ -56,11 +56,12 @@ namespace upm { /** * @library mhz16 * @sensor mhz16 - * @comname Grove CO2 Sensor + * @comname CO2 Sensor * @altname MHZ16 Serial CO2 Sensor * @type gaseous * @man seeed * @con uart + * @web http://wiki.seeed.cc/Grove-CO2_Sensor/ * * @brief API support for the Grove CO2 sensor * diff --git a/src/mic/CMakeLists.txt b/src/mic/CMakeLists.txt index 9331baf8..b9ecde37 100644 --- a/src/mic/CMakeLists.txt +++ b/src/mic/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME mic - DESCRIPTION "Simple analog microphone" + DESCRIPTION "Simple Analog Microphone" C_HDR mic.h C_SRC mic.c CPP_HDR mic.hpp diff --git a/src/mic/mic.hpp b/src/mic/mic.hpp index 3aeafbb1..065f6dec 100644 --- a/src/mic/mic.hpp +++ b/src/mic/mic.hpp @@ -43,7 +43,7 @@ namespace upm { /** * @library mic * @sensor microphone - * @comname Analog Microphone + * @comname Simple Analog Microphone * @altname Grove Sound Sensor * @type sound * @man seeed diff --git a/src/micsv89/CMakeLists.txt b/src/micsv89/CMakeLists.txt index 22e72069..9c9d126e 100644 --- a/src/micsv89/CMakeLists.txt +++ b/src/micsv89/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "micsv89") -set (libdescription "Micsv89 environmental sensor module") +set (libdescription "Low-power Air Quality Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/micsv89/micsv89.hpp b/src/micsv89/micsv89.hpp index 1b115178..918542f5 100644 --- a/src/micsv89/micsv89.hpp +++ b/src/micsv89/micsv89.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library micsv89 * @sensor micsv89 - * @comname MICS-VZ89 Gas Sensor + * @comname Low-power Air Quality Sensor * @type gaseous * @man generic * @con i2c diff --git a/src/mlx90614/CMakeLists.txt b/src/mlx90614/CMakeLists.txt index 04785a37..bde35e22 100644 --- a/src/mlx90614/CMakeLists.txt +++ b/src/mlx90614/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mlx90614") -set (libdescription "Infrared thermometer designed for non-contact emperature sensing") +set (libdescription "Digital No-contact Infrared Thermometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mlx90614/mlx90614.hpp b/src/mlx90614/mlx90614.hpp index 6242993c..d7b4ac6d 100644 --- a/src/mlx90614/mlx90614.hpp +++ b/src/mlx90614/mlx90614.hpp @@ -60,10 +60,11 @@ namespace upm { /** * @library mlx90614 * @sensor mlx90614 - * @comname MLX90614 Temperature Sensor + * @comname Digital No-contact Infrared Thermometer * @type temp * @man generic * @con i2c + * @web https://www.melexis.com/en/product/MLX90614/Digital-Plug-Play-Infrared-Thermometer-TO-Can * * @brief API for the MLX90614 Temperature Sensor * diff --git a/src/mma7361/CMakeLists.txt b/src/mma7361/CMakeLists.txt index a260afc0..a56cb728 100644 --- a/src/mma7361/CMakeLists.txt +++ b/src/mma7361/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME mma7361 - DESCRIPTION "Triaxial analog accelerometer" + DESCRIPTION "Triaxial Analog Accelerometer" C_HDR mma7361.h C_SRC mma7361.c CPP_HDR mma7361.hpp diff --git a/src/mma7361/mma7361.hpp b/src/mma7361/mma7361.hpp index 039d8549..f87cd685 100644 --- a/src/mma7361/mma7361.hpp +++ b/src/mma7361/mma7361.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library mma7361 * @sensor mma7361 - * @comname DFRobot MMA7361 Analog Accelerometer + * @comname Triaxial Analog Accelerometer * @type accelerometer * @man dfrobot * @con ainput gpio diff --git a/src/mma7455/CMakeLists.txt b/src/mma7455/CMakeLists.txt index fc2c2535..14e26920 100644 --- a/src/mma7455/CMakeLists.txt +++ b/src/mma7455/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mma7455") -set (libdescription "Freescale Semiconductor 3-axis accelerometer module") +set (libdescription "Three Axis +/- 2/4/8 g Digital Accelerometer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mma7455/mma7455.hpp b/src/mma7455/mma7455.hpp index e643decd..88172157 100644 --- a/src/mma7455/mma7455.hpp +++ b/src/mma7455/mma7455.hpp @@ -157,10 +157,11 @@ typedef union { /** * @library mma7455 * @sensor mma7455 - * @comname MMA7455 Accelerometer Sensor + * @comname Three Axis +/- 2/4/8 g Digital Accelerometer * @type accelerometer * @man generic * @con i2c + * @web http://www.nxp.com/products/sensors/accelerometers/3-axis-accelerometers/2g-4g-8g-low-g-digital-accelerometer:MMA745xL * * @brief API for the MMA7455 Accelerometer * diff --git a/src/mma7660/mma7660.hpp b/src/mma7660/mma7660.hpp index 16b4b8f9..48c12df6 100644 --- a/src/mma7660/mma7660.hpp +++ b/src/mma7660/mma7660.hpp @@ -35,11 +35,12 @@ namespace upm { /** * @library mma7660 * @sensor mma7660 - * @comname MMA7660 3-Axis Digital Accelerometer + * @comname I2C 3-axis Digital Accelerometer (1.5g) * @altname Grove 3-Axis Digital Accelerometer (1.5g) * @type accelerometer * @man seeed * @con i2c gpio + * @web http://www.nxp.com/products/sensors/accelerometers/3-axis-accelerometers/1.5g-low-g-digital-accelerometer:MMA7660FC * * @brief API for the MMA7660 I2C 3-Axis Digital Accelerometer * diff --git a/src/moisture/CMakeLists.txt b/src/moisture/CMakeLists.txt index ea719470..814e9e8a 100644 --- a/src/moisture/CMakeLists.txt +++ b/src/moisture/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME moisture - DESCRIPTION "Moisture sensor" + DESCRIPTION "Analog Moisture Sensor" C_HDR moisture.h C_SRC moisture.c CPP_HDR moisture.hpp diff --git a/src/moisture/moisture.hpp b/src/moisture/moisture.hpp index 4e424378..13d97dab 100644 --- a/src/moisture/moisture.hpp +++ b/src/moisture/moisture.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library moisture * @sensor moisture - * @comname Moisture Sensor + * @comname Analog Moisture Sensor * @altname Grove Moisture Sensor * @type liquid * @man seeed diff --git a/src/mpl3115a2/CMakeLists.txt b/src/mpl3115a2/CMakeLists.txt index d7594f21..ec8d5e91 100644 --- a/src/mpl3115a2/CMakeLists.txt +++ b/src/mpl3115a2/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mpl3115a2") -set (libdescription "Pressure/Temperature Sensor") +set (libdescription "I2C Precision Altimeter") set (module_src ${libname}.cpp) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/mpl3115a2/mpl3115a2.hpp b/src/mpl3115a2/mpl3115a2.hpp index 56ae8fdd..2d9c7d89 100644 --- a/src/mpl3115a2/mpl3115a2.hpp +++ b/src/mpl3115a2/mpl3115a2.hpp @@ -63,7 +63,7 @@ namespace upm { /** * @library mpl3115a2 * @sensor mpl3115a2 - * @comname MPL3115A2 Atmospheric Pressure Sensor + * @comname I2C Precision Altimeter * @type pressure * @man freescale * @web http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2 diff --git a/src/mpr121/CMakeLists.txt b/src/mpr121/CMakeLists.txt index 9f63f0fc..8a2e86ac 100644 --- a/src/mpr121/CMakeLists.txt +++ b/src/mpr121/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME mpr121 - DESCRIPTION "Digital capacitive touch sensor controller" + DESCRIPTION "Digital Capacitive Touch Sensor Controller" C_HDR mpr121.h C_SRC mpr121.c CPP_HDR mpr121.hpp diff --git a/src/mpr121/mpr121.hpp b/src/mpr121/mpr121.hpp index 3b01071b..e3bd7d04 100644 --- a/src/mpr121/mpr121.hpp +++ b/src/mpr121/mpr121.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library mpr121 * @sensor mpr121 - * @comname MPR121 Touch Sensor + * @comname Digital Capacitive Touch Sensor Controller * @altname Grove I2C Touch Sensor * @type touch * @man seeed diff --git a/src/mpu9150/CMakeLists.txt b/src/mpu9150/CMakeLists.txt index 47d0f952..73883445 100644 --- a/src/mpu9150/CMakeLists.txt +++ b/src/mpu9150/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "mpu9150") -set (libdescription "Gyro, acceleromter and magnometer sensor based on mpu9150") +set (libdescription "IMU Sensor Library Based On the Mpu9150") set (module_src ${libname}.cxx ak8975.cxx mpu60x0.cxx mpu9250.cxx) set (module_hpp ${libname}.hpp ak8975.hpp mpu60x0.hpp mpu9250.hpp) upm_module_init(mraa) diff --git a/src/mpu9150/ak8975.hpp b/src/mpu9150/ak8975.hpp index ba9788cd..0f7c9312 100644 --- a/src/mpu9150/ak8975.hpp +++ b/src/mpu9150/ak8975.hpp @@ -31,21 +31,22 @@ #define AK8975_DEFAULT_I2C_ADDR 0x0c namespace upm { - + /** * @library mpu9150 * @sensor ak8975 - * @comname AK8975 3-axis Magnetometer + * @comname 3-axis Magnetometer * @altname AK9875 * @type compass * @man seeed * @con i2c + * @web http://www.akm.com/akm/en/file/datasheet/AK8975.pdf * * @brief API for the AK8975 magnetometer * * This is a 3-axis magnetometer, which can be used alone, or * coupled with another device (such as the mcu9150 9-axis motion - * sensor). + * sensor). * * @snippet ak8975.cxx Interesting */ @@ -90,14 +91,14 @@ namespace upm { REG_ASAY = 0x11, REG_ASAZ = 0x12 } AK8975_REG_T; - + /** * ST1 bits */ typedef enum { ST1_DRDY = 0x01 // data ready bit } ST1_BITS_T; - + /** * ST2 bits */ @@ -105,7 +106,7 @@ namespace upm { ST2_DERR = 0x04, // data error ST2_HOFL = 0x08 // measurement overflow } ST2_BITS_T; - + /** * CNTL register, operating mode values */ @@ -115,7 +116,7 @@ namespace upm { CNTL_SELFTEST = 0x08, CNTL_FUSE_ACCESS = 0x0f // access fuse (coeff) registers } CNTL_MODES_T; - + /** * ASTC (self test control) bits */ @@ -135,7 +136,7 @@ namespace upm { * AK8975 Destructor */ ~AK8975(); - + /** * set up initial values and start operation * @@ -209,7 +210,7 @@ namespace upm { * that was read and stored at init() time. * * @param value the raw axis value to compensate - * @param adj the adjustment coefficient + * @param adj the adjustment coefficient * @return true if successful */ float adjustValue(float value, float adj); diff --git a/src/mpu9150/mpu60x0.hpp b/src/mpu9150/mpu60x0.hpp index 02f3195e..8269f823 100644 --- a/src/mpu9150/mpu60x0.hpp +++ b/src/mpu9150/mpu60x0.hpp @@ -33,14 +33,15 @@ #define MPU60X0_DEFAULT_I2C_ADDR 0x68 namespace upm { - + /** * @library mpu9150 * @sensor mpu60x0 - * @comname MPU60X0 3-axis Gyroscope and 3-axis Accelerometer + * @comname 3-axis Gyroscope and 3-axis Accelerometer * @type accelerometer compass * @man seeed * @con i2c gpio + * @web https://www.invensense.com/products/motion-tracking/6-axis/mpu-6050/ * * @brief API for the MPU60X0 3-axis Gyroscope and 3-axis Accelerometer * @@ -206,7 +207,7 @@ namespace upm { REG_WHO_AM_I = 0x75 } MPU60X0_REG_T; - + /** * CONFIG bits */ @@ -402,7 +403,7 @@ namespace upm { * MST_DLY is not enumerated in the register map. It configures * the reduced access rate of i2c slaves relative to the sample * rate. When a slave's access rate is decreased relative to the - * Sample Rate, the slave is accessed every + * Sample Rate, the slave is accessed every * 1 / (1 + I2C_MST_DLY) samples */ typedef enum { @@ -433,7 +434,7 @@ namespace upm { I2C_SLV4_DONE = 0x40, PASS_THROUGH = 0x80 } I2C_MST_STATUS_BITS_T; - + /** * REG_INT_PIN_CFG bits */ @@ -452,7 +453,7 @@ namespace upm { INT_OPEN = 0x40, INT_LEVEL = 0x80 } INT_PIN_CFG_BITS_T; - + /** * REG_INT_ENABLE bits */ @@ -469,7 +470,7 @@ namespace upm { MOT_EN = 0x40, FF_EN = 0x80 // *freefall } INT_ENABLE_BITS_T; - + /** * REG_INT_STATUS bits */ @@ -486,7 +487,7 @@ namespace upm { MOT_INT = 0x40, FF_INT = 0x80 // *freefall } INT_STATUS_BITS_T; - + /** * REG_MOT_DETECT_STATUS bits (mpu9150 only) */ @@ -504,7 +505,7 @@ namespace upm { MOT_XPOS = 0x40, // * MOT_XNEG = 0x80, // * } MOT_DETECT_STATUS_BITS_T; - + /** * REG_MST_DELAY_CTRL bits */ @@ -519,7 +520,7 @@ namespace upm { DELAY_ES_SHADOW = 0x80 } MST_DELAY_CTRL_BITS_T; - + /** * REG_SIGNAL_PATH_RESET bits */ @@ -530,7 +531,7 @@ namespace upm { // 0x08-0x80 reserved } SIGNAL_PATH_RESET_BITS_T; - + /** * REG_MOT_DETECT_CTRL bits */ @@ -551,7 +552,7 @@ namespace upm { _ACCEL_ON_DELAY_MASK = 3 // 0x40,0x80 reserved } MOT_DETECT_CTRL_BITS_T; - + /** * MOT_COUNT or FF_COUNT values (mpu9150 only) */ @@ -588,7 +589,7 @@ namespace upm { /// 0x80 reserved } USER_CTRL_BITS_T; - + /** * REG_PWR_MGMT_1 bits */ @@ -607,7 +608,7 @@ namespace upm { PWR_SLEEP = 0x40, DEVICE_RESET = 0x80 } PWR_MGMT_1_BITS_T; - + /** * CLKSEL values */ @@ -638,7 +639,7 @@ namespace upm { _LP_WAKE_CTRL_SHIFT = 6, _LP_WAKE_CTRL_MASK = 3 } PWR_MGMT_2_BITS_T; - + /** * LP_WAKE_CTRL values */ @@ -905,7 +906,7 @@ namespace upm { * @return bitmask of INT_PIN_CFG_BITS_T values */ uint8_t getInterruptPinConfig(); - + /** * install an interrupt handler. * diff --git a/src/mpu9150/mpu9150.hpp b/src/mpu9150/mpu9150.hpp index b85e5d6f..e83bffc1 100644 --- a/src/mpu9150/mpu9150.hpp +++ b/src/mpu9150/mpu9150.hpp @@ -42,7 +42,7 @@ namespace upm { /** * @library mpu9150 * @sensor mpu9150 - * @comname MPU9150 Inertial Measurement Unit + * @comname Inertial Measurement Unit * @altname Grove IMU 9DOF * @type accelerometer compass * @man seeed diff --git a/src/mpu9150/mpu9250.hpp b/src/mpu9150/mpu9250.hpp index cda71ed1..97836b37 100644 --- a/src/mpu9150/mpu9250.hpp +++ b/src/mpu9150/mpu9250.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library mpu9150 * @sensor mpu9250 - * @comname MPU9250 Inertial Measurement Unit + * @comname Inertial Measurement Unit * @altname Grove IMU 9DOF V2 * @type accelerometer compass * @man seeed diff --git a/src/mq303a/CMakeLists.txt b/src/mq303a/CMakeLists.txt index 2d2bab76..2df76fbe 100644 --- a/src/mq303a/CMakeLists.txt +++ b/src/mq303a/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME mq303a - DESCRIPTION "Alcohol detection sensor" + DESCRIPTION "Alcohol Detection Sensor" C_HDR mq303a.h C_SRC mq303a.c CPP_HDR mq303a.hpp diff --git a/src/mq303a/mq303a.hpp b/src/mq303a/mq303a.hpp index 41e5c3be..43220b67 100644 --- a/src/mq303a/mq303a.hpp +++ b/src/mq303a/mq303a.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library mq303a * @sensor mq303a - * @comname MQ303A Alcohol Sensor + * @comname Alcohol Detection Sensor * @altname Grove Alcohol Sensor * @type gaseous * @man seeed diff --git a/src/ms5611/CMakeLists.txt b/src/ms5611/CMakeLists.txt index fa48006b..14ec6244 100644 --- a/src/ms5611/CMakeLists.txt +++ b/src/ms5611/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ms5611") -set (libdescription "Pressure and temperature sensor") +set (libdescription "Barometric Pressure and Temperature Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/ms5611/ms5611.hpp b/src/ms5611/ms5611.hpp index 094e811d..1e861280 100644 --- a/src/ms5611/ms5611.hpp +++ b/src/ms5611/ms5611.hpp @@ -39,11 +39,12 @@ namespace upm /** * @library ms5611 * @sensor ms5611 - * @comname Meas-Spec MS5611 Barometric Pressure Sensor library + * @comname Barometric Pressure and Temperature Sensor * @altname MS5611 * @type temp pressure * @man meas * @con i2c + * @web http://www.amsys.info/products/ms5611.htm * @if ipressuresensor itemperaturesensor * * @brief API for MS5611 Barometric Pressure Sensor library diff --git a/src/ms5803/CMakeLists.txt b/src/ms5803/CMakeLists.txt index d9b611d2..d4d0921c 100644 --- a/src/ms5803/CMakeLists.txt +++ b/src/ms5803/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ms5803 - DESCRIPTION "MS5803 Pressure and temperature sensor" + DESCRIPTION "I2C Barometric Pressure and Temperature Sensor" C_HDR ms5803.h ms5803_defs.h C_SRC ms5803.c CPP_HDR ms5803.hpp diff --git a/src/ms5803/ms5803.hpp b/src/ms5803/ms5803.hpp index 9342c829..4cc9c0ca 100644 --- a/src/ms5803/ms5803.hpp +++ b/src/ms5803/ms5803.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library ms5803 * @sensor ms5803 - * @comname MS5803 Pressure and Temperature sensor + * @comname I2C Barometric Pressure and Temperature Sensor * @type temperature pressure * @man sparkfun * @con i2c spi diff --git a/src/my9221/CMakeLists.txt b/src/my9221/CMakeLists.txt index 8ecb01f1..5ab50fdc 100644 --- a/src/my9221/CMakeLists.txt +++ b/src/my9221/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME my9221 - DESCRIPTION "12-channel constant current LED driver with grayscale" + DESCRIPTION "12-channel Constant Current LED Driver with Grayscale" C_HDR my9221.h C_SRC my9221.c CPP_HDR my9221.hpp groveledbar.hpp grovecircularled.hpp diff --git a/src/my9221/grovecircularled.hpp b/src/my9221/grovecircularled.hpp index d12f0deb..33e11d4c 100644 --- a/src/my9221/grovecircularled.hpp +++ b/src/my9221/grovecircularled.hpp @@ -44,7 +44,7 @@ namespace upm { /** * @library my9221 * @sensor grovecircularled - * @comname Grove Circular LED + * @comname Circular LED * @type display * @man seeed * @web http://www.seeedstudio.com/wiki/Grove_-_Circular_LED diff --git a/src/my9221/groveledbar.hpp b/src/my9221/groveledbar.hpp index 3891475f..d585ed91 100644 --- a/src/my9221/groveledbar.hpp +++ b/src/my9221/groveledbar.hpp @@ -45,7 +45,7 @@ namespace upm { /** * @library my9221 * @sensor groveledbar - * @comname Grove LED Bar + * @comname LED Bar * @altname MY9221 LED Bar * @type display * @man seeed diff --git a/src/nlgpio16/CMakeLists.txt b/src/nlgpio16/CMakeLists.txt index 67eeb856..9df9e78e 100644 --- a/src/nlgpio16/CMakeLists.txt +++ b/src/nlgpio16/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "nlgpio16") -set (libdescription "Module for the Numato Labs GPIO 16 USB") +set (libdescription "16-channel USB GPIO Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/nlgpio16/nlgpio16.hpp b/src/nlgpio16/nlgpio16.hpp index fa65276f..9925c870 100644 --- a/src/nlgpio16/nlgpio16.hpp +++ b/src/nlgpio16/nlgpio16.hpp @@ -54,7 +54,7 @@ namespace upm { /** * @library nlgpio16 * @sensor nlgpio16 - * @comname NLGPIO16 16 channel USB GPIO Module + * @comname 16-channel USB GPIO Module * @type other * @man numatolabs * @con uart diff --git a/src/nmea_gps/CMakeLists.txt b/src/nmea_gps/CMakeLists.txt index 0d78db56..8ce6ffc8 100644 --- a/src/nmea_gps/CMakeLists.txt +++ b/src/nmea_gps/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME nmea_gps - DESCRIPTION "Generic driver for GPS NMEA sensors" + DESCRIPTION "Generic Serial Interface for GPS NMEA Devices" C_HDR nmea_gps.h C_SRC nmea_gps.c CPP_HDR nmea_gps.hpp diff --git a/src/nmea_gps/nmea_gps.hpp b/src/nmea_gps/nmea_gps.hpp index a155610c..52123fad 100644 --- a/src/nmea_gps/nmea_gps.hpp +++ b/src/nmea_gps/nmea_gps.hpp @@ -41,9 +41,9 @@ namespace upm { /** * @library nmea_gps * @sensor nmea_gps - * @comname Generic Serial GPS NMEA device + * @comname Generic Serial Interface for GPS NMEA Devices * @type gps - * @man dfrobot seed + * @man dfrobot seeed * @con uart gpio * @altname VK2828u7 ublox LEA-6H * diff --git a/src/nrf24l01/CMakeLists.txt b/src/nrf24l01/CMakeLists.txt index a09b0140..87da4bd4 100644 --- a/src/nrf24l01/CMakeLists.txt +++ b/src/nrf24l01/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "nrf24l01") -set (libdescription "NRF tx/rx") +set (libdescription "NRF Transceiver") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/nrf24l01/nrf24l01.hpp b/src/nrf24l01/nrf24l01.hpp index d73e2199..89194a60 100644 --- a/src/nrf24l01/nrf24l01.hpp +++ b/src/nrf24l01/nrf24l01.hpp @@ -169,7 +169,7 @@ typedef enum { /** * @library nrf24l01 * @sensor nrf24l01 - * @comname NRF24L01 Transceiver + * @comname NRF Transceiver * @type wifi * @man seeed sparkfun * @web http://www.seeedstudio.com/depot/nRF24L01Module-p-1394.html diff --git a/src/nrf8001/CMakeLists.txt b/src/nrf8001/CMakeLists.txt index a721d237..5ff23528 100644 --- a/src/nrf8001/CMakeLists.txt +++ b/src/nrf8001/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "nrf8001") -set (libdescription "BLE module from NordicSemiconductor family") +set (libdescription "Bluetooth Low Energy (BLE) Module") set (module_src hal_aci_tl.cpp aci_setup.cpp aci_queue.cpp acilib.cpp lib_aci.cpp ${libname}.cxx) set (module_hpp hal_aci_tl.h aci_setup.h aci_queue.h acilib.h lib_aci.h ${libname}.hpp) upm_module_init(mraa) diff --git a/src/nrf8001/nrf8001.hpp b/src/nrf8001/nrf8001.hpp index 5681e5c0..6cab4a39 100644 --- a/src/nrf8001/nrf8001.hpp +++ b/src/nrf8001/nrf8001.hpp @@ -30,7 +30,7 @@ /** * @library nrf8001 * @sensor nrf8001 - * @comname NRF8001 Bluetooth Low Energy + * @comname Bluetooth Low Energy (BLE) Module * @type wifi * @man adafruit * @web https://learn.adafruit.com/getting-started-with-the-nrf8001-bluefruit-le-breakout/introduction diff --git a/src/nunchuck/CMakeLists.txt b/src/nunchuck/CMakeLists.txt index 584c148e..e47cbdaf 100644 --- a/src/nunchuck/CMakeLists.txt +++ b/src/nunchuck/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME nunchuck - DESCRIPTION "I2C nunchuck driver" + DESCRIPTION "Wii Nunchuk" C_HDR nunchuck.h C_SRC nunchuck.c CPP_HDR nunchuck.hpp diff --git a/src/o2/CMakeLists.txt b/src/o2/CMakeLists.txt index 82d418d1..1d36e446 100644 --- a/src/o2/CMakeLists.txt +++ b/src/o2/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME o2 - DESCRIPTION "Oxygen (O2) concentration sensor" + DESCRIPTION "Oxygen (O2) Concentration Sensor" C_HDR o2.h C_SRC o2.c CPP_HDR o2.hpp diff --git a/src/o2/o2.hpp b/src/o2/o2.hpp index 7a045b55..47f85779 100644 --- a/src/o2/o2.hpp +++ b/src/o2/o2.hpp @@ -36,11 +36,12 @@ namespace upm { /** * @library o2 * @sensor o2 - * @comname O2 Sensor + * @comname Oxygen (O2) Concentration Sensor * @altname Grove O2 Sensor * @type gaseous * @man seeed * @con analog + * @web http://wiki.seeed.cc/Grove-Gas_Sensor-O2/ * * @brief API for the Grove O2 Oxygen Gas Sensor * diff --git a/src/otp538u/CMakeLists.txt b/src/otp538u/CMakeLists.txt index fbb84967..3fcd8228 100644 --- a/src/otp538u/CMakeLists.txt +++ b/src/otp538u/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME otp538u - DESCRIPTION "OTP538U Analog IR temperature sensor" + DESCRIPTION "Analog IR Temperature Sensor" C_HDR otp538u.h C_SRC otp538u.c CPP_HDR otp538u.hpp diff --git a/src/otp538u/otp538u.hpp b/src/otp538u/otp538u.hpp index 1572bdc5..e83aebf0 100644 --- a/src/otp538u/otp538u.hpp +++ b/src/otp538u/otp538u.hpp @@ -36,11 +36,12 @@ namespace upm { /** * @library otp538u * @sensor otp538u - * @comname OTP538U IR Temperature Sensor + * @comname Analog IR Temperature Sensor * @altname Grove IR Temperature Sensor * @type light * @man generic * @con analog + * @web http://wiki.seeed.cc/Grove-Infrared_Temperature_Sensor/ * @kit hak * * @brief API for the OTP538U IR Temperature Sensor diff --git a/src/ozw/CMakeLists.txt b/src/ozw/CMakeLists.txt index b177e88a..7c9b8d12 100644 --- a/src/ozw/CMakeLists.txt +++ b/src/ozw/CMakeLists.txt @@ -1,6 +1,6 @@ if (OPENZWAVE_FOUND) set (libname "ozw") - set (libdescription "Module for the OpenZWave library interface") + set (libdescription "Module for the OpenZWave Library Interface") set (module_src ${libname}.cxx zwNode.cxx ozwinterface.cxx ozwdump.cxx aeotecss6.cxx aeotecsdg2.cxx aeotecdw2e.cxx aeotecdsb09104.cxx tzemt400.cxx) set (module_hpp ${libname}.hpp ozwinterface.hpp ozwdump.hpp aeotecss6.hpp aeotecsdg2.hpp aeotecdw2e.hpp aeotecdsb09104.hpp tzemt400.hpp) diff --git a/src/ozw/aeotecdsb09104.hpp b/src/ozw/aeotecdsb09104.hpp index 8bb17985..0a5146c5 100644 --- a/src/ozw/aeotecdsb09104.hpp +++ b/src/ozw/aeotecdsb09104.hpp @@ -32,7 +32,11 @@ namespace upm { /** * @library ozw * @comname Aeotec Home Energy Meter Gen 1 + * @sensor dsb09104 + * @type wifi * @con uart + * @man aeon + * @web http://aeotec.com/z-wave-home-energy-measure/918-home-energy-meter-instructions.html * * @brief UPM API for Aeotec Home Energy Meter Gen 1 * diff --git a/src/ozw/aeotecdw2e.hpp b/src/ozw/aeotecdw2e.hpp index fe4c2425..207288f8 100644 --- a/src/ozw/aeotecdw2e.hpp +++ b/src/ozw/aeotecdw2e.hpp @@ -31,9 +31,13 @@ namespace upm { /** * @library ozw + * @sensor DSB29 * @comname Aeotec Door/Window Sensor 2nd Edition * @altname DSB29 + * @type wifi * @con uart + * @man aeon + * @web http://aeotec.com/z-wave-door-window-sensor * * @brief UPM API for Aeotec Door/Window Sensor 2nd Edition * diff --git a/src/ozw/aeotecsdg2.hpp b/src/ozw/aeotecsdg2.hpp index 89ef0b87..71da7bbe 100644 --- a/src/ozw/aeotecsdg2.hpp +++ b/src/ozw/aeotecsdg2.hpp @@ -31,8 +31,12 @@ namespace upm { /** * @library ozw + * @sensor dg2 * @comname Aeotec Smart Dimmer Gen 2 * @con uart + * @type wifi + * @man aeon + * @web http://aeotec.com/z-wave-in-wall-switches/877-micro-sei-2e-manual-instructions.html * * @brief UPM API for Aeotec Smart Dimmer Gen 2 * diff --git a/src/ozw/aeotecss6.hpp b/src/ozw/aeotecss6.hpp index 3ec9bdac..a0b978b2 100644 --- a/src/ozw/aeotecss6.hpp +++ b/src/ozw/aeotecss6.hpp @@ -31,8 +31,12 @@ namespace upm { /** * @library ozw + * @sensor ss6 * @comname Aeotec Smart Switch 6 * @con uart + * @type wifi + * @man aeon + * @web http://aeotec.com/z-wave-plug-in-switch * * @brief UPM API for Aeotec Smart Switch 6 * diff --git a/src/ozw/ozw.hpp b/src/ozw/ozw.hpp index b3a51caf..53b3ab81 100644 --- a/src/ozw/ozw.hpp +++ b/src/ozw/ozw.hpp @@ -45,7 +45,7 @@ namespace upm { /** * @library ozw * @sensor ozw - * @comname UPM wrapper for the OpenZWave library + * @comname Wrapper for the OpenZWave Library * @type wifi * @man other * @con uart diff --git a/src/ozw/ozwdump.hpp b/src/ozw/ozwdump.hpp index 5e1d65f8..dc90d5db 100644 --- a/src/ozw/ozwdump.hpp +++ b/src/ozw/ozwdump.hpp @@ -31,7 +31,7 @@ namespace upm { /** * @library ozw - * @comname UPM Interface API for ozwdump + * @comname Interface API for Ozwdump * @con uart * * @brief UPM Utility driver for OZW. diff --git a/src/ozw/tzemt400.hpp b/src/ozw/tzemt400.hpp index d4b666f3..66d7c0d2 100644 --- a/src/ozw/tzemt400.hpp +++ b/src/ozw/tzemt400.hpp @@ -31,8 +31,10 @@ namespace upm { /** * @library ozw + * @sensor tzemt400 * @comname Trane TZEMT400 Z-Wave Thermostat. * @con uart + * @man trane * * @brief UPM API for Trane TZEMT400 Z-Wave Thermostat * diff --git a/src/pca9685/CMakeLists.txt b/src/pca9685/CMakeLists.txt index 0579a184..71b509c3 100644 --- a/src/pca9685/CMakeLists.txt +++ b/src/pca9685/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "pca9685") -set (libdescription "Pca9685 I2C 16ch, 12b pwm, LED controller") +set (libdescription "I2C 16-channel 12-bit PWM LED Controller") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/pca9685/pca9685.hpp b/src/pca9685/pca9685.hpp index 64ed0d0c..2bfba356 100644 --- a/src/pca9685/pca9685.hpp +++ b/src/pca9685/pca9685.hpp @@ -46,7 +46,7 @@ namespace upm { /** * @library pca9685 * @sensor pca9685 - * @comname PCA9685 PWM Controller + * @comname I2C 16-channel 12-bit PWM LED Controller * @type led motor * @man adafruit * @web http://www.adafruit.com/products/815 diff --git a/src/pn532/CMakeLists.txt b/src/pn532/CMakeLists.txt index bea5d962..cb37f285 100644 --- a/src/pn532/CMakeLists.txt +++ b/src/pn532/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "pn532") -set (libdescription "Pn532 NFC/RFID reader/writer") +set (libdescription "NFC/RFID Reader/Writer") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/pn532/pn532.hpp b/src/pn532/pn532.hpp index f5bfb85f..9e5a1cfb 100644 --- a/src/pn532/pn532.hpp +++ b/src/pn532/pn532.hpp @@ -58,7 +58,7 @@ namespace upm { /** * @library pn532 * @sensor pn532 - * @comname PN532 NFC/RFID reader/writer + * @comname NFC/RFID Reader/Writer * @type rfid * @man adafruit * @web http://www.adafruit.com/products/364 diff --git a/src/ppd42ns/CMakeLists.txt b/src/ppd42ns/CMakeLists.txt index f16272d6..9a9363da 100644 --- a/src/ppd42ns/CMakeLists.txt +++ b/src/ppd42ns/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ppd42ns - DESCRIPTION "PPD42NS Dust Sensor" + DESCRIPTION "Dust Sensor" C_HDR ppd42ns.h ppd42ns_data.h C_SRC ppd42ns.c CPP_HDR ppd42ns.hpp diff --git a/src/ppd42ns/ppd42ns.hpp b/src/ppd42ns/ppd42ns.hpp index 2db26ba9..bac408af 100644 --- a/src/ppd42ns/ppd42ns.hpp +++ b/src/ppd42ns/ppd42ns.hpp @@ -37,7 +37,7 @@ namespace upm { /** * @library ppd42ns * @sensor ppd42ns - * @comname PPD42NS Dust Sensor + * @comname Dust Sensor * @altname Grove Dust Sensor * @type other * @man seeed diff --git a/src/pulsensor/CMakeLists.txt b/src/pulsensor/CMakeLists.txt index 7785be32..10e11dbd 100644 --- a/src/pulsensor/CMakeLists.txt +++ b/src/pulsensor/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "pulsensor") -set (libdescription "3-Wire pulse sensor") +set (libdescription "3-wire Pulse Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/pulsensor/pulsensor.hpp b/src/pulsensor/pulsensor.hpp index 8193945f..3779d976 100644 --- a/src/pulsensor/pulsensor.hpp +++ b/src/pulsensor/pulsensor.hpp @@ -62,7 +62,7 @@ namespace upm { /** * @library pulsensor * @sensor pulsensor - * @comname Pulse Sensor + * @comname 3-wire Pulse Sensor * @type medical * @man seeed * @web http://www.adafruit.com/products/1093 diff --git a/src/relay/CMakeLists.txt b/src/relay/CMakeLists.txt index e7f23ba2..a63573f7 100644 --- a/src/relay/CMakeLists.txt +++ b/src/relay/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME relay - DESCRIPTION "Relay module" + DESCRIPTION "Relay" C_HDR relay.h C_SRC relay.c CPP_HDR relay.hpp diff --git a/src/rf22/CMakeLists.txt b/src/rf22/CMakeLists.txt index 1c23cbd1..445d7950 100644 --- a/src/rf22/CMakeLists.txt +++ b/src/rf22/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "rf22") -set (libdescription "HopeRF RFM22B ISM Band Radio Module") +set (libdescription "ISM Band Radio Transceiver") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/rf22/rf22.hpp b/src/rf22/rf22.hpp index ca686be3..8a50ce0f 100644 --- a/src/rf22/rf22.hpp +++ b/src/rf22/rf22.hpp @@ -404,7 +404,7 @@ namespace upm { /** * @library rf22 * @sensor rf22 - * @comname RF22 Transceiver + * @comname ISM Band Radio Transceiver * @altname RFM22B * @type wifi * @man sparkfun diff --git a/src/rfr359f/CMakeLists.txt b/src/rfr359f/CMakeLists.txt index 57d6e1b5..bb7baba5 100644 --- a/src/rfr359f/CMakeLists.txt +++ b/src/rfr359f/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "rfr359f") -set (libdescription "Rfr359f grove distance interrupter") +set (libdescription "Infrared Distance Interrupter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/rfr359f/rfr359f.hpp b/src/rfr359f/rfr359f.hpp index 862574bc..eeb95dc9 100644 --- a/src/rfr359f/rfr359f.hpp +++ b/src/rfr359f/rfr359f.hpp @@ -36,11 +36,11 @@ namespace upm { /** * @library rfr359f * @sensor rfr359f - * @comname RFR359F Distance Interrupter + * @comname Infrared Distance Interrupter * @altname Grove Distance Interrupter * @type light * @man seeed - * @web http://www.seeedstudio.com/wiki/Grove_-_IR_Distance_Interrupt + * @web https://www.seeedstudio.com/Grove-IR-Distance-Interrupter-p-1278.html * @con gpio * @kit robok tsk * diff --git a/src/rgbringcoder/CMakeLists.txt b/src/rgbringcoder/CMakeLists.txt index 1b0b142b..75cdbce5 100644 --- a/src/rgbringcoder/CMakeLists.txt +++ b/src/rgbringcoder/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "rgbringcoder") -set (libdescription "Sparkfun RGB RingCoder") +set (libdescription "RGB RingCoder") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/rgbringcoder/rgbringcoder.hpp b/src/rgbringcoder/rgbringcoder.hpp index 1970f7b5..3813fb78 100644 --- a/src/rgbringcoder/rgbringcoder.hpp +++ b/src/rgbringcoder/rgbringcoder.hpp @@ -43,7 +43,7 @@ namespace upm { /** * @library rgbringcoder * @sensor rgbringcoder - * @comname SparkFun RGB Ringcoder + * @comname RGB RingCoder * @type led * @web https://www.sparkfun.com/products/11040 * @man sparkfun diff --git a/src/rhusb/CMakeLists.txt b/src/rhusb/CMakeLists.txt index 724bb9e6..0aaa9f1a 100644 --- a/src/rhusb/CMakeLists.txt +++ b/src/rhusb/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "rhusb") -set (libdescription "Module for the Omega RH-USB sensor") +set (libdescription "Omega RH-USB Temperature and Humidity Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/rotary/CMakeLists.txt b/src/rotary/CMakeLists.txt index d3c8400f..4c6289ad 100644 --- a/src/rotary/CMakeLists.txt +++ b/src/rotary/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME rotary - DESCRIPTION "Relay angle sensor" + DESCRIPTION "Rotary Angle Sensor" C_HDR rotary.h C_SRC rotary.c CPP_HDR rotary.hpp diff --git a/src/rotary/rotary.hpp b/src/rotary/rotary.hpp index 3b0208e9..ed716aa3 100644 --- a/src/rotary/rotary.hpp +++ b/src/rotary/rotary.hpp @@ -46,6 +46,7 @@ namespace upm { * @altname Rotary Potentiometer * @type ainput * @man seeed + * @web http://wiki.seeed.cc/Grove-Rotary_Angle_Sensor/ * @con analog * @kit gsk * diff --git a/src/rotaryencoder/CMakeLists.txt b/src/rotaryencoder/CMakeLists.txt index b766ed05..473e5a97 100644 --- a/src/rotaryencoder/CMakeLists.txt +++ b/src/rotaryencoder/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME rotaryencoder - DESCRIPTION "Rotary encoder" + DESCRIPTION "Rotary Encoder" C_HDR rotaryencoder.h C_SRC rotaryencoder.c CPP_HDR rotaryencoder.hpp diff --git a/src/rotaryencoder/rotaryencoder.hpp b/src/rotaryencoder/rotaryencoder.hpp index 63f70e0e..3c2c0b14 100644 --- a/src/rotaryencoder/rotaryencoder.hpp +++ b/src/rotaryencoder/rotaryencoder.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library rotaryencoder * @sensor rotaryencoder - * @comname Grove Rotary Encoder + * @comname Rotary Encoder * @type other * @man seeed * @web http://www.seeedstudio.com/wiki/Grove_-_Encoder diff --git a/src/rpr220/CMakeLists.txt b/src/rpr220/CMakeLists.txt index f81268fc..af12ab6b 100644 --- a/src/rpr220/CMakeLists.txt +++ b/src/rpr220/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME rpr220 - DESCRIPTION "Infrared (IR) reflective sensor" + DESCRIPTION "Infrared (IR) Reflective Sensor" C_HDR rpr220.h C_SRC rpr220.c CPP_HDR rpr220.hpp diff --git a/src/rpr220/rpr220.hpp b/src/rpr220/rpr220.hpp index 552048ca..630d1fea 100644 --- a/src/rpr220/rpr220.hpp +++ b/src/rpr220/rpr220.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library rpr220 * @sensor rpr220 - * @comname RPR220 IR Reflective Sensor + * @comname Infrared (IR) Reflective Sensor * @altname Grove IR Reflective Sensor * @type light * @man seeed diff --git a/src/scam/CMakeLists.txt b/src/scam/CMakeLists.txt index d2894463..63a779af 100644 --- a/src/scam/CMakeLists.txt +++ b/src/scam/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME scam - DESCRIPTION "Serial camera interface" + DESCRIPTION "Serial Camera" CPP_HDR scam.hpp CPP_SRC scam.cxx REQUIRES mraa) diff --git a/src/servo/CMakeLists.txt b/src/servo/CMakeLists.txt index 3a5e3ea4..61928a66 100644 --- a/src/servo/CMakeLists.txt +++ b/src/servo/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME servo - DESCRIPTION "Servo controller" + DESCRIPTION "Servo Controller" C_HDR es08a.h es9257.h C_SRC es08a.c es9257.c CPP_HDR servo.hpp es08a.hpp es9257.hpp diff --git a/src/servo/es08a.hpp b/src/servo/es08a.hpp index 88223895..6d3028ea 100644 --- a/src/servo/es08a.hpp +++ b/src/servo/es08a.hpp @@ -31,11 +31,11 @@ namespace upm { /** * @library servo * @sensor es08a - * @comname ES08A Servo + * @comname High-sensitivity Mini Servo * @altname Grove Servo * @type servos * @man emax - * @web http://www.seeedstudio.com/wiki/Grove_-_Servo + * @web https://www.seeedstudio.com/EMAX-9g-ES08A-High-Sensitive-Mini-Servo-p-760.html * @con pwm * @kit gsk * diff --git a/src/servo/es9257.hpp b/src/servo/es9257.hpp index a2e2e5cc..793dde88 100644 --- a/src/servo/es9257.hpp +++ b/src/servo/es9257.hpp @@ -31,11 +31,11 @@ namespace upm { /** * @library servo * @sensor es9257 - * @comname ES9257 Servo + * @comname Micro Digital 3D Tail Servo * @altname Grove Servo * @type servos * @man emax - * @web http://www.seeedstudio.com/wiki/Grove_-_Servo + * @web https://www.seeedstudio.com/EMAX-ES9257-2.5kg%26amp%3B-.05-sec-Micro-Digital-3D-Tail-Servo-p-762.html * @con pwm * @kit gsk * diff --git a/src/sht1x/CMakeLists.txt b/src/sht1x/CMakeLists.txt index 5e09cbb9..df60faa4 100644 --- a/src/sht1x/CMakeLists.txt +++ b/src/sht1x/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME sht1x - DESCRIPTION "Temperature and humidity sensor" + DESCRIPTION "Temperature and Humidity Sensor" C_HDR sht1x.h C_SRC sht1x.c CPP_HDR sht1x.hpp diff --git a/src/sht1x/sht1x.hpp b/src/sht1x/sht1x.hpp index 676ad906..f61c9273 100644 --- a/src/sht1x/sht1x.hpp +++ b/src/sht1x/sht1x.hpp @@ -41,9 +41,10 @@ namespace upm { /** * @library sht1x * @sensor sht1x - * @comname SHT1X Temperature and Humidity Sensor + * @comname Temperature and Humidity Sensor * @type temp * @man dfrobot + * @web https://www.dfrobot.com/wiki/index.php/SHT1x_Humidity_and_Temperature_Sensor_(SKU:_DFR0066) * @con gpio * * @brief SHT1X Temperature and Humidity Sensor diff --git a/src/si1132/CMakeLists.txt b/src/si1132/CMakeLists.txt index 6d239b48..bada7ce4 100644 --- a/src/si1132/CMakeLists.txt +++ b/src/si1132/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "si1132") -set (libdescription "UV and ambient light sensor") +set (libdescription "UV and Ambient Light Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/si1132/si1132.hpp b/src/si1132/si1132.hpp index c5f41704..c532b5f5 100644 --- a/src/si1132/si1132.hpp +++ b/src/si1132/si1132.hpp @@ -46,10 +46,11 @@ namespace upm { * * @library si1132 * @sensor si1132 - * @comname Si1132 Light Sensor + * @comname UV and Ambient Light Sensor * @altname Si1132 * @type light * @man silabs + * @web http://www.silabs.com/products/sensors/infraredsensors/Pages/si1132.aspx * @con i2c * @if ilightsensor diff --git a/src/si114x/CMakeLists.txt b/src/si114x/CMakeLists.txt index d43a51c8..8153cf8e 100644 --- a/src/si114x/CMakeLists.txt +++ b/src/si114x/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "si114x") -set (libdescription "Si114x UV/IR/Visible light sensor") +set (libdescription "UV/IR/visible Light Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/si114x/si114x.hpp b/src/si114x/si114x.hpp index 09059972..75d13f50 100644 --- a/src/si114x/si114x.hpp +++ b/src/si114x/si114x.hpp @@ -45,7 +45,7 @@ namespace upm { /** * @library si114x * @sensor si114x - * @comname SI1145 UV Light Sensor + * @comname UV/IR/visible Light Sensor * @altname SI1146, SI1147 * @type light * @man adafruit diff --git a/src/si7005/CMakeLists.txt b/src/si7005/CMakeLists.txt index 41e2ea98..770c6d4b 100644 --- a/src/si7005/CMakeLists.txt +++ b/src/si7005/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "si7005") -set (libdescription "Digital I2C humidity and temperature sensor") +set (libdescription "Digital I2C Humidity and Temperature Sensor") set (module_src ${libname}.cxx mraa-utils.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/si7005/si7005.hpp b/src/si7005/si7005.hpp index 64ecaf10..ca6f91a6 100644 --- a/src/si7005/si7005.hpp +++ b/src/si7005/si7005.hpp @@ -44,10 +44,11 @@ namespace upm { /** * @library si7005 * @sensor si7005 - * @comname Silicon Labs Si7005 Humidity And Temperature Sensor + * @comname Digital I2C Humidity and Temperature Sensor * @altname Si7005 * @type temp * @man silabs + * @web http://www.silabs.com/products/sensors/humidity-sensors/Pages/Si7005.aspx * @con i2c * @if itemperaturesensor * diff --git a/src/slide/CMakeLists.txt b/src/slide/CMakeLists.txt index f639050c..1e814b94 100644 --- a/src/slide/CMakeLists.txt +++ b/src/slide/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME slide - DESCRIPTION "Slide potentiometer sensor" + DESCRIPTION "Slide Potentiometer" C_HDR slide.h C_SRC slide.c CPP_HDR slide.hpp diff --git a/src/slide/slide.hpp b/src/slide/slide.hpp index 24320bdf..bda7f495 100644 --- a/src/slide/slide.hpp +++ b/src/slide/slide.hpp @@ -32,17 +32,18 @@ namespace upm { /** * @brief Slide Sensor library - * @defgroup slide libupm-slide - * @ingroup seeed analog ainput + * @defgroup slide libupm-slide + * @ingroup seeed analog ainput */ /** * @library slide * @sensor slide * @comname Slide Potentiometer - * @altname Grove Slide + * @altname Grove Slide * @type ainput * @man seeed + * @web http://wiki.seeed.cc/Grove-Slide_Potentiometer/ * @con analog * * @brief API for the Slide Potentiometer diff --git a/src/sm130/CMakeLists.txt b/src/sm130/CMakeLists.txt index e2a07d84..c11b6993 100644 --- a/src/sm130/CMakeLists.txt +++ b/src/sm130/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "sm130") -set (libdescription "Rfid reader") +set (libdescription "RFID Reader") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/sm130/sm130.hpp b/src/sm130/sm130.hpp index 2665d5d5..11ca042d 100644 --- a/src/sm130/sm130.hpp +++ b/src/sm130/sm130.hpp @@ -53,7 +53,7 @@ namespace upm { /** * @library sm130 * @sensor sm130 - * @comname SM130 RFID Reader + * @comname RFID Reader * @type rfid * @man sparkfun * @web https://www.sparkfun.com/products/10126 diff --git a/src/smartdrive/CMakeLists.txt b/src/smartdrive/CMakeLists.txt index ff213610..ab4a8b88 100644 --- a/src/smartdrive/CMakeLists.txt +++ b/src/smartdrive/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "smartdrive") -set (libdescription "SmartDrive") +set (libdescription "SmartDrive Advanced Motor Controller") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/smartdrive/smartdrive.hpp b/src/smartdrive/smartdrive.hpp index 0560a469..4da1d756 100644 --- a/src/smartdrive/smartdrive.hpp +++ b/src/smartdrive/smartdrive.hpp @@ -134,7 +134,7 @@ namespace upm { /** * @library smartdrive * @sensor smartdrive - * @comname SmartDrive advanced motor controller + * @comname SmartDrive Advanced Motor Controller * @altname smartdrive * @type motor * @man openelectrons diff --git a/src/speaker/CMakeLists.txt b/src/speaker/CMakeLists.txt index 10e60a10..fdcdee54 100644 --- a/src/speaker/CMakeLists.txt +++ b/src/speaker/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME speaker - DESCRIPTION "Speaker module" + DESCRIPTION "Speaker" C_HDR speaker.h C_SRC speaker.c CPP_HDR speaker.hpp diff --git a/src/ssd1351/CMakeLists.txt b/src/ssd1351/CMakeLists.txt index b37b3352..1be5468d 100644 --- a/src/ssd1351/CMakeLists.txt +++ b/src/ssd1351/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ssd1351") -set (libdescription "SSD1351 SPI LCD") +set (libdescription "SPI-based OLED Display") set (module_src ssd1351_gfx.cxx ssd1351.cxx) set (module_hpp ssd1351_gfx.hpp ssd1351.hpp) upm_module_init(mraa) diff --git a/src/ssd1351/ssd1351.hpp b/src/ssd1351/ssd1351.hpp index 26ee450b..a1c88421 100644 --- a/src/ssd1351/ssd1351.hpp +++ b/src/ssd1351/ssd1351.hpp @@ -84,7 +84,7 @@ namespace upm { /** * @library ssd1351 * @sensor ssd1351 - * @comname SSD1351 OLED + * @comname SPI-based OLED Display * @type display * @man adafruit * @web http://www.adafruit.com/products/1431 diff --git a/src/st7735/CMakeLists.txt b/src/st7735/CMakeLists.txt index 0842f57d..f88eea5f 100644 --- a/src/st7735/CMakeLists.txt +++ b/src/st7735/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "st7735") -set (libdescription "SPI LCD") +set (libdescription "SPI-based 262K Color Single-Chip TFT-LCD") set (module_src st7735_gfx.cxx st7735.cxx) set (module_hpp st7735_gfx.hpp st7735.hpp) upm_module_init(mraa) diff --git a/src/st7735/st7735.hpp b/src/st7735/st7735.hpp index 06b3e103..559eb9b8 100644 --- a/src/st7735/st7735.hpp +++ b/src/st7735/st7735.hpp @@ -504,7 +504,7 @@ const unsigned char font[] = { /** * @library st7735 * @sensor st7735 - * @comname ST7735 LCD + * @comname SPI-based 262K Color Single-Chip TFT-LCD * @type display * @man adafruit * @web http://www.adafruit.com/product/358 diff --git a/src/stepmotor/CMakeLists.txt b/src/stepmotor/CMakeLists.txt index 281f1606..e46388fa 100644 --- a/src/stepmotor/CMakeLists.txt +++ b/src/stepmotor/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "stepmotor") -set (libdescription "Stepper motor module") +set (libdescription "Stepper Motor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/sx1276/CMakeLists.txt b/src/sx1276/CMakeLists.txt index 820279de..72a2907f 100644 --- a/src/sx1276/CMakeLists.txt +++ b/src/sx1276/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "sx1276") -set (libdescription "SZ1276 LoRa/FSK/OOK radio") +set (libdescription "SZ1276 LoRa/FSK/OOK Radio") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/sx1276/sx1276.hpp b/src/sx1276/sx1276.hpp index f6b4026f..424836be 100644 --- a/src/sx1276/sx1276.hpp +++ b/src/sx1276/sx1276.hpp @@ -60,7 +60,7 @@ namespace upm { /** * @library sx1276 * @sensor sx1276 - * @comname SX1276 LoRa/FSK modem + * @comname SX1276 LoRa/FSK Modem * @altname SX1277 SX1278 SX1279 * @type wifi * @man semtech diff --git a/src/sx6119/CMakeLists.txt b/src/sx6119/CMakeLists.txt index 9c20b2c5..d08b7ed9 100644 --- a/src/sx6119/CMakeLists.txt +++ b/src/sx6119/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "sx6119") -set (libdescription "Grove FM receiver") +set (libdescription "FM Receiver") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/sx6119/sx6119.hpp b/src/sx6119/sx6119.hpp index f2268830..1ac5c00f 100644 --- a/src/sx6119/sx6119.hpp +++ b/src/sx6119/sx6119.hpp @@ -37,10 +37,11 @@ namespace upm { /** * @sensor sx6119 * @library sx6119 - * @comname Grove FM Receiver + * @comname FM Receiver * @altname SX6119 FM Receiver * @type sound * @man seeed + * @web http://wiki.seeed.cc/Grove-FM_Receiver/ * @con gpio * * @brief API support for the SX6119-based Grove FM Receiver diff --git a/src/t3311/CMakeLists.txt b/src/t3311/CMakeLists.txt index 74985f7f..3650c99e 100644 --- a/src/t3311/CMakeLists.txt +++ b/src/t3311/CMakeLists.txt @@ -1,6 +1,6 @@ if (MODBUS_FOUND) set (libname "t3311") - set (libdescription "Module for the Comet System T3311") + set (libdescription "Temperature and Humidity Probe") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) diff --git a/src/t3311/t3311.hpp b/src/t3311/t3311.hpp index e811230a..d519ae7f 100644 --- a/src/t3311/t3311.hpp +++ b/src/t3311/t3311.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library t3311 * @sensor t3311 - * @comname T3311 Temperature and Humidity Sensor + * @comname Temperature and Humidity Probe * @type temp * @man comet * @con uart diff --git a/src/t6713/CMakeLists.txt b/src/t6713/CMakeLists.txt index 0c1e9bea..339ad915 100644 --- a/src/t6713/CMakeLists.txt +++ b/src/t6713/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "t6713") -set (libdescription "Amphenol Telaire 6713 Series CO2 Module") +set (libdescription "I2C/UART High Accuracy CO2 Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa interfaces) diff --git a/src/t6713/t6713.hpp b/src/t6713/t6713.hpp index 7d069edb..50609c3b 100644 --- a/src/t6713/t6713.hpp +++ b/src/t6713/t6713.hpp @@ -37,10 +37,11 @@ namespace upm { /** * @library t6713 * @sensor t6713 - * @comname Telaire 6713 Series CO2 Module + * @comname I2C/UART High Accuracy CO2 Sensor * @altname T6713 * @type gaseous * @man amphenol + * @web http://amphenol-sensors.com/en/products/co2/co2-modules/3215-t6700 * @con i2c * @if ico2sensor * diff --git a/src/t8100/CMakeLists.txt b/src/t8100/CMakeLists.txt index 29f2279f..97d9b312 100644 --- a/src/t8100/CMakeLists.txt +++ b/src/t8100/CMakeLists.txt @@ -1,6 +1,6 @@ if (BACNET_FOUND) set (libname "t8100") - set (libdescription "Module for the Telaire T8100 Ventostat") + set (libdescription "Wall Mount CO2, Humidity and Temperature Transmitter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) diff --git a/src/t8100/t8100.hpp b/src/t8100/t8100.hpp index ed2754b3..534b2d08 100644 --- a/src/t8100/t8100.hpp +++ b/src/t8100/t8100.hpp @@ -40,7 +40,7 @@ namespace upm { /** * @library t8100 * @sensor t8100 - * @comname Amphenol Telaire Ventostat T8100 + * @comname Wall Mount CO2, Humidity and Temperature Transmitter * Ventilation Controller * @type gaseous temp * @man amphenol diff --git a/src/ta12200/CMakeLists.txt b/src/ta12200/CMakeLists.txt index 52b56d4d..1ef987e2 100644 --- a/src/ta12200/CMakeLists.txt +++ b/src/ta12200/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ta12200") -set (libdescription "Ta12200 current transformer module") +set (libdescription "AC Current Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/ta12200/ta12200.hpp b/src/ta12200/ta12200.hpp index cc025e0c..05b523b5 100644 --- a/src/ta12200/ta12200.hpp +++ b/src/ta12200/ta12200.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library ta12200 * @sensor ta12200 - * @comname TA12-200 Current Transformer + * @comname AC Current Sensor * @altname Grove Electricity Sensor * @type electric * @man seeed diff --git a/src/tb7300/CMakeLists.txt b/src/tb7300/CMakeLists.txt index 73c2c83a..2f37d68f 100644 --- a/src/tb7300/CMakeLists.txt +++ b/src/tb7300/CMakeLists.txt @@ -1,6 +1,6 @@ if (BACNET_FOUND) set (libname "tb7300") - set (libdescription "Module for the TB7300 Fan Coil Thermostat") + set (libdescription "Communicating Fan Coil Thermostat") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) diff --git a/src/tb7300/tb7300.hpp b/src/tb7300/tb7300.hpp index d9cedf0e..4108f40d 100644 --- a/src/tb7300/tb7300.hpp +++ b/src/tb7300/tb7300.hpp @@ -40,7 +40,7 @@ namespace upm { /** * @library tb7300 * @sensor tb7300 - * @comname Honeywell TB7300 Communicating Fan Coil + * @comname Communicating Fan Coil Thermostat * Thermostat * @type temp * @man honeywell diff --git a/src/tcs3414cs/CMakeLists.txt b/src/tcs3414cs/CMakeLists.txt index 2736a588..8eeed976 100644 --- a/src/tcs3414cs/CMakeLists.txt +++ b/src/tcs3414cs/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "tcs3414cs") -set (libdescription "I2C Color sensor") +set (libdescription "I2C Color Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/tcs3414cs/tcs3414cs.hpp b/src/tcs3414cs/tcs3414cs.hpp index d944912b..326826ae 100644 --- a/src/tcs3414cs/tcs3414cs.hpp +++ b/src/tcs3414cs/tcs3414cs.hpp @@ -112,7 +112,7 @@ typedef struct { /** * @library tcs3414cs * @sensor tcs3414cs - * @comname TCS3414CS Color Sensor + * @comname I2C Color Sensor * @altname Grove Color Sensor * @type color * @man seeed diff --git a/src/teams/CMakeLists.txt b/src/teams/CMakeLists.txt index d7f89a90..c469a923 100644 --- a/src/teams/CMakeLists.txt +++ b/src/teams/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "teams") -set (libdescription "Veris TEAMS Temperature transmitter") +set (libdescription "Veris TEAMS Temperature Transmitter") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/temperature/CMakeLists.txt b/src/temperature/CMakeLists.txt index ab423981..6172b422 100644 --- a/src/temperature/CMakeLists.txt +++ b/src/temperature/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME temperature - DESCRIPTION "Analog temperature sensor" + DESCRIPTION "Analog Temperature Sensor" C_HDR temperature.h C_SRC temperature.c CPP_HDR temperature.hpp diff --git a/src/temperature/temperature.hpp b/src/temperature/temperature.hpp index a08a2a7a..d8bb4bbd 100644 --- a/src/temperature/temperature.hpp +++ b/src/temperature/temperature.hpp @@ -38,10 +38,11 @@ namespace upm { /** * @library temperature * @sensor temperature - * @comname Temperature Sensor + * @comname Analog Temperature Sensor * @altname Grove Temperature Sensor * @type temp * @man seeed + * @web http://wiki.seeed.cc/Grove-Temperature_Sensor_V1.2/ * @con analog * @kit gsk * diff --git a/src/tex00/CMakeLists.txt b/src/tex00/CMakeLists.txt index ef2f357d..57d3e12e 100644 --- a/src/tex00/CMakeLists.txt +++ b/src/tex00/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "tex00") -set (libdescription "Veris TEX00 Temperature thermistors") +set (libdescription "Veris TEX00 Temperature Sensors") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/tex00/tex00.hpp b/src/tex00/tex00.hpp index 4b2616d1..8682092c 100644 --- a/src/tex00/tex00.hpp +++ b/src/tex00/tex00.hpp @@ -41,7 +41,7 @@ namespace upm { /** * @library tex00 * @sensor tex00 - * @comname Veris TEX00 Temperature Sensor + * @comname Veris TEX00 Temperature Sensors * @type temp * @man veris * @con ainput diff --git a/src/th02/th02.hpp b/src/th02/th02.hpp index 404180a4..ca5f91e1 100644 --- a/src/th02/th02.hpp +++ b/src/th02/th02.hpp @@ -52,7 +52,7 @@ namespace upm { /** * @library th02 * @sensor th02 - * @comname TH02 Temperature & Humidity Sensor + * @comname Temperature and Humidity Sensor Pro * @altname Grove Temperature & Humidity Sensor (High-Accuracy & Mini) * @type temp * @man seeed diff --git a/src/tm1637/CMakeLists.txt b/src/tm1637/CMakeLists.txt index f08a37fb..337c5211 100644 --- a/src/tm1637/CMakeLists.txt +++ b/src/tm1637/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "tm1637") -set (libdescription "C++ API for the TM1637 7-segment display") +set (libdescription "C++ API for the TM1637 7-segment Display") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/tm1637/tm1637.hpp b/src/tm1637/tm1637.hpp index 08ad2f31..9a54dd3e 100644 --- a/src/tm1637/tm1637.hpp +++ b/src/tm1637/tm1637.hpp @@ -52,10 +52,11 @@ namespace upm /** * @library tm1637 * @sensor tm1637 - * @comname TM1637 7-Segment Display + * @comname 7-segment Display * @altname Grove 4-Digit Display * @type display * @man seeed + * @web http://wiki.seeed.cc/Grove-4-Digit_Display/ * @con gpio * * @brief API for the TM1637 7-Segment Display diff --git a/src/tsl2561/CMakeLists.txt b/src/tsl2561/CMakeLists.txt index dbb8cee2..0e6f857e 100644 --- a/src/tsl2561/CMakeLists.txt +++ b/src/tsl2561/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME tsl2561 - DESCRIPTION "Digital light sensor" + DESCRIPTION "Digital Light Sensor" C_HDR tsl2561.h C_SRC tsl2561.c CPP_HDR tsl2561.hpp diff --git a/src/tsl2561/tsl2561.hpp b/src/tsl2561/tsl2561.hpp index 2b835330..fa0f3e13 100644 --- a/src/tsl2561/tsl2561.hpp +++ b/src/tsl2561/tsl2561.hpp @@ -99,7 +99,7 @@ namespace upm { /** * @library tsl2561 * @sensor tsl2561 - * @comname TSL2561 Light Sensor + * @comname Digital Light Sensor * @altname Grove Digital Light Sensor * @type light * @man seeed diff --git a/src/ttp223/CMakeLists.txt b/src/ttp223/CMakeLists.txt index 619aa9e0..dc0450bc 100644 --- a/src/ttp223/CMakeLists.txt +++ b/src/ttp223/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME ttp223 - DESCRIPTION "Capacitive touch sensor" + DESCRIPTION "Capacitive Touch Sensor" C_HDR ttp223.h C_SRC ttp223.c CPP_HDR ttp223.hpp diff --git a/src/ttp223/ttp223.hpp b/src/ttp223/ttp223.hpp index d2a37388..45508fa2 100644 --- a/src/ttp223/ttp223.hpp +++ b/src/ttp223/ttp223.hpp @@ -35,7 +35,7 @@ namespace upm { /** * @library ttp223 * @sensor ttp223 - * @comname TTP223 Touch Sensor + * @comname Capacitive Touch Sensor * @altname Grove Touch Sensor * @type touch * @man seeed diff --git a/src/uartat/CMakeLists.txt b/src/uartat/CMakeLists.txt index 45cc6524..ef7b3764 100644 --- a/src/uartat/CMakeLists.txt +++ b/src/uartat/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME uartat - DESCRIPTION "Generic UART driver for serial AT command driven devices" + DESCRIPTION "Generic UART Driver for Serial AT Command Driven Devices" C_HDR uartat.h uartat_defs.h C_SRC uartat.c CPP_HDR uartat.hpp diff --git a/src/uartat/uartat.hpp b/src/uartat/uartat.hpp index 66c210c8..e67fc581 100644 --- a/src/uartat/uartat.hpp +++ b/src/uartat/uartat.hpp @@ -38,7 +38,7 @@ namespace upm { /** * @library uartat * @sensor uartat - * @comname Generic AT command based UART device + * @comname Generic AT Command Based UART Device * @type other * @con uart * diff --git a/src/uln200xa/CMakeLists.txt b/src/uln200xa/CMakeLists.txt index 046adb71..196e7ab4 100644 --- a/src/uln200xa/CMakeLists.txt +++ b/src/uln200xa/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME uln200xa - DESCRIPTION "Uln200xa darlington stepper driver" + DESCRIPTION "Darlington Stepper Driver" C_HDR uln200xa.h C_SRC uln200xa.c CPP_HDR uln200xa.hpp diff --git a/src/uln200xa/uln200xa.hpp b/src/uln200xa/uln200xa.hpp index 20466552..a1de2f8c 100644 --- a/src/uln200xa/uln200xa.hpp +++ b/src/uln200xa/uln200xa.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library uln200xa * @sensor uln200xa - * @comname ULN200XA Stepper Driver + * @comname Darlington Stepper Driver * @altname ULN2001A ULN2002A ULN2003A ULN2004A * @type motor * @man seeed diff --git a/src/ultrasonic/CMakeLists.txt b/src/ultrasonic/CMakeLists.txt index d886ef3a..a89fe569 100644 --- a/src/ultrasonic/CMakeLists.txt +++ b/src/ultrasonic/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "ultrasonic") -set (libdescription "Grove ultrasonic proximity sensor") +set (libdescription "Ultrasonic Proximity Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/ultrasonic/ultrasonic.hpp b/src/ultrasonic/ultrasonic.hpp index c6dee1d5..f33739eb 100644 --- a/src/ultrasonic/ultrasonic.hpp +++ b/src/ultrasonic/ultrasonic.hpp @@ -44,9 +44,10 @@ namespace upm { /** * @library ultrasonic * @sensor ultrasonic - * @comname Grove Ultrasonic Ranger + * @comname Ultrasonic Proximity Sensor * @type sound * @man seeed + * @web http://wiki.seeed.cc/Grove-Ultrasonic_Ranger/ * @con gpio * * @brief API for Grove Ultrasonic Ranger diff --git a/src/urm37/CMakeLists.txt b/src/urm37/CMakeLists.txt index 8c529033..1a3a63c6 100644 --- a/src/urm37/CMakeLists.txt +++ b/src/urm37/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME urm37 - DESCRIPTION "Ultrasonic range finder" + DESCRIPTION "Ultrasonic Range Finder" C_HDR urm37.h C_SRC urm37.c CPP_HDR urm37.hpp diff --git a/src/urm37/urm37.hpp b/src/urm37/urm37.hpp index 2ad52b78..40ef6266 100644 --- a/src/urm37/urm37.hpp +++ b/src/urm37/urm37.hpp @@ -45,7 +45,7 @@ namespace upm { /** * @library urm37 * @sensor urm37 - * @comname DFRobot URM37 Ultrasonic Ranger + * @comname Ultrasonic Range Finder * @type sound * @man dfrobot * @con uart ainput gpio diff --git a/src/utilities/CMakeLists.txt b/src/utilities/CMakeLists.txt index ebffdc70..8ca2e715 100644 --- a/src/utilities/CMakeLists.txt +++ b/src/utilities/CMakeLists.txt @@ -1,4 +1,4 @@ upm_mixed_module_init (NAME utilities - DESCRIPTION "C utilities library" + DESCRIPTION "C Utilities Library" C_HDR upm_utilities.h C_SRC upm_utilities.c) diff --git a/src/vcap/CMakeLists.txt b/src/vcap/CMakeLists.txt index 25795be3..83964db5 100644 --- a/src/vcap/CMakeLists.txt +++ b/src/vcap/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "vcap") -set (libdescription "Video Frame Capture and image save utility") +set (libdescription "Video Frame Capture and Image Save Utility") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) diff --git a/src/vcap/vcap.hpp b/src/vcap/vcap.hpp index cfc53ff4..a49c1c1b 100644 --- a/src/vcap/vcap.hpp +++ b/src/vcap/vcap.hpp @@ -49,7 +49,7 @@ namespace upm { /** * @library vcap * @sensor vcap - * @comname Video Capture + * @comname Video Frame Capture and Image Save Utility * @type video * * @brief API for the Video Capture driver diff --git a/src/vdiv/CMakeLists.txt b/src/vdiv/CMakeLists.txt index fcac06d2..cd831463 100644 --- a/src/vdiv/CMakeLists.txt +++ b/src/vdiv/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME vdiv - DESCRIPTION "Analog voltage divider sensor" + DESCRIPTION "Analog Voltage Divider Sensor" C_HDR vdiv.h C_SRC vdiv.c CPP_HDR vdiv.hpp diff --git a/src/vdiv/vdiv.hpp b/src/vdiv/vdiv.hpp index 9fc41748..4822932f 100644 --- a/src/vdiv/vdiv.hpp +++ b/src/vdiv/vdiv.hpp @@ -44,7 +44,7 @@ namespace upm { /** * @library vdiv * @sensor vdiv - * @comname Voltage Divider + * @comname Analog Voltage Divider Sensor * @altname Grove Voltage Divider * @type electric * @man seeed diff --git a/src/water/CMakeLists.txt b/src/water/CMakeLists.txt index 7ae5a29d..dd661dc2 100644 --- a/src/water/CMakeLists.txt +++ b/src/water/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME water - DESCRIPTION "Water detection sensor" + DESCRIPTION "Water Detection Sensor" C_HDR water.h C_SRC water.c CPP_HDR water.hpp diff --git a/src/water/water.hpp b/src/water/water.hpp index 6b24472c..c6c0c8e9 100644 --- a/src/water/water.hpp +++ b/src/water/water.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library water * @sensor water - * @comname Water Sensor + * @comname Water Detection Sensor * @type liquid * @man seeed * @con gpio diff --git a/src/waterlevel/CMakeLists.txt b/src/waterlevel/CMakeLists.txt index f7f0e162..06f63bd4 100644 --- a/src/waterlevel/CMakeLists.txt +++ b/src/waterlevel/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "waterlevel") -set (libdescription "Waterlevel sensor module") +set (libdescription "Water Level Sensor") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/waterlevel/waterlevel.hpp b/src/waterlevel/waterlevel.hpp index a2fc8776..a2b3a3cb 100644 --- a/src/waterlevel/waterlevel.hpp +++ b/src/waterlevel/waterlevel.hpp @@ -34,7 +34,7 @@ namespace upm { /** * @library waterlevel * @sensor waterlevel - * @comname Grove Water Level Sensor + * @comname Water Level Sensor * @type liquid * @man seeed * @con gpio diff --git a/src/wfs/CMakeLists.txt b/src/wfs/CMakeLists.txt index 2a33aa0c..65f3ca44 100644 --- a/src/wfs/CMakeLists.txt +++ b/src/wfs/CMakeLists.txt @@ -1,7 +1,7 @@ upm_mixed_module_init (NAME wfs - DESCRIPTION "WFS (Water Flow Sensor)" C_HDR wfs.h C_SRC wfs.c + DESCRIPTION "WFS (Water Flow Sensor)" CPP_HDR wfs.hpp CPP_SRC wfs.cxx CPP_WRAPS_C diff --git a/src/wfs/wfs.hpp b/src/wfs/wfs.hpp index 82de557e..135b5861 100644 --- a/src/wfs/wfs.hpp +++ b/src/wfs/wfs.hpp @@ -27,109 +27,107 @@ namespace upm { - /** - * @brief Grove Water Flow Sensor library - * @defgroup wfs libupm-wfs - * @ingroup seeed gpio liquid eak - */ +/** + * @brief Grove Water Flow Sensor library + * @defgroup wfs libupm-wfs + * @ingroup seeed gpio liquid eak + */ - /** - * @library wfs - * @sensor wfs - * @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 - * @con gpio - * @kit eak +/** + * @library wfs + * @sensor wfs + * @comname Water Flow Sensor + * @altname Grove Water Flow Sensor + * @type liquid + * @man seeed + * @web http://wiki.seeedstudio.com/wiki/G1/2_Water_Flow_sensor + * @con gpio + * @kit eak - * @brief API for the Grove Water Flow Sensor - * - * This sensor is used to measure water flow in liters per - * minute (LPM). It incorporates a Hall Effect sensor. The UPM module - * defines an interrupt routine to be triggered on each low pulse, - * keeping count. This device requires a 10K pull-up resistor for - * the signal line (yellow wire). There is a schematic diagram on - * the SeeedStudio site (3/2015): - * http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor - * - * However, be careful when wiring this up - the schematic appears to - * have a bug in it: the lower left connection of the signal line - * (yellow) to Vcc (red) should not be there. The sensor can work - * with this connection, but probably not for very long. - * - * @image html wfs.jpg - * @snippet wfs.cxx Interesting - */ - class WFS { + * @brief API for the Grove Water Flow Sensor + * + * This sensor is used to measure water flow in liters per + * minute (LPM). It incorporates a Hall Effect sensor. The UPM module + * defines an interrupt routine to be triggered on each low pulse, + * keeping count. This device requires a 10K pull-up resistor for + * the signal line (yellow wire). There is a schematic diagram on + * the SeeedStudio site (3/2015): + * http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor + * + * However, be careful when wiring this up - the schematic appears to + * have a bug in it: the lower left connection of the signal line + * (yellow) to Vcc (red) should not be there. The sensor can work + * with this connection, but probably not for very long. + * + * @image html wfs.jpg + * @snippet wfs.cxx Interesting + */ +class WFS { public: /** - * Grove Water Flow sensor constructor - * - * @param pin GPIO pin to use. This must be an interrupt - * capable pin. - */ + * Grove Water Flow sensor constructor + * + * @param pin Digital pin to use + */ WFS(int pin); - /** - * WFS destructor - */ + * WFS destructor + */ ~WFS(); /** - * Returns the number of milliseconds elapsed since initClock() - * was last called. - * - * @return Elapsed milliseconds - */ + * Returns the number of milliseconds elapsed since initClock() + * was last called. + * + * @return Elapsed milliseconds + */ uint32_t getMillis(); /** - * Resets the clock - * - */ + * Resets the clock + * + */ void initClock(); /** - * Resets the flow counter to 0. The flow counter should be - * stopped via stopFlowCounter() prior to calling this function. - * - */ + * Resets the flow counter to 0. The flow counter should be + * stopped via stopFlowCounter() prior to calling this function. + * + */ void clearFlowCounter() { wfs_clear_flow_counter(m_wfs); }; /** - * Starts the flow counter - * - */ + * Starts the flow counter + * + */ void startFlowCounter(); /** - * Stops the flow counter - * - */ + * Stops the flow counter + * + */ void stopFlowCounter(); /** - * Gets the flow counter - * - * @return Flow counter - */ + * Gets the flow counter + * + * @return Flow counter + */ uint32_t flowCounter() { return wfs_flow_counter(m_wfs); }; /** - * Computes the flow rate in liters per minute (LPM). Note, this - * is for the Grove WFS. If you are using some other WFS, you - * should compute the flow rate on your own based on the data for - * your sensor. - * - * @return Computed flow rate - */ + * Computes the flow rate in liters per minute (LPM). Note, this + * is for the Grove WFS. If you are using some other WFS, you + * should compute the flow rate on your own based on the data for + * your sensor. + * + * @return Computed flow rate + */ float flowRate(); protected: wfs_context m_wfs; private: - }; +}; } diff --git a/src/wheelencoder/CMakeLists.txt b/src/wheelencoder/CMakeLists.txt index 41d32064..ec4f02be 100644 --- a/src/wheelencoder/CMakeLists.txt +++ b/src/wheelencoder/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "wheelencoder") -set (libdescription "DFRobot wheelencoder") +set (libdescription "Wheel Encoder") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/wheelencoder/wheelencoder.hpp b/src/wheelencoder/wheelencoder.hpp index 17356e07..92b26692 100644 --- a/src/wheelencoder/wheelencoder.hpp +++ b/src/wheelencoder/wheelencoder.hpp @@ -39,7 +39,7 @@ namespace upm { /** * @library wheelencoder * @sensor wheelencoder - * @comname DFRobot Wheel Encoder + * @comname Wheel Encoder * @type other * @man dfrobot * @web http://www.dfrobot.com/index.php?route=product/product&product_id=98 diff --git a/src/wt5001/CMakeLists.txt b/src/wt5001/CMakeLists.txt index 1f9bc97c..f7f74f37 100644 --- a/src/wt5001/CMakeLists.txt +++ b/src/wt5001/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "wt5001") -set (libdescription "Grove serial mp3 (wt5001) module") +set (libdescription "Serial MP3 Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/wt5001/wt5001.hpp b/src/wt5001/wt5001.hpp index c21135ac..37971612 100644 --- a/src/wt5001/wt5001.hpp +++ b/src/wt5001/wt5001.hpp @@ -56,7 +56,7 @@ namespace upm { /** * @library wt5001 * @sensor wt5001 - * @comname WT5001 Serial MP3 Module + * @comname Serial MP3 Module * @altname Grove Serial MP3 Player * @type sound * @man seeed diff --git a/src/xbee/CMakeLists.txt b/src/xbee/CMakeLists.txt index 1d4c6deb..d41782d8 100644 --- a/src/xbee/CMakeLists.txt +++ b/src/xbee/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "xbee") -set (libdescription "XBee serial module") +set (libdescription "XBee Serial Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/xbee/xbee.hpp b/src/xbee/xbee.hpp index c03c00a3..afb0ac5b 100644 --- a/src/xbee/xbee.hpp +++ b/src/xbee/xbee.hpp @@ -48,7 +48,7 @@ namespace upm { /** * @library xbee * @sensor xbee - * @comname XBee modules + * @comname XBee Serial Module * @type wifi * @man sparkfun * @con uart diff --git a/src/yg1006/CMakeLists.txt b/src/yg1006/CMakeLists.txt index 5883f354..c73fe555 100644 --- a/src/yg1006/CMakeLists.txt +++ b/src/yg1006/CMakeLists.txt @@ -1,5 +1,5 @@ upm_mixed_module_init (NAME yg1006 - DESCRIPTION "Analog flame sensor" + DESCRIPTION "Flame Sensor" C_HDR yg1006.h C_SRC yg1006.c CPP_HDR yg1006.hpp diff --git a/src/yg1006/yg1006.hpp b/src/yg1006/yg1006.hpp index 7bd81599..74569fcc 100644 --- a/src/yg1006/yg1006.hpp +++ b/src/yg1006/yg1006.hpp @@ -36,7 +36,7 @@ namespace upm { /** * @library yg1006 * @sensor yg1006 - * @comname YG1006 Flame Sensor + * @comname Flame Sensor * @altname Grove Flame Sensor * @type light * @man seeed diff --git a/src/zfm20/CMakeLists.txt b/src/zfm20/CMakeLists.txt index 513539a8..3fa95e8a 100644 --- a/src/zfm20/CMakeLists.txt +++ b/src/zfm20/CMakeLists.txt @@ -1,5 +1,5 @@ set (libname "zfm20") -set (libdescription "Grove zfm20 fingerprint sensor module") +set (libdescription "Fingerprint Sensor Module") set (module_src ${libname}.cxx) set (module_hpp ${libname}.hpp) upm_module_init(mraa) diff --git a/src/zfm20/zfm20.hpp b/src/zfm20/zfm20.hpp index 91ae18b4..25b9b2fa 100644 --- a/src/zfm20/zfm20.hpp +++ b/src/zfm20/zfm20.hpp @@ -67,10 +67,11 @@ namespace upm { /** * @library zfm20 * @sensor zfm20 - * @comname ZFM-20 Fingerprint Sensor + * @comname Fingerprint Sensor Module * @altname Grove Fingerprint Sensor * @type touch * @man seeed + * @web http://wiki.seeed.cc/Grove-Fingerprint_Sensor/ * @con uart * * @brief API for the ZFM-20 Fingerprint Sensor Module