diff --git a/src/am2315/am2315.h b/src/am2315/am2315.h index 8e440d94..5d698824 100644 --- a/src/am2315/am2315.h +++ b/src/am2315/am2315.h @@ -89,7 +89,7 @@ class AM2315 { AM2315 (int bus, int devAddr=AM2315_I2C_ADDRESS); /** - * AM2315 object destructor; basicaly, it closes the I2C connection. + * AM2315 object destructor; basically, it closes the I2C connection. */ ~AM2315 (); diff --git a/src/ecs1030/ecs1030.h b/src/ecs1030/ecs1030.h index f4f684cc..29deb4ab 100644 --- a/src/ecs1030/ecs1030.h +++ b/src/ecs1030/ecs1030.h @@ -86,7 +86,7 @@ class ECS1030 { ECS1030 (uint8_t pinNumber); /** - * ECS1030 object destructor; basicaly, it closes the GPIO. + * ECS1030 object destructor; basically, it closes the GPIO. */ ~ECS1030 (); diff --git a/src/h3lis331dl/h3lis331dl.h b/src/h3lis331dl/h3lis331dl.h index 2e319ed8..0dcbb126 100644 --- a/src/h3lis331dl/h3lis331dl.h +++ b/src/h3lis331dl/h3lis331dl.h @@ -337,7 +337,7 @@ namespace upm { bool setPowerMode(PM_BITS_T pm); /** - * Enables one or more of the 3 axes. The arguement is a bitmask + * Enables one or more of the 3 axes. The argument is a bitmask * composed of REG1_XEN, REG1_YEN, and/or REG1_ZEN corresponding to * the axes you want enabled. * diff --git a/src/m24lr64e/m24lr64e.h b/src/m24lr64e/m24lr64e.h index 59a2caff..e9730322 100644 --- a/src/m24lr64e/m24lr64e.h +++ b/src/m24lr64e/m24lr64e.h @@ -56,21 +56,21 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_-_NFC_Tag * @con i2c * - * @brief C++ API for the M24LR64E based Grove NFC Tag + * @brief C++ API for the M24LR64E-based Grove NFC Tag * - * The Grove NFC tag is, in essence, an 8KB EEPROM that can be written - * to or read from using I2C and NFC equipped devices. + * Grove NFC tag is an 8KB electrically erasable programmable read-only memory (EEPROM) + * that can be written to or read from using I2C and NFC-equipped devices. * - * The USER mode (default) allows read and write access to all 8KB + * The user mode (default) allows read and write access to all 8KB * of space, provided the sector security status (SSS) allows it. - * The ROOT mode allows modification of the SSS data and other + * The root mode allows modification of the SSS data and other * information, provided the proper password is submitted. The - * default password for a new tag is 0x00000000. See the data sheet - * for much more detailed information. + * default password for a new tag is 0x00000000. See the datasheet + * for more details. * - * The Seeed Studio wiki page for this device includes a link to an - * Android application that can be used to also read and write the - * device via NFC, as well as set the NFC passwords, which cannot be + * The Seeed Studio* wiki page for this device includes a link to an + * Android* application that can be used to also read and write the + * device via NFC, as well as set NFC passwords, which cannot be * done via I2C. * * @image html m24lr64e.jpg @@ -92,12 +92,12 @@ namespace upm { static const unsigned int I2C_WRITE_TIME = 5; // 5ms /** - * M24LR64E addresses, accessable only in root mode + * M24LR64E addresses, accessible only in the root mode */ typedef enum { I2C_PASSWORD_ADDR = 2304, RF_PASSWORD_1_ADDR = 2308, // RF pwds not available in - RF_PASSWORD_2_ADDR = 2312, // i2c access modes + RF_PASSWORD_2_ADDR = 2312, // I2C access modes RF_PASSWORD_3_ADDR = 2316, DSFID_ADDR = 2320, // 1 byte AFI_ADDR = 2321, // 1 byte @@ -110,8 +110,8 @@ namespace upm { } M24LR64E_ADDR_T; enum AccessMode { - USER_MODE = 0x0, // offer simple read/write access right - ROOT_MODE = 0x1 // offer password change access right + USER_MODE = 0x0, // offers simple read/write access right + ROOT_MODE = 0x1 // offers password change access right }; enum SectorAccessRight { @@ -141,39 +141,39 @@ namespace upm { }; /** - * m24lr64e constructor + * M24LR64E constructor * - * @param bus i2c bus to use - * @param mode the access mode (user or root) to use + * @param bus I2C bus to use + * @param mode Access mode (user or root) to use */ M24LR64E(int bus, AccessMode mode = USER_MODE); /** - * M24LR64E Destructor + * M24LR64E destructor */ ~M24LR64E(); /** - * submit an i2c access password + * Submits an I2C access password * - * @param passwd the 4-byte access password + * @param passwd 4-byte access password */ bool submitPasswd(uint32_t passwd); /** - * write a new i2c password + * Writes a new I2C password * - * @param passwd the 4-byte access password + * @param passwd 4-byte access password */ bool writePasswd(uint32_t passwd); /** - * Set the protection bit for a sector. Must be in ROOT mode + * Sets a protection bit for a sector. Must be in the root mode * - * @param sectorNumber the sector whose protection you are modifying - * @param protectEnable true if you are enabling protection - * @param accessRight the access rights to set - * @param passwd the password number to enable, if any + * @param sectorNumber Sector whose protection you are modifying + * @param protectEnable True if you are enabling protection + * @param accessRight Access rights to set + * @param passwd Password number to enable, if any */ void sectorProtectConfig(unsigned int sectorNumber, bool protectEnable, @@ -181,88 +181,88 @@ namespace upm { SectorSelectPassWd passwd); /** - * Clear the sector protection bits. Must be in ROOT mode. + * Clears sector protection bits. Must be in the root mode. */ void clearSectorProtect(void); /** - * Set or clear the Sector Security Status Lock bit for a sector. - * Must be in ROOT mode. + * Sets or clears a sector security status lock bit for a sector. + * Must be in the root mode. * - * @param sectorNumber the sector who's SSS you want to modify - * @param sockEnable true r false to set or clear the bit + * @param sectorNumber Sector whose SSS you want to modify + * @param sockEnable True to set the bit, false to clear it */ void sectorWriteLockBit(unsigned int sectorNumber, bool sockEnable); /** - * return the Data Storage Familiy Identifier - * Must be in ROOT mode. + * Returns a data storage family identifier (DSFID) + * Must be in the root mode. * - * @return the DSFID + * @return DSFID */ uint8_t getDSFID(); /** - * return the Application Family Identifier - * Must be in ROOT mode. + * Returns an application family identifier (AFI) + * Must be in the root mode. * - * @return the AFI + * @return AFI */ uint8_t getAFI(); /** - * return the Unique ID. - * Must be in ROOT mode. + * Returns a unique ID. + * Must be in the root mode. * - * @param buf buffer to hold returned UID. Must be UID_LENGTH bytes. + * @param buf Buffer to hold the returned UID. Must be UID_LENGTH bytes. */ void getUID(uint8_t* buf); /** - * return the memory size - * Must be in ROOT mode. + * Returns the memory size + * Must be in the root mode. * - * @return the amount of memory present + * @return Amount of memory present */ uint32_t getMemorySize(); /** - * set all memory to 0, if permissions allow + * Sets all memory to 0, if permissions allow */ void clearMemory(); /** - * write a byte to EEPROM + * Writes a byte to the EEPROM * - * @param address address to write to - * @param data data to write + * @param address Address to write to + * @param data Data to write */ void writeByte(unsigned int address, uint8_t data); /** - * write bytes to EEPROM + * Writes bytes to the EEPROM * - * @param address address to write to - * @param data data to write - * @param data length of data buffer + * @param address Address to write to + * @param data Data to write + * @param data Length of the data buffer */ void writeBytes(unsigned int address, uint8_t* buf, unsigned int len); /** - * read a byte from EEPROM + * Reads a byte from the EEPROM * - * @param address address to read from - * @return data value read + * @param address Address to read from + * @return data Value read */ uint8_t readByte(unsigned int address); /** - * read multiple bytes from EEPROM + * Reads multiple bytes from the EEPROM * - * @param address address to read from - * @param buffer buffer to store data - * @param len number of bytes to read + * @param address Address to read from + * @param buffer Buffer to store data + * @param len Number of bytes to read */ void readBytes(unsigned int address, uint8_t* buf, unsigned int len); diff --git a/src/max31723/max31723.h b/src/max31723/max31723.h index eac7f986..cfdba02c 100644 --- a/src/max31723/max31723.h +++ b/src/max31723/max31723.h @@ -34,7 +34,7 @@ namespace upm { /** - * @brief MAX31723 temperature sensor library + * @brief MAX31723 Temperature Sensor library * @defgroup max31723 libupm-max31723 * @ingroup maxim spi temperature */ @@ -46,11 +46,11 @@ namespace upm { * @man maxim * @con spi * - * @brief API for MAX31723 chip (Temperature Sensor) + * @brief API for the MAX31723 Temperature Sensor * - * The Maxim Integrated + * Maxim Integrated* * [MAX31723](http://datasheets.maximintegrated.com/en/ds/MAX31722-MAX31723.pdf) - * is a Low-Voltage 3-Wire/SPI Temperature Sensor controller. This module was + * is a low-voltage 3-wire/SPI temperature sensor controller. This module was * tested on the Maxim Integrated [MAX31732PMB1 PMOD * module](http://datasheets.maximintegrated.com/en/ds/MAX31723PMB1.pdf) from * the analog PMOD kit. @@ -67,25 +67,25 @@ class MAX31723 { static const uint8_t B_CONT_READING = 0x00; /** - * Instanciates a MAX31723 object + * Instantiates an MAX31723 object * - * @param bus number of used bus - * @param devAddr addres of used i2c device + * @param bus Number of the used bus + * @param devAddr Address of the used I2C device */ MAX31723 (int csn); /** - * MAXDS3231M object destructor, basicaly it close i2c connection. + * MAXDS3231M object destructor; basically, it closes the I2C connection. */ ~MAX31723 (); /** - * Get on board temperature. + * Gets the on-board temperature. */ short getTemperature (); /** - * Return name of the component + * Returns the name of the component */ std::string name() { @@ -100,12 +100,12 @@ class MAX31723 { void writeRegister (uint8_t reg, uint8_t data); /** - * Set chip select pin LOW + * Sets the chip select pin to LOW */ mraa_result_t CSOn (); /** - * Set chip select pin HIGH + * Sets the chip select pin to HIGH */ mraa_result_t CSOff (); }; diff --git a/src/max31855/max31855.h b/src/max31855/max31855.h index 311f0bb2..bbd6af86 100644 --- a/src/max31855/max31855.h +++ b/src/max31855/max31855.h @@ -30,7 +30,7 @@ namespace upm { /** - * @brief MAX31855 thermocouple library + * @brief MAX31855 Thermocouple library * @defgroup max31855 libupm-max31855 * @ingroup maxim adafruit spi other */ @@ -42,12 +42,12 @@ namespace upm { * @man maxim adafruit * @con spi * - * @brief API for MAX31855 Thermocouple Amplifier + * @brief API for the MAX31855 Thermocouple Amplifier * - * The Maxim Integrated + * Maxim Integrated* * [MAX31855](http://datasheets.maximintegrated.com/en/ds/MAX31855.pdf) - * is a Cold-Junction Compensated Thermocouple-to-Digital Converter. This - * module was * tested on the Maxim Integrated + * is a cold-junction compensated thermocouple-to-digital converter. This + * module was tested on the Maxim Integrated * [MAX31855PMB1 PMOD module] * (http://datasheets.maximintegrated.com/en/ds/MAX31855PMB1.pdf) from the * analog PMOD kit. @@ -58,10 +58,10 @@ namespace upm { class MAX31855 { public: /** - * Instanciates a MAX31855 object + * Instantiates an MAX31855 object * - * @param bus The spi bus to use - * @param cs The chip select pin + * @param bus SPI bus to use + * @param cs Chip select pin */ MAX31855(int bus, int cs); @@ -71,9 +71,9 @@ class MAX31855 { ~MAX31855(); /** - * Get the distance from the sensor + * Gets the distance from the sensor * - * @return value in degrees celcius + * @return Value in Celsius */ //! [Interesting] double getTemp(); diff --git a/src/max44000/max44000.h b/src/max44000/max44000.h index 1191a350..43812866 100644 --- a/src/max44000/max44000.h +++ b/src/max44000/max44000.h @@ -38,7 +38,7 @@ #define PRXDATA 0x15 // proximity sensor data #define ALS_UP_THRESH_HIGH 0x06 // ALS Interrupt Threshold Registers High -#define ALS_UP_THRESH_LOW 0x07 // ALS Interrupt Threshold Registers LOW +#define ALS_UP_THRESH_LOW 0x07 // ALS Interrupt Threshold Registers Low #define ALS_LO_THRESH_HIGH 0x08 // ALS Interrupt Threshold Registers High #define ALS_LO_THRESH_LOW 0x09 // ALS Interrupt Threshold Registers Low #define TPTR 0x0A // ALS/PROX Threshold Persist Timer Register @@ -53,7 +53,7 @@ namespace upm { /** - * @brief MAX44000 proximity sensor library + * @brief MAX44000 Proximity Sensor library * @defgroup max44000 libupm-max44000 * @ingroup maxim i2c light */ @@ -65,11 +65,11 @@ namespace upm { * @man maxim * @con i2c * - * @brief API for MAX44000 chip (Ambient and Infrared Proximity Sensor) + * @brief API for the MAX44000 Ambient and Infrared Proximity Sensor * - * The Maxim Integrated + * Maxim Integrated* * [MAX44000](http://datasheets.maximintegrated.com/en/ds/MAX44000.pdf) - * is Ambient and Infrared Proximity Sensor. This module was tested on the + * is an ambient and infrared proximity sensor. This module was tested on the * Maxim Integrated * [MAX44000PMB1 PMOD module] * (http://datasheets.maximintegrated.com/en/ds/MAX44000PMB1.pdf) from the @@ -80,29 +80,29 @@ namespace upm { class MAX44000 { public: /** - * Instanciates a MAX44000 object + * Instantiates an MAX44000 object * - * @param bus number of used bus - * @param devAddr addres of used i2c device + * @param bus Number of the used bus + * @param devAddr Address of the used I2C device */ MAX44000 (int bus, int devAddr); /** - * MAX44000 object destructor, basicaly it close i2c connection. + * MAX44000 object destructor; basically, it closes the I2C connection. */ ~MAX44000 (); /** - * Read the proximity value from the chip (based on ambient data). + * Reads the proximity value from the sensor (based on ambient data). */ uint16_t getProximity (); /** - * Read the ambient value from the chip (based on ambient data). + * Reads the ambient value from the sensor (based on ambient data). */ uint16_t getAmbient (); /** - * Return name of the component + * Returns the name of the component */ std::string name() { @@ -110,24 +110,24 @@ class MAX44000 { } /** - * Read one byte register + * Reads a one-byte register * - * @param reg address of a register + * @param reg Address of the register */ uint8_t i2cReadReg_8 (int reg); /** - * Read two bytes register + * Reads a two-byte register * - * @param reg address of a register + * @param reg Address of the register */ uint16_t i2cReadReg_16 (int reg); /** - * Write to one byte register + * Writes to a one-byte register * - * @param reg address of a register - * @param value byte to be written + * @param reg Address of the register + * @param value Byte to be written */ mraa_result_t i2cWriteReg (uint8_t reg, uint8_t value); diff --git a/src/max5487/max5487.h b/src/max5487/max5487.h index c1ad4b65..0784d48b 100644 --- a/src/max5487/max5487.h +++ b/src/max5487/max5487.h @@ -34,7 +34,7 @@ namespace upm { /** - * @brief MAX5487 digital potentiometer library + * @brief MAX5487 Digital Potentiometer library * @defgroup max5487 libupm-max5487 * @ingroup maxim spi digipot */ @@ -46,12 +46,12 @@ namespace upm { * @man maxim * @con spi * - * @brief API for MAX5487 chip (SPI digital potentiometer) + * @brief API for the MAX5487 SPI Digital Potentiometer * - * The Maxim Integrated + * Maxim Integrated* * [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf) - * is a Dual, 256-Tap, Nonvolatile, SPI-Interface, Linear-Taper Digital - * Potentiometer. This module was tested on the Maxim Integrated [MAX5487PMB1 + * is a dual, 256-tap, nonvolatile, SPI, linear-taper digital + * potentiometer. This module was tested on the Maxim Integrated [MAX5487PMB1 * PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf) * from the analog PMOD kit. * @@ -63,9 +63,9 @@ class MAX5487 { static const uint8_t R_WR_WIPER_B = 0x02; /** - * Instanciates a MAX5487 object + * Instantiates an MAX5487 object * - * @param csn to use if any, by default will use ICSP CS (-1) + * @param csn CSN to use, if any; by default, ICSP CS (-1) is used */ MAX5487 (int csn = -1); @@ -75,17 +75,17 @@ class MAX5487 { ~MAX5487 (); /** - * Set wiper for port A. + * Sets a wiper for port A. */ void setWiperA (uint8_t wiper); /** - * Set wiper for port B. + * Sets a wiper for port B. */ void setWiperB (uint8_t wiper); /** - * Return name of the component + * Returns the name of the component */ std::string name() { @@ -97,12 +97,12 @@ class MAX5487 { mraa_gpio_context m_csnPinCtx; /** - * Set chip select pin LOW + * Sets the chip select pin to LOW */ mraa_result_t CSOn (); /** - * Set chip select pin HIGH + * Sets the chip select pin to HIGH */ mraa_result_t CSOff (); }; diff --git a/src/maxds3231m/maxds3231m.h b/src/maxds3231m/maxds3231m.h index 9b3c53dc..62822eb7 100644 --- a/src/maxds3231m/maxds3231m.h +++ b/src/maxds3231m/maxds3231m.h @@ -63,7 +63,7 @@ struct Time3231 { }; /** - * @brief MAXDS3231M proximity sensor library + * @brief MAXDS3231M Proximity Sensor library * @defgroup maxds3231m libupm-maxds3231m * @ingroup maxim i2c light */ @@ -75,48 +75,48 @@ struct Time3231 { * @man maxim * @con i2c * - * @brief API for MAXDS3231M chip (I2C Real-Time Clock) + * @brief API for the MAXDS3231M I2C Real-Time Clock * - * This file defines the API for maxds3231m + * This file defines the API for MAXDS3231M * * @snippet maxds3231m.cxx Interesting */ class MAXDS3231M { public: /** - * Instanciates a MAXDS3231M object + * Instantiates an MAXDS3231M object * - * @param bus number of used bus - * @param devAddr addres of used i2c device + * @param bus Number of the used bus + * @param devAddr Address of the used I2C device */ MAXDS3231M (int bus=0, int devAddr=0x68); /** - * MAXDS3231M object destructor, basicaly it close i2c connection. + * MAXDS3231M object destructor; basically, it closes the I2C connection. */ ~MAXDS3231M (); /** - * Set date and time on the chip. + * Sets the date and time on the chip. * - * @param time staracture + * @param time Time structure */ void setDate (Time3231 &time); /** - * Get date and time located on the chip. + * Gets the date and time from the chip. * - * @param time staracture + * @param time Time structure */ bool getDate (Time3231 &time); /** - * Get on board temperature. + * Gets the on-board temperature. */ uint16_t getTemperature (); /** - * Return name of the component + * Returns the name of the component */ std::string name() { diff --git a/src/maxsonarez/maxsonarez.h b/src/maxsonarez/maxsonarez.h index 908d4522..b63226d7 100644 --- a/src/maxsonarez/maxsonarez.h +++ b/src/maxsonarez/maxsonarez.h @@ -32,7 +32,7 @@ namespace upm { /** - * @brief MaxSonar-EZ family of ultrasonic rangers library + * @brief MaxSonar-EZ Family of Ultrasonic Rangers library * @defgroup maxsonarez libupm-maxsonarez * @ingroup seeed analog sound */ @@ -47,20 +47,20 @@ namespace upm { * @web https://www.sparkfun.com/products/8502 * @con analog * - * @brief API for the LV-MaxSonar-EZ family of ultrasonic rangers + * @brief API for the LV-MaxSonar-EZ Family of Ultrasonic Rangers * - * This sensor family returns an analog voltage corresponding to the - * distance of an object from the sensor in inches. It has a - * resolution of about 9.7 millivolts per inch with a 5.0 AREF. The - * differences between the various versions (EZ1, EZ2, etc) are + * Sensors of this family return an analog voltage corresponding to the + * distance of an object from the sensor in inches. They have a + * resolution of about 9.7 millivolts per inch with an analog reference voltage of 5.0 V. The + * differences between various versions (EZ1, EZ2, etc.) are * related to the narrowness of the beam angle. * * This class supports these sensors with an analog input only. * - * This driver was developed using an LV-MaxSonar-EZ3. + * This driver was developed using an LV-MaxSonar-EZ3 ultrasonic ranger. * * @image html maxsonarez.jpg - *
LV-MaxSonar-EZ Ultrasonic Ranger image provided by SparkFun under + *
LV-MaxSonar-EZ Ultrasonic Ranger image provided by SparkFun* under * * CC BY-NC-SA-3.0. * @@ -71,22 +71,22 @@ namespace upm { public: /** - * MAXSONAREZ sensor constructor + * MAXSONAREZ constructor * - * @param pin analog pin to use - * @param aref the analog reference voltage, default: 5.0 + * @param pin Analog pin to use + * @param aref Analog reference voltage; default is 5.0 V */ MAXSONAREZ(int pin, float aref=5.0); /** - * MAXSONAREZ Destructor + * MAXSONAREZ destructor */ ~MAXSONAREZ(); /** - * get the distance to the object in inches + * Gets the distance to the object in inches * - * @return the distance to the object in inches + * @return Distance to the object in inches */ int inches(); @@ -95,7 +95,7 @@ namespace upm { float m_aref; // ADC resolution int m_aRes; - // computed Volts per Inch + // computed volts per inch float m_vI; }; } diff --git a/src/mhz16/mhz16.h b/src/mhz16/mhz16.h index 6d7856bf..7cf822d9 100644 --- a/src/mhz16/mhz16.h +++ b/src/mhz16/mhz16.h @@ -48,7 +48,7 @@ const uint8_t MHZ16_END = 0x7e; namespace upm { /** - * @brief MHZ16 Serial CO2 sensor library + * @brief MHZ16 Serial CO2 Sensor library * @defgroup mhz16 libupm-mhz16 * @ingroup seeed uart gaseous */ @@ -66,8 +66,8 @@ namespace upm { * * This class implements support for the Grove CO2 sensor. * - * It's CO2 detection ranges from 0PPM to 2000PPM. It requires a - * 2-3 minute warm up time before reporting valid data. + * Its CO2 detection range is 0-2,000 ppm. It requires a + * 2-3 minute warm-up time before reporting valid data. * * @image html mhz16.jpg * @snippet mhz16.cxx Interesting @@ -77,75 +77,75 @@ namespace upm { /** - * MHZ16 module constructor + * MHZ16 constructor * - * @param uart default uart to use (0 or 1) + * @param uart Default UART to use (0 or 1) */ MHZ16(int uart); /** - * MHZ16 module Destructor + * MHZ16 destructor */ ~MHZ16(); /** - * Check to see if there is data available for reading + * Checks to see if there is data available for reading * - * @param millis number of milliseconds to wait, 0 means no wait. - * @return true if there is data available to be read + * @param millis Number of milliseconds to wait; 0 means no waiting. + * @return True if there is data available for reading */ bool dataAvailable(unsigned int millis); /** - * read any available data into a user-supplied buffer. Note, the - * call will block until data is available to be read. Use + * Reads any available data in a user-supplied buffer. Note: the + * call blocks until data is available to be read. Use * dataAvailable() to determine whether there is data available * beforehand, to avoid blocking. * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes read + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes read */ int readData(char *buffer, size_t len); /** - * write the data in buffer to the device + * Writes the data in the buffer to the device * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes written + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes written */ int writeData(char *buffer, size_t len); /** - * setup the proper tty i/o modes and the baudrate. The default - * baud rate is 9600 (B9600). + * Sets up proper tty I/O modes and the baud rate. The default + * baud rate is 9,600 (B9600). * - * @param baud the desired baud rate. - * @return true if successful + * @param baud Desired baud rate. + * @return True if successful */ bool setupTty(speed_t baud=B9600); /** - * verify the packet header and indicate it's validity + * Verifies the packet header and indicates its validity * - * @param pkt the packet to check - * @return true if valid checksum, false otherwise + * @param pkt Packet to check + * @return True if the checksum is valid, false otherwise */ bool verifyPacket(unsigned char *pkt); /** - * Query the sensor and return gas (CO2) concentration and + * Queries the sensor and returns gas (CO2) concentration and * temperature data. * - * @param gas the returned gas concentration - * @param temp the returned temperature in celsius - * @return true if successful + * @param gas Returned gas concentration + * @param temp Returned temperature in Celsius + * @return True if successful */ bool getData(int *gas, int *temp); /** - * Set the zero point of the sensor + * Sets the zero point of the sensor * */ void calibrateZeroPoint(); diff --git a/src/mic/mic.h b/src/mic/mic.h index db49b634..e2dfb5b0 100644 --- a/src/mic/mic.h +++ b/src/mic/mic.h @@ -36,7 +36,7 @@ struct thresholdContext { namespace upm { /** - * @brief Analog microphone library + * @brief Analog Microphone library * @defgroup mic libupm-mic * @ingroup seeed pwm sound gsk */ @@ -51,9 +51,9 @@ namespace upm { * @con pwm * @kit gsk * - * @brief API for Microphone + * @brief API for the Analog Microphone * - * This file defines the Microphone Analog sensor + * This file defines the Analog Microphone sensor * * @image html mic.jpg * @snippet mic.cxx Interesting @@ -61,43 +61,43 @@ namespace upm { class Microphone { public: /** - * Instanciates a Microphone object + * Instantiates a Microphone object * - * @param micPin pin where microphone is connected + * @param micPin Pin where the microphone is connected */ Microphone(int micPin); /** - * MAX31723 object destructor + * Microphone object destructor */ ~Microphone(); /** - * Get samples from microphone according to provided window and + * Gets samples from the microphone according to the provided window and * number of samples * - * @param freqMS time between each sample (in microseconds) - * @param numberOfSamples number of sample to sample for this window - * @param buffer bufer with sampled data + * @param freqMS Time between each sample (in microseconds) + * @param numberOfSamples Number of sample to sample for this window + * @param buffer Buffer with sampled data */ int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer); /** - * Given sampled buffer this method will return TRUE/FALSE if threshold - * was reached + * Given the sampled buffer, this method returns TRUE/FALSE if threshold + * is reached * - * @param ctx threshold context - * @param threshold sample threshold - * @param buffer buffer with samples - * @param len bufer len + * @param ctx Threshold context + * @param threshold Sample threshold + * @param buffer Buffer with samples + * @param len Buffer length */ int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len); /** * - * Print running average of threshold context + * Prints a running average of the threshold context * - * @param ctx threshold context + * @param ctx Threshold context */ void printGraph (thresholdContext* ctx); diff --git a/src/mlx90614/mlx90614.h b/src/mlx90614/mlx90614.h index 209a4860..f6b96d9e 100644 --- a/src/mlx90614/mlx90614.h +++ b/src/mlx90614/mlx90614.h @@ -53,7 +53,7 @@ namespace upm { /** - * @brief MLX90614 temperature sensor library + * @brief MLX90614 Temperature Sensor library * @defgroup mlx90614 libupm-mlx90614 * @ingroup generic i2c temperature */ @@ -65,7 +65,7 @@ namespace upm { * @man generic * @con i2c * - * @brief API for MLX90614 + * @brief API for the MLX90614 Temperature Sensor * * This file defines the MLX90614 interface for libmlx90614 * @@ -76,39 +76,39 @@ class MLX90614 { public: /** - * Instanciates a MLX90614 object + * Instantiates an MLX90614 object * - * @param bus number of used bus - * @param devAddr addres of used i2c device + * @param bus Number of the used bus + * @param devAddr Address of the used I2C device */ MLX90614 (int bus=0, int devAddr=0x5A); /** - * MLX90614 object destructor, basicaly it close i2c connection. + * MLX90614 object destructor; basically, it closes the I2C connection. */ ~MLX90614 (); /** - * Read object temperature in Fahrenheit + * Reads the object temperature in Fahrenheit */ float readObjectTempF(void); /** - * Read ambient temperature in Fahrenheit + * Reads the ambient temperature in Fahrenheit */ float readAmbientTempF(void); /** - * Read object temperature in Celsius + * Reads the object temperature in Celsius */ float readObjectTempC(void); /** - * Read ambient temperature in Celsius + * Reads the ambient temperature in Celsius */ float readAmbientTempC(void); /** - * Return name of the component + * Returns the name of the component */ std::string name() { diff --git a/src/mma7455/mma7455.h b/src/mma7455/mma7455.h index 3df18923..a9738217 100644 --- a/src/mma7455/mma7455.h +++ b/src/mma7455/mma7455.h @@ -30,7 +30,7 @@ // Register names according to the datasheet. // Register 0x1C is sometimes called 'PW', and sometimes 'PD'. -// The two reserved registers can not be used. +// The two reserved registers cannot be used. #define MMA7455_XOUTL 0x00 // Read only, Output Value X LSB #define MMA7455_XOUTH 0x01 // Read only, Output Value X MSB #define MMA7455_YOUTL 0x02 // Read only, Output Value Y LSB @@ -64,9 +64,9 @@ #define MMA7455_TW 0x1E // Read/Write, Time Window for Second Pulse Value #define MMA7455_RESERVED2 0x1F // Reserved -// Defines for the bits, to be able to change -// between bit number and binary definition. -// By using the bit number, programming the MMA7455 +// Defines for the bits to be able to change +// between the bit number and the binary definition. +// By using the bit number, programming MMA7455 // is like programming an AVR microcontroller. // But instead of using "(1<SM130 RFID Reader image provided by SparkFun under + *
SM130 RFID Reader image provided by SparkFun* under * * CC BY-NC-SA-3.0. * @@ -103,10 +103,10 @@ class SM130 { static const uint8_t CMD_SLEEP = 0x96; /** - * Instanciates a SM130 object + * Instantiates an SM130 object * - * @param di data pin - * @param dcki clock pin + * @param di Data pin + * @param dcki Clock pin */ SM130 (int bus, int devAddr, int rst, int dready); @@ -116,22 +116,22 @@ class SM130 { ~SM130 (); /** - * Get the firmware version string. + * Gets the firmware version string. */ const char* getFirmwareVersion (); /** * Checks for availability of a valid response packet. * - * This function should always be called and return true prior to using results + * This function should always be called and return true prior to using the results * of a command. * - * @returns true if a valid response packet is available + * @returns True if a valid response packet is available */ uint8_t available (); /** - * Returns the packet length, excluding checksum + * Returns the packet length, excluding the checksum */ uint8_t getPacketLength () { return this->m_Data[0]; }; @@ -141,7 +141,7 @@ class SM130 { uint8_t getCommand () { return this->m_Data[1]; }; /** - * Return name of the component + * Returns the name of the component */ std::string name() { diff --git a/src/st7735/gfx.h b/src/st7735/gfx.h index 797302ac..3337ab39 100644 --- a/src/st7735/gfx.h +++ b/src/st7735/gfx.h @@ -36,17 +36,17 @@ namespace upm { /** * @brief GFX helper class * - * This file used by the screen. + * This file is used by the screen. */ class GFX { public: /** - * Instanciates a GFX object + * Instantiates a GFX object * - * @param width screen width - * @param height screen height - * @param screenBuffer pointer to screen buffer - * @param font pointer to font map + * @param width Screen width + * @param height Screen height + * @param screenBuffer Pointer to the screen buffer + * @param font Pointer to the font map */ GFX (int width, int height, uint8_t * screenBuffer, const unsigned char * font); @@ -56,147 +56,147 @@ class GFX { ~GFX (); /** - * Set the window address + * Sets the window address * - * @param x0 first coordinate - * @param y0 first coordinate - * @param x1 second coordinate - * @param y1 second coordinate + * @param x0 First coordinate + * @param y0 First coordinate + * @param x1 Second coordinate + * @param y1 Second coordinate */ virtual void setAddrWindow (uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1) = 0; /** - * Send pixel collor (RGB) to the chip. Must be implemented by + * Sends a pixel color (RGB) to the chip. Must be implemented by the * inherited class. * - * @param x axis on horizontal scale - * @param y axis on vertical scale - * @param color rgb value + * @param x Axis on the horizontal scale + * @param y Axis on the vertical scale + * @param color RGB value */ virtual void drawPixel (int16_t x, int16_t y, uint16_t color) = 0; /** - * Copy the buffer to the chip via SPI interface. + * Copies the buffer to the chip via the SPI. */ virtual void refresh () = 0; /** * * - * @param x axis on horizontal scale - * @param y axis on vertical scale - * @param data character to write - * @param color character's color - * @param bg character's background color - * @param size size of the font + * @param x Axis on the horizontal scale + * @param y Axis on the vertical scale + * @param data Character to write + * @param color Character color + * @param bg Character background color + * @param size Size of the font */ void drawChar (int16_t x, int16_t y, uint8_t data, uint16_t color, uint16_t bg, uint8_t size); /** - * Print the message to the screen + * Prints a message on the screen * - * @param msg message which will be printed + * @param msg Message to print */ void print (std::string msg); /** - * Print the message to the screen + * Prints a message on the screen * - * @param x axis on horizontal scale - * @param y axis on vertical scale - * @param color pixel's color + * @param x Axis on the horizontal scale + * @param y Axis on the vertical scale + * @param color Pixel color */ mraa_result_t setPixel (int x, int y, uint16_t color); /** - * Fill screen with selected color + * Fills the screen with a selected color * - * @param color selected's color + * @param color Selected color */ void fillScreen (uint16_t color); /** - * Fill rectangle with selected color + * Fills a rectangle with a selected color * - * @param x axis on horizontal scale (top left corner) - * @param y axis on vertical scale (top left corner) - * @param w distanse from x - * @param h distanse from y - * @param color selected color + * @param x Axis on the horizontal scale (top-left corner) + * @param y Axis on the vertical scale (top-left corner) + * @param w Distanse from x + * @param h Distanse from y + * @param color Selected color */ void fillRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color); /** - * Draw line in vertical scale. + * Draws a line on the vertical scale * - * @param x axis on horizontal scale - * @param y axis on vertical scale - * @param h distanse from y - * @param color selected color + * @param x Axis on the horizontal scale + * @param y Axis on the vertical scale + * @param h Distanse from y + * @param color Selected color */ void drawFastVLine(int16_t x, int16_t y, int16_t h, uint16_t color); /** - * Draw line from coordinate C0 to coordinate C1 + * Draws a line from coordinate C0 to coordinate C1 * - * @param x0 first coordinate - * @param y0 first coordinate - * @param x1 second coordinate - * @param y1 second coordinate + * @param x0 First coordinate + * @param y0 First coordinate + * @param x1 Second coordinate + * @param y1 Second coordinate * @param color selected color */ void drawLine (int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color); /** - * Draw a triangle + * Draws a triangle * - * @param x0 first coordinate - * @param y0 first coordinate - * @param x1 second coordinate - * @param y1 second coordinate - * @param x2 third coordinate - * @param y2 third coordinate - * @param color selected color + * @param x0 First coordinate + * @param y0 First coordinate + * @param x1 Second coordinate + * @param y1 Second coordinate + * @param x2 Third coordinate + * @param y2 Third coordinate + * @param color Selected color */ void drawTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color); /** - * Draw a circle + * Draws a circle * - * @param x center of circle on X scale - * @param y center of circle on Y scale - * @param r radius of circle - * @param color color of circle + * @param x Center of the circle on the horizontal scale + * @param y Center of the circle on the vertical scale + * @param r Radius of the circle + * @param color Color of the circle */ void drawCircle (int16_t x, int16_t y, int16_t r, uint16_t color); /** - * Set cursor for text message + * Sets the cursor for a text message * - * @param x axis on horizontal scale - * @param y axis on vertical scale + * @param x Axis on the horizontal scale + * @param y Axis on the vertical scale */ void setCursor (int16_t x, int16_t y); /** - * Set text color for the message + * Sets a text color for a message * - * @param textColor font color - * @param textBGColor background color + * @param textColor Font color + * @param textBGColor Background color */ void setTextColor (uint16_t textColor, uint16_t textBGColor); /** - * Set the size of the font + * Sets the size of the font * - * @param size font size + * @param size Font size */ void setTextSize (uint8_t size); /** - * Wrap printed message. + * Wraps a printed message * - * @param wrap true (0x1) or false (0x0) + * @param wrap True (0x1) or false (0x0) */ void setTextWrap (uint8_t wrap); diff --git a/src/st7735/st7735.h b/src/st7735/st7735.h index 646a840b..bb932a41 100644 --- a/src/st7735/st7735.h +++ b/src/st7735/st7735.h @@ -494,22 +494,22 @@ const unsigned char font[] = { }; /** - * @brief ST7735 LCD display library + * @brief ST7735 LCD library * @defgroup st7735 libupm-st7735 * @ingroup adafruit spi display */ /** * @library st7735 * @sensor st7735 - * @comname ST7735 LCD display + * @comname ST7735 LCD * @type display * @man adafruit * @web http://www.adafruit.com/product/358 * @con spi * - * @brief API for the st7735 lcd display library + * @brief API for the ST7735 LCD * - * This file defines the interface for ST7735 display library + * This file defines the interface for the ST7735 display library * * @image html st7735.jpg * @snippet st7735.cxx Interesting @@ -517,12 +517,12 @@ const unsigned char font[] = { class ST7735 : public GFX { public: /** - * Instantiates a ST7735 object + * Instantiates an ST7735 object * * @param csLCD LCD chip select pin * @param cSD SD card chip select pin - * @param rs data/command pin - * @param rst reset pin + * @param rs Data/command pin + * @param rst Reset pin */ ST7735 (uint8_t csLCD, uint8_t cSD, uint8_t rs, uint8_t rst); @@ -532,7 +532,7 @@ class ST7735 : public GFX { ~ST7735 (); /** - * Return name of the component + * Returns the name of the component */ std::string name() { @@ -540,88 +540,88 @@ class ST7735 : public GFX { } /** - * Initialize the modules GPIOs + * Initializes the module GPIOs */ void initModule (); /** - * Configure the chip via SPI interface + * Configures the chip via the SPI */ void configModule (); /** - * Send command to SPI bus (rs must be LOW) + * Sends a command to an SPI bus (rs must be LOW) * - * @param value command number + * @param value Command number */ void write (uint8_t value); /** - * Send data to SPI bus (rs must be HIGH) + * Sends data to an SPI bus (rs must be HIGH) * - * @param value command number + * @param value Command number */ void data (uint8_t value); /** - * Execute set of commands and data + * Executes a set of commands and data * - * @param addr pointer to start of the commands/data section + * @param addr Pointer to the start of the commands/data section */ void executeCMDList (const uint8_t *addr); /** - * Set the window size inside the screen where the pixels data - * will be written. + * Sets the window size inside the screen where pixels data + * is written. * - * @param x0 first coordinate - * @param y0 first coordinate - * @param x1 second coordinate - * @param y1 second coordinate + * @param x0 First coordinate + * @param y0 First coordinate + * @param x1 Second coordinate + * @param y1 Second coordinate */ void setAddrWindow (uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1); /** - * Send pixel collor (RGB) to the chip. + * Sends a pixel color (RGB) to the chip. * - * @param x axis on horizontal scale - * @param y axis on vertical scale - * @param color rgb (16bit) color (R[0-4], G[5-10], B[11-15]) + * @param x Axis on the horizontal scale + * @param y Axis on the vertical scale + * @param color RGB (16-bit) color (R[0-4], G[5-10], B[11-15]) */ void drawPixel (int16_t x, int16_t y, uint16_t color); /** - * Copy the buffer to the chip via SPI interface. + * Copies the buffer to the chip via the SPI. */ void refresh (); /** - * LCD chip select LOW. + * LCD chip select is LOW */ mraa_result_t lcdCSOn (); /** - * LCD chip select HIGH. + * LCD chip select is HIGH */ mraa_result_t lcdCSOff (); /** - * CD card chip select LOW. + * CD card chip select is LOW */ mraa_result_t sdCSOn (); /** - * CD card select HIGH. + * CD card select is HIGH */ mraa_result_t sdCSOff (); /** - * Data select HIGH. + * Data select is HIGH */ mraa_result_t rsHIGH (); /** - * Data select LOW. + * Data select is LOW */ mraa_result_t rsLOW (); diff --git a/src/stepmotor/stepmotor.h b/src/stepmotor/stepmotor.h index 19a086cb..e5eee5c4 100644 --- a/src/stepmotor/stepmotor.h +++ b/src/stepmotor/stepmotor.h @@ -41,7 +41,7 @@ namespace upm { /** - * @brief Stepper motor library + * @brief Stepper Motor library * @defgroup stepper libupm-stepper * @ingroup seeed sparkfun pwm gpio motor */ @@ -55,10 +55,10 @@ namespace upm { * @web http://www.schmalzhaus.com/EasyDriver/index.html * @con pwm gpio * - * @brief API for the Stepper motor library + * @brief API for the Stepper Motor * - * This file defines the StepMotor interface. It is compatible with Stepper - * Motor Drivers that use 2 pins to control the motor, like the EasyDriver + * This file defines the Stepper Motor interface. It is compatible with stepper + * motor drivers that use 2 pins to control the motor, like an Easy Driver * from Brian Schmalz. * * @image html stepmotor.jpg @@ -69,34 +69,34 @@ class StepMotor { /** * Instantiates a StepMotor object * - * @param dirPin direction GPIO pin - * @param stePin stepper pulse PWM pin + * @param dirPin Direction GPIO pin + * @param stePin Stepper pulse PWM pin */ StepMotor (int dirPin, int stePin); /** - * StepMotor object destructor. + * StepMotor object destructor */ ~StepMotor (); /** - * Set the speed of rotation + * Sets the rotation speed * - * @param speed rotation speed + * @param speed Rotation speed */ void setSpeed (int speed); /** - * Rotate motor forward + * Rotates the motor forward * - * @param ticks number of ticks the motor will move + * @param ticks Number of ticks the motor moves */ mraa_result_t stepForward (int ticks); /** - * Rotate motor backward + * Rotates the motor backward * - * @param ticks number of ticks the motor will move + * @param ticks Number of ticks the motor moves */ mraa_result_t stepBackwards (int ticks); diff --git a/src/sx6119/sx6119.h b/src/sx6119/sx6119.h index 7e5c9ad6..f2268830 100644 --- a/src/sx6119/sx6119.h +++ b/src/sx6119/sx6119.h @@ -29,7 +29,7 @@ namespace upm { /** - * @brief SX6119 based FM receiver library + * @brief SX6119-based FM Receiver library * @defgroup sx6119 libupm-sx6119 * @ingroup seeed gpio sound */ @@ -43,10 +43,10 @@ namespace upm { * @man seeed * @con gpio * - * @brief API support for the SX6119 based Grove FM Receiver + * @brief API support for the SX6119-based Grove FM Receiver * - * This class implements support for the FM Receiver. There are - * two digital pins, one that toggles power on/off, and one that + * This class implements support for the SX6119 FM Receiver. There are + * two digital pins: one that toggles power on/off, and the other that * does a seek to the next station. * * @image html sx6119.jpg @@ -56,26 +56,26 @@ namespace upm { public: /** - * SX6119 module constructor + * SX6119 constructor * - * @param powerPin the pin to use for recording - * @param seekPin the pin to use to seek to the next station + * @param powerPin Pin to use for recording + * @param seekPin Pin to use for seeking to the next station */ SX6119(int powerPin, int seekPin); /** - * SX6119 module Destructor + * SX6119 destructor */ ~SX6119(); /** - * Toggle the device power on or off + * Toggles the device power on or off * */ void togglePower(); /** - * Seek to the next station + * Seeks to the next station * */ void seek(); diff --git a/src/ta12200/ta12200.h b/src/ta12200/ta12200.h index dbebc4b2..b3561d48 100644 --- a/src/ta12200/ta12200.h +++ b/src/ta12200/ta12200.h @@ -34,26 +34,26 @@ namespace upm { /** - * @brief TA12-200 current transformer library + * @brief TA12-200 Current Transformer library * @defgroup ta12200 libupm-ta12200 * @ingroup seeed analog electric */ /** * @library ta12200 * @sensor ta12200 - * @comname TA12-200 Current transformer + * @comname TA12-200 Current Transformer * @altname Grove Electricity Sensor * @type electric * @man seeed * @web http://www.seeedstudio.com/wiki/Grove_-_Electricity_Sensor * @con analog * - * @brief API for the TA12-200 current transformer + * @brief API for the TA12-200 Current Transformer * - * UPM module for the TA12-200 current transformer, which is found, + * UPM module for the TA12-200 current transformer found, * for instance, in the Grove Electricity Sensor. - * This module can measure AC current moving through a wire at up - * to 5A. + * This module can measure AC moving through a wire at up + * to 5 A. * * @image html ta12200.jpg * @snippet ta12200.cxx Interesting @@ -61,45 +61,45 @@ namespace upm { class TA12200 { public: /** - * TA12200 sensor constructor + * TA12200 constructor * - * @param pin analog pin to use + * @param pin Analog pin to use */ TA12200(int pin); /** - * TA12200 Destructor + * TA12200 destructor */ ~TA12200(); /** - * Return the number of milliseconds elapsed since initClock() + * Returns the number of milliseconds elapsed since initClock() * was last called. * - * @return elapsed milliseconds + * @return Elapsed milliseconds */ uint32_t getMillis(); /** - * Reset the Clock + * Resets the clock * */ void initClock(); /** - * Get the conversion value from the sensor + * Gets the conversion value from the sensor * - * @return the highest value obtained over 1 second of measuring + * @return Highest value obtained over 1 second of measuring */ unsigned int highestValue(); /** - * Compute the measured voltage + * Computes the measured voltage * - * @param val value measured by highestValue() + * @param val Value measured by highestValue() * @param res ADC resolution * - * @return the measured current in milliamps + * @return Measured current in mA */ float milliAmps(unsigned int val, int res=TA12200_ADC_RES); diff --git a/src/tcs3414cs/tcs3414cs.h b/src/tcs3414cs/tcs3414cs.h index 9ff84d13..652baeba 100644 --- a/src/tcs3414cs/tcs3414cs.h +++ b/src/tcs3414cs/tcs3414cs.h @@ -105,7 +105,7 @@ typedef struct { } tcs3414sc_rgb_t; /** - * @brief TCS3414CS color sensor library + * @brief TCS3414CS Color Sensor library * @defgroup tcs3414cs libupm-tcs3414cs * @ingroup seeed i2c color */ @@ -119,9 +119,9 @@ typedef struct { * @web http://www.seeedstudio.com/wiki/Grove_-_I2C_Color_Sensor * @con i2c * - * @brief API for TCS3414CS chip (Color sensor) + * @brief API for the TCS3414CS Color Sensor * - * This file defines the TCS3414CS interface for the color sensor + * This file defines the TCS3414CS interface for the color sensor * * @image html tcs3414cs.jpg * @snippet tcs3414cs.cxx Interesting @@ -129,31 +129,31 @@ typedef struct { class TCS3414CS { public: /** - * Instanciates a TCS3414CS object + * Instantiates a TCS3414CS object * - * @param bus number of used bus + * @param bus Number of the used bus */ TCS3414CS (); /** - * TCS3414CS object destructor, basicaly it close i2c connection. + * TCS3414CS object destructor; basically, it closes the I2C connection. */ ~TCS3414CS (); /** - * Get the RGB value from sensor. + * Gets the RGB value from the sensor. * - * @param rgb color values + * @param rgb Color values */ void readRGB (tcs3414sc_rgb_t * rgb); /** - * Clear interrupts. + * Clears interrupts. */ void clearInterrupt (); /** - * Return name of the component + * Returns the name of the component */ std::string name() { diff --git a/src/th02/th02.h b/src/th02/th02.h index adaa5dbe..baed1fd0 100644 --- a/src/th02/th02.h +++ b/src/th02/th02.h @@ -45,7 +45,7 @@ namespace upm { /** - * @brief TH02 temperature & humidity sensor library + * @brief TH02 Temperature & Humidity Sensor library * @defgroup th02 libupm-th02 * @ingroup seeed i2c temp */ @@ -53,18 +53,18 @@ namespace upm { * @library th02 * @sensor th02 * @comname TH02 Temperature & Humidity Sensor - * @altname Grove Temperature & Humidity Sensor (High Accuracy & Mini) + * @altname Grove Temperature & Humidity Sensor (High-Accuracy & Mini) * @type temp * @man seeed * @web http://www.seeedstudio.com/wiki/Grove_-_Tempture%26Humidity_Sensor_(High-Accuracy_%26Mini)_v1.0 * @con i2c * - * @brief API for th02 temperature & humidity sensor library + * @brief API for the TH02 Temperature & Humidity Sensor * * This file defines the TH02 interface for libth02 * - * NOTE: For use on the Edison with the Arduino breakout board, the - * Edison must be set to 3v rather than 5v. + * Note: For use on Intel(R) Edison with an Arduino* breakout board, Intel + * Edison must be set to 3 V rather than 5 V. * * @image html th02.jpg * @snippet th02.cxx Interesting @@ -72,32 +72,32 @@ namespace upm { class TH02 { public: /** - * Instanciates a TH02 object + * Instantiates a TH02 object */ TH02 (int bus=0, uint8_t addr=TH02_ADDR); /** - * TH02 object destructor, basicaly it close i2c connection. + * TH02 object destructor; basically, it closes the I2C connection. */ ~TH02 (); /** - * Get the temperature value from sensor. + * Gets the temperature value from the sensor. */ float getTemperature (); /** - * Get the humidity value from sensor. + * Gets the humidity value from the sensor. */ float getHumidity (); /** - * Get the sensor's status. + * Gets the sensor status. */ bool getStatus (); /** - * Return name of the component + * Returns the name of the component */ std::string name() { diff --git a/src/tm1637/tm1637.h b/src/tm1637/tm1637.h index 9480ea2a..08ad2f31 100644 --- a/src/tm1637/tm1637.h +++ b/src/tm1637/tm1637.h @@ -32,19 +32,19 @@ #include -// TM1637 specific register addresses for writing all digits at a time +// TM1637-specific register addresses for writing all digits at a time #define TM1637_ADDR 0x40 #define TM1637_REG 0xC0 #define TM1637_CMD 0x88 -// Display specific values +// Display-specific values #define M_DISPLAY_DIGITS 4 namespace upm { /** - * @brief TM1637 7-segment display library + * @brief TM1637 7-Segment Display library * @defgroup tm1637 libupm-tm1637 * @ingroup seeed gpio display */ @@ -58,13 +58,13 @@ namespace upm * @man seeed * @con gpio * - * @brief API for TM1637 (7-segment display) + * @brief API for the TM1637 7-Segment Display * - * The TM1637 is a display controller for LED based 7-segment displays. + * TM1637 is a display controller for LED-based 7-segment displays. * It can be used to address and write data to multiple display digits. This - * driver is based on the Grove version of the TM1637 display which uses 4 - * digits thus making it ideal for clock displays, timers, counters or even - * score display in a two player arcade game. + * driver is based on the Grove version of the TM1637 display that uses 4 + * digits, thus making it ideal for clock displays, timers, counters, or even + * score displays in a two-player arcade game. * * @image html tm1637.jpeg * @snippet tm1637.cxx Interesting @@ -74,7 +74,7 @@ namespace upm { public: /** - * Enum for memory mapped GPIO + * Enum for the memory-mapped GPIO */ typedef enum { NO = 0, @@ -83,10 +83,10 @@ namespace upm /** * TM1637 constructor * - * @param clk_pin the clock pin the sensor is connected to - * @param dio_pin the data pin the sensor is connected to - * @param bright initial brightness from 0 to 7 dark to bright (default 3) - * @param mmio fast memory mapped gpio writes, default is yes + * @param clk_pin Clock pin the sensor is connected to + * @param dio_pin Data pin the sensor is connected to + * @param bright Initial brightness, from 0 (dark) to 7 (bright) (default is 3) + * @param mmio Fast memory-mapped GPIO writes; default is yes */ TM1637(int clk_pin, int dio_pin, int bright = 3, M_FAST_GPIO mmio = YES); /** @@ -94,44 +94,44 @@ namespace upm */ ~TM1637(); /** - * Write digits to the display in 7 segment encoding + * Writes digits to the display in a 7-segment encoding * - * @param digits an array of digits to send to the display - * @return 0 if the write was successful, error code otherwise + * @param digits Array of digits to send to the display + * @return 0 if successful, error code otherwise */ mraa_result_t write(uint8_t *digits); /** - * Write digits to the display in 7 segment encoding + * Writes digits to the display in a 7-segment encoding * - * @param d list of multiple arguments to send to the display - * @return 0 if the write was successful, error code otherwise + * @param d List of multiple arguments to send to the display + * @return 0 if successful, error code otherwise */ mraa_result_t write(int d, ...); /** - * Write a symbol (digit or letter) to the display at a specified index + * Writes a symbol (digit or letter) to the display in a specified index * * @param index 0-based index of the digit to change from the left - * @param symbol the digit or letter to display - * @return 0 if the write was successful, error code otherwise + * @param symbol Digit or letter to display + * @return 0 if successful, error code otherwise */ mraa_result_t writeAt(int index, char symbol); /** - * Write all the digits or letters to the display as a string + * Writes all the digits or letters to the display as a string * - * @param digits a string of symbols to display - * @return 0 if the write was successful, error code otherwise + * @param digits String of symbols to display + * @return 0 if successful, error code otherwise */ mraa_result_t write(std::string digits); /** * Toggles the colon between digits on the display * - * @param value pass true to turn on the colon, false to turn it off + * @param value True to turn the colon on, false to turn it off */ void setColon(bool value); /** - * Use to control the brightness of the display + * Controls the brightness of the display * - * @param value between 0 and 7, darkest to brightest + * @param value Brightness, from 0 (darkest) to 7 (brightest) */ void setBrightness(int value); diff --git a/src/tsl2561/tsl2561.h b/src/tsl2561/tsl2561.h index f361f045..30958b19 100644 --- a/src/tsl2561/tsl2561.h +++ b/src/tsl2561/tsl2561.h @@ -92,7 +92,7 @@ namespace upm { #define LUX_M8C (0x0000) // 0.000 * 2^LUX_SCALE /** - * @brief TSL2561 digital light sensor library + * @brief TSL2561 Digital Light Sensor library * @defgroup tsl2561 libupm-tsl2561 * @ingroup seeed i2c light eak */ @@ -107,12 +107,10 @@ namespace upm { * @con i2c * @kit eak * - * @brief TSL2561 Digital Light Sensor library + * @brief API for the TSL2561 Digital Light Sensor * - * The LIGHT-TO-DIGITAL CONVERTER [TAOS-TSL2561] - * (http://www.adafruit.com/datasheets/TSL2561.pdf) - * The TSL2560 and TSL2561 are light-to-digital converters that transform - * light intensity to a digital signal output capable of direct I2C (TSL2561) + * TSL2560 and TSL2561 are light-to-digital converters that transform + * light intensity to a digital signal output capable of a direct I2C (TSL2561) interface * * @image html tsl2561.jpg * @snippet tsl2561.cxx Interesting @@ -120,42 +118,42 @@ namespace upm { class TSL2561{ public: /** - * Instanciates a TSL2561 object + * Instantiates a TSL2561 object * - * @param bus number of used bus - * @param devAddr address of used i2c device - * @param gain the correct gain to use - * @param integration time to use + * @param bus Number of the used bus + * @param devAddr Address of the used I2C device + * @param gain Correct gain to use + * @param integration Time to use */ TSL2561(int bus=0, uint8_t devAddr=TSL2561_Address, uint8_t gain=GAIN_0X, uint8_t integrationTime=INTEGRATION_TIME1_101MS); /** - * GY65 object destructor to power down TSL2561 and close i2c connection. + * GY65 object destructor; powers down TSL2561 and closes the I2C connection. */ ~TSL2561(); /** - * Get calculated lux reading from TSL2561 + * Gets the calculated lux reading from TSL2561 * - * @return the calculated lux value from the sensor + * @return Calculated lux value from the sensor */ int getLux(); private: /** - * Write to TSL2561 register + * Writes to a TSL2561 register * - * @param reg addess to write - * @param value to write + * @param reg Addess to write + * @param Value to write * @return mraa_result_t */ mraa_result_t i2cWriteReg(uint8_t reg, uint8_t value); /** - * Read from TSL2561 register + * Reads from a TSL2561 register * - * @param reg addess to read - * @param data byte read from the register + * @param reg Addess to read + * @param data Byte read from the register * @return mraa_result_t */ mraa_result_t i2cReadReg(uint8_t reg, uint8_t &data); diff --git a/src/ttp223/ttp223.h b/src/ttp223/ttp223.h index 589734b0..f3ec5c1d 100644 --- a/src/ttp223/ttp223.h +++ b/src/ttp223/ttp223.h @@ -28,13 +28,7 @@ namespace upm { /** - * @brief TTP223 touch detector sensor library - * - * This touch sensor detects when a finger is near the metallic pad - * by a change in capacitance. It can replace a more traditional push - * button. The touch sensor can still function when placed under a - * non-metallic surface like glass or plastic. - * + * @brief TTP223 Touch Detector Sensor library * @defgroup ttp223 libupm-ttp223 * @ingroup seeed gpio touch */ @@ -48,11 +42,11 @@ namespace upm { * @web http://www.seeedstudio.com/depot/Grove-Touch-Sensor-p-747.html * @con gpio * - * @brief TTP223 Touch Detector sensor library + * @brief API for the TTP223 Touch Sensor * * This touch sensor detects when a finger is near the metallic pad - * by a change in capacitance. It can replace a more traditional push - * button. The touch sensor can still function when placed under a + * by the change in capacitance. It can replace a more traditional push + * button. The touch sensor can still function when placed under a * non-metallic surface like glass or plastic. * * @image html ttp223.jpg @@ -61,9 +55,9 @@ namespace upm { class TTP223 { public: /** - * TTP223 touch sensor constructor + * TTP223 constructor * - * @param pin GPIO pin where sensor is connected + * @param pin GPIO pin where the sensor is connected */ TTP223(unsigned int pin); @@ -73,23 +67,23 @@ class TTP223 { ~TTP223(); /** - * Return name of this sensor + * Returns the name of this sensor * - * @return the name of this sensor + * @return Name of this sensor */ std::string name(); /** - * Get value from GPIO pin + * Gets the value from the GPIO pin * - * @return the value from the GPIO pin + * @return Value from the GPIO pin */ int value(); /** - * Returns whether or not the touch sensor is being touched + * Determines whether the touch sensor is being touched * - * @return true if the touch sensor is being touched; false otherwise + * @return True if touched, false otherwise */ bool isPressed(); diff --git a/src/ublox6/ublox6.h b/src/ublox6/ublox6.h index 87bc3728..f9ceef35 100644 --- a/src/ublox6/ublox6.h +++ b/src/ublox6/ublox6.h @@ -44,7 +44,7 @@ const int UBLOX6_DEFAULT_UART = 0; namespace upm { /** - * @brief UBLOX6 & SIM28 GPS module library + * @brief UBLOX6 & SIM28 GPS Module library * @defgroup ublox6 libupm-ublox6 * @ingroup seeed uart gps tsk */ @@ -52,17 +52,17 @@ namespace upm { * @library ublox6 * @sensor ublox6 * @comname Grove GPS - * @altname U-BLOX6 SIM28 + * @altname U-BLOX 6 SIM28 * @type gps * @man seeed * @web http://www.seeedstudio.com/depot/Grove-GPS-p-959.html * @con uart * @kit tsk * - * @brief API for the U-BLOX 6 and SIM28 GPS modules + * @brief API for the U-BLOX 6 and SIM28 GPS Modules * - * UPM support for the U-BLOX 6 GPS Module. It is also compatible with - * the SIM28 GPS Module. + * UPM support for the U-BLOX 6 GPS module. It is also compatible with + * the SIM28 GPS module. * * @image html ublox6.jpg * @snippet ublox6.cxx Interesting @@ -70,51 +70,51 @@ namespace upm { class Ublox6 { public: /** - * U-BLOX 6 GPS module constructor + * Ublox6 object constructor * - * @param uart defualt uart to use (0 or 1) + * @param uart Default UART to use (0 or 1) */ Ublox6(int uart); /** - * U-BLOX 6 GPS module Destructor + * Ublox6 object destructor */ ~Ublox6(); /** - * Check to see if there is data available for reading + * Checks to see if there is data available for reading * - * @return true if there is data available to be read + * @return True if there is data available for reading */ bool dataAvailable(); /** - * read any available data into a user-supplied buffer. Note, the - * call will block until data is available to be read. Use + * Reads any available data in a user-supplied buffer. Note: the + * call blocks until data is available to be read. Use * dataAvailable() to determine whether there is data available * beforehand, to avoid blocking. * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes read + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return the Number of bytes read */ int readData(char *buffer, size_t len); /** - * write the data in buffer to the device + * Writes the data in the buffer to the device * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes written + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes written */ int writeData(char *buffer, size_t len); /** - * setup the proper tty i/o modes and the baudrate. The default - * baud rate is 9600 (B9600). + * Sets up proper tty I/O modes and the baud rate. The default + * baud rate is 9,600 (B9600). * - * @param baud the desired baud rate. - * @return true if successful + * @param baud Desired baud rate + * @return True if successful */ bool setupTty(speed_t baud=B9600); diff --git a/src/uln200xa/uln200xa.h b/src/uln200xa/uln200xa.h index 54ed436a..5a941b17 100644 --- a/src/uln200xa/uln200xa.h +++ b/src/uln200xa/uln200xa.h @@ -32,7 +32,7 @@ namespace upm { /** - * @brief ULN200XA stepper driver library + * @brief ULN200XA Stepper Driver library * @defgroup uln200xa libupm-uln200xa * @ingroup seeed gpio motor */ @@ -47,11 +47,11 @@ namespace upm { * @web http://www.seeedstudio.com/depot/Gear-Stepper-Motor-with-Driver-p-1685.html?cPath=39_40 * @con gpio * - * @brief UPM module for the ULN200XA Darlington Stepper driver + * @brief UPM module for the ULN200XA Darlington Stepper Driver * - * This module was developed on a ULBN2003A Stepper Driver. It - * should support the uln2001a, 2002a, 2003a, and 2004a devices, for - * use in driving a unipolar stepper motor, the 28BYJ-48. + * This module was developed on a ULN2003A Stepper Driver. It + * should also support the ULN2001A, ULN2002A, and ULN2004A devices, when + * using to drive the 28BYJ-48 unipolar stepper motor. * * @image html uln200xa.jpg * Example driving a stepper motor @@ -73,56 +73,56 @@ namespace upm { /** * ULN200XA constructor * - * @param stepsPerRev number of steps per full revolution - * @param i1 digital pin to use for stepper input 1 - * @param i2 digital pin to use for stepper input 2 - * @param i3 digital pin to use for stepper input 3 - * @param i4 digital pin to use for stepper input 4 + * @param stepsPerRev Number of steps per full revolution + * @param i1 Digital pin to use for stepper input 1 + * @param i2 Digital pin to use for stepper input 2 + * @param i3 Digital pin to use for stepper input 3 + * @param i4 Digital pin to use for stepper input 4 */ ULN200XA(int stepsPerRev, int i1, int i2, int i3, int i4); /** - * ULN200XA Destructor + * ULN200XA destructor */ ~ULN200XA(); /** - * Return the number of milliseconds elapsed since initClock() + * Returns the number of milliseconds elapsed since initClock() * was last called. * - * @return elapsed milliseconds + * @return Elapsed milliseconds */ uint32_t getMillis(); /** - * Reset the Clock + * Resets the clock * */ void initClock(); /** - * set the speed of the stepper in RPM (Rotation Per Minute + * Sets the speed of the stepper motor in revolutions per minute (RPM) * - * @param speed speed to set the motor to in RPM's + * @param speed Speed to set the motor to, in RPM */ void setSpeed(int speed); /** - * set the direction of the motor, clockwise or counter clockwise + * Sets the direction of the motor, clockwise or counterclockwise * - * @param dir direction to set the motor to + * @param dir Direction to set the motor to */ void setDirection(ULN200XA_DIRECTION_T dir); /** - * step the stepper motor a specified number of steps + * Steps the stepper motor a specified number of steps * - * @param steps number of steps to move the stepper motor + * @param steps Number of steps to move the stepper motor */ void stepperSteps(unsigned int steps); /** - * release the stepper, by removing power + * Releases the stepper motor by removing power * */ void release(); @@ -142,13 +142,13 @@ namespace upm { uint32_t m_stepDelay; /** - * step the motor one tick + * Steps the stepper motor one tick * */ void stepperStep(); /** - * step direction - 1 = forward, -1 = backward + * Defines the step direction: 1 = forward, -1 = backward * */ int m_stepDirection; diff --git a/src/waterlevel/waterlevel.h b/src/waterlevel/waterlevel.h index 708b9f83..a2fc8776 100644 --- a/src/waterlevel/waterlevel.h +++ b/src/waterlevel/waterlevel.h @@ -27,7 +27,7 @@ namespace upm { /** - * @brief Water Level switch library + * @brief Water Level Switch Library * @defgroup waterlevel libupm-waterlevel * @ingroup seeed gpio liquid */ @@ -50,17 +50,17 @@ namespace upm { class WaterLevel { public: /** - * Water Level Constructor + * WaterLevel constructor * - * @param pin digital pin to use + * @param pin Digital pin to use */ WaterLevel(int pin); /** - * Water Level Destructor + * WaterLevel destructor */ ~WaterLevel(); /** - * @return bool returns whether liquid has gone above sensor + * @return bool Determines whether liquid has risen above the sensor */ bool isSubmerged(); diff --git a/src/wt5001/wt5001.h b/src/wt5001/wt5001.h index c337261a..35015c40 100644 --- a/src/wt5001/wt5001.h +++ b/src/wt5001/wt5001.h @@ -63,9 +63,9 @@ namespace upm { * @web http://www.seeedstudio.com/wiki/Grove_%E2%80%93_Serial_MP3_Player * @con uart * - * @brief API for the WT5001 Serial MP3 module + * @brief API for the WT5001 Serial MP3 Module * - * UPM support for the WT5001 Serial MP3 Module. This was tested + * UPM support for the WT5001 Serial MP3 module. This was tested * specifically with the Grove Serial MP3 module. * * @image html wt5001.jpg @@ -120,220 +120,220 @@ namespace upm { } WT5001_PLAYSOURCE_T; /** - * WT5001 Serial MP3 module constructor + * WT5001 constructor * - * @param uart default uart to use (0 or 1) + * @param uart Default UART to use (0 or 1) */ WT5001(int uart); /** - * WT5001 Serial MP3 module Destructor + * WT5001 destructor */ ~WT5001(); /** - * Check to see if there is data available for reading + * Checks to see if there is data available for reading * - * @param millis number of milliseconds to wait, 0 means no wait. - * @return true if there is data available to be read + * @param millis Number of milliseconds to wait; 0 means no waiting + * @return True if there is data available for reading */ bool dataAvailable(unsigned int millis); /** - * read any available data into a user-supplied buffer. Note, the - * call will block until data is available to be read. Use + * Reads any available data in a user-supplied buffer. Note: the + * call blocks until data is available to be read. Use * dataAvailable() to determine whether there is data available * beforehand, to avoid blocking. * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes read + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes read */ int readData(char *buffer, size_t len); /** - * write the data in buffer to the device + * Writes the data in the buffer to the device * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes written + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes written */ int writeData(char *buffer, size_t len); /** - * setup the proper tty i/o modes and the baudrate. The default - * baud rate is 9600 (B9600). + * Sets up proper tty I/O modes and the baud rate. The default + * baud rate is 9,600 (B9600). * - * @param baud the desired baud rate. - * @return true if successful + * @param baud Desired baud rate. + * @return True if successful */ bool setupTty(speed_t baud=B9600); /** - * Get a command response and return it's validity + * Gets a command response and returns its validity * - * @param index opcode to verify - * @return true if successful + * @param index Opcode to verify + * @return True if successful */ bool checkResponse(WT5001_OPCODE_T opcode); /** - * play a file, from a source + * Plays a file from a source * - * @param psrc the play source (SD, UDISK, SPI) - * @param index file number to play - * @return true if successful + * @param psrc Play source (SD, UDISK, SPI) + * @param index File number to play + * @return True if successful */ bool play(WT5001_PLAYSOURCE_T psrc, uint16_t index); /** - * stop playing + * Stops playing * - * @return true if successful + * @return True if successful */ bool stop(); /** - * pause playback, or resume playback if already paused + * Pauses the playback or resumes it if already paused * - * @return true if successful + * @return True if successful */ bool pause(); /** - * go to next track + * Moves to the next track * - * @return true if successful + * @return True if successful */ bool next(); /** - * go to previous track + * Moves to the previous track * - * @return true if successful + * @return True if successful */ bool previous(); /** - * set the volume. Range is between 0-31. 0 means mute. + * Sets the volume. Valid range is 0-31. 0 means mute. * - * @return true if successful + * @return True if successful */ bool setVolume(uint8_t vol); /** - * queue a track to play next, when current song is finished + * Queues a track to play next, when the current song is finished * - * @param index file number to queue - * @return true if successful + * @param index File number to queue + * @return True if successful */ bool queue(uint16_t index); /** - * set the playback mode + * Sets the playback mode * - * @param pm play mode to enable - * @return true if successful + * @param pm Play mode to enable + * @return True if successful */ bool setPlayMode(WT5001_PLAYMODE_T pm); /** - * insert a track to play immediately, interrupting the current - * track. When the inserted track is finished playing, the - * interrupted track will resume where it was interrupted. + * Inserts a track to play immediately, interrupting the current + * track. When the inserted track is finished, the + * interrupted track resumes where it was interrupted. * - * @param index file number to insert - * @return true if successful + * @param index File number to insert + * @return True if successful */ bool insert(uint16_t index); /** - * set the date of the internal clock + * Sets the date of the internal clock * - * @param year 4 digit year - * @param month the month - * @param day the day - * @return true if successful + * @param year 4-digit year + * @param month Month + * @param day Day + * @return True if successful */ bool setDate(uint16_t year, uint8_t month, uint8_t day); /** - * set the time of the internal clock + * Sets the time of the internal clock * - * @param hour hour - * @param minute minute - * @param second second - * @return true if successful + * @param hour Hour + * @param minute Minute + * @param second Second + * @return True if successful */ bool setTime(uint8_t hour, uint8_t minute, uint8_t second); /** - * set the alarm + * Sets the alarm * - * @param hour hour - * @param minute minute - * @param second second - * @return true if successful + * @param hour Hour + * @param minute Minute + * @param second Second + * @return True if successful */ bool setAlarm(uint8_t hour, uint8_t minute, uint8_t second); /** - * clear any alarm that has been set + * Clears any alarm that has been set * - * @return true if successful + * @return True if successful */ bool clearAlarm(); /** - * get the current volume + * Gets the current volume * - * @param vol the returned volume - * @return true if successful + * @param vol Volume + * @return True if successful */ bool getVolume(uint8_t *vol); /** - * get the current play state. 1 = playing, 2 = stopped, 3 = paused + * Gets the current play state: 1 = playing, 2 = stopped, 3 = paused * - * @param ps the returned play state - * @return true if successful + * @param ps Play state + * @return True if successful */ bool getPlayState(uint8_t *ps); /** - * get the number of files present on the source device + * Gets the number of files present on the source device * - * @param psrc the storage source - * @param numf the returned number of files - * @return true if successful + * @param psrc Storage source + * @param numf Number of files + * @return True if successful */ bool getNumFiles(WT5001_PLAYSOURCE_T psrc, uint16_t *numf); /** - * get the index of the current file + * Gets the index of the current file * - * @param curf the index of the current file - * @return true if successful + * @param curf Index of the current file + * @return True if successful */ bool getCurrentFile(uint16_t *curf); /** - * get the device date + * Gets the device date * - * @param year returned 4 digit year - * @param month returned month - * @param day returned day - * @return true if successful + * @param year 4-digit year + * @param month Month + * @param day Day + * @return True if successful */ bool getDate(uint16_t *year, uint8_t *month, uint8_t *day); /** - * get the device time + * Gets the device time * - * @param hour returned hour - * @param minute returned minute - * @param second returned second - * @return true if successful + * @param hour Hour + * @param minute Minute + * @param second Second + * @return True if successful */ bool getTime(uint8_t *hour, uint8_t *minute, uint8_t *second); diff --git a/src/yg1006/yg1006.h b/src/yg1006/yg1006.h index a60a7257..a64f32db 100644 --- a/src/yg1006/yg1006.h +++ b/src/yg1006/yg1006.h @@ -28,7 +28,7 @@ namespace upm { /** - * @brief YG1006 flame sensor library + * @brief YG1006 Flame Sensor library * @defgroup yg1006 libupm-yg1006 * @ingroup seeed gpio light hak */ @@ -43,10 +43,10 @@ namespace upm { * @con gpio * @kit hak * - * @brief API for the YG1006 flame sensor + * @brief API for the YG1006 Flame Sensor * - * UPM module for the YG1006 flame sensor. It detects flame or any - * other light in the 760nm - 1100nm wavelength range. + * UPM module for the YG1006 flame sensor. It detects a flame or any + * other light source in the 760-1,100 nm wavelength range. * * @image html yg1006.jpg * @snippet yg1006.cxx Interesting @@ -54,19 +54,19 @@ namespace upm { class YG1006 { public: /** - * YG1006 digital flame sensor constructor + * YG1006 constructor * - * @param pin digital pin to use + * @param pin Digital pin to use */ YG1006(int pin); /** - * YG1006 Destructor + * YG1006 destructor */ ~YG1006(); /** - * Determine whether a flame has been detected + * Determines whether a flame has been detected * - * @return True if a flame or other comparable light source is detected + * @return True if a flame or another comparable light source has been detected */ bool flameDetected(); diff --git a/src/zfm20/zfm20.h b/src/zfm20/zfm20.h index 11097e4f..fbeefa27 100644 --- a/src/zfm20/zfm20.h +++ b/src/zfm20/zfm20.h @@ -59,7 +59,7 @@ namespace upm { /** - * @brief ZFM-20 fingerprint sensor module library + * @brief ZFM-20 Fingerprint Sensor Module library * @defgroup zfm20 libupm-zfm20 * @ingroup seeed uart touch */ @@ -73,14 +73,14 @@ namespace upm { * @man seeed * @con uart * - * @brief API for the ZFM-20 fingerprint sensor module + * @brief API for the ZFM-20 Fingerprint Sensor Module * * This class was tested on the Grove Fingerprint Sensor * Module. It can store up to 163 fingerprints. * - * It is connected via a UART at 57600 baud. + * It is connected via a UART at 57,600 baud. * - * @image html zfm20.jpg + * @image html zfm20.jpg * This example demonstrates how to register and store a new fingerprint * @snippet zfm20-register.cxx Interesting * This example demonstrates reading a fingerprint and locating it in the DB @@ -138,7 +138,7 @@ namespace upm { ERR_INVALID_REG = 0x1a, ERR_INVALID_ADDR = 0x20, ERR_NEEDS_PWD = 0x21, - // end of module specific errors + // end of module-specific errors ERR_INTERNAL_ERR = 0xff // API internal error } ZFM20_ERRORS_T; @@ -150,215 +150,215 @@ namespace upm { } ZFM20_PKTCODES_T; /** - * ZFM20 module constructor + * ZFM20 constructor * - * @param uart default uart to use (0 or 1) + * @param uart Default UART to use (0 or 1) */ ZFM20(int uart); /** - * ZFM20 module Destructor + * ZFM20 destructor */ ~ZFM20(); /** - * check to see if there is data available for reading + * Checks to see if there is data available for reading * - * @param millis number of milliseconds to wait, 0 means no wait. - * @return true if there is data available to be read + * @param millis Number of milliseconds to wait; 0 means no waiting + * @return true if there is data available for reading */ bool dataAvailable(unsigned int millis); /** - * read any available data into a user-supplied buffer. Note, the - * call will block until data is available to be read. Use + * Reads any available data in a user-supplied buffer. Note: the + * call blocks until data is available to be read. Use * dataAvailable() to determine whether there is data available * beforehand, to avoid blocking. * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes read + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes read */ int readData(char *buffer, size_t len); /** - * write the data in buffer to the device + * Writes the data in the buffer to the device * - * @param buffer the buffer to hold the data read - * @param len the length of the buffer - * @return the number of bytes written + * @param buffer Buffer to hold the data read + * @param len Length of the buffer + * @return Number of bytes written */ int writeData(char *buffer, size_t len); /** - * setup the proper tty i/o modes and the baudrate. The default - * baud rate is 57600 (B57600) for this device. + * Sets up proper tty I/O modes and the baud rate. For this device, + * the default baud rate is 57,600 (B57600). * - * @param baud the desired baud rate. - * @return true if successful + * @param baud Desired baud rate. + * @return True if successful */ bool setupTty(speed_t baud=B57600); /** - * compose and write a command packet + * Composes and writes a command packet * - * @param pkt the packet - * @param len length of packet - * @return the number of bytes written + * @param pkt Packet + * @param len Length of packet + * @return Number of bytes written */ int writeCmdPacket(unsigned char *pkt, int len); /** - * verify the packet header and indicate it's validity + * Verifies the packet header and indicates its validity * - * @param pkt the packet to check - * @return true if valid checksum, false otherwise + * @param pkt Packet to check + * @return True if the checksum is valid, false otherwise */ bool verifyPacket(unsigned char *pkt); /** - * Return the number of milliseconds elapsed since initClock() - * was last called. + * Returns the number of milliseconds elapsed since initClock() + * was last called * - * @return elapsed milliseconds + * @return Elapsed milliseconds */ uint32_t getMillis(); /** - * Reset the Clock + * Resets the clock * */ void initClock(); /** - * set the address that should be used to access the module + * Sets the address that should be used to access the module * - * @param addr the address to use + * @param addr Address to use */ void setAddress(uint32_t addr) { m_address = addr; }; /** - * set the password that should be used to access the module + * Sets the password that should be used to access the module * - * @param pw password to use + * @param pw Password to use */ void setPassword(uint32_t pw) { m_password = pw; }; /** - * get the returned data from a request + * Gets the returned data from a request * - * @param pkt the buffer to store the returned data into - * @param len the expected response length. pkt should be at least this - * big. - * @return true if successful + * @param pkt Buffer to store the returned data + * @param len Expected response length; pkt should be at least this + * large + * @return True if successful */ bool getResponse(unsigned char *pkt, int len); /** - * verify and authenticate to the module. The password used is - * the one last set by setPassword(). + * Verifies and authenticates to the module. The password used is + * the last one set by setPassword(). * - * @return true if successful + * @return True if successful */ bool verifyPassword(); /** - * query the module for the number of stored templates + * Queries the module for the number of stored templates * (fingerprints). * - * @return the number of currently stored templates + * @return Number of currently stored templates */ int getNumTemplates(); /** - * set a new password for the module. This passowrd will be - * stored on the module, and will be required in order to access + * Sets a new password for the module. This passowrd is + * stored in the module, and is required to access * the module in the future. * - * @param pwd the new password to set on the module - * @return true if successful + * @param pwd New password to set on the module + * @return True if successful */ bool setNewPassword(uint32_t pwd); /** - * set a new address for the module. This address will be - * stored on the module, and will be required in order to access + * Sets a new address for the module. This address is + * stored in the module, and is required to access * the module in the future. * - * @param addr the new address to set on the module - * @return true if successful + * @param addr New address to set on the module + * @return True if successful */ bool setNewAddress(uint32_t addr); /** - * generate a new fingerprint image (scan a fingerprint) + * Generates a new fingerprint image (scans a fingerprint) * - * @return one of the ZFM20_ERRORS_T values + * @return One of the ZFM20_ERRORS_T values */ uint8_t generateImage(); /** - * convert the image in the image buffer (generated by - * generateImage()) and store it in one of the two characteristics + * Converts the image in the image buffer (generated by + * generateImage()) and stores it in one of the two characteristics * buffers, 1 or 2 * - * @param slot the characteristics buffer to use. Must be 1 or 2. - * @return one of the ZFM20_ERRORS_T values + * @param slot Characteristics buffer to use; must be 1 or 2 + * @return One of the ZFM20_ERRORS_T values */ uint8_t image2Tz(int slot); /** - * based on the two characteristics bufferes (1 & 2), create a - * fingerprint model. Once a model has been successfully created, + * Based on the two characteristics buffers (1 & 2), creates a + * fingerprint model. Once a model is successfully created, * it can be stored in the module with storeModel(). * - * @return one of the ZFM20_ERRORS_T values + * @return One of the ZFM20_ERRORS_T values */ uint8_t createModel(); /** - * once a fingerprint model has been created, this method can be + * Once a fingerprint model is created, this method can be * used to store it (via one of the characteristics buffers) in a * given location. * - * @param slot the characteristics buffer to store (1 or 2) - * @param id the location in which to store the model - * @return one of the ZFM20_ERRORS_T values + * @param slot Characteristics buffer to store the model, 1 or 2 + * @param id Location to store the model + * @return One of the ZFM20_ERRORS_T values */ uint8_t storeModel(int slot, uint16_t id); /** - * delete a stored model. + * Deletes a stored model * - * @param id the location containing the model to delete - * @return one of the ZFM20_ERRORS_T values + * @param id Location containing the model to delete + * @return One of the ZFM20_ERRORS_T values */ uint8_t deleteModel(uint16_t id); /** - * delete the model database + * Deletes the model database (DB) * - * @return one of the ZFM20_ERRORS_T values + * @return One of the ZFM20_ERRORS_T values */ uint8_t deleteDB(); /** - * search the fingerprint DB and return the id and score, if found + * Searches the fingerprint DB and returns an ID and score, if found * * - * @param slot the slot containing a converted image to search for - * @param id the returned id if found, 0 otherwise - * @param score the returned score if found, 0 otherwise - * @return one of the ZFM20_ERRORS_T values + * @param slot Slot containing a converted image to search for + * @param id ID if found, 0 otherwise + * @param score Score if found, 0 otherwise + * @return One of the ZFM20_ERRORS_T values */ uint8_t search(int slot, uint16_t *id, uint16_t *score); /** - * compares the features in characteristic buffers 1 and 2 and + * Compares the features in characteristics buffers 1 and 2 and * returns a score if they match * - * @param score the returned score - * @return one of the ZFM20_ERRORS_T values + * @param score Score + * @return One of the ZFM20_ERRORS_T values */ uint8_t match(uint16_t *score);