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 <string>
27 #include <mraa/aio.hpp>
28 #include "lcm1602.h"
29 
30 namespace upm
31 {
32   /**
33    * @library i2clcd
34    * @sensor sainsmartks
35    * @comname SainSmart LCD Keypad Shield
36    * @type display
37    * @man sainsmart
38    * @web http://www.sainsmart.com/sainsmart-1602-lcd-keypad-shield-for-arduino-duemilanove-uno-mega2560-mega1280.html
39    * @con gpio analog
40    *
41    * @brief API for Sainsmart LCD Keypad Shield
42    *
43    * The Sainsmart LCD Keypad Shield uses 6 digital outputs and 1
44    * analog input (for the keypad).  The outputs are used to drive an
45    * attached LCM1602 LCD controller.
46    *
47    * @snippet sainsmartks.cxx Interesting
48    */
49   class SAINSMARTKS : public Lcm1602
50   {
51   public:
52     /**
53      * SAINSMARTKS constructor
54      *
55      * As this is a shield, you will not likely have any choice over
56      * the pins that are used.  For this reason, we provide defaults
57      * for all of them -- of course they can be changed if your device
58      * is different.
59      *
60      * @param rs register select pin
61      * @param enable enable pin
62      * @param d0 data 0 pin
63      * @param d1 data 1 pin
64      * @param d2 data 2 pin
65      * @param d3 data 3 pin
66      * @param keypad analog pin of the keypad
67      */
68     SAINSMARTKS(uint8_t rs=8,  uint8_t enable=9,
69                 uint8_t d0=4, uint8_t d1=5, uint8_t d2=6, uint8_t d3=7,
70                 uint8_t keypad=0);
71     /**
72      * SAINSMARTKS destructor
73      */
74     ~SAINSMARTKS();
75 
76     /**
77      * returns the floating point representation of the key that is
78      * being pushed.  Each key produces a different value between 0.0
79      * and 1.0, and only one key can be read at a time.
80      *
81      * @return the floating point value representing a key
82      */
83     float getRawKeyValue();
84 
85   private:
86     mraa::Aio m_aioKeypad;
87   };
88 }
89