alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Moisture: Add C Src and Example

Browse Source 
Changed from GroveMoisture.

Signed-off-by: Abhishek Malik <abhishek.malik@intel.com>
This commit is contained in:
Abhishek Malik
2016-09-12 15:25:45 -07:00
committed by Noel Eck
parent 0f7bb5573c
commit 1caf805d2b
19 changed files with 112 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/grovemoisture/CMakeLists.txt
View File

@ -1,9 +0,0 @@
upm_mixed_module_init (NAME grovemoisture
DESCRIPTION "upm grove moisture module"
C_HDR moisture.h
C_SRC moisture.c
CPP_HDR grovemoisture.hpp
CPP_SRC grovemoisture.cxx
FTI_SRC grovemoisture_fti.c
CPP_WRAPS_C
REQUIRES libmraa)

48
src/grovemoisture/grovemoisture.cxx
View File

@ -1,48 +0,0 @@
/*
* 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 <string>
#include <stdexcept>
#include "grovemoisture.hpp"
using namespace upm;
GroveMoisture::GroveMoisture(int pin)
{
if ( !(m_aio = mraa_aio_init(pin)) )
throw std::invalid_argument(std::string(__FUNCTION__) +
": mraa_aio_init() failed, invalid pin?");
}
GroveMoisture::~GroveMoisture()
{
mraa_aio_close(m_aio);
}
int GroveMoisture::value()
{
return mraa_aio_read(m_aio);
}

81
src/grovemoisture/grovemoisture.hpp
View File

@ -1,81 +0,0 @@
/*
* 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/aio.h>
namespace upm {
/**
* @brief Grove Moisture Sensor library
* @defgroup grovemoisture libupm-grovemoisture
* @ingroup seeed analog liquid eak hak
*/
/**
* @library grovemoisture
* @sensor grovemoisture
* @comname Grove Moisture Sensor
* @type liquid
* @man seeed
* @con analog
* @kit eak hak
*
* @brief API for the Grove Moisture Sensor
*
* UPM module for the Grove Moisture Sensor.
* This sensor can be used to detect the moisture content
* of soil or whether there is water around the sensor.
* As the moisture content increases, so does the value that is read.
* Note: this sensor is not designed to be left in soil
* nor to be used outdoors.
*
* @image html grovemoisture.jpg
* @snippet grovemoisture.cxx Interesting
*/
class GroveMoisture {
public:
/**
* Grove analog moisture sensor constructor
*
* @param pin Analog pin to use
*/
GroveMoisture(int pin);
/**
* GroveMoisture destructor
*/
~GroveMoisture();
/**
* Gets the moisture value from the sensor
*
* @return Moisture reading
*/
int value();
private:
mraa_aio_context m_aio;
};
}

88
src/grovemoisture/grovemoisture_fti.c
View File

@ -1,88 +0,0 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Abhishek Malik <abhishek.malik@intel.com>
* Copyright (c) 2016 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 "moisture.h"
#include "upm_fti.h"
/**
* This file implements the Function Table Interface (FTI) for this sensor
*/
const char upm_grovemoisture_name[] = "Grove Moisture";
const char upm_grovemoisture_description[] = "Analog Grove Moisture Sensor";
const upm_protocol_t upm_grovemoisture_protocol[] = {UPM_ANALOG};
const upm_sensor_t upm_grovemoisture_category[] = {UPM_MOISTURE};
// forward declarations
const void* upm_grovemoisture_get_ft(upm_sensor_t sensor_type);
void* upm_grovemoisture_init_name();
void upm_grovemoisture_close(void* dev);
upm_result_t upm_grovemoisture_get_moisture(void* dev, int* moisture);
const upm_sensor_descriptor_t upm_grovemoisture_get_descriptor (){
upm_sensor_descriptor_t usd;
usd.name = upm_grovemoisture_name;
usd.description = upm_grovemoisture_description;
usd.protocol_size = 1;
usd.protocol = upm_grovemoisture_protocol;
usd.category_size = 1;
usd.category = upm_grovemoisture_category;
return usd;
}
static const upm_sensor_ft ft =
{
.upm_sensor_init_name = &upm_grovemoisture_init_name,
.upm_sensor_close = &upm_grovemoisture_close,
.upm_sensor_get_descriptor = &upm_grovemoisture_get_descriptor
};
static const upm_moisture_ft mft =
{
.upm_moisture_sensor_get_moisture = &upm_grovemoisture_get_moisture
};
const void* upm_grovemoisture_get_ft(upm_sensor_t sensor_type){
if(sensor_type == UPM_MOISTURE){
return &mft;
}
if(sensor_type == UPM_SENSOR){
return &ft;
}
return NULL;
}
void* upm_grovemoisture_init_name(){
return NULL;
}
void upm_grovemoisture_close(void* dev){
grovemoisture_close((grovemoisture_context)dev);
}
upm_result_t upm_grovemoisture_get_moisture(void* dev, int* moisture){
return grovemoisture_get_moisture((grovemoisture_context)dev, moisture);
}

19
src/grovemoisture/javaupm_grovemoisture.i
View File

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

8
src/grovemoisture/jsupm_grovemoisture.i
View File

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

61
src/grovemoisture/moisture.c
View File

@ -1,61 +0,0 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Abhishek Malik <abhishek.malik@intel.com>
* Copyright (c) 2016 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 "moisture.h"
grovemoisture_context grovemoisture_init(int pin) {
grovemoisture_context dev =
(grovemoisture_context) malloc(sizeof(struct _grovemoisture_context));
if (dev == NULL) {
printf("Unable to allocate memory for device context\n");
return NULL;
}
dev->analog_pin = pin;
dev->aio = mraa_aio_init(dev->analog_pin);
if (dev->aio == NULL) {
printf("mraa_aio_init() failed.\n");
free(dev);
return NULL;
}
return dev;
}
void grovemoisture_close(grovemoisture_context dev) {
mraa_aio_close(dev->aio);
free(dev);
}
upm_result_t grovemoisture_get_moisture(grovemoisture_context dev,
int* moisture) {
*moisture = mraa_aio_read(dev->aio);
return UPM_SUCCESS;
}

74
src/grovemoisture/moisture.h
View File

@ -1,74 +0,0 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Abhishek Malik <abhishek.malik@intel.com>
* Copyright (c) 2016 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 <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "upm.h"
#include "mraa/aio.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* device context
*/
typedef struct _grovemoisture_context {
mraa_aio_context aio;
uint16_t analog_pin;
} *grovemoisture_context;
/**
* Init function
*
* @param pin analog pin number
* @return void* pointer to the sensor struct
*/
grovemoisture_context grovemoisture_init(int pin);
/**
* Close function
*
* @param dev pointer to the sensor structure
*/
void grovemoisture_close(grovemoisture_context dev);
/**
* Get Moisture function.
*
* @param dev pointer to the sensor struct
* @param moisture pointer that will be used to store the
* output value from the sensor
*/
upm_result_t grovemoisture_get_moisture(grovemoisture_context dev,
int* moisture);
#ifdef __cplusplus
}
#endif

11
src/grovemoisture/pyupm_grovemoisture.i
View File

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