mirror of
https://github.com/eclipse/upm.git
synced 2025-03-14 20:47:30 +03:00
max5847: improve documentation
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
parent
cbe211c8cf
commit
02fb40f058
BIN
docs/images/max5487.jpeg
Normal file
BIN
docs/images/max5487.jpeg
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.9 KiB |
@ -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 ();
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user