mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 21:17:29 +03:00

This keeps the constants in the correct scope and avoid potential naming conflicts with other files. Signed-off-by: Wouter van Verre <wouter.van.verre@intel.com> Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
124 lines
3.6 KiB
C++
124 lines
3.6 KiB
C++
/*
|
||
* Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@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 "i2clcd.h"
|
||
#include "ssd.h"
|
||
|
||
namespace upm
|
||
{
|
||
const uint8_t DISPLAY_CMD_SET_NORMAL = 0xA4;
|
||
|
||
/**
|
||
* @library i2clcd
|
||
* @sensor ssd1327
|
||
* @comname SSD1327 OLED Display
|
||
* @altname Grove OLED Display 1.12"
|
||
* @type display
|
||
* @man seeed adafruit
|
||
* @web http://garden.seeedstudio.com/images/8/82/SSD1327_datasheet.pdf
|
||
* @web http://www.seeedstudio.com/wiki/Grove_-_OLED_Display_1.12%22
|
||
* @con i2c
|
||
*
|
||
* @brief C++ API for SSD1327 i2c controlled OLED displays
|
||
*
|
||
* The SSD1327 is a 96x96 Dot matrix OLED/PLED segment driver with controller.
|
||
* This implementation was tested using the Grove LED 96×96 Display module
|
||
* which is an OLED monochrome display.
|
||
*
|
||
* @image html ssd1327.jpeg
|
||
* @snippet ssd1327-oled.cxx Interesting
|
||
*/
|
||
class SSD1327 : public I2CLcd
|
||
{
|
||
public:
|
||
/**
|
||
* SSD1327 Constructor, calls libmraa initialisation functions
|
||
*
|
||
* @param bus i2c bus to use
|
||
* @param address the slave address the lcd is registered on
|
||
*/
|
||
SSD1327(int bus, int address = 0x3C);
|
||
/**
|
||
* SSD1327 destructor
|
||
*/
|
||
~SSD1327();
|
||
/**
|
||
* Draw an image, see examples/python/make_oled_pic.py for an
|
||
* explanation on how the pixels are mapped to bytes
|
||
*
|
||
* @param data the buffer to read
|
||
* @param bytes the amount of bytes to read from the pointer
|
||
* @return Result of operation
|
||
*/
|
||
mraa_result_t draw(uint8_t* data, int bytes);
|
||
/**
|
||
* Set gray level for LCD panel
|
||
*
|
||
* @param gray level from 0-255
|
||
* @return Result of operation
|
||
*/
|
||
mraa_result_t setGrayLevel(uint8_t level);
|
||
/**
|
||
* Write a string to LCD
|
||
*
|
||
* @param msg The std::string to write to display, note only ascii
|
||
* chars are supported
|
||
* @return Result of operation
|
||
*/
|
||
mraa_result_t write(std::string msg);
|
||
/**
|
||
* Set cursor to a coordinate
|
||
*
|
||
* @param row The row to set cursor to
|
||
* @param column The column to set cursor to
|
||
* @return Result of operation
|
||
*/
|
||
mraa_result_t setCursor(int row, int column);
|
||
/**
|
||
* Clear display from characters
|
||
*
|
||
* @return Result of operatio
|
||
*/
|
||
mraa_result_t clear();
|
||
/**
|
||
* Return to coordinate 0,0
|
||
*
|
||
* @return Result of operation
|
||
*/
|
||
mraa_result_t home();
|
||
|
||
private:
|
||
mraa_result_t writeChar(uint8_t value);
|
||
mraa_result_t setNormalDisplay();
|
||
mraa_result_t setHorizontalMode();
|
||
mraa_result_t setVerticalMode();
|
||
|
||
uint8_t grayHigh;
|
||
uint8_t grayLow;
|
||
};
|
||
}
|