Collision: Added C Src and Example

This module was initially known as GroveCollision. It has been
now changed to Collision. C source and examples added.

Signed-off-by: Abhishek Malik <abhishek.malik@intel.com>

src/collision/CMakeLists.txt

@@ -0,0 +1,9 @@
+upm_mixed_module_init (NAME collision
+    DESCRIPTION "upm collisionsensor module"
+    C_HDR collision.h
+    C_SRC collision.c
+    CPP_HDR collision.hpp
+    CPP_SRC collision.cxx
+    FTI_SRC collision_fti.c
+    CPP_WRAPS_C
+    REQUIRES mraa)

src/collision/collision.c

@@ -23,11 +23,11 @@
  * 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 "grovecollision.h"
+#include "collision.h"
 
-mvs0608_context mvs0608_init(int pin){
-    mvs0608_context dev =
-      (mvs0608_context)malloc(sizeof(struct _mvs0608_context));
+collision_context collision_init(int pin){
+    collision_context dev =
+      (collision_context)malloc(sizeof(struct _collision_context));
 
     if (!dev)
       return NULL;
@@ -44,11 +44,11 @@ mvs0608_context mvs0608_init(int pin){
     return dev;
 }
 
-void mvs0608_close(mvs0608_context dev){
+void collision_close(collision_context dev){
     free(dev);
 }
 
-upm_result_t mvs0608_is_colliding(mvs0608_context dev, bool* collision_val){
+upm_result_t collision_is_colliding(collision_context dev, bool* collision_val){
     int value = mraa_gpio_read(dev->gpio);
 
     if(!value)

src/collision/collision.cxx

@@ -25,11 +25,11 @@
 #include <string>
 #include <stdexcept>
 
-#include "grovecollision.hpp"
+#include "collision.hpp"
 
 using namespace upm;
 
-GroveCollision::GroveCollision(int pin)
+Collision::Collision(int pin)
 {
     
     if ( !(m_gpio = mraa_gpio_init(pin)) ) 
@@ -41,12 +41,12 @@ GroveCollision::GroveCollision(int pin)
     mraa_gpio_dir(m_gpio, MRAA_GPIO_IN);
 }
 
-GroveCollision::~GroveCollision()
+Collision::~Collision()
 {
     mraa_gpio_close(m_gpio);
 }
 
-bool GroveCollision::isColliding()
+bool Collision::isColliding()
 {
 	// Collisions cause 0; no collision is 1
 	return (!(bool)mraa_gpio_read(m_gpio));

src/collision/collision.h

@@ -22,8 +22,8 @@
  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
-#ifndef MVS0608_H_
-#define MVS0608_H_
+#ifndef COLLISION_H_
+#define COLLISION_H_
 
 #include <stdlib.h>
 #include <unistd.h>
@@ -33,49 +33,50 @@
 #include "mraa/gpio.h"
 
 /**
- * @brief MVS0608 - Grove Collision Sensor library
+ * @brief MVS0608 - GPIO Collision Sensor library
  * @ingroup gpio accelerometer
  */
 
 /**
- * @library mvs0608
- * @sensor mvs0608
- * @comname Grove Collision Sensor
+ * @library collision
+ * @sensor Collision
+ * @comname Collision Sensor
+ * @altname Grove Collision Sensor
  * @type accelerometer
  * @con gpio
  *
- * @brief API for the mvs0608
+ * @brief API for the Collision Sensor
  *
  * MVS0608 can detect whether any
  * collision movement or vibration happens.
  * It outputs a low pulse signal when vibration is detected.
  *
  * @image html grovecollision.jpg
- * @snippet grovecollision.cxx Interesting
+ * @snippet collision.c Interesting
  */
 
 /**
  * device context
  */
-typedef struct _mvs0608_context {
+typedef struct _collision_context {
     mraa_gpio_context        gpio;
     uint8_t                  gpio_pin;
-} *mvs0608_context;
+} *collision_context;
 
 /**
- * MVS0608 Initialization function
+ * Collision Initialization function
  *
  * @param pin number
  * @return void* pointer to the sensor struct
  */
-mvs0608_context mvs0608_init(int pin);
+collision_context collision_init(int pin);
 
 /**
- * MVS0608 Initialization function
+ * Collision Initialization function
  *
  * @param void* pointer to the sensor struct
  */
-void mvs0608_close(mvs0608_context dev);
+void collision_close(collision_context dev);
 
 /**
  * This function tells you whether the sensor has
@@ -85,6 +86,6 @@ void mvs0608_close(mvs0608_context dev);
  * @param bool* pointer to hold the collision value
  * @return upm_result_t UPM success/error code
  */
-upm_result_t mvs0608_is_colliding(mvs0608_context dev, bool* collision_val);
+upm_result_t collision_is_colliding(collision_context dev, bool* collision_val);
 
-#endif /* MVS0608_H_ */
+#endif /* COLLISION_H_ */

src/collision/collision.hpp

@@ -27,40 +27,41 @@
 
 namespace upm {
   /**
-   * @brief Grove Collision Sensor library
-   * @defgroup grovecollision libupm-grovecollision
+   * @brief Collision Sensor library
+   * @defgroup collision libupm-collision
    * @ingroup seeed gpio accelerometer
    */
 
   /**
-   * @library grovecollision
-   * @sensor grovecollision
-   * @comname Grove Collision Sensor
+   * @library collision
+   * @sensor collision
+   * @comname Collision Sensor
+   * @altname Grove Collision Sensor
    * @type accelerometer
    * @man seeed
    * @con gpio
    *
-   * @brief API for the Grove Collision Sensor
+   * @brief API for the Collision Sensor
    * 
-   * The Grove Collision Sensor can detect whether any
+   * The Collision Sensor can detect whether any
    * collision movement or vibration happens.
    * It outputs a low pulse signal when vibration is detected. 
    *
    * @image html grovecollision.jpg
-   * @snippet grovecollision.cxx Interesting
+   * @snippet collision.cxx Interesting
    */
-  class GroveCollision {
+  class Collision {
   public:
     /**
-     * Grove collision sensor constructor
+     * Collision sensor constructor
      *
      * @param pin Digital pin to use
      */
-    GroveCollision(int pin);
+    Collision(int pin);
     /**
-     * GroveCollision destructor
+     * Collision destructor
      */
-    ~GroveCollision();
+    ~Collision();
     /**
      * @return bool  Defines whether something is colliding with sensor
      */

src/collision/collision_fti.c

@@ -22,57 +22,57 @@
  * 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 "grovecollision.h"
+#include "collision.h"
 #include "upm_fti.h"
 
 /** 
  * This file implements the Function Table Interface (FTI) for this sensor
  */
 
-const char upm_mvs0608_name[] = "MVS0608";
-const char upm_mvs0608_description[] = "MVS0608 Grove Collision sensor";
-const upm_protocol_t upm_mvs0608_protocol[] = {UPM_GPIO};
-const upm_sensor_t upm_mvs0608_category[] = {UPM_ELECTRICITY};
+const char upm_collision_name[] = "Collision";
+const char upm_collision_description[] = "Collision sensor";
+const upm_protocol_t upm_collision_protocol[] = {UPM_GPIO};
+const upm_sensor_t upm_collision_category[] = {UPM_ELECTRICITY};
 
 // forward declarations
-const upm_sensor_descriptor_t upm_mvs0608_get_descriptor();
-const void* upm_mvs0608_get_ft(upm_sensor_t sensor_type);
-void* upm_mvs0608_init_name();
-void upm_mvs0608_close(void* dev);
+const upm_sensor_descriptor_t upm_collision_get_descriptor();
+const void* upm_collision_get_ft(upm_sensor_t sensor_type);
+void* upm_collision_init_name();
+void upm_collision_close(void* dev);
 
-const upm_sensor_descriptor_t upm_mvs0608_get_descriptor(){
+const upm_sensor_descriptor_t upm_collision_get_descriptor(){
     upm_sensor_descriptor_t usd;
-    usd.name = upm_mvs0608_name;
-    usd.description = upm_mvs0608_description;
+    usd.name = upm_collision_name;
+    usd.description = upm_collision_description;
     usd.protocol_size = 1;
-    usd.protocol = upm_mvs0608_protocol;
+    usd.protocol = upm_collision_protocol;
     usd.category_size = 1;
-    usd.category = upm_mvs0608_category;
+    usd.category = upm_collision_category;
     return usd;
 }
 
 static const upm_sensor_ft ft =
 {
-    .upm_sensor_init_name = &upm_mvs0608_init_name,
-    .upm_sensor_close = &upm_mvs0608_close,
-    .upm_sensor_get_descriptor = &upm_mvs0608_get_descriptor
+    .upm_sensor_init_name = &upm_collision_init_name,
+    .upm_sensor_close = &upm_collision_close,
+    .upm_sensor_get_descriptor = &upm_collision_get_descriptor
 };
 
-const void* upm_mvs0608_get_ft(upm_sensor_t sensor_type){
+const void* upm_collision_get_ft(upm_sensor_t sensor_type){
     if(sensor_type == UPM_SENSOR){
         return &ft;
     }
     return NULL;
 }
 
-void* upm_mvs0608_init_name(){
+void* upm_collision_init_name(){
     return NULL;
 }
 
-void upm_mvs0608_close(void* dev){
-    mvs0608_close((mvs0608_context)dev);
+void upm_collision_close(void* dev){
+    collision_close((collision_context)dev);
 }
 
-upm_result_t upm_mvs0608_is_colliding(void* dev, bool* collision_val){
-    return mvs0608_is_colliding((mvs0608_context)dev, collision_val);
+upm_result_t upm_collision_is_colliding(void* dev, bool* collision_val){
+    return collision_is_colliding((collision_context)dev, collision_val);
 }

src/collision/javaupm_collision.i

@@ -1,16 +1,16 @@
-%module javaupm_grovecollision
+%module javaupm_collision
 %include "../upm.i"
 
 %{
-    #include "grovecollision.hpp"
+    #include "collision.hpp"
 %}
 
-%include "grovecollision.hpp"
+%include "collision.hpp"
 
 %pragma(java) jniclasscode=%{
     static {
         try {
-            System.loadLibrary("javaupm_grovecollision");
+            System.loadLibrary("javaupm_collision");
         } catch (UnsatisfiedLinkError e) {
             System.err.println("Native code library failed to load. \n" + e);
             System.exit(1);

src/collision/jsupm_collision.i

@@ -0,0 +1,8 @@
+%module jsupm_collision
+%include "../upm.i"
+
+%{
+    #include "collision.hpp"
+%}
+
+%include "collision.hpp"

src/collision/pyupm_collision.i

@@ -1,11 +1,11 @@
 // Include doxygen-generated documentation
 %include "pyupm_doxy2swig.i"
-%module pyupm_grovecollision
+%module pyupm_collision
 %include "../upm.i"
 
 %feature("autodoc", "3");
 
-%include "grovecollision.hpp"
+%include "collision.hpp"
 %{
-    #include "grovecollision.hpp"
+    #include "collision.hpp"
 %}

src/grovecollision/CMakeLists.txt

@@ -1,9 +0,0 @@
-upm_mixed_module_init (NAME grovecollision
-    DESCRIPTION "upm grovecollisionsensor module"
-    C_HDR grovecollision.h
-    C_SRC grovecollision.c
-    CPP_HDR grovecollision.hpp
-    CPP_SRC grovecollision.cxx
-    FTI_SRC grovecollision_fti.c
-    CPP_WRAPS_C
-    REQUIRES mraa)

src/grovecollision/jsupm_grovecollision.i

@@ -1,8 +0,0 @@
-%module jsupm_grovecollision
-%include "../upm.i"
-
-%{
-    #include "grovecollision.hpp"
-%}
-
-%include "grovecollision.hpp"