groveelectromagnet: Initial implementation

This module implements support for the Grove Electromagnet.

Signed-off-by: Zion Orent <zorent@ics.com>
Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: John Van Drasek <john.r.van.drasek@intel.com>

src/groveelectromagnet/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "groveelectromagnet")
+set (libdescription "upm groveelectromagnet sensor module")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init("-lrt")

src/groveelectromagnet/groveelectromagnet.cxx

@@ -0,0 +1,54 @@
+/*
+ * Author: Zion Orent <sorent@ics.com>
+ * Copyright (c) 2015 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 "groveelectromagnet.h"
+
+using namespace upm;
+
+GroveElectromagnet::GroveElectromagnet(int pin)
+{
+    m_gpio = mraa_gpio_init(pin);
+    mraa_gpio_dir(m_gpio, MRAA_GPIO_OUT);
+}
+
+GroveElectromagnet::~GroveElectromagnet()
+{
+    mraa_gpio_close(m_gpio);
+}
+
+void GroveElectromagnet::on()
+{
+	mraa_result_t error = MRAA_SUCCESS;
+	error = mraa_gpio_write (m_gpio, HIGH);
+	if (error != MRAA_SUCCESS)
+		mraa_result_print(error);
+}
+
+void GroveElectromagnet::off()
+{
+	mraa_result_t error = MRAA_SUCCESS;
+	error = mraa_gpio_write (m_gpio, LOW);
+	if (error != MRAA_SUCCESS)
+		mraa_result_print(error);
+}

src/groveelectromagnet/groveelectromagnet.h

@@ -0,0 +1,68 @@
+/*
+ * Author: Zion Orent <sorent@ics.com>
+ * Copyright (c) 2015 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 <mraa/gpio.h>
+
+#define HIGH      1
+#define LOW       0
+
+namespace upm {
+  /**
+   * @brief UPM module for the Grove Electromagnet
+   * @defgroup groveelectromagnet libupm-groveelectromagnet
+   */
+  /**
+   * @brief C++ API for the Grove Electromagnet
+   * 
+   * The Grove Electromagnet can hold up to 1 KG
+   *
+   * @ingroup gpio groveelectromagnet
+   * @snippet groveelectromagnet.cxx Interesting
+   */
+  class GroveElectromagnet {
+  public:
+    /**
+     * Grove Electromagnet Constructor
+     *
+     * @param pin digital pin to use
+     */
+    GroveElectromagnet(int pin);
+    /**
+     * Grove Electromagnet Destructor
+     */
+    ~GroveElectromagnet();
+    /**
+     * Turn magnet on
+     */
+     void on();
+    /**
+     * Turn magnet off
+     */
+     void off();
+
+  private:
+        mraa_gpio_context m_gpio;
+	};
+}

src/groveelectromagnet/jsupm_groveelectromagnet.i

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

src/groveelectromagnet/pyupm_groveelectromagnet.i

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