src/ledbar/my9221.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@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 <maa/aio.h>
  28 #include <maa/gpio.h>
  29
  30 #define MAX_BIT_PER_BLOCK     16
  31 #define CMDMODE               0x0000
  32 #define BIT_HIGH              0x00ff
  33 #define BIT_LOW               0x0000
  34
  35 #define HIGH                  1
  36 #define LOW                   0
  37
  38 namespace upm {
  39
  40 /**
  41  * @brief C++ API for MY9221 led bar module
  42  *
  43  * This file defines the MY9221 C++ interface for libmy9221
  44  *
  45  * @snippet led-bar.cxx Interesting
  46  */
  47 class MY9221 {
  48     public:
  49          /**
  50          * Instanciates a MY9221 object
  51          *
  52          * @param di data pin
  53          * @param dcki clock pin
  54          */
  55         MY9221 (uint8_t di, uint8_t dcki);
  56
  57         /**
  58          * MY9221 object destructor
  59          */
  60         ~MY9221 ();
  61
  62         /**
  63          * Set the level bar
  64          *
  65          * @param level selected level for the bar (1 - 10)
  66          */
  67         maa_result_t setBarLevel (uint8_t level);
  68
  69         /**
  70          * Return name of the component
  71          */
  72         std::string name()
  73         {
  74             return m_name;
  75         }
  76     private:
  77         maa_result_t lockData ();
  78         maa_result_t send16bitBlock (short data);
  79
  80         std::string m_name;
  81         maa_gpio_context m_clkPinCtx;
  82         maa_gpio_context m_dataPinCtx;
  83 };
  84
  85 }