rover_display.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2017 FH Dortmund and others
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Description:
 *    Rover Display API - Interfaces for Rover display application development - Header file
 *
 * Usage Instructions:
 *    1) One should set-up I2C on Raspberry Pi to run this script properly (taken from Adafruit):
 *           1.1) Install necessary modules:
 *                sudo apt-get install -y python-smbus
 *                sudo apt-get install -y i2c-tools
 *           1.2) In /etc/modules, add following lines:
 *                i2c-bcm2708
 *                i2c-dev
 *           1.3) In /etc/modprobe.d/raspi-blacklist.conf, uncomment possible following lines:
 *                blacklist spi-bcm2708
 *                blacklist i2c-bcm2708
 *           1.4) In /boot/config.txt, add following lines:
 *                dtparam=i2c1=on
 *                dtparam=i2c_arm=on
 *           1.5) Then reboot
 *                sudo reboot
 *           1.6) To test I2C and see the addresses,
 *                sudo i2cdetect -y 1
 *    2) For cross-compilation using Eclipse IDE, make sure to follow the instructions located under readme.txt files
 *       in drivers/oled_drivers:
 *          Please note that in order to use OLED SSD1306 with I2C,
 *          one has to download bcm2835.c, bcm2835.h, and has access to current <linux/i2c-dev.h>.
 *          In case the compiler complains, please also download the newest i2c-dev.h and put it in drivers/oled_drivers folder.
 *          Download i2c-dev.h from: https://www.kernel.org/pub/linux/
 *          Download bcm2835.c and bcm2835.h from: https://github.com/hallard/ArduiPi_SSD1306
 *
 * Contributors:
 *    M.Ozcelikors <mozcelikors@gmail.com>, created API 17.11.2017
 *
 */

#ifndef API_ROVER_DISPLAY_HPP_
#define API_ROVER_DISPLAY_HPP_

#include <drivers/oled_drivers/Adafruit_SSD1306.h>

#define NUMFLAKES 10
#define XPOS 0
#define YPOS 1
#define DELTAY 2

namespace rover
{
    class RoverDisplay
    {
        private:
            Adafruit_SSD1306 my_display;

            int ROVER_DISPLAY_INIT_;

        public:

            static const int BLACK_COLOR = 0;

            static const int WHITE_COLOR = 1;

            RoverDisplay();

            void initialize (void);

            void display (void);

            Adafruit_SSD1306& getDisplay (void);

            void clearDisplay (void) ;

            void drawBitmap (int16_t x, int16_t y, const uint8_t *bitmap, int16_t w, int16_t h, uint16_t color) ;

            void setCursor (int16_t x, int16_t y);

            void setTextSize (uint8_t s);

            void setTextColor (uint16_t c);

            void setTextColor (uint16_t c, uint16_t b);

            void print (const char * string);

            void drawRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color);

            void drawPixel(int16_t x, int16_t y, uint16_t color);

            void drawCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);

            void fillCircle(int16_t x0, int16_t y0, int16_t r, uint16_t color);

            void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color);

            void fillScreen(uint16_t color);

            void fillRoundRect(int16_t x, int16_t y, int16_t w, int16_t h, int16_t r, uint16_t color);

            void drawRoundRect(int16_t x, int16_t y, int16_t w, int16_t h, int16_t r, uint16_t color);

            void drawTriangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);

            void fillTriangle ( int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color);

            void drawChar(int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size);

            void setRotation(uint8_t x);

            void invertDisplay(boolean i);

            int16_t width(void);

            int16_t height(void);


    };
}



#endif /* API_ROVER_DISPLAY_HPP_ */