Home | History | Annotate | Download | only in joystick12 
      1 /*
      2  * Author: Alexander Komarov <alexander.komarov (at) 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/gpio.h>
     28 #include <mraa/aio.h>
     29 
     30 namespace upm {
     31 
     32 /**
     33  * @brief Analog Joystick library
     34  * @defgroup joystick12 libupm-joystick12
     35  * @ingroup generic analog ainput robok
     36  */
     37 
     38 /**
     39  * @library joystick12
     40  * @sensor joystick12
     41  * @comname Analog Joystick
     42  * @type ainput
     43  * @man generic
     44  * @con analog
     45  * @kit robok
     46  *
     47  * @brief API for the ElecFreaks* Joystick v 1.2-1.4 Breakout
     48  *
     49  * This module defines the Joystick API, and implementation for the X and Y
     50  * buttons could be treated as normal GPIO - this enables easier
     51  * interrupt support. This driver should be compatible with any
     52  * 2-axis analog joystick.
     53  *
     54  * @image html joystick12.jpg
     55  * @snippet joystick12-example.cxx Interesting
     56  */
     57 class Joystick12 {
     58     public:
     59         /**
     60          * Instantiates a Joystick object
     61          *
     62          * @param pinX Analog pin where the X input is connected
     63          * @param pinY Analog pin where the Y input is connected
     64          */
     65         Joystick12(int pinX, int pinY);
     66 
     67         /**
     68          * Joystick object destructor
     69          */
     70         ~Joystick12();
     71 
     72         /**
     73          * Gets the X input
     74          * @return float X value, ranging from -1 to 1; 0 is mid
     75          */
     76         float getXInput();
     77 
     78         /**
     79          * Gets the Y input
     80          *
     81          * @return float Y value, ranging from -1 to 1; 0 is mid
     82          */
     83         float getYInput();
     84 
     85     private:
     86         mraa_aio_context    m_joystickCtxX;
     87         mraa_aio_context    m_joystickCtxY;
     88 
     89         static const int X_left;
     90         static const int X_center;
     91         static const int X_right;
     92         static const int Y_left;
     93         static const int Y_center;
     94         static const int Y_right;
     95 };
     96 };
     97 
     98