From 02147dfe4b5e76b624ba373bad3d7f57ae279ae1 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Fri, 20 Mar 2015 16:39:20 -0700 Subject: [PATCH] adis16448: updated header and example with new tags Signed-off-by: Mihai Tudor Panu --- examples/c++/adis16448.cxx | 35 ++++++++++++++++++----------------- src/adis16448/adis16448.h | 23 +++++++++++++++++++++-- 2 files changed, 39 insertions(+), 19 deletions(-) diff --git a/examples/c++/adis16448.cxx b/examples/c++/adis16448.cxx index e77947b1..a1d4296f 100644 --- a/examples/c++/adis16448.cxx +++ b/examples/c++/adis16448.cxx @@ -11,7 +11,7 @@ // // This example code runs on an Intel Edison and uses mraa to acquire data // from an ADIS16448. This data is then scaled and printed onto the terminal. -// +// // This software has been tested to connect to an ADIS16448 through a level shifter // such as the TI TXB0104. The SPI lines (DIN, DOUT, SCLK, /CS) are all wired through // the level shifter and the ADIS16448 is also being powered by the Intel Edison. @@ -45,21 +45,22 @@ int main(int argc, char **argv) { - while(true) - { - upm::ADIS16448* imu = new upm::ADIS16448(0,3); //upm::ADIS16448(SPI,RST) + while(true) + { + //! [Interesting] + upm::ADIS16448* imu = new upm::ADIS16448(0,3); //upm::ADIS16448(SPI,RST) - //Read the specified register, scale it, and display it on the screen - std::cout << "XGYRO_OUT:" << imu->gyroScale(imu->regRead(XGYRO_OUT)) << std::endl; - std::cout << "YGYRO_OUT:" << imu->gyroScale(imu->regRead(YGYRO_OUT)) << std::endl; - std::cout << "ZGYRO_OUT:" << imu->gyroScale(imu->regRead(ZGYRO_OUT)) << std::endl; - std::cout << " " << std::endl; - std::cout << "XACCL_OUT:" << imu->accelScale(imu->regRead(XACCL_OUT)) << std::endl; - std::cout << "YACCL_OUT:" << imu->accelScale(imu->regRead(YACCL_OUT)) << std::endl; - std::cout << "ZACCL_OUT:" << imu->accelScale(imu->regRead(ZACCL_OUT)) << std::endl; - std::cout << " " << std::endl; - - sleep(1); - } - return (0); + //Read the specified register, scale it, and display it on the screen + std::cout << "XGYRO_OUT:" << imu->gyroScale(imu->regRead(XGYRO_OUT)) << std::endl; + std::cout << "YGYRO_OUT:" << imu->gyroScale(imu->regRead(YGYRO_OUT)) << std::endl; + std::cout << "ZGYRO_OUT:" << imu->gyroScale(imu->regRead(ZGYRO_OUT)) << std::endl; + std::cout << " " << std::endl; + std::cout << "XACCL_OUT:" << imu->accelScale(imu->regRead(XACCL_OUT)) << std::endl; + std::cout << "YACCL_OUT:" << imu->accelScale(imu->regRead(YACCL_OUT)) << std::endl; + std::cout << "ZACCL_OUT:" << imu->accelScale(imu->regRead(ZACCL_OUT)) << std::endl; + std::cout << " " << std::endl; + //! [Interesting] + sleep(1); + } + return (0); } diff --git a/src/adis16448/adis16448.h b/src/adis16448/adis16448.h index d76c36ad..e990b740 100644 --- a/src/adis16448/adis16448.h +++ b/src/adis16448/adis16448.h @@ -83,8 +83,27 @@ #define SERIAL_NUM 0x58 //Lot-specific serial number namespace upm { - - // ADIS16448 class definition + /** + * @brief Adis16448 + * @defgroup adis16448 libupm-adis16488 + * @ingroup generic spi accelerometer + */ + + /** + * @library adis16448 + * @sensor adis16448 + * @comname ADIS16448 Accelerometer + * @type accelerometer + * @man generic + * @web http://www.analog.com/en/products/sensors/isensor-mems-inertial-measurement-units/adis16448.html + * @con spi + * + * @brief C++ API for Analog Devices ADIS16448 + * + * This is an industrial grade accelerometer by Analog Devices. + * + * @snippet adis16448.cxx Interesting + */ class ADIS16448{ public: