maxds3231m: Added new sensor support get/set data&time and get temperature (NOT TESTED YET)

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

src/maxds3231m/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "maxds3231m")
+set (libdescription "realtime clock sensor from MAX family")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/maxds3231m/jsupm_maxds3231m.i

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

src/maxds3231m/maxds3231m.cxx

@@ -0,0 +1,141 @@
+/*
+ * 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 "maxds3231m.h"
+
+using namespace upm;
+
+struct DS3231Exception : public std::exception {
+    std::string message;
+    DS3231Exception (std::string msg) : message (msg) { }
+    ~DS3231Exception () throw () { }
+    const char* what() const throw () { return message.c_str(); }
+};
+
+MAXDS3231M::MAXDS3231M (int bus, int devAddr) {
+    m_name = "MAXDS3231M";
+
+    m_i2cAddr = devAddr;
+    m_bus = bus;
+
+    m_i2Ctx = mraa_i2c_init(m_bus);
+
+    mraa_result_t ret = mraa_i2c_address(m_i2Ctx, m_i2cAddr);
+    if (ret != MRAA_SUCCESS) {
+        throw DS3231Exception ("Couldn't initilize I2C.");
+    }
+}
+
+MAXDS3231M::~MAXDS3231M() {
+    mraa_i2c_stop(m_i2Ctx);
+}
+
+void
+MAXDS3231M::setDate (Time3231 &time) {
+    uint8_t *data = (uint8_t *)&time;
+
+    i2cWriteReg_N (TIME_CAL_ADDR, 7, data);
+}
+
+bool
+MAXDS3231M::getDate (Time3231 &time) {
+    uint8_t buffer[7];
+
+    // We need 7 bytes of data.
+    if (i2cReadReg_N (TIME_CAL_ADDR, 7, buffer) > 6) {
+        uint8_t century = (buffer[5] & 0x80) >> 7;
+
+        time.second     = BCDtoDEC(buffer[0]);
+        time.minute     = BCDtoDEC(buffer[1]);
+        time.hour       = BCDtoDEC(buffer[2]);
+        time.day        = BCDtoDEC(buffer[4]);
+        time.month      = BCDtoDEC(buffer[5] & 0x1F);
+        time.year       = (century == 1) ? 2000 + BCDtoDEC(buffer[6]) : 1900 + BCDtoDEC(buffer[6]);
+        time.weekDay    = BCDtoDEC(buffer[3]);
+
+        return true;
+    }
+
+    return false;
+}
+
+uint16_t
+MAXDS3231M::getTemperature () {
+    uint8_t buffer[2];
+    uint16_t tempRaw = 0;
+
+    i2cReadReg_N (TEMPERATURE_ADDR, 2, buffer);
+    tempRaw = (((int16_t)buffer[0]) << 8) | buffer[1];
+
+    return tempRaw;
+}
+
+/*
+ * **************
+ *  private area
+ * **************
+ */
+uint16_t
+MAXDS3231M::i2cReadReg_N (int reg, unsigned int len, uint8_t * buffer) {
+    int readByte = 0;
+
+    if (m_i2Ctx == NULL) {
+        throw DS3231Exception ("Couldn't find initilized I2C.");
+    }
+
+    mraa_i2c_address(m_i2Ctx, m_i2cAddr);
+    mraa_i2c_write_byte(m_i2Ctx, reg);
+
+    mraa_i2c_address(m_i2Ctx, m_i2cAddr);
+    readByte = mraa_i2c_read(m_i2Ctx, buffer, len);
+    return readByte;
+}
+
+mraa_result_t
+MAXDS3231M::i2cWriteReg_N (uint8_t reg, unsigned int len, uint8_t * buffer) {
+    mraa_result_t error = MRAA_SUCCESS;
+
+    if (m_i2Ctx == NULL) {
+        throw DS3231Exception ("Couldn't find initilized I2C.");
+    }
+
+    error = mraa_i2c_address (m_i2Ctx, m_i2cAddr);
+    error = mraa_i2c_write (m_i2Ctx, buffer, len);
+
+    return error;
+}
+
+uint8_t
+MAXDS3231M::DECtoBSD(uint8_t data) {
+    return ((data / 10 * 16) + (data % 10));
+}
+
+uint8_t
+MAXDS3231M::BCDtoDEC(uint8_t data) {
+    return ((data / 16 * 10) + (data % 16));
+}

src/maxds3231m/maxds3231m.h

@@ -0,0 +1,125 @@
+/*
+ * 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/i2c.h>
+
+#define ADDR                    0x68 // device address
+
+// timekeeping registers
+#define TIME_CAL_ADDR           0x00
+#define ALARM1_ADDR             0x07
+#define ALARM2_ADDR             0x0B
+#define CONTROL_ADDR            0x0E
+#define STATUS_ADDR             0x0F
+#define AGING_OFFSET_ADDR       0x10
+#define TEMPERATURE_ADDR        0x11
+
+// control register bits
+#define A1IE                    0x1
+#define A2IE                    0x2
+#define INTCN                   0x4
+
+// status register bits
+#define A1F                     0x1
+#define A2F                     0x2
+#define OSF                     0x80
+
+#define HIGH                    1
+#define LOW                     0
+
+namespace upm {
+
+struct Time3231 {
+    uint8_t second;
+    uint8_t minute;
+    uint8_t hour;
+    uint8_t day;
+    uint8_t month;
+    int16_t year;
+    uint8_t weekDay;
+};
+
+/**
+ * @brief C++ API for MAXDS3231M chip (Ambient and Infrared Proximity Sensor)
+ *
+ * This file defines the MAXDS3231M C++ interface for libmax44000
+ *
+ */
+class MAXDS3231M {
+    public:
+        /**
+         * Instanciates a MAXDS3231M object
+         *
+         * @param bus number of used bus
+         * @param devAddr addres of used i2c device
+         */
+        MAXDS3231M (int bus, int devAddr);
+
+        /**
+         * MAXDS3231M object destructor, basicaly it close i2c connection.
+         */
+        ~MAXDS3231M ();
+
+        /**
+         * Set date and time on the chip.
+         *
+         * @param time staracture
+         */
+        void setDate (Time3231 &time);
+
+        /**
+         * Get date and time located on the chip.
+         *
+         * @param time staracture
+         */
+        bool getDate (Time3231 &time);
+
+        /**
+         * Get on board temperature.
+         */
+        uint16_t getTemperature ();
+
+        /**
+         * Return name of the component
+         */
+        std::string name()
+        {
+            return m_name;
+        }
+    private:
+        std::string m_name;
+
+        int m_i2cAddr;
+        int m_bus;
+        mraa_i2c_context m_i2Ctx;
+
+        uint16_t i2cReadReg_N (int reg, unsigned int len, uint8_t * buffer);
+        mraa_result_t i2cWriteReg_N (uint8_t reg, unsigned int len, uint8_t * buffer);
+        uint8_t DECtoBSD (uint8_t data);
+        uint8_t BCDtoDEC (uint8_t data);
+};
+
+}

src/maxds3231m/pyupm_maxds3231m.i

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