1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2015 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 <iostream>
27 
28 #include <mraa/gpio.h>
29 
30 namespace upm {
31     /**
32      * @brief SX6119-based FM Receiver library
33      * @defgroup sx6119 libupm-sx6119
34      * @ingroup seeed gpio sound
35      */
36 
37     /**
38      * @sensor sx6119
39      * @library sx6119
40      * @comname Grove FM Receiver
41      * @altname SX6119 FM Receiver
42      * @type sound
43      * @man seeed
44      * @con gpio
45      *
46      * @brief API support for the SX6119-based Grove FM Receiver
47      *
48      * This class implements support for the SX6119 FM Receiver. There are
49      * two digital pins: one that toggles power on/off, and the other that
50      * does a seek to the next station.
51      *
52      * @image html sx6119.jpg
53      * @snippet sx6119.cxx Interesting
54      */
55   class SX6119 {
56   public:
57 
58     /**
59      * SX6119 constructor
60      *
61      * @param powerPin Pin to use for recording
62      * @param seekPin Pin to use for seeking to the next station
63      */
64     SX6119(int powerPin, int seekPin);
65 
66     /**
67      * SX6119 destructor
68      */
69     ~SX6119();
70 
71     /**
72      * Toggles the device power on or off
73      *
74      */
75     void togglePower();
76 
77     /**
78      * Seeks to the next station
79      *
80      */
81     void seek();
82 
83   private:
84     mraa_gpio_context m_gpioPower;
85     mraa_gpio_context m_gpioSeek;
86   };
87 }
88 
89 
90