a110x: Initial implementation

Signed-off-by: Jon Trulson <jtrulson@ics.com>
Signed-off-by: Sarah Knepper <sarah.knepper@intel.com>

examples/CMakeLists.txt

@@ -55,6 +55,7 @@ add_executable (itg3200-example itg3200.cxx)
 add_executable (enc03r-example enc03r.cxx)
 add_executable (adc121c021-example adc121c021.cxx)
 add_executable (ds1307-example ds1307.cxx)
+add_executable (a110x-example a110x.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -97,6 +98,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/itg3200)
 include_directories (${PROJECT_SOURCE_DIR}/src/enc03r)
 include_directories (${PROJECT_SOURCE_DIR}/src/adc121c021)
 include_directories (${PROJECT_SOURCE_DIR}/src/ds1307)
+include_directories (${PROJECT_SOURCE_DIR}/src/a110x)
 
 target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
@@ -155,3 +157,4 @@ target_link_libraries (itg3200-example itg3200 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (enc03r-example enc03r ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (adc121c021-example adc121c021 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (ds1307-example ds1307 ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (a110x-example a110x ${CMAKE_THREAD_LIBS_INIT})

examples/a110x.cxx

@@ -0,0 +1,67 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.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 <signal.h>
+#include "a110x.h"
+
+using namespace std;
+
+int shouldRun = true;
+
+void sig_handler(int signo)
+{
+  if (signo == SIGINT)
+    shouldRun = false;
+}
+
+
+int main ()
+{
+  signal(SIGINT, sig_handler);
+
+//! [Interesting]
+  // Instantiate an A110X sensor on digital pin D2
+  upm::A110X* hall = new upm::A110X(2);
+  
+  // check every second for the presence of a magnetic field (south
+  // polarity)
+  while (shouldRun)
+    {
+      bool val = hall->magnetDetected();
+      if (val)
+        cout << "Magnet (south polarity) detected." << endl;
+      else
+        cout << "No magnet detected." << endl;
+
+      sleep(1);
+    }
+//! [Interesting]
+
+  cout << "Exiting..." << endl;
+
+  delete hall;
+  return 0;
+}

examples/javascript/a110x.js

@@ -0,0 +1,47 @@
+/*jslint node:true, vars:true, bitwise:true, unparam:true */
+/*jshint unused:true */
+/*global */
+/*
+* Author: Zion Orent <zorent@ics.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.
+*/
+
+var hallEffectSensor = require('jsupm_a110x');
+
+// Instantiate a Hall Effect magnet sensor on digital pin D2
+var myHallEffectSensor = new hallEffectSensor.A110X(2);
+
+// Check every second for the presence of a magnetic field (south polarity)
+setInterval(function()
+{
+	if (myHallEffectSensor.magnetDetected())
+		console.log("Magnet (south polarity) detected.");
+	else
+		console.log("No magnet detected.");
+}, 1000);
+
+// Print message when exiting
+process.on('SIGINT', function()
+{
+	console.log("Exiting...");
+	process.exit(0);
+});

src/a110x/CMakeLists.txt

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

src/a110x/a110x.cxx

@@ -0,0 +1,54 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.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 "a110x.h"
+
+using namespace upm;
+using namespace std;
+
+A110X::A110X(int pin)
+{
+  mraa_init();
+
+  if ( !(m_gpio = mraa_gpio_init(pin)) )
+    {
+      cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
+      return;
+    }
+
+  mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
+}
+
+A110X::~A110X()
+{
+  mraa_gpio_close(m_gpio);
+}
+
+bool A110X::magnetDetected()
+{
+  return (!mraa_gpio_read(m_gpio) ? true : false);
+}
+

src/a110x/a110x.h

@@ -0,0 +1,66 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.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/gpio.h>
+
+namespace upm {
+
+  /**
+   * @brief C++ API for the A110x Hall Effect sensors
+   *
+   * UPM module for the A110x (A1101, A1102, A1103, A1104, and A1106)
+   * Hall Effect sensors.  It outputs a digital signal indicating
+   * whether it is detecting a magnetic field with south polarity
+   * perpendicular to the sensor element.
+   *
+   * @ingroup gpio
+   * @snippet a110x.cxx Interesting
+   */
+  class A110X {
+  public:
+    /**
+     * A110x digital sensor constructor
+     *
+     * @param pin digital pin to use
+     */
+    A110X(int pin);
+    /**
+     * A110X Destructor
+     */
+    ~A110X();
+    /**
+     * Determine whether a magnetic field of south polarity has been detected
+     *
+     * @return True if magnetic field detected
+     */
+    bool magnetDetected();
+
+  private:
+    mraa_gpio_context m_gpio;
+  };
+}
+
+

src/a110x/jsupm_a110x.i

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

src/a110x/pyupm_a110x.i

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