display.h

/* University of York Robotics Laboratory PsiSwarm Library: Display Driver Header File
 *
 * Copyright 2016 University of York
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and limitations under the License.
 *
 * File: display.h
 *
 * (C) Dept. Electronics & Computer Science, University of York
 * James Hilder, Alan Millard, Alexander Horsfield, Homero Elizondo, Jon Timmis
 *
 * PsiSwarm Library Version: 0.8
 *
 * October 2016
 *
 *
 * Driver for the Midas 16x2 I2C LCD Display (MCCOG21605x6W) LCD
 *
 * Farnell part 2218942 or 2063206
 *
 */


#ifndef DISPLAY_H
#define DISPLAY_H

#define PAGE_TIME 0.4
#define CLEAR_TIME 0.8

class Display : public Stream
{

// Public Functions

public:

    Display();

    Display(PinName sda, PinName scl, PinName reset, PinName backlight);

    void clear_display(void);

    void home(void);

    void write_string(char * message);

    void write_string(char * message, char length);

    void set_position(char row, char column);

    void set_cursor(char enable);

    void set_blink(char enable);

    void set_display(char enable);

    void set_backlight_brightness(float brightness);

    // Special function for when debug messages are sent to display
    void debug_page(char * message, char length);

    // Internal function used to restore display after debug messages
    void IF_restore_page(void);

    // Internal function used to show multi-page debug messages
    void IF_debug_multipage(void);

    // Internal function used to toggle backlight
    void IF_backlight_toggle(void);

    //Parts of initialisation routine
    void post_init(void);
    void post_post_init(void);

    // Send a 1-byte control message to the display
    int i2c_message(char byte);

    // Default initialisation sequence for the display
    void init_display(char mode);

    int disp_putc(int c);


private :

    I2C _i2c;
    DigitalOut _reset;
    DigitalOut _backlight;

    char display_on;
    char cursor_on;
    char blink_on;

    void _set_display();

    virtual int _putc(int c);
    virtual int _getc();

};

#endif // DISPLAY_H