upm/src/lol/lol.hpp
Noel Eck 922e0cc26b cpp_headers: Renamed C++ headers from .h -> .hpp
To make room for UPM C and C++ sensor code to coexist, all UPM
C++ headers have been renamed from h -> hpp.  This commit contains
updates to documentation, includes, cmake collateral, examples, and
swig interface files.

    * Renamed all cxx/cpp header files which contain the string
    'copyright intel' from .h -> .hpp (if not already hpp).

    * Replaced all references to .h with .hpp in documentation,
    source files, cmake collateral, example code, and swig interface
    files.

    * Replaced cmake variable module_h with module_hpp.

    * Intentionally left upm.h since this file currently does not
    contain code (documentation only).

Signed-off-by: Noel Eck <noel.eck@intel.com>
2016-04-28 14:00:54 -07:00

101 lines
2.8 KiB
C++

/*
* Author: Alexander Komarov <alexander.komarov@intel.com>
* Copyright (c) 2014 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
#include <string>
#include <mraa/gpio.h>
#include <mraa/aio.h>
#include <pthread.h>
namespace upm {
#define LOL_X 14
#define LOL_Y 9
/**
* @brief Olimex LoL Array library
* @defgroup lol libupm-lol
* @ingroup adafruit gpio display
*/
/**
* @library lol
* @sensor lol
* @comname Olimex LoL Array
* @type display
* @man adafruit
* @con gpio
*
* @brief API for the Olimex LoL array
*
* This module defines the LoL API and implementation for a simple framebuffer.
*
* @image html lolshield.jpg
* @snippet lol-example.cxx Interesting
*/
class LoL {
public:
/**
* Instantiates an LoL object
* singleton
*/
LoL();
/**
* LoL object destructor
*/
~LoL();
/**
* Gets a framebuffer pointer
* @return 0 if successful
*/
unsigned char *getFramebuffer();
/**
* Gets a pixel at specified coordinates
* @param x Coordinate x
* @param y Coordinate y
* @return true if the pixel is on, false if off
* @throws std::invalid_argument if pixel is out of bounds
*/
bool getPixel(int x, int y);
/**
* Sets a pixel at specified coordinates
* @param x Coordinate x
* @param y Coordinate y
* @param pixel false is off, true is on
* @throws std::invalid_argument if pixel is out of bounds
*/
void setPixel(int x, int y, bool pixel);
private:
mraa_gpio_context m_LoLCtx[14];
unsigned char framebuffer[LOL_X*LOL_Y];
pthread_t drawer_thread;
};
};