Home | History | Annotate | Download | only in my9221 
      1 /*
      2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha (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/aio.hpp>
     28 #include <mraa/common.hpp>
     29 
     30 #include <mraa/gpio.hpp>
     31 
     32 #define MAX_BIT_PER_BLOCK     16
     33 #define CMDMODE               0x0000
     34 #define BIT_HIGH              0x00ff
     35 #define BIT_LOW               0x0000
     36 
     37 #define HIGH                  1
     38 #define LOW                   0
     39 
     40 namespace upm {
     41 
     42 /**
     43  * @brief MY9221 LED Bar library
     44  * @defgroup my9221 libupm-my9221
     45  * @ingroup seeed display gpio eak
     46  */
     47 /**
     48  * @library my9221
     49  * @sensor my9221
     50  * @comname Grove LED Bar
     51  * @altname MY9221 LED Bar
     52  * @type display
     53  * @man seeed
     54  * @web http://www.seeedstudio.com/wiki/Grove_-_LED_Bar
     55  * @con gpio
     56  * @kit eak
     57  *
     58  * @brief API for MY9221-based LED Bars
     59  *
     60  * This module defines the MY9221 interface for libmy9221
     61  *
     62  * @image html my9221.jpg
     63  * @snippet my9221-ledbar.cxx Interesting
     64  * @snippet my9221-updown.cxx Interesting
     65  */
     66 class MY9221 {
     67     public:
     68          /**
     69          * Instantiates an MY9221 object
     70          *
     71          * @param di Data pin
     72          * @param dcki Clock pin
     73          */
     74         MY9221 (uint8_t di, uint8_t dcki);
     75 
     76         /**
     77          * Sets the bar level
     78          *
     79          * @param level Selected level for the bar (1 - 10)
     80          * @param direction Up or down; up is true and default
     81          */
     82         mraa::Result setBarLevel (uint8_t level, bool direction=true);
     83 
     84         /**
     85          * Returns the name of the component
     86          */
     87         std::string name()
     88         {
     89             return m_name;
     90         }
     91     private:
     92         mraa::Result lockData ();
     93         mraa::Result send16bitBlock (short data);
     94 
     95         std::string m_name;
     96         mraa::Gpio m_clkPinCtx;
     97         mraa::Gpio m_dataPinCtx;
     98 };
     99 
    100 }
    101