|
@@ -34,10 +34,16 @@
|
34
|
34
|
namespace upm {
|
35
|
35
|
|
36
|
36
|
/**
|
37
|
|
- * @brief C++ API for MAX5487 chip (Temperature sensor)
|
|
37
|
+ * @brief C++ API for MAX5487 chip (SPI digital potentionmeter)
|
38
|
38
|
*
|
39
|
|
- * This file defines the MAX5487 C++ interface for libmax5487
|
|
39
|
+ * The Maxim Integrated
|
|
40
|
+ * [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf)
|
|
41
|
+ * is a Dual, 256-Tap, Nonvolatile, SPI-Interface, Linear-Taper Digital
|
|
42
|
+ * Potentiometer. This module was tested on the Maxim Integrated [MAX5487PMB1
|
|
43
|
+ * PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf)
|
|
44
|
+ * from the analog PMOD kit.
|
40
|
45
|
*
|
|
46
|
+ * @image html max5487.jpeg
|
41
|
47
|
*/
|
42
|
48
|
class MAX5487 {
|
43
|
49
|
public:
|
|
@@ -47,13 +53,12 @@ class MAX5487 {
|
47
|
53
|
/**
|
48
|
54
|
* Instanciates a MAX5487 object
|
49
|
55
|
*
|
50
|
|
- * @param bus number of used bus
|
51
|
|
- * @param devAddr addres of used i2c device
|
|
56
|
+ * @param csn to use if any, by default will use ICSP CS (-1)
|
52
|
57
|
*/
|
53
|
58
|
MAX5487 (int csn);
|
54
|
59
|
|
55
|
60
|
/**
|
56
|
|
- * MAX5487 object destructor, basicaly it close SPI connection and GPIO.
|
|
61
|
+ * MAX5487 object destructor, closes all IO connections
|
57
|
62
|
*/
|
58
|
63
|
~MAX5487 ();
|
59
|
64
|
|