alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

max5847: improve documentation

Browse Source 
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll 2014-08-29 15:35:30 +01:00
parent cbe211c8cf
commit 02fb40f058
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/images/max5487.jpeg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.9 KiB

15
src/max5487/max5487.h
View File

@ -34,10 +34,16 @@
namespace upm {
/**
* @brief C++ API for MAX5487 chip (Temperature sensor)
* @brief C++ API for MAX5487 chip (SPI digital potentionmeter)
*
* This file defines the MAX5487 C++ interface for libmax5487
* The 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
* PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf)
* from the analog PMOD kit.
*
* @image html max5487.jpeg
*/
class MAX5487 {
public:
@ -47,13 +53,12 @@ class MAX5487 {
/**
* Instanciates a MAX5487 object
*
* @param bus number of used bus
* @param devAddr addres of used i2c device
* @param csn to use if any, by default will use ICSP CS (-1)
*/
MAX5487 (int csn);
/**
* MAX5487 object destructor, basicaly it close SPI connection and GPIO.
* MAX5487 object destructor, closes all IO connections
*/
~MAX5487 ();