isd1820: Initial implementation

This driver implements support for the Grove Recorder.  It records up
to about 10 seconds of audio, and can play it back on command.

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

examples/c++/CMakeLists.txt

@@ -113,6 +113,7 @@ add_executable (zfm20-example zfm20.cxx)
 add_executable (zfm20-register-example zfm20-register.cxx)
 add_executable (uln200xa-example uln200xa.cxx)
 add_executable (grovewfs-example grovewfs.cxx)
+add_executable (isd1820-example isd1820.cxx)
 
 include_directories (${PROJECT_SOURCE_DIR}/src/hmc5883l)
 include_directories (${PROJECT_SOURCE_DIR}/src/grove)
@@ -204,6 +205,7 @@ include_directories (${PROJECT_SOURCE_DIR}/src/tm1637)
 include_directories (${PROJECT_SOURCE_DIR}/src/zfm20)
 include_directories (${PROJECT_SOURCE_DIR}/src/uln200xa)
 include_directories (${PROJECT_SOURCE_DIR}/src/grovewfs)
+include_directories (${PROJECT_SOURCE_DIR}/src/isd1820)
 
 target_link_libraries (hmc5883l-example hmc5883l ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (groveled-example grove ${CMAKE_THREAD_LIBS_INIT})
@@ -318,3 +320,4 @@ target_link_libraries (zfm20-example zfm20 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (zfm20-register-example zfm20 ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (uln200xa-example uln200xa ${CMAKE_THREAD_LIBS_INIT})
 target_link_libraries (grovewfs-example grovewfs ${CMAKE_THREAD_LIBS_INIT})
+target_link_libraries (isd1820-example isd1820 ${CMAKE_THREAD_LIBS_INIT})

examples/c++/isd1820.cxx

@@ -0,0 +1,80 @@
+/*
+ * Author: Jon Trulson <jtrulson@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 <unistd.h>
+#include <iostream>
+#include <signal.h>
+#include "isd1820.h"
+
+using namespace std;
+
+int main (int argc, char **argv)
+{
+//! [Interesting]
+  // Instantiate a ISD1820 on digital pins 2 (play) and 3 (record)
+  // This example was tested on the Grove Recorder.
+
+  upm::ISD1820* recorder = new upm::ISD1820(2, 3);
+  
+  // if an argument was specified (any argument), go into record mode,
+  // else playback a previously recorded sample
+
+  cout << "Supply any argument to the command line to record." << endl;
+  cout << "Running this example without arguments will play back any " << endl;
+  cout << "previously recorded sound." << endl;
+  cout << "There is approximately 10 seconds of recording time." << endl;
+
+  cout << endl;
+
+  bool doRecord = false;
+
+  if (argc > 1)
+    doRecord = true;
+  
+  // depending on what was selected, do it, and sleep for 15 seconds
+
+  if (doRecord)
+    recorder->record(true);
+  else
+    recorder->play(true);
+    
+  // There are about 10 seconds of recording/playback time, so we will
+  // sleep for a little extra time.
+  cout << "Sleeping for 15 seconds..." << endl;
+  sleep(15);
+
+  // now, turn off whatever we were doing.
+
+  if (doRecord)
+    recorder->record(false);
+  else
+    recorder->play(false);
+
+//! [Interesting]
+
+  cout << "Exiting..." << endl;
+
+  delete recorder;
+  return 0;
+}

examples/javascript/isd1820.js

@@ -0,0 +1,68 @@
+/*jslint node:true, vars:true, bitwise:true, unparam:true */
+/*jshint unused:true */
+/*
+* Author: Zion Orent <zorent@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.
+*/
+
+var recorder_lib = require("jsupm_isd1820");
+
+// Instantiate a ISD1820 on digital pins 2 (play) and 3 (record)
+// This example was tested on the Grove Recorder.
+var myRecorder = new recorder_lib.ISD1820(2, 3);
+
+
+var doRecord = false;
+
+if (process.argv.length > 2)
+	doRecord = true;
+
+// if an argument was specified (any argument), go into record mode,
+// else playback a previously recorded sample
+console.log("Supply any argument to the command line to record.");
+console.log("Running this example without arguments will play back ");
+console.log("any previously recorded sound.");
+console.log("There is approximately 10 seconds of recording time.\n");
+
+// depending on what was selected, do it, and sleep for 15 seconds
+if (doRecord)
+	myRecorder.record(true);
+else
+	myRecorder.play(true);
+
+// There are about 10 seconds of recording/playback time, so we will
+// sleep for a little extra time.
+console.log("Sleeping for 15 seconds...");
+
+setTimeout(function()
+{
+	// turn off whatever we were doing.
+	if (doRecord)
+		myRecorder.record(false);
+	else
+		myRecorder.play(false);
+	console.log("Exiting");
+	myRecorder = null;
+	recorder_lib.cleanUp();
+	recorder_lib = null;
+	process.exit(0);
+}, 15 * 1000);

examples/python/isd1820.py

@@ -0,0 +1,74 @@
+#!/usr/bin/python
+# Author: Zion Orent <zorent@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.
+
+import time, sys, atexit
+import pyupm_isd1820 as upmIsd1820
+
+# Instantiate a ISD1820 on digital pins 2 (play) and 3 (record)
+# This example was tested on the Grove Recorder.
+myRecorder = upmIsd1820.ISD1820(2, 3)
+
+
+doRecord = False
+
+if len(sys.argv) > 1:
+	doRecord = True
+
+
+# This lets you run code on exit,
+# including functions from myRecorder
+def exitHandler():
+	# turn off whatever we were doing.
+	if (doRecord):
+		myRecorder.record(False)
+	else:
+		myRecorder.play(False)
+	print "Exiting"
+	sys.exit(0)
+
+# Register exit handlers
+atexit.register(exitHandler)
+
+
+# if an argument was specified (any argument), go into record mode,
+# else playback a previously recorded sample
+
+print "Supply any argument to the command line to record."
+print "Running this example without arguments will play back any "
+print "previously recorded sound."
+print "There is approximately 10 seconds of recording time.\n"
+
+
+# depending on what was selected, do it, and sleep for 15 seconds
+if (doRecord):
+	myRecorder.record(True)
+else:
+	myRecorder.play(True)
+    
+# There are about 10 seconds of recording/playback time, so we will
+# sleep for a little extra time.
+print "Sleeping for 15 seconds..."
+time.sleep(15)
+
+
+# exitHandler runs automatically

src/isd1820/CMakeLists.txt

@@ -0,0 +1,5 @@
+set (libname "isd1820")
+set (libdescription "upm grove recorder")
+set (module_src ${libname}.cxx)
+set (module_h ${libname}.h)
+upm_module_init()

src/isd1820/isd1820.cxx

@@ -0,0 +1,87 @@
+/*
+ * Author: Jon Trulson <jtrulson@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 <iostream>
+
+#include "isd1820.h"
+
+using namespace upm;
+using namespace std;
+
+ISD1820::ISD1820(int playPin, int recPin)
+{
+  if ( !(m_gpioPlay = mraa_gpio_init(playPin)) )
+    {
+      cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
+      return;
+    }
+
+  mraa_gpio_dir(m_gpioPlay, MRAA_GPIO_OUT);
+
+  if ( !(m_gpioRec = mraa_gpio_init(recPin)) )
+    {
+      cerr << __FUNCTION__ << ": mraa_gpio_init() failed" << endl;
+      return;
+    }
+
+  mraa_gpio_dir(m_gpioRec, MRAA_GPIO_OUT);
+
+  // make sure we are not recording or playing
+  play(false);
+  record(false);
+}
+
+ISD1820::~ISD1820()
+{
+  mraa_gpio_close(m_gpioPlay);
+  mraa_gpio_close(m_gpioRec);
+}
+
+void ISD1820::play(bool enable)
+{
+  if (enable)
+    {
+      // make sure we are not recording
+      record(false);
+      mraa_gpio_write(m_gpioPlay, 1);
+    }
+  else
+    {
+      mraa_gpio_write(m_gpioPlay, 0);
+    }
+}
+
+void ISD1820::record(bool enable)
+{
+  if (enable)
+    {
+      // make sure we are not playing
+      play(false);
+      mraa_gpio_write(m_gpioRec, 1);
+    }
+  else
+    {
+      mraa_gpio_write(m_gpioRec, 0);
+    }
+}

src/isd1820/isd1820.h

@@ -0,0 +1,89 @@
+/*
+ * Author: Jon Trulson <jtrulson@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 <iostream>
+
+#include <mraa/gpio.h>
+
+namespace upm {
+    /**
+     * @brief UPM support for the ISD1820 based Grove Recorder
+     * @defgroup isd1820 libupm-isd1820
+     * @ingroup seeed gpio sound
+     */
+
+    /**
+     * @sensor isd1820
+     * @library isd1820
+     * @comname Grove Recorder v1.0
+     * @type sound
+     * @man seeed
+     * @con gpio
+     *
+     * @brief C++ API support for the ISD1820 based Grove Recorder
+     *
+     * This class implements support for the Grove Recorder.  There
+     * are two digital pins, one that enables recording, and the other
+     * that plays back what was previously recorded.
+     *
+     * @snippet isd1820.cxx Interesting
+     */
+  class ISD1820 {
+  public:
+
+    /**
+     * ISD1820 module constructor
+     *
+     * @param recPin the pin to use for recording
+     * @param playPin the pin to use for playback
+     */
+    ISD1820(int playPin, int recPin);
+
+    /**
+     * ISD1820 module Destructor
+     */
+    ~ISD1820();
+
+    /**
+     * Start or stop playback
+     *
+     * @param enable start playback if true, stop if false
+     */
+    void play(bool enable);
+
+    /**
+     * Start or stop recording
+     *
+     * @param enable start recording if true, stop if false
+     */
+    void record(bool enable);
+
+  private:
+    mraa_gpio_context m_gpioRec;
+    mraa_gpio_context m_gpioPlay;
+  };
+}
+
+

src/isd1820/jsupm_isd1820.i

@@ -0,0 +1,9 @@
+%module jsupm_isd1820
+%include "../upm.i"
+
+%{
+    #include "isd1820.h"
+%}
+
+%include "isd1820.h"
+

src/isd1820/pyupm_isd1820.i

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