max5487: added new sensor with example (TESTED AND WORKING)

Signed-off-by: Kiveisha Yevgeniy <yevgeniy.kiveisha@intel.com>

examples/CMakeLists.txt

@@ -23,6 +23,7 @@ add_executable (mic-example mic-example.cxx)
 add_executable (mpu9150-example mpu9150-example.cxx)
 add_executable (maxds3231m-example maxds3231m.cxx)
 add_executable (max31723-example max31723.cxx)
+add_executable (max5487-example max5487.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -44,6 +45,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/mic)
 include_directories (${PROJECT_SOURCE_DIR}/src/mpu9150)
 include_directories (${PROJECT_SOURCE_DIR}/src/maxds3231m)
 include_directories (${PROJECT_SOURCE_DIR}/src/max31723)
+include_directories (${PROJECT_SOURCE_DIR}/src/max5487)
 
 target_link_libraries (compass hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled grove ${CMAKE_THREAD_LIBS_INIT})
@@ -70,3 +72,4 @@ target_link_libraries (mic-example mic ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (mpu9150-example mpu9150 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (maxds3231m-example maxds3231m ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (max31723-example max31723 ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (max5487-example max5487 ${CMAKE_THREAD_LIBS_INIT})

examples/max5487.cxx

@@ -0,0 +1,66 @@
+/*
+ * 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.
+ */
+
+#include <unistd.h>
+#include <iostream>
+#include "max5487.h"
+#include <signal.h>
+
+upm::MAX5487 *sensor = NULL;
+
+void
+sig_handler(int signo)
+{
+    printf("got signal\n");
+    if (signo == SIGINT) {
+        printf("exiting application\n");
+    }
+}
+
+int
+main(int argc, char **argv)
+{
+    //! [Interesting]
+    sensor = new upm::MAX5487(7);
+
+    // Power LED UP
+    for (int i = 0; i < 255; i++) {
+        sensor->setWiperA(i);
+        usleep (5000);
+    }
+
+    // Power LED DOWN
+    for (int i = 0; i < 255; i++) {
+        sensor->setWiperA(255 - i);
+        usleep (5000);
+    }
+
+    //! [Interesting]
+
+    std::cout << "exiting application" << std::endl;
+
+    delete sensor;
+
+    return 0;
+}

src/max5487/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "max5487")
+set (libdescription "Digital potentiometer")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/max5487/jsupm_max5487.i

@@ -0,0 +1,8 @@
+%module jsupm_max5487
+%include "../upm.i"
+
+%{
+    #include "max5487.h"
+%}
+
+%include "max5487.h"

src/max5487/max5487.cxx

@@ -0,0 +1,117 @@
+/*
+ * 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.
+ */
+
+#include <iostream>
+#include <unistd.h>
+#include <stdlib.h>
+
+#include "max5487.h"
+
+using namespace upm;
+
+struct MAX5487Exception : public std::exception {
+    std::string message;
+    MAX5487Exception (std::string msg) : message (msg) { }
+    ~MAX5487Exception () throw () { }
+    const char* what() const throw () { return message.c_str(); }
+};
+
+MAX5487::MAX5487 (int csn) {
+    mraa_result_t error = MRAA_SUCCESS;
+    m_name = "MAX5487";
+
+    m_csnPinCtx = mraa_gpio_init (csn);
+    if (m_csnPinCtx == NULL) {
+        throw MAX5487Exception ("GPIO failed to initilize");
+    }
+
+    error = mraa_gpio_dir (m_csnPinCtx, MRAA_GPIO_OUT);
+    if (error != MRAA_SUCCESS) {
+        throw MAX5487Exception ("GPIO failed to initilize");
+    }
+
+    m_spi = mraa_spi_init (0);
+    if (m_spi == NULL) {
+        throw MAX5487Exception ("SPI failed to initilize");
+    }
+
+    CSOff ();
+}
+
+MAX5487::~MAX5487() {
+    mraa_result_t error = MRAA_SUCCESS;
+
+    error = mraa_spi_stop(m_spi);
+    if (error != MRAA_SUCCESS) {
+        mraa_result_print(error);
+    }
+    error = mraa_gpio_close (m_csnPinCtx);
+    if (error != MRAA_SUCCESS) {
+        mraa_result_print(error);
+    }
+}
+
+void
+MAX5487::setWiperA (uint8_t wiper) {
+    uint8_t data[2] = { 0x00, 0x00};
+
+    CSOn ();
+
+    data[0] = R_WR_WIPER_A;
+    data[1] = wiper;
+
+    uint8_t* retData = mraa_spi_write_buf(m_spi, data, 2);
+
+    CSOff ();
+}
+
+void
+MAX5487::setWiperB (uint8_t wiper) {
+    uint8_t data[2] = { 0x00, 0x00};
+
+    CSOn ();
+
+    data[0] = R_WR_WIPER_B;
+    data[1] = wiper;
+
+    uint8_t* retData = mraa_spi_write_buf(m_spi, data, 2);
+
+    CSOff ();
+}
+
+/*
+ * **************
+ *  private area
+ * **************
+ */
+
+mraa_result_t
+MAX5487::CSOn () {
+    return mraa_gpio_write (m_csnPinCtx, LOW);
+}
+
+mraa_result_t
+MAX5487::CSOff () {
+    return mraa_gpio_write (m_csnPinCtx, HIGH);
+}

src/max5487/max5487.h

@@ -0,0 +1,93 @@
+/*
+ * 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.h>
+#include <mraa/gpio.h>
+#include <mraa/spi.h>
+
+#define HIGH                    1
+#define LOW                     0
+
+namespace upm {
+
+/**
+ * @brief C++ API for MAX5487 chip (Temperature sensor)
+ *
+ * This file defines the MAX5487 C++ interface for libmax5487
+ *
+ */
+class MAX5487 {
+    public:
+        static const uint8_t R_WR_WIPER_A   = 0x01;
+        static const uint8_t R_WR_WIPER_B   = 0x02;
+
+        /**
+         * Instanciates a MAX5487 object
+         *
+         * @param bus number of used bus
+         * @param devAddr addres of used i2c device
+         */
+        MAX5487 (int csn);
+
+        /**
+         * MAX5487 object destructor, basicaly it close SPI connection and GPIO.
+         */
+        ~MAX5487 ();
+
+        /**
+         * Set wiper for port A.
+         */
+        void setWiperA (uint8_t wiper);
+
+        /**
+         * Set wiper for port B.
+         */
+        void setWiperB (uint8_t wiper);
+
+        /**
+         * Return name of the component
+         */
+        std::string name()
+        {
+            return m_name;
+        }
+    private:
+        std::string m_name;
+        mraa_spi_context        m_spi;
+        mraa_gpio_context       m_csnPinCtx;
+
+        /**
+         * Set chip select pin LOW
+         */
+        mraa_result_t CSOn ();
+
+        /**
+         * Set chip select pin HIGH
+         */
+        mraa_result_t CSOff ();
+};
+
+}

src/max5487/pyupm_max5487.i

@@ -0,0 +1,9 @@
+%module pyupm_max5487
+%include "../upm.i"
+
+%feature("autodoc", "3");
+
+%include "max5487.h"
+%{
+    #include "max5487.h"
+%}