diff options
Diffstat (limited to 'peripheral/libupm/src/max5487/max5487.h')
-rw-r--r-- | peripheral/libupm/src/max5487/max5487.h | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/peripheral/libupm/src/max5487/max5487.h b/peripheral/libupm/src/max5487/max5487.h new file mode 100644 index 0000000..287d30a --- /dev/null +++ b/peripheral/libupm/src/max5487/max5487.h @@ -0,0 +1,113 @@ +/* + * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com> + * Copyright (c) 2014 Intel Corporation. + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * "Software"), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +#pragma once + +#include <string> +#include <mraa/aio.hpp> + +#include <mraa/gpio.hpp> +#include <mraa/spi.hpp> + +#define HIGH 1 +#define LOW 0 + +namespace upm { + +/** + * @brief MAX5487 Digital Potentiometer library + * @defgroup max5487 libupm-max5487 + * @ingroup maxim spi digipot + */ +/** + * @library max5487 + * @sensor max5487 + * @comname MAX5487 Digital Potentiometer + * @type digipot + * @man maxim + * @con spi + * + * @brief API for the MAX5487 SPI Digital Potentiometer + * + * Maxim Integrated* + * [MAX5487](http://datasheets.maximintegrated.com/en/ds/MAX5487-MAX5489.pdf) + * 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. + * + * @snippet max5487.cxx Interesting + */ +class MAX5487 { + public: + static const uint8_t R_WR_WIPER_A = 0x01; + static const uint8_t R_WR_WIPER_B = 0x02; + + /** + * Instantiates an MAX5487 object + * + * @param csn CSN to use, if any; by default, ICSP CS (-1) is used + */ + MAX5487 (int csn = -1); + + /** + * MAX5487 object destructor, closes all IO connections + * no more needed as the connections will be closed when + * m_spi and m_csnPinCtx will go out of scope + * ~MAX5487 (); + **/ + + /** + * Sets a wiper for port A. + */ + void setWiperA (uint8_t wiper); + + /** + * Sets a wiper for port B. + */ + void setWiperB (uint8_t wiper); + + /** + * Returns the name of the component + */ + std::string name() + { + return m_name; + } + private: + std::string m_name; + mraa::Spi m_spi; + mraa::Gpio m_csnPinCtx; + + /** + * Sets the chip select pin to LOW + */ + mraa::Result CSOn (); + + /** + * Sets the chip select pin to HIGH + */ + mraa::Result CSOff (); +}; + +} |