Display.hpp

00001 /*******************************************************************************
00002 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef DISPLAY_HPP
00034 #define DISPLAY_HPP
00035 
00036 #include <stdint.h>
00037 #include <mbed-os/drivers/DigitalOut.h>
00038 #include <mbed-os/drivers/SPI.h>
00039 #include "Bitmap.hpp"
00040 
00041 /// Interface to the SPI LCD module.
00042 class Display {
00043 public:
00044   Display(PinName mosi, PinName miso, PinName sclk, PinName ssel, PinName a0);
00045 
00046   /// Initializes the display to a known configuration before other operations.
00047   void initialize();
00048 
00049   Bitmap & canvas() { return canvas_; }
00050 
00051   const Bitmap & canvas() const { return canvas_; }
00052 
00053   /// @brief Updates the display with the specified bitmap.
00054   /// @param canvas
00055   /// Bitmap to display which should typically match the width and height dimensions.
00056   void update();
00057 
00058 private:
00059   Bitmap canvas_;
00060   mbed::SPI spi;
00061   mbed::DigitalOut cs;
00062   mbed::DigitalOut a0;
00063 
00064   void sendCommand(uint8_t command);
00065   void sendData(uint8_t data);
00066 };
00067 
00068 #endif