alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 01:11:10 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: final batch of header files reviewed

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-10 18:53:31 +03:00
committed by Mihai Tudor Panu
parent 04edb9be04
commit 1fe9b9eb1d
53 changed files with 1182 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/max5487/max5487.h
View File

@ -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 ();
};