1 /*
2  * Author: Sarah Knepper <sarah.knepper@intel.com>
3  * Copyright (c) 2014 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 #pragma once
25 
26 #include <string>
27 #include <mraa/aio.h>
28 
29 namespace upm {
30 
31 /**
32  * @brief LDT0-028 Piezo Vibration Sensor library
33  * @defgroup ldt0028 libupm-ldt0028
34  * @ingroup seeed analog flexfor
35  */
36 
37 /**
38  * @library ldt0028
39  * @sensor ldt0028
40  * @comname LDT0-028 Piezo Vibration Sensor
41  * @altname Grove Piezo Vibration Sensor
42  * @type flexfor
43  * @man seeed
44  * @con analog
45  *
46  * @brief API for LDT0-028 PZT film-based sensors,
47  * such as a Grove Piezo Vibration sensor
48  *
49  * This module defines the LDT0-028 interface for libupm-ldt0028
50  *
51  * @image html ldt0028.jpg
52  * @snippet ldt0028.cxx Interesting
53  */
54 class LDT0028 {
55     public:
56         /**
57          * LDT0028 constructor
58          *
59          * @param pin AIO pin where the sensor is connected
60          */
61         LDT0028(unsigned int pin);
62 
63         /**
64          * LDT0028 destructor
65          */
66         ~LDT0028();
67 
68         /**
69          * Returns the name of this sensor
70          *
71          * @return Name of this sensor
72          */
73         std::string name();
74 
75         /**
76          * Returns one sample from this sensor
77          *
78          * @return One value from this sensor
79          */
80         int getSample();
81 
82     protected:
83         std::string         m_name; //!< name of this sensor
84         mraa_aio_context    m_pin;  //!< AIO pin
85 };
86 
87 }
88