Qrome - removed the OledDisplay libs as they are not used here
Chrome Legion
parent
0adead3bbf
commit
9d51257d04
|
|
@ -1,405 +0,0 @@
|
||||||
[](https://travis-ci.org/ThingPulse/esp8266-oled-ssd1306)
|
|
||||||
|
|
||||||
# ESP8266 OLED SSD1306
|
|
||||||
|
|
||||||
> We just released version 4.0.0. Please have a look at our [upgrade guide](UPGRADE-4.0.md)
|
|
||||||
|
|
||||||
This is a driver for the SSD1306 based 128x64 pixel OLED display running on the Arduino/ESP8266 platform.
|
|
||||||
Can be used with either the I2C or SPI version of the display
|
|
||||||
|
|
||||||
You can either download this library as a zip file and unpack it to your Arduino/libraries folder or (once it has been added) choose it from the Arduino library manager.
|
|
||||||
|
|
||||||
It is also available as a platformio library. Just execute the following command:
|
|
||||||
```
|
|
||||||
platformio lib install 562
|
|
||||||
```
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
This library has initially been written by Daniel Eichhorn (@squix78). Many thanks go to Fabrice Weinberg (@FWeinb) for optimizing and refactoring many aspects of the library. Also many thanks to the many committers who helped to add new features and who fixed many bugs.
|
|
||||||
The init sequence for the SSD1306 was inspired by Adafruit's library for the same display.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Check out the examples folder for a few comprehensive demonstrations how to use the library. Also check out the [ESP8266 Weather Station](https://github.com/ThingPulse/esp8266-weather-station) library which uses the OLED library to display beautiful weather information.
|
|
||||||
|
|
||||||
## Upgrade
|
|
||||||
|
|
||||||
The API changed a lot with the 3.0 release. If you were using this library with older versions please have a look at the [Upgrade Guide](UPGRADE-3.0.md).
|
|
||||||
|
|
||||||
Going from 3.x version to 4.0 a lot of internals changed and compatibility for more displays was added. Please read the [Upgrade Guide](UPGRADE-4.0.md).
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
* Draw pixels at given coordinates
|
|
||||||
* Draw lines from given coordinates to given coordinates
|
|
||||||
* Draw or fill a rectangle with given dimensions
|
|
||||||
* Draw Text at given coordinates:
|
|
||||||
* Define Alignment: Left, Right and Center
|
|
||||||
* Set the Fontface you want to use (see section Fonts below)
|
|
||||||
* Limit the width of the text by an amount of pixels. Before this widths will be reached, the renderer will wrap the text to a new line if possible
|
|
||||||
* Display content in automatically side scrolling carousel
|
|
||||||
* Define transition cycles
|
|
||||||
* Define how long one frame will be displayed
|
|
||||||
* Draw the different frames in callback methods
|
|
||||||
* One indicator per frame will be automatically displayed. The active frame will be displayed from inactive once
|
|
||||||
|
|
||||||
## Fonts
|
|
||||||
|
|
||||||
Fonts are defined in a proprietary but open format. You can create new font files by choosing from a given list
|
|
||||||
of open sourced Fonts from this web app: http://oleddisplay.squix.ch
|
|
||||||
Choose the font family, style and size, check the preview image and if you like what you see click the "Create" button. This will create the font array in a text area form where you can copy and paste it into a new or existing header file.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Hardware Abstraction
|
|
||||||
|
|
||||||
The library supports different protocols to access the OLED display. Currently there is support for I2C using the built in Wire.h library, I2C by using the much faster BRZO I2C library [https://github.com/pasko-zh/brzo_i2c] written in assembler and it also supports displays which come with the SPI interface.
|
|
||||||
|
|
||||||
### I2C with Wire.h
|
|
||||||
|
|
||||||
```C++
|
|
||||||
#include <Wire.h>
|
|
||||||
#include "SSD1306Wire.h"
|
|
||||||
|
|
||||||
SSD1306Wire display(ADDRESS, SDA, SDC);
|
|
||||||
```
|
|
||||||
or for a SH1106:
|
|
||||||
```C++
|
|
||||||
#include <Wire.h>
|
|
||||||
#include "SH1106Wire.h"
|
|
||||||
|
|
||||||
SH1106Wire display(ADDRESS, SDA, SDC);
|
|
||||||
```
|
|
||||||
|
|
||||||
### I2C with brzo_i2c
|
|
||||||
|
|
||||||
```C++
|
|
||||||
#include <brzo_i2c.h>
|
|
||||||
#include "SSD1306Brzo.h"
|
|
||||||
|
|
||||||
SSD1306Brzo display(ADDRESS, SDA, SDC);
|
|
||||||
```
|
|
||||||
or for the SH1106:
|
|
||||||
```C++
|
|
||||||
#include <brzo_i2c.h>
|
|
||||||
#include "SH1106Brzo.h"
|
|
||||||
|
|
||||||
SH1106Brzo display(ADDRESS, SDA, SDC);
|
|
||||||
```
|
|
||||||
|
|
||||||
### SPI
|
|
||||||
|
|
||||||
```C++
|
|
||||||
#include <SPI.h>
|
|
||||||
#include "SSD1306Spi.h"
|
|
||||||
|
|
||||||
SSD1306Spi display(RES, DC, CS);
|
|
||||||
```
|
|
||||||
or for the SH1106:
|
|
||||||
```C++
|
|
||||||
#include <SPI.h>
|
|
||||||
#include "SH1106Spi.h"
|
|
||||||
|
|
||||||
SH1106Spi display(RES, DC, CS);
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
### Display Control
|
|
||||||
|
|
||||||
```C++
|
|
||||||
// Initialize the display
|
|
||||||
void init();
|
|
||||||
|
|
||||||
// Free the memory used by the display
|
|
||||||
void end();
|
|
||||||
|
|
||||||
// Cycle through the initialization
|
|
||||||
void resetDisplay(void);
|
|
||||||
|
|
||||||
// Connect again to the display through I2C
|
|
||||||
void reconnect(void);
|
|
||||||
|
|
||||||
// Turn the display on
|
|
||||||
void displayOn(void);
|
|
||||||
|
|
||||||
// Turn the display offs
|
|
||||||
void displayOff(void);
|
|
||||||
|
|
||||||
// Clear the local pixel buffer
|
|
||||||
void clear(void);
|
|
||||||
|
|
||||||
// Write the buffer to the display memory
|
|
||||||
void display(void);
|
|
||||||
|
|
||||||
// Inverted display mode
|
|
||||||
void invertDisplay(void);
|
|
||||||
|
|
||||||
// Normal display mode
|
|
||||||
void normalDisplay(void);
|
|
||||||
|
|
||||||
// Set display contrast
|
|
||||||
// really low brightness & contrast: contrast = 10, precharge = 5, comdetect = 0
|
|
||||||
// normal brightness & contrast: contrast = 100
|
|
||||||
void setContrast(uint8_t contrast, uint8_t precharge = 241, uint8_t comdetect = 64);
|
|
||||||
|
|
||||||
// Convenience method to access
|
|
||||||
void setBrightness(uint8_t);
|
|
||||||
|
|
||||||
// Turn the display upside down
|
|
||||||
void flipScreenVertically();
|
|
||||||
|
|
||||||
// Draw the screen mirrored
|
|
||||||
void mirrorScreen();
|
|
||||||
```
|
|
||||||
|
|
||||||
## Pixel drawing
|
|
||||||
|
|
||||||
```C++
|
|
||||||
|
|
||||||
/* Drawing functions */
|
|
||||||
// Sets the color of all pixel operations
|
|
||||||
void setColor(OLEDDISPLAY_COLOR color);
|
|
||||||
|
|
||||||
// Draw a pixel at given position
|
|
||||||
void setPixel(int16_t x, int16_t y);
|
|
||||||
|
|
||||||
// Draw a line from position 0 to position 1
|
|
||||||
void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1);
|
|
||||||
|
|
||||||
// Draw the border of a rectangle at the given location
|
|
||||||
void drawRect(int16_t x, int16_t y, int16_t width, int16_t height);
|
|
||||||
|
|
||||||
// Fill the rectangle
|
|
||||||
void fillRect(int16_t x, int16_t y, int16_t width, int16_t height);
|
|
||||||
|
|
||||||
// Draw the border of a circle
|
|
||||||
void drawCircle(int16_t x, int16_t y, int16_t radius);
|
|
||||||
|
|
||||||
// Fill circle
|
|
||||||
void fillCircle(int16_t x, int16_t y, int16_t radius);
|
|
||||||
|
|
||||||
// Draw a line horizontally
|
|
||||||
void drawHorizontalLine(int16_t x, int16_t y, int16_t length);
|
|
||||||
|
|
||||||
// Draw a lin vertically
|
|
||||||
void drawVerticalLine(int16_t x, int16_t y, int16_t length);
|
|
||||||
|
|
||||||
// Draws a rounded progress bar with the outer dimensions given by width and height. Progress is
|
|
||||||
// a unsigned byte value between 0 and 100
|
|
||||||
void drawProgressBar(uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t progress);
|
|
||||||
|
|
||||||
// Draw a bitmap in the internal image format
|
|
||||||
void drawFastImage(int16_t x, int16_t y, int16_t width, int16_t height, const uint8_t *image);
|
|
||||||
|
|
||||||
// Draw a XBM
|
|
||||||
void drawXbm(int16_t x, int16_t y, int16_t width, int16_t height, const char* xbm);
|
|
||||||
```
|
|
||||||
|
|
||||||
## Text operations
|
|
||||||
|
|
||||||
``` C++
|
|
||||||
void drawString(int16_t x, int16_t y, String text);
|
|
||||||
|
|
||||||
// Draws a String with a maximum width at the given location.
|
|
||||||
// If the given String is wider than the specified width
|
|
||||||
// The text will be wrapped to the next line at a space or dash
|
|
||||||
void drawStringMaxWidth(int16_t x, int16_t y, int16_t maxLineWidth, String text);
|
|
||||||
|
|
||||||
// Returns the width of the const char* with the current
|
|
||||||
// font settings
|
|
||||||
uint16_t getStringWidth(const char* text, uint16_t length);
|
|
||||||
|
|
||||||
// Convencience method for the const char version
|
|
||||||
uint16_t getStringWidth(String text);
|
|
||||||
|
|
||||||
// Specifies relative to which anchor point
|
|
||||||
// the text is rendered. Available constants:
|
|
||||||
// TEXT_ALIGN_LEFT, TEXT_ALIGN_CENTER, TEXT_ALIGN_RIGHT, TEXT_ALIGN_CENTER_BOTH
|
|
||||||
void setTextAlignment(OLEDDISPLAY_TEXT_ALIGNMENT textAlignment);
|
|
||||||
|
|
||||||
// Sets the current font. Available default fonts
|
|
||||||
// ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24
|
|
||||||
// Or create one with the font tool at http://oleddisplay.squix.ch
|
|
||||||
void setFont(const uint8_t* fontData);
|
|
||||||
```
|
|
||||||
|
|
||||||
## Ui Library (OLEDDisplayUi)
|
|
||||||
|
|
||||||
The Ui Library is used to provide a basic set of Ui elements called, `Frames` and `Overlays`. A `Frame` is used to provide
|
|
||||||
information the default behaviour is to display a `Frame` for a defined time and than move to the next. The library also provides an `Indicator` that will be updated accordingly. An `Overlay` on the other hand is a pieces of information (e.g. a clock) that is displayed always at the same position.
|
|
||||||
|
|
||||||
|
|
||||||
```C++
|
|
||||||
/**
|
|
||||||
* Initialise the display
|
|
||||||
*/
|
|
||||||
void init();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configure the internal used target FPS
|
|
||||||
*/
|
|
||||||
void setTargetFPS(uint8_t fps);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enable automatic transition to next frame after the some time can be configured with
|
|
||||||
* `setTimePerFrame` and `setTimePerTransition`.
|
|
||||||
*/
|
|
||||||
void enableAutoTransition();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable automatic transition to next frame.
|
|
||||||
*/
|
|
||||||
void disableAutoTransition();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the direction if the automatic transitioning
|
|
||||||
*/
|
|
||||||
void setAutoTransitionForwards();
|
|
||||||
void setAutoTransitionBackwards();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the approx. time a frame is displayed
|
|
||||||
*/
|
|
||||||
void setTimePerFrame(uint16_t time);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the approx. time a transition will take
|
|
||||||
*/
|
|
||||||
void setTimePerTransition(uint16_t time);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Draw the indicator.
|
|
||||||
* This is the default state for all frames if
|
|
||||||
* the indicator was hidden on the previous frame
|
|
||||||
* it will be slided in.
|
|
||||||
*/
|
|
||||||
void enableIndicator();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Don't draw the indicator.
|
|
||||||
* This will slide out the indicator
|
|
||||||
* when transitioning to the next frame.
|
|
||||||
*/
|
|
||||||
void disableIndicator();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enable drawing of all indicators.
|
|
||||||
*/
|
|
||||||
void enableAllIndicators();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable drawing of all indicators.
|
|
||||||
*/
|
|
||||||
void disableAllIndicators();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the position of the indicator bar.
|
|
||||||
*/
|
|
||||||
void setIndicatorPosition(IndicatorPosition pos);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the direction of the indicator bar. Defining the order of frames ASCENDING / DESCENDING
|
|
||||||
*/
|
|
||||||
void setIndicatorDirection(IndicatorDirection dir);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the symbol to indicate an active frame in the indicator bar.
|
|
||||||
*/
|
|
||||||
void setActiveSymbol(const char* symbol);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the symbol to indicate an inactive frame in the indicator bar.
|
|
||||||
*/
|
|
||||||
void setInactiveSymbol(const char* symbol);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configure what animation is used to transition from one frame to another
|
|
||||||
*/
|
|
||||||
void setFrameAnimation(AnimationDirection dir);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add frame drawing functions
|
|
||||||
*/
|
|
||||||
void setFrames(FrameCallback* frameFunctions, uint8_t frameCount);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add overlays drawing functions that are draw independent of the Frames
|
|
||||||
*/
|
|
||||||
void setOverlays(OverlayCallback* overlayFunctions, uint8_t overlayCount);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the function that will draw each step
|
|
||||||
* in the loading animation
|
|
||||||
*/
|
|
||||||
void setLoadingDrawFunction(LoadingDrawFunction loadingDrawFunction);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Run the loading process
|
|
||||||
*/
|
|
||||||
void runLoadingProcess(LoadingStage* stages, uint8_t stagesCount);
|
|
||||||
|
|
||||||
// Manuell Controll
|
|
||||||
void nextFrame();
|
|
||||||
void previousFrame();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Switch without transition to frame `frame`.
|
|
||||||
*/
|
|
||||||
void switchToFrame(uint8_t frame);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transition to frame `frame`, when the `frame` number is bigger than the current
|
|
||||||
* frame the forward animation will be used, otherwise the backwards animation is used.
|
|
||||||
*/
|
|
||||||
void transitionToFrame(uint8_t frame);
|
|
||||||
|
|
||||||
// State Info
|
|
||||||
OLEDDisplayUiState* getUiState();
|
|
||||||
|
|
||||||
// This needs to be called in the main loop
|
|
||||||
// the returned value is the remaining time (in ms)
|
|
||||||
// you have to draw after drawing to keep the frame budget.
|
|
||||||
int8_t update();
|
|
||||||
```
|
|
||||||
|
|
||||||
## Example: SSD1306Demo
|
|
||||||
|
|
||||||
### Frame 1
|
|
||||||
|
|
||||||
|
|
||||||
This frame shows three things:
|
|
||||||
* How to draw an xbm image
|
|
||||||
* How to draw a static text which is not moved by the frame transition
|
|
||||||
* The active/inactive frame indicators
|
|
||||||
|
|
||||||
### Frame 2
|
|
||||||
|
|
||||||
|
|
||||||
Currently there are one fontface with three sizes included in the library: Arial 10, 16 and 24. Once the converter is published you will be able to convert any ttf font into the used format.
|
|
||||||
|
|
||||||
### Frame 3
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
This frame demonstrates the text alignment. The coordinates in the frame show relative to which position the texts have been rendered.
|
|
||||||
|
|
||||||
### Frame 4
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
This shows how to use define a maximum width after which the driver automatically wraps a word to the next line. This comes in very handy if you have longer texts to display.
|
|
||||||
|
|
||||||
### SPI version
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
This shows the code working on the SPI version of the display. See demo code for ESP8266 pins used.
|
|
||||||
|
|
||||||
## Project using this library
|
|
||||||
|
|
||||||
* [QRCode ESP8266](https://github.com/anunpanya/ESP8266_QRcode) (by @anunpanya)
|
|
||||||
* [Scan I2C](https://github.com/hallard/Scan-I2C-WiFi) (by @hallard)
|
|
||||||
* [Weather Station](https://github.com/squix78/esp8266-weather-station) (by @squix)
|
|
||||||
|
|
@ -1,125 +0,0 @@
|
||||||
# Upgrade from 2.0 to 3.0
|
|
||||||
|
|
||||||
While developing version 3.0 we made some breaking changes to the public
|
|
||||||
API of this library. This document will help you update your code to work with
|
|
||||||
version 3.0
|
|
||||||
|
|
||||||
## Font Definitions
|
|
||||||
|
|
||||||
To get better performance and a smaller font definition format, we change the memory
|
|
||||||
layout of the font definition format. If you are using custom fonts not included in
|
|
||||||
this library we updated the font generator [here](http://oleddisplay.squix.ch/#/home).
|
|
||||||
Please update your fonts to be working with 3.0 by selecting the respective version in the dropdown.
|
|
||||||
|
|
||||||
|
|
||||||
## Architectural Changes
|
|
||||||
|
|
||||||
To become a more versatile library for the SSD1306 chipset we abstracted the
|
|
||||||
hardware connection into subclasses of the base display class now called `OLEDDisplay`.
|
|
||||||
This library is currently shipping with three implementations:
|
|
||||||
|
|
||||||
* `SSD1306Wire` implementing the I2C protocol using the Wire Library.
|
|
||||||
* `SSD1306Brzo` implementing the I2C protocol using the faster [`brzo_i2c`](https://github.com/pasko-zh/brzo_i2c) library.
|
|
||||||
* `SSD1306Spi` implementing the SPI protocol.
|
|
||||||
|
|
||||||
To keep backwards compatiblity with the old API `SSD1306` is an alias of `SSD1306Wire`.
|
|
||||||
If you are not using the UI components you don't have to change anything to keep your code working.
|
|
||||||
|
|
||||||
## Name Changes
|
|
||||||
|
|
||||||
[Naming things is hard](http://martinfowler.com/bliki/TwoHardThings.html), to better reflect our intention with this library
|
|
||||||
we changed the name of the base class to `OLEDDisplay` and the UI library accordingly to `OLEDDisplayUi`.
|
|
||||||
As a consequence the type definitions of all frame and overlay related functions changed.
|
|
||||||
This means that you have to update all your frame drawing callbacks from:
|
|
||||||
|
|
||||||
```c
|
|
||||||
bool frame1(SSD1306 *display, SSD1306UiState* state, int x, int y);
|
|
||||||
```
|
|
||||||
|
|
||||||
too
|
|
||||||
|
|
||||||
```c
|
|
||||||
void frame1(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y);
|
|
||||||
```
|
|
||||||
|
|
||||||
And your overlay drawing functions from:
|
|
||||||
|
|
||||||
```c
|
|
||||||
bool overlay1(SSD1306 *display, SSD1306UiState* state);
|
|
||||||
```
|
|
||||||
|
|
||||||
too
|
|
||||||
|
|
||||||
```c
|
|
||||||
void overlay1(OLEDDisplay *display, OLEDDisplayUiState* state);
|
|
||||||
```
|
|
||||||
|
|
||||||
## New Features
|
|
||||||
|
|
||||||
### Loading Animation
|
|
||||||
|
|
||||||
While using this library ourself we noticed a pattern emerging. We want to drawing
|
|
||||||
a loading progress while connecting to WiFi and updating weather data etc.
|
|
||||||
|
|
||||||
The simplest thing was to add the function `drawProgressBar(x, y, width, height, progress)`
|
|
||||||
,where `progress` is between `0` and `100`, right to the `OLEDDisplay` class.
|
|
||||||
|
|
||||||
But we didn't stop there. We added a new feature to the `OLEDDisplayUi` called `LoadingStages`.
|
|
||||||
You can define your loading process like this:
|
|
||||||
|
|
||||||
```c++
|
|
||||||
LoadingStage loadingStages[] = {
|
|
||||||
{
|
|
||||||
.process = "Connect to WiFi",
|
|
||||||
.callback = []() {
|
|
||||||
// Connect to WiFi
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
.process = "Get time from NTP",
|
|
||||||
.callback = []() {
|
|
||||||
// Get current time via NTP
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// more steps
|
|
||||||
};
|
|
||||||
|
|
||||||
int LOADING_STAGES_COUNT = sizeof(loadingStages) / sizeof(LoadingStage);
|
|
||||||
```
|
|
||||||
|
|
||||||
After defining your array of `LoadingStages` you can then run the loading process by using
|
|
||||||
`ui.runLoadingProcess(loadingStages, LOADING_STAGES_COUNT)`. This will give you a
|
|
||||||
nice little loading animation you can see in the beginning of [this](https://vimeo.com/168362918)
|
|
||||||
video.
|
|
||||||
|
|
||||||
To further customize this you are free to define your own `LoadingDrawFunction` like this:
|
|
||||||
|
|
||||||
```c
|
|
||||||
void myLoadingDraw(OLEDDisplay *display, LoadingStage* stage, uint8_t progress) {
|
|
||||||
display->setTextAlignment(TEXT_ALIGN_CENTER);
|
|
||||||
display->setFont(ArialMT_Plain_10);
|
|
||||||
// stage->process contains the text of the current progress e.q. "Connect to WiFi"
|
|
||||||
display->drawString(64, 18, stage->process);
|
|
||||||
// you could just print the current process without the progress bar
|
|
||||||
display->drawString(64, 28, progress);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
After defining a function like that, you can pass it to the Ui library by use
|
|
||||||
`ui.setLoadingDrawFunction(myLoadingDraw)`.
|
|
||||||
|
|
||||||
|
|
||||||
### Text Logging
|
|
||||||
|
|
||||||
It is always useful to display some text on the display without worrying to much
|
|
||||||
where it goes and managing it. In 3.0 we made the `OLEDDisplay` class implement
|
|
||||||
[`Print`](https://github.com/arduino/Arduino/blob/master/hardware/arduino/avr/cores/arduino/Print.h)
|
|
||||||
so you can use it like you would use `Serial`. We calls this feature `LogBuffer`
|
|
||||||
and the only thing you have to do is to define how many lines you want to display
|
|
||||||
and how many characters there are on average on each. This is done by calling
|
|
||||||
`setLogBuffer(lines, chars);`. If there is not enough memory the function will
|
|
||||||
return false.
|
|
||||||
|
|
||||||
After that you can draw the `LogBuffer` anywhere you want by calling `drawLogBuffer(x, y)`.
|
|
||||||
(Note: You have to call `display()` to update the screen)
|
|
||||||
We made a [video](https://www.youtube.com/watch?v=8Fiss77A3TE) showing this feature in action.
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
# Upgrade from 3.x to 4.0
|
|
||||||
|
|
||||||
There are changes that breaks compatibility with older versions.
|
|
||||||
|
|
||||||
1. You'll have to change data type for all your binary resources such as images and fonts from
|
|
||||||
|
|
||||||
```c
|
|
||||||
const char MySymbol[] PROGMEM = {
|
|
||||||
```
|
|
||||||
|
|
||||||
to
|
|
||||||
|
|
||||||
```c
|
|
||||||
const uint8_t MySymbol[] PROGMEM = {
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Arguments of `setContrast` from `char` to `uint8_t`
|
|
||||||
|
|
||||||
```c++
|
|
||||||
void OLEDDisplay::setContrast(char contrast, char precharge, char comdetect);
|
|
||||||
```
|
|
||||||
|
|
||||||
to
|
|
||||||
|
|
||||||
```c++
|
|
||||||
void OLEDDisplay::setContrast(uint8_t contrast, uint8_t precharge, uint8_t comdetect);
|
|
||||||
```
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2016 by Daniel Eichhorn
|
|
||||||
Copyright (c) 2016 by Fabrice Weinberg
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
See more at http://blog.squix.ch
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
|
@ -1,633 +0,0 @@
|
||||||
<!--The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2017 by Xavier Grosjean
|
|
||||||
|
|
||||||
Based on work
|
|
||||||
Copyright (c) 2016 by Daniel Eichhorn
|
|
||||||
Copyright (c) 2016 by Fabrice Weinberg
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
-->
|
|
||||||
<!--
|
|
||||||
Standalone page to draw icons in matrix and generates the map definition with the format required by
|
|
||||||
library for OLED SD1306 screen: https://github.com/squix78/esp8266-oled-ssd1306
|
|
||||||
100% quick and dirty vanilla ECS6, no framework or library was injured for this project.
|
|
||||||
|
|
||||||
-->
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<style>
|
|
||||||
#form, #chars table {
|
|
||||||
user-select: none;
|
|
||||||
-moz-user-select: none;
|
|
||||||
margin-top: 5px;
|
|
||||||
}
|
|
||||||
#chars table, tr, td, th {
|
|
||||||
border-collapse: collapse;
|
|
||||||
}
|
|
||||||
#chars td, th {
|
|
||||||
border: 1px solid #CCC;
|
|
||||||
width: 12px;
|
|
||||||
height: 15px;
|
|
||||||
}
|
|
||||||
#chars th[action] {
|
|
||||||
cursor:pointer;
|
|
||||||
}
|
|
||||||
#chars th[action="up"], #chars th[action="down"], #chars th[action="left"], #chars th[action="right"] {
|
|
||||||
font-size: 10px;
|
|
||||||
}
|
|
||||||
#chars td.on {
|
|
||||||
background-color: #00F;
|
|
||||||
}
|
|
||||||
|
|
||||||
#addChar, #generate {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
body.started #addChar, body.started #generate {
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
body.started #create {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
#page {
|
|
||||||
position:relative;
|
|
||||||
}
|
|
||||||
#page>div {
|
|
||||||
position: relative;
|
|
||||||
float: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
#output {
|
|
||||||
margin-left: 20px;
|
|
||||||
margin-top: 12px;
|
|
||||||
font-size:12px;
|
|
||||||
user-select: all;
|
|
||||||
-moz-user-select: all;
|
|
||||||
max-width:60%;
|
|
||||||
}
|
|
||||||
|
|
||||||
#header {
|
|
||||||
margin-top: 10px;
|
|
||||||
}
|
|
||||||
#inputText {
|
|
||||||
width: 100%;
|
|
||||||
height:120px;
|
|
||||||
}
|
|
||||||
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div id="form">
|
|
||||||
<table width="100%">
|
|
||||||
<tr>
|
|
||||||
<td>Font array name:</td><td><input placeholder="Font array name" type="text" id="name" value="My_Font"/></td>
|
|
||||||
<td width="75%" rowspan="5">
|
|
||||||
<textarea id="inputText" placeholder="Or paste a char array font definition here">
|
|
||||||
const char My_Font[] PROGMEM = {
|
|
||||||
0x0A, // Width: 10
|
|
||||||
0x0D, // Height: 13
|
|
||||||
0x01, // First char: 1
|
|
||||||
0x02, // Number of chars: 2
|
|
||||||
// Jump Table:
|
|
||||||
0x00, 0x00, 0x13, 0x0A, // 1
|
|
||||||
0x00, 0x13, 0x14, 0x0A, // 2
|
|
||||||
// Font Data:
|
|
||||||
0xF0, 0x03, 0x10, 0x02, 0xF0, 0x03, 0x10, 0x02, 0xF0, 0x03, 0x10, 0x02, 0xF0, 0x03, 0x10, 0x02, 0xF0, 0x03, 0xC0, // 1
|
|
||||||
0x00, 0x0C, 0x80, 0x0B, 0x70, 0x08, 0x0C, 0x08, 0xF3, 0x0A, 0xF3, 0x0A, 0x0C, 0x08, 0x70, 0x08, 0x80, 0x0B, 0x00, 0x0C, // 2
|
|
||||||
};
|
|
||||||
</textarea></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>First char code:</td><td><input placeholder="First char code" type="number" id="code" value="1" min="1"/></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Width:</td><td><input placeholder="Font width" type="number" id="width" value="10"/></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td>Height:</td><td><input placeholder="Font height" type="number" id="height" value="13" max="64"/></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td colspan="3"> </td> <!--slightly improves layout-->
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td colspan="2"><button id="create">Create</button> <button id="generate">Generate</button> <button id="savetoFile">Save To File</button> </td>
|
|
||||||
<td><input type="file" id="fileinput" /> <button id="parse">Parse</button></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
<br/>
|
|
||||||
</div>
|
|
||||||
<div id="page">
|
|
||||||
<div id="charxContainer" ondragstart="return false;">
|
|
||||||
<div id="chars"></div><br/>
|
|
||||||
<button id="addChar">Add a character</button>
|
|
||||||
</div>
|
|
||||||
<div id="output">
|
|
||||||
<div class="output" id="header"> </div>
|
|
||||||
<div class="output" id="jump"> </div>
|
|
||||||
<div class="output" id="data"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<script>
|
|
||||||
(function() {
|
|
||||||
let font;
|
|
||||||
|
|
||||||
class Font {
|
|
||||||
constructor() {
|
|
||||||
this.height = parseInt(document.getElementById('height').value);
|
|
||||||
this.width = parseInt(document.getElementById('width').value);
|
|
||||||
this.currentCharCode = parseInt(document.getElementById('code').value);
|
|
||||||
this.fontContainer = document.getElementById('chars');
|
|
||||||
this.bytesForHeight = (1 + ((this.height - 1) >> 3)); // number of bytes needed for this font height
|
|
||||||
document.body.className = "started";
|
|
||||||
document.getElementById('height').disabled = true;
|
|
||||||
document.getElementById('width').disabled = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Should we have a Char and a Pixel class ? not sure it's worth it.
|
|
||||||
// Let's use the DOM to store everything for now
|
|
||||||
|
|
||||||
static updateCaption(element, code) {
|
|
||||||
element.textContent = `Char #${code}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add a pixel matrix to draw a new character
|
|
||||||
// jumpaData not used for now: some day, use the last byte for optimisation
|
|
||||||
addChar(jumpData, charData) {
|
|
||||||
let charContainer = this.fontContainer.appendChild(document.createElement("table"));
|
|
||||||
charContainer.setAttribute("code", this.currentCharCode);
|
|
||||||
let caption = charContainer.appendChild(document.createElement("caption"));
|
|
||||||
Font.updateCaption(caption, this.currentCharCode);
|
|
||||||
let header = charContainer.appendChild(document.createElement("tr"));
|
|
||||||
header.innerHTML = '<th title="Delete this char" action="delete">✗</th>'
|
|
||||||
+ '<th title="Add a char above" action="add">+</th>'
|
|
||||||
+ '<th title="Shift pixels to the left" action="left">←</th>'
|
|
||||||
+ '<th title="Shift pixels down" action="down">↓</th>'
|
|
||||||
+ '<th title="Shift pixels up" action="up">↑</th>'
|
|
||||||
+ '<th title="Shift pixels to the right" action="right">→</th>'
|
|
||||||
+ '<th title="Copy from another character" action="copy">©</th>'
|
|
||||||
+ '<th title="Reset all pixels" action="clean">∅</th>';
|
|
||||||
// If data is provided, decode it to pixel initialization friendly structure
|
|
||||||
let pixelInit = [];
|
|
||||||
if (charData && charData.length) {
|
|
||||||
// charData byte count needs to be a multiple of bytesForHeight. End bytes with value 0 may have been trimmed
|
|
||||||
let missingBytes = charData.length % this.bytesForHeight;
|
|
||||||
for(let b = 0; b < missingBytes ; b++) {
|
|
||||||
charData.push(0);
|
|
||||||
}
|
|
||||||
while(charData.length) {
|
|
||||||
let row = charData.splice(0, this.bytesForHeight).reverse();
|
|
||||||
let pixelRow = [];
|
|
||||||
for (let b = 0; b < row.length; b++) {
|
|
||||||
let mask = 0x80;
|
|
||||||
let byte = row[b];
|
|
||||||
for (let bit = 0; bit < 8; bit++) {
|
|
||||||
if (byte & mask) {
|
|
||||||
pixelRow.push(1);
|
|
||||||
} else {
|
|
||||||
pixelRow.push(0);
|
|
||||||
}
|
|
||||||
mask = mask >> 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
pixelRow.splice(0, pixelRow.length - this.height);
|
|
||||||
//Font.output('data', pixelRow);
|
|
||||||
pixelInit.push(pixelRow.reverse());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for(let r = 0; r < this.height; r++) {
|
|
||||||
let rowContainer = charContainer.appendChild(document.createElement("tr"));
|
|
||||||
for(let c = 0; c < this.width; c++) {
|
|
||||||
let pixContainer = rowContainer.appendChild(document.createElement("td"));
|
|
||||||
pixContainer.setAttribute('action', 'toggle');
|
|
||||||
// If there is some init data, set the pixel accordingly
|
|
||||||
if (pixelInit.length && pixelInit[c]) {
|
|
||||||
if (pixelInit[c][r]) {
|
|
||||||
pixContainer.className = 'on';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
this.currentCharCode++;
|
|
||||||
return charContainer;
|
|
||||||
}
|
|
||||||
|
|
||||||
static togglePixel(pixel) {
|
|
||||||
pixel.className = pixel.className === 'on' ? '': 'on';
|
|
||||||
}
|
|
||||||
|
|
||||||
// Return anInt as hex string
|
|
||||||
static toHexString(aByte) {
|
|
||||||
let zero = aByte < 16?'0':'';
|
|
||||||
return `0x${zero}${aByte.toString(16).toUpperCase()}`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Return least significant byte as hex string
|
|
||||||
static getLsB(anInt) {
|
|
||||||
return Font.toHexString(anInt & 0xFF);
|
|
||||||
}
|
|
||||||
// Return most significant byte as hex string
|
|
||||||
static getMsB(anInt) {
|
|
||||||
return Font.toHexString(anInt>>>8);
|
|
||||||
}
|
|
||||||
|
|
||||||
static output(targetId, msg) {
|
|
||||||
let output = document.getElementById(targetId);
|
|
||||||
let line = output.appendChild(document.createElement('div'));
|
|
||||||
line.textContent = msg;
|
|
||||||
}
|
|
||||||
static emptyChars() {
|
|
||||||
document.getElementById('chars').textContent = '';
|
|
||||||
}
|
|
||||||
static emptyOutput() {
|
|
||||||
document.getElementById('header').textContent = '';
|
|
||||||
document.getElementById('jump').textContent = '';
|
|
||||||
document.getElementById('data').textContent = '';
|
|
||||||
}
|
|
||||||
|
|
||||||
saveFile() {
|
|
||||||
let filename = document.getElementById('name').value.replace(/[^a-zA-Z0-9_$]/g, '_') + ".h";
|
|
||||||
let data = document.getElementById("output").innerText;
|
|
||||||
if(data.length < 10) return;
|
|
||||||
let blobObject = new Blob([data], {type:'text/plain'});
|
|
||||||
|
|
||||||
if(window.navigator.msSaveBlob) {
|
|
||||||
window.navigator.msSaveBlob(blobObject, filename);
|
|
||||||
} else {
|
|
||||||
let a = document.createElement("a");
|
|
||||||
a.setAttribute("href", URL.createObjectURL(blobObject));
|
|
||||||
a.setAttribute("download", filename);
|
|
||||||
if (document.createEvent) {
|
|
||||||
let event = document.createEvent('MouseEvents');
|
|
||||||
event.initEvent('click', true, true);
|
|
||||||
a.dispatchEvent(event);
|
|
||||||
} else {
|
|
||||||
a.click();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read from the <td> css class the pixels that need to be on
|
|
||||||
// generates the jump table and font data
|
|
||||||
generate() {
|
|
||||||
Font.emptyOutput();
|
|
||||||
let chars = this.fontContainer.getElementsByTagName('table');
|
|
||||||
let firstCharCode = parseInt(document.getElementById('code').value);
|
|
||||||
let name = document.getElementById('name').value.replace(/[^a-zA-Z0-9_$]/g, '_');
|
|
||||||
|
|
||||||
let bits2add = this.bytesForHeight*8 - this.height; // number of missing bits to fill leftmost byte
|
|
||||||
let charCount = chars.length;
|
|
||||||
let charAddr = 0;
|
|
||||||
// Comments are used when parsing back a generated font
|
|
||||||
Font.output('jump', ' // Jump Table:');
|
|
||||||
Font.output('data', ' // Font Data:');
|
|
||||||
// Browse each character
|
|
||||||
for(let ch = 0; ch < charCount; ch++) {
|
|
||||||
// Fix renumbering in case first char code was modified
|
|
||||||
Font.updateCaption(chars[ch].getElementsByTagName('caption')[0], ch + firstCharCode);
|
|
||||||
let charBytes = [];
|
|
||||||
let charCode = ch + firstCharCode;
|
|
||||||
let rows = chars[ch].getElementsByTagName('tr');
|
|
||||||
let notZero = false;
|
|
||||||
// Browse each column
|
|
||||||
for(let col = 0; col < this.width ; col++) {
|
|
||||||
let bits = ""; // using string because js uses 32b ints when performing bit operations
|
|
||||||
// Browse each row starting from the bottom one, going up, and accumulate pixels in
|
|
||||||
// a string: this rotates the glyph
|
|
||||||
// Beware, row 0 is table headers.
|
|
||||||
for(let r = rows.length-1; r >=1 ; r--) {
|
|
||||||
let pixelState = rows[r].children[col].className;
|
|
||||||
bits += (pixelState === 'on' ? '1': '0');
|
|
||||||
}
|
|
||||||
// Need to complete missing bits to have a sizeof byte multiple number of bits
|
|
||||||
for(let b = 0; b < bits2add; b++) {
|
|
||||||
bits = '0' + bits;
|
|
||||||
}
|
|
||||||
// Font.output('data', ` // ${bits}`); // Debugging help: rotated bitmap
|
|
||||||
|
|
||||||
// read bytes from the end
|
|
||||||
for(let b = bits.length - 1; b >= 7; b -= 8) {
|
|
||||||
//Font.output('data', ` // ${bits.substr(b-7, 8)}`); // Debugging help: rotated bitmap
|
|
||||||
let byte = parseInt(bits.substr(b-7, 8), 2);
|
|
||||||
if (byte !== 0) {
|
|
||||||
notZero = true;
|
|
||||||
}
|
|
||||||
charBytes.push(Font.toHexString(byte));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Remove bytes with value 0 at the end of the array.
|
|
||||||
while(parseInt(charBytes[charBytes.length-1]) === 0 && charBytes.length !== 1) {
|
|
||||||
charBytes.pop();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (notZero) {
|
|
||||||
Font.output('data', ` ${charBytes.join(', ')}, // ${charCode}`);
|
|
||||||
// TODO: last param width is not the best value. Need to compute the actual occupied width
|
|
||||||
Font.output('jump', ` ${Font.getMsB(charAddr)}, ${Font.getLsB(charAddr)}, ${Font.toHexString(charBytes.length)}, ${Font.toHexString(this.width)}, // ${charCode} `);
|
|
||||||
charAddr += charBytes.length;
|
|
||||||
} else {
|
|
||||||
Font.output('jump', ` 0xFF, 0xFF, 0x00, ${Font.toHexString(this.width)}, // ${charCode} `);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Font.output('data', '};');
|
|
||||||
|
|
||||||
Font.output('header', "// Font generated or edited with the glyphEditor");
|
|
||||||
Font.output('header', `const char ${name}[] PROGMEM = {`);
|
|
||||||
// Comments are used when parsing back a generated font
|
|
||||||
Font.output('header', ` ${Font.toHexString(this.width)}, // Width: ${this.width}`);
|
|
||||||
Font.output('header', ` ${Font.toHexString(this.height)}, // Height: ${this.height}`);
|
|
||||||
Font.output('header', ` ${Font.toHexString(firstCharCode)}, // First char: ${firstCharCode}`);
|
|
||||||
Font.output('header', ` ${Font.toHexString(charCount)}, // Number of chars: ${charCount}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
document.getElementById('fileinput').addEventListener('change', function(e) {
|
|
||||||
let f = e.target.files[0];
|
|
||||||
if (f) {
|
|
||||||
let r = new FileReader();
|
|
||||||
r.onload = function(e) {
|
|
||||||
let contents = e.target.result;
|
|
||||||
alert( "Got the file.\n"
|
|
||||||
+"name: " + f.name + "\n"
|
|
||||||
+"type: " + f.type + "\n"
|
|
||||||
+"size: " + f.size + " bytes\n"
|
|
||||||
+"starts with: " + contents.substr(0, contents.indexOf("\n"))
|
|
||||||
);
|
|
||||||
document.getElementById("inputText").value = contents;
|
|
||||||
};
|
|
||||||
r.readAsText(f);
|
|
||||||
} else {
|
|
||||||
alert("Failed to load file");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
document.getElementById('savetoFile').addEventListener('click', function() {
|
|
||||||
font.saveFile();
|
|
||||||
});
|
|
||||||
|
|
||||||
document.getElementById('generate').addEventListener('click', function() {
|
|
||||||
font.generate();
|
|
||||||
});
|
|
||||||
document.getElementById('addChar').addEventListener('click', function() {
|
|
||||||
font.addChar();
|
|
||||||
});
|
|
||||||
document.getElementById('inputText').addEventListener('click', function(e) {
|
|
||||||
let target = e.target;
|
|
||||||
target.select();
|
|
||||||
});
|
|
||||||
document.getElementById('chars').addEventListener('mousedown', function(e) {
|
|
||||||
if (e.button !== 0) return;
|
|
||||||
let target = e.target;
|
|
||||||
let action = target.getAttribute('action') || '';
|
|
||||||
if (action === '') return;
|
|
||||||
let result, code, nextContainer, previousContainer, pixels ;
|
|
||||||
let currentContainer = target.parentNode.parentNode;
|
|
||||||
switch(action) {
|
|
||||||
case 'add':
|
|
||||||
code = currentContainer.getAttribute('code');
|
|
||||||
nextContainer = font.addChar();
|
|
||||||
currentContainer.parentNode.insertBefore(nextContainer, currentContainer);
|
|
||||||
do {
|
|
||||||
nextContainer.setAttribute('code', code);
|
|
||||||
Font.updateCaption(nextContainer.getElementsByTagName('caption')[0], code);
|
|
||||||
code ++;
|
|
||||||
} while (nextContainer = nextContainer.nextSibling);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'delete':
|
|
||||||
result = confirm("Delete this character ?");
|
|
||||||
if (!result) return;
|
|
||||||
code = currentContainer.getAttribute('code');
|
|
||||||
nextContainer = currentContainer;
|
|
||||||
while (nextContainer = nextContainer.nextSibling) {
|
|
||||||
nextContainer.setAttribute('code', code);
|
|
||||||
Font.updateCaption(nextContainer.getElementsByTagName('caption')[0], code);
|
|
||||||
code ++;
|
|
||||||
}
|
|
||||||
currentContainer.parentNode.removeChild(currentContainer);
|
|
||||||
break;
|
|
||||||
|
|
||||||
// Shift pixels to the left
|
|
||||||
case 'left':
|
|
||||||
pixels = currentContainer.getElementsByTagName('td');
|
|
||||||
for(p = 0; p < pixels.length; p++) {
|
|
||||||
if((p + 1) % font.width) {
|
|
||||||
pixels[p].className = pixels[p + 1].className;
|
|
||||||
} else {
|
|
||||||
pixels[p].className = '';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
|
|
||||||
// Shift pixels to the right
|
|
||||||
case 'right':
|
|
||||||
pixels = currentContainer.getElementsByTagName('td');
|
|
||||||
for(p = pixels.length-1; p >=0 ; p--) {
|
|
||||||
if(p % font.width) {
|
|
||||||
pixels[p].className = pixels[p - 1].className;
|
|
||||||
} else {
|
|
||||||
pixels[p].className = '';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
|
|
||||||
// Shift pixels down
|
|
||||||
case 'down':
|
|
||||||
pixels = currentContainer.getElementsByTagName('td');
|
|
||||||
for(p = pixels.length-1; p >=0 ; p--) {
|
|
||||||
if(p >= font.width) {
|
|
||||||
pixels[p].className = pixels[p - font.width].className;
|
|
||||||
} else {
|
|
||||||
pixels[p].className = '';
|
|
||||||
}
|
|
||||||
} break;
|
|
||||||
|
|
||||||
// Shift pixels up
|
|
||||||
case 'up':
|
|
||||||
pixels = currentContainer.getElementsByTagName('td');
|
|
||||||
for(p = 0; p < pixels.length; p++) {
|
|
||||||
if(p < font.width*(font.height -1)) {
|
|
||||||
pixels[p].className = pixels[p + font.width].className;
|
|
||||||
} else {
|
|
||||||
pixels[p].className = '';
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'toggle':
|
|
||||||
Font.togglePixel(target);
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'clean':
|
|
||||||
result = confirm("Delete the pixels ?");
|
|
||||||
if (!result) return;
|
|
||||||
pixels = currentContainer.getElementsByTagName('td');
|
|
||||||
for (let p = 0; p < pixels.length; p++) {
|
|
||||||
pixels[p].className = '';
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
|
|
||||||
case 'copy':
|
|
||||||
let charNumber = parseInt(prompt("Source char #: "));
|
|
||||||
let chars = font.fontContainer.getElementsByTagName('table');
|
|
||||||
let tableOffset = charNumber - parseInt(document.getElementById('code').value);
|
|
||||||
let srcPixels = chars[tableOffset].getElementsByTagName('td');
|
|
||||||
let targetPixels = currentContainer.getElementsByTagName('td');
|
|
||||||
for(let i=0; i < srcPixels.length; i++) {
|
|
||||||
// First tds are in the th row, for editing actions. Skip them
|
|
||||||
if (targetPixels[i].parentNode.localName === 'th') continue; // In case we give them css at some point...
|
|
||||||
targetPixels[i].className = srcPixels[i].className;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
// no.
|
|
||||||
}
|
|
||||||
|
|
||||||
});
|
|
||||||
document.getElementById('chars').addEventListener('mouseover', function(e) {
|
|
||||||
let target = e.target;
|
|
||||||
let action = target.getAttribute('action');
|
|
||||||
if (action !== 'toggle' || e.buttons !== 1) return;
|
|
||||||
Font.togglePixel(target);
|
|
||||||
});
|
|
||||||
document.getElementById('chars').addEventListener('dragstart', function() {
|
|
||||||
return false;
|
|
||||||
});
|
|
||||||
|
|
||||||
document.getElementById('create').addEventListener('click', function() {
|
|
||||||
font = new Font();
|
|
||||||
font.addChar();
|
|
||||||
});
|
|
||||||
|
|
||||||
// parse a char array declaration for an existing font.
|
|
||||||
// parsing heavily relies on comments.
|
|
||||||
document.getElementById('parse').addEventListener('click', function() {
|
|
||||||
if (document.getElementById('chars').childElementCount) {
|
|
||||||
let result = confirm("Confirm you want to overwrite the existing grids ?");
|
|
||||||
if (!result) return;
|
|
||||||
}
|
|
||||||
let lines = document.getElementById('inputText').value.split('\n');
|
|
||||||
let name = '';
|
|
||||||
let height = 0;
|
|
||||||
let width = 0;
|
|
||||||
let firstCharCode = 0;
|
|
||||||
let jumpTable = [];
|
|
||||||
let charData = [];
|
|
||||||
let readingJumpTable = false;
|
|
||||||
let readingData = false;
|
|
||||||
|
|
||||||
for(let l = 0 ; l < lines.length; l++) {
|
|
||||||
// TODO ? keep C compilation directives to copy them (not lowercased :)) to newly generated char array
|
|
||||||
let line = lines[l].trim();
|
|
||||||
//alert(line);
|
|
||||||
let fields;
|
|
||||||
|
|
||||||
// Declaration line: grab the name
|
|
||||||
if (line.indexOf('PROGMEM') > 0) {
|
|
||||||
fields = line.split(' ');
|
|
||||||
name = fields[2].replace(/[\[\]]/g, '');
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
line = line.toLowerCase();
|
|
||||||
// Todo: could rely on line order...
|
|
||||||
// width line: grab the width
|
|
||||||
if (line.indexOf('width') > 0) {
|
|
||||||
fields = line.split(',');
|
|
||||||
width = fields[0];
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// height line: grab the height
|
|
||||||
if (line.indexOf('height') > 0) {
|
|
||||||
fields = line.split(',');
|
|
||||||
height = fields[0];
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// first char code line: grab the first char code
|
|
||||||
if (line.indexOf('first char') > 0) {
|
|
||||||
fields = line.split(',');
|
|
||||||
firstCharCode = fields[0];
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
// End of array declaration
|
|
||||||
// TODO warn if more lines: next fonts are ignored
|
|
||||||
if (line.indexOf('};') === 0) {
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (readingJumpTable || readingData) {
|
|
||||||
if (line.indexOf('#') !== 0 && line.length !== 0 && line.indexOf('//') !== 0) {
|
|
||||||
line = line.replace(/\/\/.*/, ''); // get rid of end of line comments
|
|
||||||
fields = line.split(',');
|
|
||||||
let newEntry = [];
|
|
||||||
for(let f=0; f < fields.length; f++) {
|
|
||||||
let value = parseInt(fields[f]);
|
|
||||||
if (isNaN(value)) continue;
|
|
||||||
if (readingData) {
|
|
||||||
charData.push(value);
|
|
||||||
}
|
|
||||||
if (readingJumpTable) {
|
|
||||||
newEntry.push(value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (readingJumpTable) {
|
|
||||||
jumpTable.push(newEntry);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Begining of data
|
|
||||||
if (line.indexOf('font data') > 0) {
|
|
||||||
readingData = true;
|
|
||||||
readingJumpTable = false;
|
|
||||||
}
|
|
||||||
// Begining of jump table
|
|
||||||
if (line.indexOf('jump table') > 0) {
|
|
||||||
readingJumpTable = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (!name || !height || !width || !firstCharCode) {
|
|
||||||
alert("Does not look like a parsable font. Try again.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
Font.emptyChars();
|
|
||||||
Font.emptyOutput();
|
|
||||||
document.getElementById('name').value = name;
|
|
||||||
document.getElementById('height').value = parseInt(height);
|
|
||||||
document.getElementById('width').value = parseInt(width);
|
|
||||||
document.getElementById('code').value = parseInt(firstCharCode);
|
|
||||||
font = new Font();
|
|
||||||
for(let c = 0 ; c < jumpTable.length; c++) {
|
|
||||||
let jumpEntry = jumpTable[c];
|
|
||||||
let charEntry = [];
|
|
||||||
// displayable character
|
|
||||||
if (jumpEntry[0] !== 255 || jumpEntry[1] !== 255) {
|
|
||||||
charEntry = charData.splice(0, jumpEntry[2]);
|
|
||||||
}
|
|
||||||
font.addChar(jumpEntry, charEntry);
|
|
||||||
}
|
|
||||||
document.body.className = "started";
|
|
||||||
});
|
|
||||||
|
|
||||||
})();
|
|
||||||
</script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 41 KiB |
|
|
@ -1,890 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
|
|
||||||
OLEDDisplay::~OLEDDisplay() {
|
|
||||||
end();
|
|
||||||
}
|
|
||||||
|
|
||||||
bool OLEDDisplay::init() {
|
|
||||||
if (!this->connect()) {
|
|
||||||
DEBUG_OLEDDISPLAY("[OLEDDISPLAY][init] Can't establish connection to display\n");
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(this->buffer==NULL) {
|
|
||||||
this->buffer = (uint8_t*) malloc(sizeof(uint8_t) * displayBufferSize);
|
|
||||||
|
|
||||||
if(!this->buffer) {
|
|
||||||
DEBUG_OLEDDISPLAY("[OLEDDISPLAY][init] Not enough memory to create display\n");
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
if(this->buffer_back==NULL) {
|
|
||||||
this->buffer_back = (uint8_t*) malloc(sizeof(uint8_t) * displayBufferSize);
|
|
||||||
|
|
||||||
if(!this->buffer_back) {
|
|
||||||
DEBUG_OLEDDISPLAY("[OLEDDISPLAY][init] Not enough memory to create back buffer\n");
|
|
||||||
free(this->buffer);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
sendInitCommands();
|
|
||||||
resetDisplay();
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::end() {
|
|
||||||
if (this->buffer) { free(this->buffer); this->buffer = NULL; }
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
if (this->buffer_back) { free(this->buffer_back); this->buffer_back = NULL; }
|
|
||||||
#endif
|
|
||||||
if (this->logBuffer != NULL) { free(this->logBuffer); this->logBuffer = NULL; }
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::resetDisplay(void) {
|
|
||||||
clear();
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
memset(buffer_back, 1, displayBufferSize);
|
|
||||||
#endif
|
|
||||||
display();
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setColor(OLEDDISPLAY_COLOR color) {
|
|
||||||
this->color = color;
|
|
||||||
}
|
|
||||||
|
|
||||||
OLEDDISPLAY_COLOR OLEDDisplay::getColor() {
|
|
||||||
return this->color;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setPixel(int16_t x, int16_t y) {
|
|
||||||
if (x >= 0 && x < this->width() && y >= 0 && y < this->height()) {
|
|
||||||
switch (color) {
|
|
||||||
case WHITE: buffer[x + (y / 8) * this->width()] |= (1 << (y & 7)); break;
|
|
||||||
case BLACK: buffer[x + (y / 8) * this->width()] &= ~(1 << (y & 7)); break;
|
|
||||||
case INVERSE: buffer[x + (y / 8) * this->width()] ^= (1 << (y & 7)); break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Bresenham's algorithm - thx wikipedia and Adafruit_GFX
|
|
||||||
void OLEDDisplay::drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1) {
|
|
||||||
int16_t steep = abs(y1 - y0) > abs(x1 - x0);
|
|
||||||
if (steep) {
|
|
||||||
_swap_int16_t(x0, y0);
|
|
||||||
_swap_int16_t(x1, y1);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (x0 > x1) {
|
|
||||||
_swap_int16_t(x0, x1);
|
|
||||||
_swap_int16_t(y0, y1);
|
|
||||||
}
|
|
||||||
|
|
||||||
int16_t dx, dy;
|
|
||||||
dx = x1 - x0;
|
|
||||||
dy = abs(y1 - y0);
|
|
||||||
|
|
||||||
int16_t err = dx / 2;
|
|
||||||
int16_t ystep;
|
|
||||||
|
|
||||||
if (y0 < y1) {
|
|
||||||
ystep = 1;
|
|
||||||
} else {
|
|
||||||
ystep = -1;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (; x0<=x1; x0++) {
|
|
||||||
if (steep) {
|
|
||||||
setPixel(y0, x0);
|
|
||||||
} else {
|
|
||||||
setPixel(x0, y0);
|
|
||||||
}
|
|
||||||
err -= dy;
|
|
||||||
if (err < 0) {
|
|
||||||
y0 += ystep;
|
|
||||||
err += dx;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawRect(int16_t x, int16_t y, int16_t width, int16_t height) {
|
|
||||||
drawHorizontalLine(x, y, width);
|
|
||||||
drawVerticalLine(x, y, height);
|
|
||||||
drawVerticalLine(x + width - 1, y, height);
|
|
||||||
drawHorizontalLine(x, y + height - 1, width);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::fillRect(int16_t xMove, int16_t yMove, int16_t width, int16_t height) {
|
|
||||||
for (int16_t x = xMove; x < xMove + width; x++) {
|
|
||||||
drawVerticalLine(x, yMove, height);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawCircle(int16_t x0, int16_t y0, int16_t radius) {
|
|
||||||
int16_t x = 0, y = radius;
|
|
||||||
int16_t dp = 1 - radius;
|
|
||||||
do {
|
|
||||||
if (dp < 0)
|
|
||||||
dp = dp + 2 * (++x) + 3;
|
|
||||||
else
|
|
||||||
dp = dp + 2 * (++x) - 2 * (--y) + 5;
|
|
||||||
|
|
||||||
setPixel(x0 + x, y0 + y); //For the 8 octants
|
|
||||||
setPixel(x0 - x, y0 + y);
|
|
||||||
setPixel(x0 + x, y0 - y);
|
|
||||||
setPixel(x0 - x, y0 - y);
|
|
||||||
setPixel(x0 + y, y0 + x);
|
|
||||||
setPixel(x0 - y, y0 + x);
|
|
||||||
setPixel(x0 + y, y0 - x);
|
|
||||||
setPixel(x0 - y, y0 - x);
|
|
||||||
|
|
||||||
} while (x < y);
|
|
||||||
|
|
||||||
setPixel(x0 + radius, y0);
|
|
||||||
setPixel(x0, y0 + radius);
|
|
||||||
setPixel(x0 - radius, y0);
|
|
||||||
setPixel(x0, y0 - radius);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawCircleQuads(int16_t x0, int16_t y0, int16_t radius, uint8_t quads) {
|
|
||||||
int16_t x = 0, y = radius;
|
|
||||||
int16_t dp = 1 - radius;
|
|
||||||
while (x < y) {
|
|
||||||
if (dp < 0)
|
|
||||||
dp = dp + 2 * (++x) + 3;
|
|
||||||
else
|
|
||||||
dp = dp + 2 * (++x) - 2 * (--y) + 5;
|
|
||||||
if (quads & 0x1) {
|
|
||||||
setPixel(x0 + x, y0 - y);
|
|
||||||
setPixel(x0 + y, y0 - x);
|
|
||||||
}
|
|
||||||
if (quads & 0x2) {
|
|
||||||
setPixel(x0 - y, y0 - x);
|
|
||||||
setPixel(x0 - x, y0 - y);
|
|
||||||
}
|
|
||||||
if (quads & 0x4) {
|
|
||||||
setPixel(x0 - y, y0 + x);
|
|
||||||
setPixel(x0 - x, y0 + y);
|
|
||||||
}
|
|
||||||
if (quads & 0x8) {
|
|
||||||
setPixel(x0 + x, y0 + y);
|
|
||||||
setPixel(x0 + y, y0 + x);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (quads & 0x1 && quads & 0x8) {
|
|
||||||
setPixel(x0 + radius, y0);
|
|
||||||
}
|
|
||||||
if (quads & 0x4 && quads & 0x8) {
|
|
||||||
setPixel(x0, y0 + radius);
|
|
||||||
}
|
|
||||||
if (quads & 0x2 && quads & 0x4) {
|
|
||||||
setPixel(x0 - radius, y0);
|
|
||||||
}
|
|
||||||
if (quads & 0x1 && quads & 0x2) {
|
|
||||||
setPixel(x0, y0 - radius);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void OLEDDisplay::fillCircle(int16_t x0, int16_t y0, int16_t radius) {
|
|
||||||
int16_t x = 0, y = radius;
|
|
||||||
int16_t dp = 1 - radius;
|
|
||||||
do {
|
|
||||||
if (dp < 0)
|
|
||||||
dp = dp + 2 * (++x) + 3;
|
|
||||||
else
|
|
||||||
dp = dp + 2 * (++x) - 2 * (--y) + 5;
|
|
||||||
|
|
||||||
drawHorizontalLine(x0 - x, y0 - y, 2*x);
|
|
||||||
drawHorizontalLine(x0 - x, y0 + y, 2*x);
|
|
||||||
drawHorizontalLine(x0 - y, y0 - x, 2*y);
|
|
||||||
drawHorizontalLine(x0 - y, y0 + x, 2*y);
|
|
||||||
|
|
||||||
|
|
||||||
} while (x < y);
|
|
||||||
drawHorizontalLine(x0 - radius, y0, 2 * radius);
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawHorizontalLine(int16_t x, int16_t y, int16_t length) {
|
|
||||||
if (y < 0 || y >= this->height()) { return; }
|
|
||||||
|
|
||||||
if (x < 0) {
|
|
||||||
length += x;
|
|
||||||
x = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ( (x + length) > this->width()) {
|
|
||||||
length = (this->width() - x);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (length <= 0) { return; }
|
|
||||||
|
|
||||||
uint8_t * bufferPtr = buffer;
|
|
||||||
bufferPtr += (y >> 3) * this->width();
|
|
||||||
bufferPtr += x;
|
|
||||||
|
|
||||||
uint8_t drawBit = 1 << (y & 7);
|
|
||||||
|
|
||||||
switch (color) {
|
|
||||||
case WHITE: while (length--) {
|
|
||||||
*bufferPtr++ |= drawBit;
|
|
||||||
}; break;
|
|
||||||
case BLACK: drawBit = ~drawBit; while (length--) {
|
|
||||||
*bufferPtr++ &= drawBit;
|
|
||||||
}; break;
|
|
||||||
case INVERSE: while (length--) {
|
|
||||||
*bufferPtr++ ^= drawBit;
|
|
||||||
}; break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawVerticalLine(int16_t x, int16_t y, int16_t length) {
|
|
||||||
if (x < 0 || x >= this->width()) return;
|
|
||||||
|
|
||||||
if (y < 0) {
|
|
||||||
length += y;
|
|
||||||
y = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ( (y + length) > this->height()) {
|
|
||||||
length = (this->height() - y);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (length <= 0) return;
|
|
||||||
|
|
||||||
|
|
||||||
uint8_t yOffset = y & 7;
|
|
||||||
uint8_t drawBit;
|
|
||||||
uint8_t *bufferPtr = buffer;
|
|
||||||
|
|
||||||
bufferPtr += (y >> 3) * this->width();
|
|
||||||
bufferPtr += x;
|
|
||||||
|
|
||||||
if (yOffset) {
|
|
||||||
yOffset = 8 - yOffset;
|
|
||||||
drawBit = ~(0xFF >> (yOffset));
|
|
||||||
|
|
||||||
if (length < yOffset) {
|
|
||||||
drawBit &= (0xFF >> (yOffset - length));
|
|
||||||
}
|
|
||||||
|
|
||||||
switch (color) {
|
|
||||||
case WHITE: *bufferPtr |= drawBit; break;
|
|
||||||
case BLACK: *bufferPtr &= ~drawBit; break;
|
|
||||||
case INVERSE: *bufferPtr ^= drawBit; break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (length < yOffset) return;
|
|
||||||
|
|
||||||
length -= yOffset;
|
|
||||||
bufferPtr += this->width();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (length >= 8) {
|
|
||||||
switch (color) {
|
|
||||||
case WHITE:
|
|
||||||
case BLACK:
|
|
||||||
drawBit = (color == WHITE) ? 0xFF : 0x00;
|
|
||||||
do {
|
|
||||||
*bufferPtr = drawBit;
|
|
||||||
bufferPtr += this->width();
|
|
||||||
length -= 8;
|
|
||||||
} while (length >= 8);
|
|
||||||
break;
|
|
||||||
case INVERSE:
|
|
||||||
do {
|
|
||||||
*bufferPtr = ~(*bufferPtr);
|
|
||||||
bufferPtr += this->width();
|
|
||||||
length -= 8;
|
|
||||||
} while (length >= 8);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (length > 0) {
|
|
||||||
drawBit = (1 << (length & 7)) - 1;
|
|
||||||
switch (color) {
|
|
||||||
case WHITE: *bufferPtr |= drawBit; break;
|
|
||||||
case BLACK: *bufferPtr &= ~drawBit; break;
|
|
||||||
case INVERSE: *bufferPtr ^= drawBit; break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawProgressBar(uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t progress) {
|
|
||||||
uint16_t radius = height / 2;
|
|
||||||
uint16_t xRadius = x + radius;
|
|
||||||
uint16_t yRadius = y + radius;
|
|
||||||
uint16_t doubleRadius = 2 * radius;
|
|
||||||
uint16_t innerRadius = radius - 2;
|
|
||||||
|
|
||||||
setColor(WHITE);
|
|
||||||
drawCircleQuads(xRadius, yRadius, radius, 0b00000110);
|
|
||||||
drawHorizontalLine(xRadius, y, width - doubleRadius + 1);
|
|
||||||
drawHorizontalLine(xRadius, y + height, width - doubleRadius + 1);
|
|
||||||
drawCircleQuads(x + width - radius, yRadius, radius, 0b00001001);
|
|
||||||
|
|
||||||
uint16_t maxProgressWidth = (width - doubleRadius + 1) * progress / 100;
|
|
||||||
|
|
||||||
fillCircle(xRadius, yRadius, innerRadius);
|
|
||||||
fillRect(xRadius + 1, y + 2, maxProgressWidth, height - 3);
|
|
||||||
fillCircle(xRadius + maxProgressWidth, yRadius, innerRadius);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawFastImage(int16_t xMove, int16_t yMove, int16_t width, int16_t height, const uint8_t *image) {
|
|
||||||
drawInternal(xMove, yMove, width, height, image, 0, 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawXbm(int16_t xMove, int16_t yMove, int16_t width, int16_t height, const uint8_t *xbm) {
|
|
||||||
int16_t widthInXbm = (width + 7) / 8;
|
|
||||||
uint8_t data = 0;
|
|
||||||
|
|
||||||
for(int16_t y = 0; y < height; y++) {
|
|
||||||
for(int16_t x = 0; x < width; x++ ) {
|
|
||||||
if (x & 7) {
|
|
||||||
data >>= 1; // Move a bit
|
|
||||||
} else { // Read new data every 8 bit
|
|
||||||
data = pgm_read_byte(xbm + (x / 8) + y * widthInXbm);
|
|
||||||
}
|
|
||||||
// if there is a bit draw it
|
|
||||||
if (data & 0x01) {
|
|
||||||
setPixel(xMove + x, yMove + y);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawStringInternal(int16_t xMove, int16_t yMove, char* text, uint16_t textLength, uint16_t textWidth) {
|
|
||||||
uint8_t textHeight = pgm_read_byte(fontData + HEIGHT_POS);
|
|
||||||
uint8_t firstChar = pgm_read_byte(fontData + FIRST_CHAR_POS);
|
|
||||||
uint16_t sizeOfJumpTable = pgm_read_byte(fontData + CHAR_NUM_POS) * JUMPTABLE_BYTES;
|
|
||||||
|
|
||||||
uint8_t cursorX = 0;
|
|
||||||
uint8_t cursorY = 0;
|
|
||||||
|
|
||||||
switch (textAlignment) {
|
|
||||||
case TEXT_ALIGN_CENTER_BOTH:
|
|
||||||
yMove -= textHeight >> 1;
|
|
||||||
// Fallthrough
|
|
||||||
case TEXT_ALIGN_CENTER:
|
|
||||||
xMove -= textWidth >> 1; // divide by 2
|
|
||||||
break;
|
|
||||||
case TEXT_ALIGN_RIGHT:
|
|
||||||
xMove -= textWidth;
|
|
||||||
break;
|
|
||||||
case TEXT_ALIGN_LEFT:
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Don't draw anything if it is not on the screen.
|
|
||||||
if (xMove + textWidth < 0 || xMove > this->width() ) {return;}
|
|
||||||
if (yMove + textHeight < 0 || yMove > this->width() ) {return;}
|
|
||||||
|
|
||||||
for (uint16_t j = 0; j < textLength; j++) {
|
|
||||||
int16_t xPos = xMove + cursorX;
|
|
||||||
int16_t yPos = yMove + cursorY;
|
|
||||||
|
|
||||||
byte code = text[j];
|
|
||||||
if (code >= firstChar) {
|
|
||||||
byte charCode = code - firstChar;
|
|
||||||
|
|
||||||
// 4 Bytes per char code
|
|
||||||
byte msbJumpToChar = pgm_read_byte( fontData + JUMPTABLE_START + charCode * JUMPTABLE_BYTES ); // MSB \ JumpAddress
|
|
||||||
byte lsbJumpToChar = pgm_read_byte( fontData + JUMPTABLE_START + charCode * JUMPTABLE_BYTES + JUMPTABLE_LSB); // LSB /
|
|
||||||
byte charByteSize = pgm_read_byte( fontData + JUMPTABLE_START + charCode * JUMPTABLE_BYTES + JUMPTABLE_SIZE); // Size
|
|
||||||
byte currentCharWidth = pgm_read_byte( fontData + JUMPTABLE_START + charCode * JUMPTABLE_BYTES + JUMPTABLE_WIDTH); // Width
|
|
||||||
|
|
||||||
// Test if the char is drawable
|
|
||||||
if (!(msbJumpToChar == 255 && lsbJumpToChar == 255)) {
|
|
||||||
// Get the position of the char data
|
|
||||||
uint16_t charDataPosition = JUMPTABLE_START + sizeOfJumpTable + ((msbJumpToChar << 8) + lsbJumpToChar);
|
|
||||||
drawInternal(xPos, yPos, currentCharWidth, textHeight, fontData, charDataPosition, charByteSize);
|
|
||||||
}
|
|
||||||
|
|
||||||
cursorX += currentCharWidth;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void OLEDDisplay::drawString(int16_t xMove, int16_t yMove, String strUser) {
|
|
||||||
uint16_t lineHeight = pgm_read_byte(fontData + HEIGHT_POS);
|
|
||||||
|
|
||||||
// char* text must be freed!
|
|
||||||
char* text = utf8ascii(strUser);
|
|
||||||
|
|
||||||
uint16_t yOffset = 0;
|
|
||||||
// If the string should be centered vertically too
|
|
||||||
// we need to now how heigh the string is.
|
|
||||||
if (textAlignment == TEXT_ALIGN_CENTER_BOTH) {
|
|
||||||
uint16_t lb = 0;
|
|
||||||
// Find number of linebreaks in text
|
|
||||||
for (uint16_t i=0;text[i] != 0; i++) {
|
|
||||||
lb += (text[i] == 10);
|
|
||||||
}
|
|
||||||
// Calculate center
|
|
||||||
yOffset = (lb * lineHeight) / 2;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t line = 0;
|
|
||||||
char* textPart = strtok(text,"\n");
|
|
||||||
while (textPart != NULL) {
|
|
||||||
uint16_t length = strlen(textPart);
|
|
||||||
drawStringInternal(xMove, yMove - yOffset + (line++) * lineHeight, textPart, length, getStringWidth(textPart, length));
|
|
||||||
textPart = strtok(NULL, "\n");
|
|
||||||
}
|
|
||||||
free(text);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawStringMaxWidth(int16_t xMove, int16_t yMove, uint16_t maxLineWidth, String strUser) {
|
|
||||||
uint16_t firstChar = pgm_read_byte(fontData + FIRST_CHAR_POS);
|
|
||||||
uint16_t lineHeight = pgm_read_byte(fontData + HEIGHT_POS);
|
|
||||||
|
|
||||||
char* text = utf8ascii(strUser);
|
|
||||||
|
|
||||||
uint16_t length = strlen(text);
|
|
||||||
uint16_t lastDrawnPos = 0;
|
|
||||||
uint16_t lineNumber = 0;
|
|
||||||
uint16_t strWidth = 0;
|
|
||||||
|
|
||||||
uint16_t preferredBreakpoint = 0;
|
|
||||||
uint16_t widthAtBreakpoint = 0;
|
|
||||||
|
|
||||||
for (uint16_t i = 0; i < length; i++) {
|
|
||||||
strWidth += pgm_read_byte(fontData + JUMPTABLE_START + (text[i] - firstChar) * JUMPTABLE_BYTES + JUMPTABLE_WIDTH);
|
|
||||||
|
|
||||||
// Always try to break on a space or dash
|
|
||||||
if (text[i] == ' ' || text[i]== '-') {
|
|
||||||
preferredBreakpoint = i;
|
|
||||||
widthAtBreakpoint = strWidth;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (strWidth >= maxLineWidth) {
|
|
||||||
if (preferredBreakpoint == 0) {
|
|
||||||
preferredBreakpoint = i;
|
|
||||||
widthAtBreakpoint = strWidth;
|
|
||||||
}
|
|
||||||
drawStringInternal(xMove, yMove + (lineNumber++) * lineHeight , &text[lastDrawnPos], preferredBreakpoint - lastDrawnPos, widthAtBreakpoint);
|
|
||||||
lastDrawnPos = preferredBreakpoint + 1;
|
|
||||||
// It is possible that we did not draw all letters to i so we need
|
|
||||||
// to account for the width of the chars from `i - preferredBreakpoint`
|
|
||||||
// by calculating the width we did not draw yet.
|
|
||||||
strWidth = strWidth - widthAtBreakpoint;
|
|
||||||
preferredBreakpoint = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Draw last part if needed
|
|
||||||
if (lastDrawnPos < length) {
|
|
||||||
drawStringInternal(xMove, yMove + lineNumber * lineHeight , &text[lastDrawnPos], length - lastDrawnPos, getStringWidth(&text[lastDrawnPos], length - lastDrawnPos));
|
|
||||||
}
|
|
||||||
|
|
||||||
free(text);
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t OLEDDisplay::getStringWidth(const char* text, uint16_t length) {
|
|
||||||
uint16_t firstChar = pgm_read_byte(fontData + FIRST_CHAR_POS);
|
|
||||||
|
|
||||||
uint16_t stringWidth = 0;
|
|
||||||
uint16_t maxWidth = 0;
|
|
||||||
|
|
||||||
while (length--) {
|
|
||||||
stringWidth += pgm_read_byte(fontData + JUMPTABLE_START + (text[length] - firstChar) * JUMPTABLE_BYTES + JUMPTABLE_WIDTH);
|
|
||||||
if (text[length] == 10) {
|
|
||||||
maxWidth = max(maxWidth, stringWidth);
|
|
||||||
stringWidth = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return max(maxWidth, stringWidth);
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t OLEDDisplay::getStringWidth(String strUser) {
|
|
||||||
char* text = utf8ascii(strUser);
|
|
||||||
uint16_t length = strlen(text);
|
|
||||||
uint16_t width = getStringWidth(text, length);
|
|
||||||
free(text);
|
|
||||||
return width;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setTextAlignment(OLEDDISPLAY_TEXT_ALIGNMENT textAlignment) {
|
|
||||||
this->textAlignment = textAlignment;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setFont(const uint8_t *fontData) {
|
|
||||||
this->fontData = fontData;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::displayOn(void) {
|
|
||||||
sendCommand(DISPLAYON);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::displayOff(void) {
|
|
||||||
sendCommand(DISPLAYOFF);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::invertDisplay(void) {
|
|
||||||
sendCommand(INVERTDISPLAY);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::normalDisplay(void) {
|
|
||||||
sendCommand(NORMALDISPLAY);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setContrast(uint8_t contrast, uint8_t precharge, uint8_t comdetect) {
|
|
||||||
sendCommand(SETPRECHARGE); //0xD9
|
|
||||||
sendCommand(precharge); //0xF1 default, to lower the contrast, put 1-1F
|
|
||||||
sendCommand(SETCONTRAST);
|
|
||||||
sendCommand(contrast); // 0-255
|
|
||||||
sendCommand(SETVCOMDETECT); //0xDB, (additionally needed to lower the contrast)
|
|
||||||
sendCommand(comdetect); //0x40 default, to lower the contrast, put 0
|
|
||||||
sendCommand(DISPLAYALLON_RESUME);
|
|
||||||
sendCommand(NORMALDISPLAY);
|
|
||||||
sendCommand(DISPLAYON);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setBrightness(uint8_t brightness) {
|
|
||||||
uint8_t contrast = brightness;
|
|
||||||
if (brightness < 128) {
|
|
||||||
// Magic values to get a smooth/ step-free transition
|
|
||||||
contrast = brightness * 1.171;
|
|
||||||
} else {
|
|
||||||
contrast = brightness * 1.171 - 43;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t precharge = 241;
|
|
||||||
if (brightness == 0) {
|
|
||||||
precharge = 0;
|
|
||||||
}
|
|
||||||
uint8_t comdetect = brightness / 8;
|
|
||||||
|
|
||||||
setContrast(contrast, precharge, comdetect);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::resetOrientation() {
|
|
||||||
sendCommand(SEGREMAP);
|
|
||||||
sendCommand(COMSCANINC); //Reset screen rotation or mirroring
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::flipScreenVertically() {
|
|
||||||
sendCommand(SEGREMAP | 0x01);
|
|
||||||
sendCommand(COMSCANDEC); //Rotate screen 180 Deg
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::mirrorScreen() {
|
|
||||||
sendCommand(SEGREMAP);
|
|
||||||
sendCommand(COMSCANDEC); //Mirror screen
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::clear(void) {
|
|
||||||
memset(buffer, 0, displayBufferSize);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::drawLogBuffer(uint16_t xMove, uint16_t yMove) {
|
|
||||||
uint16_t lineHeight = pgm_read_byte(fontData + HEIGHT_POS);
|
|
||||||
// Always align left
|
|
||||||
setTextAlignment(TEXT_ALIGN_LEFT);
|
|
||||||
|
|
||||||
// State values
|
|
||||||
uint16_t length = 0;
|
|
||||||
uint16_t line = 0;
|
|
||||||
uint16_t lastPos = 0;
|
|
||||||
|
|
||||||
for (uint16_t i=0;i<this->logBufferFilled;i++){
|
|
||||||
// Everytime we have a \n print
|
|
||||||
if (this->logBuffer[i] == 10) {
|
|
||||||
length++;
|
|
||||||
// Draw string on line `line` from lastPos to length
|
|
||||||
// Passing 0 as the lenght because we are in TEXT_ALIGN_LEFT
|
|
||||||
drawStringInternal(xMove, yMove + (line++) * lineHeight, &this->logBuffer[lastPos], length, 0);
|
|
||||||
// Remember last pos
|
|
||||||
lastPos = i;
|
|
||||||
// Reset length
|
|
||||||
length = 0;
|
|
||||||
} else {
|
|
||||||
// Count chars until next linebreak
|
|
||||||
length++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Draw the remaining string
|
|
||||||
if (length > 0) {
|
|
||||||
drawStringInternal(xMove, yMove + line * lineHeight, &this->logBuffer[lastPos], length, 0);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t OLEDDisplay::getWidth(void) {
|
|
||||||
return displayWidth;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t OLEDDisplay::getHeight(void) {
|
|
||||||
return displayHeight;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool OLEDDisplay::setLogBuffer(uint16_t lines, uint16_t chars){
|
|
||||||
if (logBuffer != NULL) free(logBuffer);
|
|
||||||
uint16_t size = lines * chars;
|
|
||||||
if (size > 0) {
|
|
||||||
this->logBufferLine = 0; // Lines printed
|
|
||||||
this->logBufferFilled = 0; // Nothing stored yet
|
|
||||||
this->logBufferMaxLines = lines; // Lines max printable
|
|
||||||
this->logBufferSize = size; // Total number of characters the buffer can hold
|
|
||||||
this->logBuffer = (char *) malloc(size * sizeof(uint8_t));
|
|
||||||
if(!this->logBuffer) {
|
|
||||||
DEBUG_OLEDDISPLAY("[OLEDDISPLAY][setLogBuffer] Not enough memory to create log buffer\n");
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t OLEDDisplay::write(uint8_t c) {
|
|
||||||
if (this->logBufferSize > 0) {
|
|
||||||
// Don't waste space on \r\n line endings, dropping \r
|
|
||||||
if (c == 13) return 1;
|
|
||||||
|
|
||||||
// convert UTF-8 character to font table index
|
|
||||||
c = (this->fontTableLookupFunction)(c);
|
|
||||||
// drop unknown character
|
|
||||||
if (c == 0) return 1;
|
|
||||||
|
|
||||||
bool maxLineNotReached = this->logBufferLine < this->logBufferMaxLines;
|
|
||||||
bool bufferNotFull = this->logBufferFilled < this->logBufferSize;
|
|
||||||
|
|
||||||
// Can we write to the buffer?
|
|
||||||
if (bufferNotFull && maxLineNotReached) {
|
|
||||||
this->logBuffer[logBufferFilled] = c;
|
|
||||||
this->logBufferFilled++;
|
|
||||||
// Keep track of lines written
|
|
||||||
if (c == 10) this->logBufferLine++;
|
|
||||||
} else {
|
|
||||||
// Max line number is reached
|
|
||||||
if (!maxLineNotReached) this->logBufferLine--;
|
|
||||||
|
|
||||||
// Find the end of the first line
|
|
||||||
uint16_t firstLineEnd = 0;
|
|
||||||
for (uint16_t i=0;i<this->logBufferFilled;i++) {
|
|
||||||
if (this->logBuffer[i] == 10){
|
|
||||||
// Include last char too
|
|
||||||
firstLineEnd = i + 1;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// If there was a line ending
|
|
||||||
if (firstLineEnd > 0) {
|
|
||||||
// Calculate the new logBufferFilled value
|
|
||||||
this->logBufferFilled = logBufferFilled - firstLineEnd;
|
|
||||||
// Now we move the lines infront of the buffer
|
|
||||||
memcpy(this->logBuffer, &this->logBuffer[firstLineEnd], logBufferFilled);
|
|
||||||
} else {
|
|
||||||
// Let's reuse the buffer if it was full
|
|
||||||
if (!bufferNotFull) {
|
|
||||||
this->logBufferFilled = 0;
|
|
||||||
}// else {
|
|
||||||
// Nothing to do here
|
|
||||||
//}
|
|
||||||
}
|
|
||||||
write(c);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// We are always writing all uint8_t to the buffer
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
size_t OLEDDisplay::write(const char* str) {
|
|
||||||
if (str == NULL) return 0;
|
|
||||||
size_t length = strlen(str);
|
|
||||||
for (size_t i = 0; i < length; i++) {
|
|
||||||
write(str[i]);
|
|
||||||
}
|
|
||||||
return length;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Private functions
|
|
||||||
void OLEDDisplay::setGeometry(OLEDDISPLAY_GEOMETRY g) {
|
|
||||||
this->geometry = g;
|
|
||||||
if (g == GEOMETRY_128_64) {
|
|
||||||
this->displayWidth = 128;
|
|
||||||
this->displayHeight = 64;
|
|
||||||
} else if (g == GEOMETRY_128_32) {
|
|
||||||
this->displayWidth = 128;
|
|
||||||
this->displayHeight = 32;
|
|
||||||
}
|
|
||||||
this->displayBufferSize = displayWidth*displayHeight/8;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::sendInitCommands(void) {
|
|
||||||
sendCommand(DISPLAYOFF);
|
|
||||||
sendCommand(SETDISPLAYCLOCKDIV);
|
|
||||||
sendCommand(0xF0); // Increase speed of the display max ~96Hz
|
|
||||||
sendCommand(SETMULTIPLEX);
|
|
||||||
sendCommand(this->height() - 1);
|
|
||||||
sendCommand(SETDISPLAYOFFSET);
|
|
||||||
sendCommand(0x00);
|
|
||||||
sendCommand(SETSTARTLINE);
|
|
||||||
sendCommand(CHARGEPUMP);
|
|
||||||
sendCommand(0x14);
|
|
||||||
sendCommand(MEMORYMODE);
|
|
||||||
sendCommand(0x00);
|
|
||||||
sendCommand(SEGREMAP);
|
|
||||||
sendCommand(COMSCANINC);
|
|
||||||
sendCommand(SETCOMPINS);
|
|
||||||
|
|
||||||
if (geometry == GEOMETRY_128_64) {
|
|
||||||
sendCommand(0x12);
|
|
||||||
} else if (geometry == GEOMETRY_128_32) {
|
|
||||||
sendCommand(0x02);
|
|
||||||
}
|
|
||||||
|
|
||||||
sendCommand(SETCONTRAST);
|
|
||||||
|
|
||||||
if (geometry == GEOMETRY_128_64) {
|
|
||||||
sendCommand(0xCF);
|
|
||||||
} else if (geometry == GEOMETRY_128_32) {
|
|
||||||
sendCommand(0x8F);
|
|
||||||
}
|
|
||||||
|
|
||||||
sendCommand(SETPRECHARGE);
|
|
||||||
sendCommand(0xF1);
|
|
||||||
sendCommand(SETVCOMDETECT); //0xDB, (additionally needed to lower the contrast)
|
|
||||||
sendCommand(0x40); //0x40 default, to lower the contrast, put 0
|
|
||||||
sendCommand(DISPLAYALLON_RESUME);
|
|
||||||
sendCommand(NORMALDISPLAY);
|
|
||||||
sendCommand(0x2e); // stop scroll
|
|
||||||
sendCommand(DISPLAYON);
|
|
||||||
}
|
|
||||||
|
|
||||||
void inline OLEDDisplay::drawInternal(int16_t xMove, int16_t yMove, int16_t width, int16_t height, const uint8_t *data, uint16_t offset, uint16_t bytesInData) {
|
|
||||||
if (width < 0 || height < 0) return;
|
|
||||||
if (yMove + height < 0 || yMove > this->height()) return;
|
|
||||||
if (xMove + width < 0 || xMove > this->width()) return;
|
|
||||||
|
|
||||||
uint8_t rasterHeight = 1 + ((height - 1) >> 3); // fast ceil(height / 8.0)
|
|
||||||
int8_t yOffset = yMove & 7;
|
|
||||||
|
|
||||||
bytesInData = bytesInData == 0 ? width * rasterHeight : bytesInData;
|
|
||||||
|
|
||||||
int16_t initYMove = yMove;
|
|
||||||
int8_t initYOffset = yOffset;
|
|
||||||
|
|
||||||
|
|
||||||
for (uint16_t i = 0; i < bytesInData; i++) {
|
|
||||||
|
|
||||||
// Reset if next horizontal drawing phase is started.
|
|
||||||
if ( i % rasterHeight == 0) {
|
|
||||||
yMove = initYMove;
|
|
||||||
yOffset = initYOffset;
|
|
||||||
}
|
|
||||||
|
|
||||||
byte currentByte = pgm_read_byte(data + offset + i);
|
|
||||||
|
|
||||||
int16_t xPos = xMove + (i / rasterHeight);
|
|
||||||
int16_t yPos = ((yMove >> 3) + (i % rasterHeight)) * this->width();
|
|
||||||
|
|
||||||
// int16_t yScreenPos = yMove + yOffset;
|
|
||||||
int16_t dataPos = xPos + yPos;
|
|
||||||
|
|
||||||
if (dataPos >= 0 && dataPos < displayBufferSize &&
|
|
||||||
xPos >= 0 && xPos < this->width() ) {
|
|
||||||
|
|
||||||
if (yOffset >= 0) {
|
|
||||||
switch (this->color) {
|
|
||||||
case WHITE: buffer[dataPos] |= currentByte << yOffset; break;
|
|
||||||
case BLACK: buffer[dataPos] &= ~(currentByte << yOffset); break;
|
|
||||||
case INVERSE: buffer[dataPos] ^= currentByte << yOffset; break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (dataPos < (displayBufferSize - this->width())) {
|
|
||||||
switch (this->color) {
|
|
||||||
case WHITE: buffer[dataPos + this->width()] |= currentByte >> (8 - yOffset); break;
|
|
||||||
case BLACK: buffer[dataPos + this->width()] &= ~(currentByte >> (8 - yOffset)); break;
|
|
||||||
case INVERSE: buffer[dataPos + this->width()] ^= currentByte >> (8 - yOffset); break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// Make new offset position
|
|
||||||
yOffset = -yOffset;
|
|
||||||
|
|
||||||
switch (this->color) {
|
|
||||||
case WHITE: buffer[dataPos] |= currentByte >> yOffset; break;
|
|
||||||
case BLACK: buffer[dataPos] &= ~(currentByte >> yOffset); break;
|
|
||||||
case INVERSE: buffer[dataPos] ^= currentByte >> yOffset; break;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Prepare for next iteration by moving one block up
|
|
||||||
yMove -= 8;
|
|
||||||
|
|
||||||
// and setting the new yOffset
|
|
||||||
yOffset = 8 - yOffset;
|
|
||||||
}
|
|
||||||
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// You need to free the char!
|
|
||||||
char* OLEDDisplay::utf8ascii(String str) {
|
|
||||||
uint16_t k = 0;
|
|
||||||
uint16_t length = str.length() + 1;
|
|
||||||
|
|
||||||
// Copy the string into a char array
|
|
||||||
char* s = (char*) malloc(length * sizeof(char));
|
|
||||||
if(!s) {
|
|
||||||
DEBUG_OLEDDISPLAY("[OLEDDISPLAY][utf8ascii] Can't allocate another char array. Drop support for UTF-8.\n");
|
|
||||||
return (char*) str.c_str();
|
|
||||||
}
|
|
||||||
str.toCharArray(s, length);
|
|
||||||
|
|
||||||
length--;
|
|
||||||
|
|
||||||
for (uint16_t i=0; i < length; i++) {
|
|
||||||
char c = (this->fontTableLookupFunction)(s[i]);
|
|
||||||
if (c!=0) {
|
|
||||||
s[k++]=c;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
s[k]=0;
|
|
||||||
|
|
||||||
// This will leak 's' be sure to free it in the calling function.
|
|
||||||
return s;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplay::setFontTableLookupFunction(FontTableLookupFunction function) {
|
|
||||||
this->fontTableLookupFunction = function;
|
|
||||||
}
|
|
||||||
|
|
@ -1,329 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef OLEDDISPLAY_h
|
|
||||||
#define OLEDDISPLAY_h
|
|
||||||
|
|
||||||
#include <Arduino.h>
|
|
||||||
#include "OLEDDisplayFonts.h"
|
|
||||||
|
|
||||||
//#define DEBUG_OLEDDISPLAY(...) Serial.printf( __VA_ARGS__ )
|
|
||||||
|
|
||||||
#ifndef DEBUG_OLEDDISPLAY
|
|
||||||
#define DEBUG_OLEDDISPLAY(...)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// Use DOUBLE BUFFERING by default
|
|
||||||
#ifndef OLEDDISPLAY_REDUCE_MEMORY
|
|
||||||
#define OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// Header Values
|
|
||||||
#define JUMPTABLE_BYTES 4
|
|
||||||
|
|
||||||
#define JUMPTABLE_LSB 1
|
|
||||||
#define JUMPTABLE_SIZE 2
|
|
||||||
#define JUMPTABLE_WIDTH 3
|
|
||||||
#define JUMPTABLE_START 4
|
|
||||||
|
|
||||||
#define WIDTH_POS 0
|
|
||||||
#define HEIGHT_POS 1
|
|
||||||
#define FIRST_CHAR_POS 2
|
|
||||||
#define CHAR_NUM_POS 3
|
|
||||||
|
|
||||||
|
|
||||||
// Display commands
|
|
||||||
#define CHARGEPUMP 0x8D
|
|
||||||
#define COLUMNADDR 0x21
|
|
||||||
#define COMSCANDEC 0xC8
|
|
||||||
#define COMSCANINC 0xC0
|
|
||||||
#define DISPLAYALLON 0xA5
|
|
||||||
#define DISPLAYALLON_RESUME 0xA4
|
|
||||||
#define DISPLAYOFF 0xAE
|
|
||||||
#define DISPLAYON 0xAF
|
|
||||||
#define EXTERNALVCC 0x1
|
|
||||||
#define INVERTDISPLAY 0xA7
|
|
||||||
#define MEMORYMODE 0x20
|
|
||||||
#define NORMALDISPLAY 0xA6
|
|
||||||
#define PAGEADDR 0x22
|
|
||||||
#define SEGREMAP 0xA0
|
|
||||||
#define SETCOMPINS 0xDA
|
|
||||||
#define SETCONTRAST 0x81
|
|
||||||
#define SETDISPLAYCLOCKDIV 0xD5
|
|
||||||
#define SETDISPLAYOFFSET 0xD3
|
|
||||||
#define SETHIGHCOLUMN 0x10
|
|
||||||
#define SETLOWCOLUMN 0x00
|
|
||||||
#define SETMULTIPLEX 0xA8
|
|
||||||
#define SETPRECHARGE 0xD9
|
|
||||||
#define SETSEGMENTREMAP 0xA1
|
|
||||||
#define SETSTARTLINE 0x40
|
|
||||||
#define SETVCOMDETECT 0xDB
|
|
||||||
#define SWITCHCAPVCC 0x2
|
|
||||||
|
|
||||||
#ifndef _swap_int16_t
|
|
||||||
#define _swap_int16_t(a, b) { int16_t t = a; a = b; b = t; }
|
|
||||||
#endif
|
|
||||||
|
|
||||||
enum OLEDDISPLAY_COLOR {
|
|
||||||
BLACK = 0,
|
|
||||||
WHITE = 1,
|
|
||||||
INVERSE = 2
|
|
||||||
};
|
|
||||||
|
|
||||||
enum OLEDDISPLAY_TEXT_ALIGNMENT {
|
|
||||||
TEXT_ALIGN_LEFT = 0,
|
|
||||||
TEXT_ALIGN_RIGHT = 1,
|
|
||||||
TEXT_ALIGN_CENTER = 2,
|
|
||||||
TEXT_ALIGN_CENTER_BOTH = 3
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
enum OLEDDISPLAY_GEOMETRY {
|
|
||||||
GEOMETRY_128_64 = 0,
|
|
||||||
GEOMETRY_128_32 = 1
|
|
||||||
};
|
|
||||||
|
|
||||||
typedef byte (*FontTableLookupFunction)(const byte ch);
|
|
||||||
|
|
||||||
|
|
||||||
class OLEDDisplay : public Print {
|
|
||||||
|
|
||||||
public:
|
|
||||||
virtual ~OLEDDisplay();
|
|
||||||
|
|
||||||
const uint16_t width(void) const { return displayWidth; };
|
|
||||||
const uint16_t height(void) const { return displayHeight; };
|
|
||||||
|
|
||||||
// Initialize the display
|
|
||||||
bool init();
|
|
||||||
|
|
||||||
// Free the memory used by the display
|
|
||||||
void end();
|
|
||||||
|
|
||||||
// Cycle through the initialization
|
|
||||||
void resetDisplay(void);
|
|
||||||
|
|
||||||
/* Drawing functions */
|
|
||||||
// Sets the color of all pixel operations
|
|
||||||
void setColor(OLEDDISPLAY_COLOR color);
|
|
||||||
|
|
||||||
// Returns the current color.
|
|
||||||
OLEDDISPLAY_COLOR getColor();
|
|
||||||
|
|
||||||
// Draw a pixel at given position
|
|
||||||
void setPixel(int16_t x, int16_t y);
|
|
||||||
|
|
||||||
// Draw a line from position 0 to position 1
|
|
||||||
void drawLine(int16_t x0, int16_t y0, int16_t x1, int16_t y1);
|
|
||||||
|
|
||||||
// Draw the border of a rectangle at the given location
|
|
||||||
void drawRect(int16_t x, int16_t y, int16_t width, int16_t height);
|
|
||||||
|
|
||||||
// Fill the rectangle
|
|
||||||
void fillRect(int16_t x, int16_t y, int16_t width, int16_t height);
|
|
||||||
|
|
||||||
// Draw the border of a circle
|
|
||||||
void drawCircle(int16_t x, int16_t y, int16_t radius);
|
|
||||||
|
|
||||||
// Draw all Quadrants specified in the quads bit mask
|
|
||||||
void drawCircleQuads(int16_t x0, int16_t y0, int16_t radius, uint8_t quads);
|
|
||||||
|
|
||||||
// Fill circle
|
|
||||||
void fillCircle(int16_t x, int16_t y, int16_t radius);
|
|
||||||
|
|
||||||
// Draw a line horizontally
|
|
||||||
void drawHorizontalLine(int16_t x, int16_t y, int16_t length);
|
|
||||||
|
|
||||||
// Draw a line vertically
|
|
||||||
void drawVerticalLine(int16_t x, int16_t y, int16_t length);
|
|
||||||
|
|
||||||
// Draws a rounded progress bar with the outer dimensions given by width and height. Progress is
|
|
||||||
// a unsigned byte value between 0 and 100
|
|
||||||
void drawProgressBar(uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t progress);
|
|
||||||
|
|
||||||
// Draw a bitmap in the internal image format
|
|
||||||
void drawFastImage(int16_t x, int16_t y, int16_t width, int16_t height, const uint8_t *image);
|
|
||||||
|
|
||||||
// Draw a XBM
|
|
||||||
void drawXbm(int16_t x, int16_t y, int16_t width, int16_t height, const uint8_t *xbm);
|
|
||||||
|
|
||||||
/* Text functions */
|
|
||||||
|
|
||||||
// Draws a string at the given location
|
|
||||||
void drawString(int16_t x, int16_t y, String text);
|
|
||||||
|
|
||||||
// Draws a String with a maximum width at the given location.
|
|
||||||
// If the given String is wider than the specified width
|
|
||||||
// The text will be wrapped to the next line at a space or dash
|
|
||||||
void drawStringMaxWidth(int16_t x, int16_t y, uint16_t maxLineWidth, String text);
|
|
||||||
|
|
||||||
// Returns the width of the const char* with the current
|
|
||||||
// font settings
|
|
||||||
uint16_t getStringWidth(const char* text, uint16_t length);
|
|
||||||
|
|
||||||
// Convencience method for the const char version
|
|
||||||
uint16_t getStringWidth(String text);
|
|
||||||
|
|
||||||
// Specifies relative to which anchor point
|
|
||||||
// the text is rendered. Available constants:
|
|
||||||
// TEXT_ALIGN_LEFT, TEXT_ALIGN_CENTER, TEXT_ALIGN_RIGHT, TEXT_ALIGN_CENTER_BOTH
|
|
||||||
void setTextAlignment(OLEDDISPLAY_TEXT_ALIGNMENT textAlignment);
|
|
||||||
|
|
||||||
// Sets the current font. Available default fonts
|
|
||||||
// ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24
|
|
||||||
void setFont(const uint8_t *fontData);
|
|
||||||
|
|
||||||
// Set the function that will convert utf-8 to font table index
|
|
||||||
void setFontTableLookupFunction(FontTableLookupFunction function);
|
|
||||||
|
|
||||||
/* Display functions */
|
|
||||||
|
|
||||||
// Turn the display on
|
|
||||||
void displayOn(void);
|
|
||||||
|
|
||||||
// Turn the display offs
|
|
||||||
void displayOff(void);
|
|
||||||
|
|
||||||
// Inverted display mode
|
|
||||||
void invertDisplay(void);
|
|
||||||
|
|
||||||
// Normal display mode
|
|
||||||
void normalDisplay(void);
|
|
||||||
|
|
||||||
// Set display contrast
|
|
||||||
// really low brightness & contrast: contrast = 10, precharge = 5, comdetect = 0
|
|
||||||
// normal brightness & contrast: contrast = 100
|
|
||||||
void setContrast(uint8_t contrast, uint8_t precharge = 241, uint8_t comdetect = 64);
|
|
||||||
|
|
||||||
// Convenience method to access
|
|
||||||
void setBrightness(uint8_t);
|
|
||||||
|
|
||||||
// Reset display rotation or mirroring
|
|
||||||
void resetOrientation();
|
|
||||||
|
|
||||||
// Turn the display upside down
|
|
||||||
void flipScreenVertically();
|
|
||||||
|
|
||||||
// Mirror the display (to be used in a mirror or as a projector)
|
|
||||||
void mirrorScreen();
|
|
||||||
|
|
||||||
// Write the buffer to the display memory
|
|
||||||
virtual void display(void) = 0;
|
|
||||||
|
|
||||||
// Clear the local pixel buffer
|
|
||||||
void clear(void);
|
|
||||||
|
|
||||||
// Log buffer implementation
|
|
||||||
|
|
||||||
// This will define the lines and characters you can
|
|
||||||
// print to the screen. When you exeed the buffer size (lines * chars)
|
|
||||||
// the output may be truncated due to the size constraint.
|
|
||||||
bool setLogBuffer(uint16_t lines, uint16_t chars);
|
|
||||||
|
|
||||||
// Draw the log buffer at position (x, y)
|
|
||||||
void drawLogBuffer(uint16_t x, uint16_t y);
|
|
||||||
|
|
||||||
// Get screen geometry
|
|
||||||
uint16_t getWidth(void);
|
|
||||||
uint16_t getHeight(void);
|
|
||||||
|
|
||||||
// Implement needed function to be compatible with Print class
|
|
||||||
size_t write(uint8_t c);
|
|
||||||
size_t write(const char* s);
|
|
||||||
|
|
||||||
uint8_t *buffer = NULL;
|
|
||||||
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t *buffer_back = NULL;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
protected:
|
|
||||||
|
|
||||||
OLEDDISPLAY_GEOMETRY geometry = GEOMETRY_128_64;
|
|
||||||
|
|
||||||
uint16_t displayWidth = 128;
|
|
||||||
uint16_t displayHeight = 64;
|
|
||||||
uint16_t displayBufferSize = 1024;
|
|
||||||
|
|
||||||
// Set the correct height, width and buffer for the geometry
|
|
||||||
void setGeometry(OLEDDISPLAY_GEOMETRY g);
|
|
||||||
|
|
||||||
OLEDDISPLAY_TEXT_ALIGNMENT textAlignment = TEXT_ALIGN_LEFT;
|
|
||||||
OLEDDISPLAY_COLOR color = WHITE;
|
|
||||||
|
|
||||||
const uint8_t *fontData = ArialMT_Plain_10;
|
|
||||||
|
|
||||||
// State values for logBuffer
|
|
||||||
uint16_t logBufferSize = 0;
|
|
||||||
uint16_t logBufferFilled = 0;
|
|
||||||
uint16_t logBufferLine = 0;
|
|
||||||
uint16_t logBufferMaxLines = 0;
|
|
||||||
char *logBuffer = NULL;
|
|
||||||
|
|
||||||
// Send a command to the display (low level function)
|
|
||||||
virtual void sendCommand(uint8_t com) {(void)com;};
|
|
||||||
|
|
||||||
// Connect to the display
|
|
||||||
virtual bool connect() { return false; };
|
|
||||||
|
|
||||||
// Send all the init commands
|
|
||||||
void sendInitCommands();
|
|
||||||
|
|
||||||
// converts utf8 characters to extended ascii
|
|
||||||
char* utf8ascii(String s);
|
|
||||||
|
|
||||||
void inline drawInternal(int16_t xMove, int16_t yMove, int16_t width, int16_t height, const uint8_t *data, uint16_t offset, uint16_t bytesInData) __attribute__((always_inline));
|
|
||||||
|
|
||||||
void drawStringInternal(int16_t xMove, int16_t yMove, char* text, uint16_t textLength, uint16_t textWidth);
|
|
||||||
|
|
||||||
// UTF-8 to font table index converter
|
|
||||||
// Code form http://playground.arduino.cc/Main/Utf8ascii
|
|
||||||
FontTableLookupFunction fontTableLookupFunction = [](const byte ch) {
|
|
||||||
static uint8_t LASTCHAR;
|
|
||||||
|
|
||||||
if (ch < 128) { // Standard ASCII-set 0..0x7F handling
|
|
||||||
LASTCHAR = 0;
|
|
||||||
return ch;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t last = LASTCHAR; // get last char
|
|
||||||
LASTCHAR = ch;
|
|
||||||
|
|
||||||
switch (last) { // conversion depnding on first UTF8-character
|
|
||||||
case 0xC2: return (uint8_t) ch;
|
|
||||||
case 0xC3: return (uint8_t) (ch | 0xC0);
|
|
||||||
case 0x82: if (ch == 0xAC) return (uint8_t) 0x80; // special case Euro-symbol
|
|
||||||
}
|
|
||||||
|
|
||||||
return (uint8_t) 0; // otherwise: return zero, if character has to be ignored
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,422 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include "OLEDDisplayUi.h"
|
|
||||||
|
|
||||||
OLEDDisplayUi::OLEDDisplayUi(OLEDDisplay *display) {
|
|
||||||
this->display = display;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::init() {
|
|
||||||
this->display->init();
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::setTargetFPS(uint8_t fps){
|
|
||||||
float oldInterval = this->updateInterval;
|
|
||||||
this->updateInterval = ((float) 1.0 / (float) fps) * 1000;
|
|
||||||
|
|
||||||
// Calculate new ticksPerFrame
|
|
||||||
float changeRatio = oldInterval / (float) this->updateInterval;
|
|
||||||
this->ticksPerFrame *= changeRatio;
|
|
||||||
this->ticksPerTransition *= changeRatio;
|
|
||||||
}
|
|
||||||
|
|
||||||
// -/------ Automatic controll ------\-
|
|
||||||
|
|
||||||
void OLEDDisplayUi::enableAutoTransition(){
|
|
||||||
this->autoTransition = true;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::disableAutoTransition(){
|
|
||||||
this->autoTransition = false;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setAutoTransitionForwards(){
|
|
||||||
this->state.frameTransitionDirection = 1;
|
|
||||||
this->lastTransitionDirection = 1;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setAutoTransitionBackwards(){
|
|
||||||
this->state.frameTransitionDirection = -1;
|
|
||||||
this->lastTransitionDirection = -1;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setTimePerFrame(uint16_t time){
|
|
||||||
this->ticksPerFrame = (uint16_t) ( (float) time / (float) updateInterval);
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setTimePerTransition(uint16_t time){
|
|
||||||
this->ticksPerTransition = (uint16_t) ( (float) time / (float) updateInterval);
|
|
||||||
}
|
|
||||||
|
|
||||||
// -/------ Customize indicator position and style -------\-
|
|
||||||
void OLEDDisplayUi::enableIndicator(){
|
|
||||||
this->state.isIndicatorDrawen = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::disableIndicator(){
|
|
||||||
this->state.isIndicatorDrawen = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::enableAllIndicators(){
|
|
||||||
this->shouldDrawIndicators = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::disableAllIndicators(){
|
|
||||||
this->shouldDrawIndicators = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::setIndicatorPosition(IndicatorPosition pos) {
|
|
||||||
this->indicatorPosition = pos;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setIndicatorDirection(IndicatorDirection dir) {
|
|
||||||
this->indicatorDirection = dir;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setActiveSymbol(const uint8_t* symbol) {
|
|
||||||
this->activeSymbol = symbol;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setInactiveSymbol(const uint8_t* symbol) {
|
|
||||||
this->inactiveSymbol = symbol;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// -/----- Frame settings -----\-
|
|
||||||
void OLEDDisplayUi::setFrameAnimation(AnimationDirection dir) {
|
|
||||||
this->frameAnimationDirection = dir;
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::setFrames(FrameCallback* frameFunctions, uint8_t frameCount) {
|
|
||||||
this->frameFunctions = frameFunctions;
|
|
||||||
this->frameCount = frameCount;
|
|
||||||
this->resetState();
|
|
||||||
}
|
|
||||||
|
|
||||||
// -/----- Overlays ------\-
|
|
||||||
void OLEDDisplayUi::setOverlays(OverlayCallback* overlayFunctions, uint8_t overlayCount){
|
|
||||||
this->overlayFunctions = overlayFunctions;
|
|
||||||
this->overlayCount = overlayCount;
|
|
||||||
}
|
|
||||||
|
|
||||||
// -/----- Loading Process -----\-
|
|
||||||
|
|
||||||
void OLEDDisplayUi::setLoadingDrawFunction(LoadingDrawFunction loadingDrawFunction) {
|
|
||||||
this->loadingDrawFunction = loadingDrawFunction;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::runLoadingProcess(LoadingStage* stages, uint8_t stagesCount) {
|
|
||||||
uint8_t progress = 0;
|
|
||||||
uint8_t increment = 100 / stagesCount;
|
|
||||||
|
|
||||||
for (uint8_t i = 0; i < stagesCount; i++) {
|
|
||||||
display->clear();
|
|
||||||
this->loadingDrawFunction(this->display, &stages[i], progress);
|
|
||||||
display->display();
|
|
||||||
|
|
||||||
stages[i].callback();
|
|
||||||
|
|
||||||
progress += increment;
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
display->clear();
|
|
||||||
this->loadingDrawFunction(this->display, &stages[stagesCount-1], progress);
|
|
||||||
display->display();
|
|
||||||
|
|
||||||
delay(150);
|
|
||||||
}
|
|
||||||
|
|
||||||
// -/----- Manuel control -----\-
|
|
||||||
void OLEDDisplayUi::nextFrame() {
|
|
||||||
if (this->state.frameState != IN_TRANSITION) {
|
|
||||||
this->state.manuelControll = true;
|
|
||||||
this->state.frameState = IN_TRANSITION;
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
this->lastTransitionDirection = this->state.frameTransitionDirection;
|
|
||||||
this->state.frameTransitionDirection = 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
void OLEDDisplayUi::previousFrame() {
|
|
||||||
if (this->state.frameState != IN_TRANSITION) {
|
|
||||||
this->state.manuelControll = true;
|
|
||||||
this->state.frameState = IN_TRANSITION;
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
this->lastTransitionDirection = this->state.frameTransitionDirection;
|
|
||||||
this->state.frameTransitionDirection = -1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::switchToFrame(uint8_t frame) {
|
|
||||||
if (frame >= this->frameCount) return;
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
if (frame == this->state.currentFrame) return;
|
|
||||||
this->state.frameState = FIXED;
|
|
||||||
this->state.currentFrame = frame;
|
|
||||||
this->state.isIndicatorDrawen = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::transitionToFrame(uint8_t frame) {
|
|
||||||
if (frame >= this->frameCount) return;
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
if (frame == this->state.currentFrame) return;
|
|
||||||
this->nextFrameNumber = frame;
|
|
||||||
this->lastTransitionDirection = this->state.frameTransitionDirection;
|
|
||||||
this->state.manuelControll = true;
|
|
||||||
this->state.frameState = IN_TRANSITION;
|
|
||||||
this->state.frameTransitionDirection = frame < this->state.currentFrame ? -1 : 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// -/----- State information -----\-
|
|
||||||
OLEDDisplayUiState* OLEDDisplayUi::getUiState(){
|
|
||||||
return &this->state;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
int8_t OLEDDisplayUi::update(){
|
|
||||||
unsigned long frameStart = millis();
|
|
||||||
int8_t timeBudget = this->updateInterval - (frameStart - this->state.lastUpdate);
|
|
||||||
if ( timeBudget <= 0) {
|
|
||||||
// Implement frame skipping to ensure time budget is keept
|
|
||||||
if (this->autoTransition && this->state.lastUpdate != 0) this->state.ticksSinceLastStateSwitch += ceil(-timeBudget / this->updateInterval);
|
|
||||||
|
|
||||||
this->state.lastUpdate = frameStart;
|
|
||||||
this->tick();
|
|
||||||
}
|
|
||||||
return this->updateInterval - (millis() - frameStart);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
void OLEDDisplayUi::tick() {
|
|
||||||
this->state.ticksSinceLastStateSwitch++;
|
|
||||||
|
|
||||||
switch (this->state.frameState) {
|
|
||||||
case IN_TRANSITION:
|
|
||||||
if (this->state.ticksSinceLastStateSwitch >= this->ticksPerTransition){
|
|
||||||
this->state.frameState = FIXED;
|
|
||||||
this->state.currentFrame = getNextFrameNumber();
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
this->nextFrameNumber = -1;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case FIXED:
|
|
||||||
// Revert manuelControll
|
|
||||||
if (this->state.manuelControll) {
|
|
||||||
this->state.frameTransitionDirection = this->lastTransitionDirection;
|
|
||||||
this->state.manuelControll = false;
|
|
||||||
}
|
|
||||||
if (this->state.ticksSinceLastStateSwitch >= this->ticksPerFrame){
|
|
||||||
if (this->autoTransition){
|
|
||||||
this->state.frameState = IN_TRANSITION;
|
|
||||||
}
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
this->display->clear();
|
|
||||||
this->drawFrame();
|
|
||||||
if (shouldDrawIndicators) {
|
|
||||||
this->drawIndicator();
|
|
||||||
}
|
|
||||||
this->drawOverlays();
|
|
||||||
this->display->display();
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::resetState() {
|
|
||||||
this->state.lastUpdate = 0;
|
|
||||||
this->state.ticksSinceLastStateSwitch = 0;
|
|
||||||
this->state.frameState = FIXED;
|
|
||||||
this->state.currentFrame = 0;
|
|
||||||
this->state.isIndicatorDrawen = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::drawFrame(){
|
|
||||||
switch (this->state.frameState){
|
|
||||||
case IN_TRANSITION: {
|
|
||||||
float progress = (float) this->state.ticksSinceLastStateSwitch / (float) this->ticksPerTransition;
|
|
||||||
int16_t x = 0, y = 0, x1 = 0, y1 = 0;
|
|
||||||
switch(this->frameAnimationDirection){
|
|
||||||
case SLIDE_LEFT:
|
|
||||||
x = -this->display->width() * progress;
|
|
||||||
y = 0;
|
|
||||||
x1 = x + this->display->width();
|
|
||||||
y1 = 0;
|
|
||||||
break;
|
|
||||||
case SLIDE_RIGHT:
|
|
||||||
x = this->display->width() * progress;
|
|
||||||
y = 0;
|
|
||||||
x1 = x - this->display->width();
|
|
||||||
y1 = 0;
|
|
||||||
break;
|
|
||||||
case SLIDE_UP:
|
|
||||||
x = 0;
|
|
||||||
y = -this->display->height() * progress;
|
|
||||||
x1 = 0;
|
|
||||||
y1 = y + this->display->height();
|
|
||||||
break;
|
|
||||||
case SLIDE_DOWN:
|
|
||||||
default:
|
|
||||||
x = 0;
|
|
||||||
y = this->display->height() * progress;
|
|
||||||
x1 = 0;
|
|
||||||
y1 = y - this->display->height();
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Invert animation if direction is reversed.
|
|
||||||
int8_t dir = this->state.frameTransitionDirection >= 0 ? 1 : -1;
|
|
||||||
x *= dir; y *= dir; x1 *= dir; y1 *= dir;
|
|
||||||
|
|
||||||
bool drawenCurrentFrame;
|
|
||||||
|
|
||||||
|
|
||||||
// Prope each frameFunction for the indicator Drawen state
|
|
||||||
this->enableIndicator();
|
|
||||||
(this->frameFunctions[this->state.currentFrame])(this->display, &this->state, x, y);
|
|
||||||
drawenCurrentFrame = this->state.isIndicatorDrawen;
|
|
||||||
|
|
||||||
this->enableIndicator();
|
|
||||||
(this->frameFunctions[this->getNextFrameNumber()])(this->display, &this->state, x1, y1);
|
|
||||||
|
|
||||||
// Build up the indicatorDrawState
|
|
||||||
if (drawenCurrentFrame && !this->state.isIndicatorDrawen) {
|
|
||||||
// Drawen now but not next
|
|
||||||
this->indicatorDrawState = 2;
|
|
||||||
} else if (!drawenCurrentFrame && this->state.isIndicatorDrawen) {
|
|
||||||
// Not drawen now but next
|
|
||||||
this->indicatorDrawState = 1;
|
|
||||||
} else if (!drawenCurrentFrame && !this->state.isIndicatorDrawen) {
|
|
||||||
// Not drawen in both frames
|
|
||||||
this->indicatorDrawState = 3;
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the indicator isn't draw in the current frame
|
|
||||||
// reflect it in state.isIndicatorDrawen
|
|
||||||
if (!drawenCurrentFrame) this->state.isIndicatorDrawen = false;
|
|
||||||
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
case FIXED:
|
|
||||||
// Always assume that the indicator is drawn!
|
|
||||||
// And set indicatorDrawState to "not known yet"
|
|
||||||
this->indicatorDrawState = 0;
|
|
||||||
this->enableIndicator();
|
|
||||||
(this->frameFunctions[this->state.currentFrame])(this->display, &this->state, 0, 0);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::drawIndicator() {
|
|
||||||
|
|
||||||
// Only draw if the indicator is invisible
|
|
||||||
// for both frames or
|
|
||||||
// the indiactor is shown and we are IN_TRANSITION
|
|
||||||
if (this->indicatorDrawState == 3 || (!this->state.isIndicatorDrawen && this->state.frameState != IN_TRANSITION)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t posOfHighlightFrame = 0;
|
|
||||||
float indicatorFadeProgress = 0;
|
|
||||||
|
|
||||||
// if the indicator needs to be slided in we want to
|
|
||||||
// highlight the next frame in the transition
|
|
||||||
uint8_t frameToHighlight = this->indicatorDrawState == 1 ? this->getNextFrameNumber() : this->state.currentFrame;
|
|
||||||
|
|
||||||
// Calculate the frame that needs to be highlighted
|
|
||||||
// based on the Direction the indiactor is drawn
|
|
||||||
switch (this->indicatorDirection){
|
|
||||||
case LEFT_RIGHT:
|
|
||||||
posOfHighlightFrame = frameToHighlight;
|
|
||||||
break;
|
|
||||||
case RIGHT_LEFT:
|
|
||||||
default:
|
|
||||||
posOfHighlightFrame = this->frameCount - frameToHighlight;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
switch (this->indicatorDrawState) {
|
|
||||||
case 1: // Indicator was not drawn in this frame but will be in next
|
|
||||||
// Slide IN
|
|
||||||
indicatorFadeProgress = 1 - ((float) this->state.ticksSinceLastStateSwitch / (float) this->ticksPerTransition);
|
|
||||||
break;
|
|
||||||
case 2: // Indicator was drawn in this frame but not in next
|
|
||||||
// Slide OUT
|
|
||||||
indicatorFadeProgress = ((float) this->state.ticksSinceLastStateSwitch / (float) this->ticksPerTransition);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
//Space between indicators - reduce for small screen sizes
|
|
||||||
uint16_t indicatorSpacing = 12;
|
|
||||||
if (this->display->getHeight() < 64 && (this->indicatorPosition == RIGHT || this->indicatorPosition == LEFT)) {
|
|
||||||
indicatorSpacing = 6;
|
|
||||||
}
|
|
||||||
|
|
||||||
uint16_t frameStartPos = (indicatorSpacing * frameCount / 2);
|
|
||||||
const uint8_t *image;
|
|
||||||
|
|
||||||
uint16_t x = 0,y = 0;
|
|
||||||
|
|
||||||
|
|
||||||
for (byte i = 0; i < this->frameCount; i++) {
|
|
||||||
|
|
||||||
switch (this->indicatorPosition){
|
|
||||||
case TOP:
|
|
||||||
y = 0 - (8 * indicatorFadeProgress);
|
|
||||||
x = (this->display->width() / 2) - frameStartPos + 12 * i;
|
|
||||||
break;
|
|
||||||
case BOTTOM:
|
|
||||||
y = (this->display->height() - 8) + (8 * indicatorFadeProgress);
|
|
||||||
x = (this->display->width() / 2) - frameStartPos + 12 * i;
|
|
||||||
break;
|
|
||||||
case RIGHT:
|
|
||||||
x = (this->display->width() - 8) + (8 * indicatorFadeProgress);
|
|
||||||
y = (this->display->height() / 2) - frameStartPos + 2 + 12 * i;
|
|
||||||
break;
|
|
||||||
case LEFT:
|
|
||||||
default:
|
|
||||||
x = 0 - (8 * indicatorFadeProgress);
|
|
||||||
y = (this->display->height() / 2) - frameStartPos + 2 + indicatorSpacing * i;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (posOfHighlightFrame == i) {
|
|
||||||
image = this->activeSymbol;
|
|
||||||
} else {
|
|
||||||
image = this->inactiveSymbol;
|
|
||||||
}
|
|
||||||
|
|
||||||
this->display->drawFastImage(x, y, 8, 8, image);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OLEDDisplayUi::drawOverlays() {
|
|
||||||
for (uint8_t i=0;i<this->overlayCount;i++){
|
|
||||||
(this->overlayFunctions[i])(this->display, &this->state);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t OLEDDisplayUi::getNextFrameNumber(){
|
|
||||||
if (this->nextFrameNumber != -1) return this->nextFrameNumber;
|
|
||||||
return (this->state.currentFrame + this->frameCount + this->state.frameTransitionDirection) % this->frameCount;
|
|
||||||
}
|
|
||||||
|
|
@ -1,309 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef OLEDDISPLAYUI_h
|
|
||||||
#define OLEDDISPLAYUI_h
|
|
||||||
|
|
||||||
#include <Arduino.h>
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
|
|
||||||
//#define DEBUG_OLEDDISPLAYUI(...) Serial.printf( __VA_ARGS__ )
|
|
||||||
|
|
||||||
#ifndef DEBUG_OLEDDISPLAYUI
|
|
||||||
#define DEBUG_OLEDDISPLAYUI(...)
|
|
||||||
#endif
|
|
||||||
|
|
||||||
enum AnimationDirection {
|
|
||||||
SLIDE_UP,
|
|
||||||
SLIDE_DOWN,
|
|
||||||
SLIDE_LEFT,
|
|
||||||
SLIDE_RIGHT
|
|
||||||
};
|
|
||||||
|
|
||||||
enum IndicatorPosition {
|
|
||||||
TOP,
|
|
||||||
RIGHT,
|
|
||||||
BOTTOM,
|
|
||||||
LEFT
|
|
||||||
};
|
|
||||||
|
|
||||||
enum IndicatorDirection {
|
|
||||||
LEFT_RIGHT,
|
|
||||||
RIGHT_LEFT
|
|
||||||
};
|
|
||||||
|
|
||||||
enum FrameState {
|
|
||||||
IN_TRANSITION,
|
|
||||||
FIXED
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
const uint8_t ANIMATION_activeSymbol[] PROGMEM = {
|
|
||||||
0x00, 0x18, 0x3c, 0x7e, 0x7e, 0x3c, 0x18, 0x00
|
|
||||||
};
|
|
||||||
|
|
||||||
const uint8_t ANIMATION_inactiveSymbol[] PROGMEM = {
|
|
||||||
0x00, 0x0, 0x0, 0x18, 0x18, 0x0, 0x0, 0x00
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
// Structure of the UiState
|
|
||||||
struct OLEDDisplayUiState {
|
|
||||||
uint64_t lastUpdate = 0;
|
|
||||||
uint16_t ticksSinceLastStateSwitch = 0;
|
|
||||||
|
|
||||||
FrameState frameState = FIXED;
|
|
||||||
uint8_t currentFrame = 0;
|
|
||||||
|
|
||||||
bool isIndicatorDrawen = true;
|
|
||||||
|
|
||||||
// Normal = 1, Inverse = -1;
|
|
||||||
int8_t frameTransitionDirection = 1;
|
|
||||||
|
|
||||||
bool manuelControll = false;
|
|
||||||
|
|
||||||
// Custom data that can be used by the user
|
|
||||||
void* userData = NULL;
|
|
||||||
};
|
|
||||||
|
|
||||||
struct LoadingStage {
|
|
||||||
const char* process;
|
|
||||||
void (*callback)();
|
|
||||||
};
|
|
||||||
|
|
||||||
typedef void (*FrameCallback)(OLEDDisplay *display, OLEDDisplayUiState* state, int16_t x, int16_t y);
|
|
||||||
typedef void (*OverlayCallback)(OLEDDisplay *display, OLEDDisplayUiState* state);
|
|
||||||
typedef void (*LoadingDrawFunction)(OLEDDisplay *display, LoadingStage* stage, uint8_t progress);
|
|
||||||
|
|
||||||
class OLEDDisplayUi {
|
|
||||||
private:
|
|
||||||
OLEDDisplay *display;
|
|
||||||
|
|
||||||
// Symbols for the Indicator
|
|
||||||
IndicatorPosition indicatorPosition = BOTTOM;
|
|
||||||
IndicatorDirection indicatorDirection = LEFT_RIGHT;
|
|
||||||
|
|
||||||
const uint8_t* activeSymbol = ANIMATION_activeSymbol;
|
|
||||||
const uint8_t* inactiveSymbol = ANIMATION_inactiveSymbol;
|
|
||||||
|
|
||||||
bool shouldDrawIndicators = true;
|
|
||||||
|
|
||||||
// Values for the Frames
|
|
||||||
AnimationDirection frameAnimationDirection = SLIDE_RIGHT;
|
|
||||||
|
|
||||||
int8_t lastTransitionDirection = 1;
|
|
||||||
|
|
||||||
uint16_t ticksPerFrame = 151; // ~ 5000ms at 30 FPS
|
|
||||||
uint16_t ticksPerTransition = 15; // ~ 500ms at 30 FPS
|
|
||||||
|
|
||||||
bool autoTransition = true;
|
|
||||||
|
|
||||||
FrameCallback* frameFunctions;
|
|
||||||
uint8_t frameCount = 0;
|
|
||||||
|
|
||||||
// Internally used to transition to a specific frame
|
|
||||||
int8_t nextFrameNumber = -1;
|
|
||||||
|
|
||||||
// Values for Overlays
|
|
||||||
OverlayCallback* overlayFunctions;
|
|
||||||
uint8_t overlayCount = 0;
|
|
||||||
|
|
||||||
// Will the Indicator be drawen
|
|
||||||
// 3 Not drawn in both frames
|
|
||||||
// 2 Drawn this frame but not next
|
|
||||||
// 1 Not drown this frame but next
|
|
||||||
// 0 Not known yet
|
|
||||||
uint8_t indicatorDrawState = 1;
|
|
||||||
|
|
||||||
// Loading screen
|
|
||||||
LoadingDrawFunction loadingDrawFunction = [](OLEDDisplay *display, LoadingStage* stage, uint8_t progress) {
|
|
||||||
display->setTextAlignment(TEXT_ALIGN_CENTER);
|
|
||||||
display->setFont(ArialMT_Plain_10);
|
|
||||||
display->drawString(64, 18, stage->process);
|
|
||||||
display->drawProgressBar(4, 32, 120, 8, progress);
|
|
||||||
};
|
|
||||||
|
|
||||||
// UI State
|
|
||||||
OLEDDisplayUiState state;
|
|
||||||
|
|
||||||
// Bookeeping for update
|
|
||||||
uint8_t updateInterval = 33;
|
|
||||||
|
|
||||||
uint8_t getNextFrameNumber();
|
|
||||||
void drawIndicator();
|
|
||||||
void drawFrame();
|
|
||||||
void drawOverlays();
|
|
||||||
void tick();
|
|
||||||
void resetState();
|
|
||||||
|
|
||||||
public:
|
|
||||||
|
|
||||||
OLEDDisplayUi(OLEDDisplay *display);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Initialise the display
|
|
||||||
*/
|
|
||||||
void init();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configure the internal used target FPS
|
|
||||||
*/
|
|
||||||
void setTargetFPS(uint8_t fps);
|
|
||||||
|
|
||||||
// Automatic Controll
|
|
||||||
/**
|
|
||||||
* Enable automatic transition to next frame after the some time can be configured with `setTimePerFrame` and `setTimePerTransition`.
|
|
||||||
*/
|
|
||||||
void enableAutoTransition();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable automatic transition to next frame.
|
|
||||||
*/
|
|
||||||
void disableAutoTransition();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the direction if the automatic transitioning
|
|
||||||
*/
|
|
||||||
void setAutoTransitionForwards();
|
|
||||||
void setAutoTransitionBackwards();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the approx. time a frame is displayed
|
|
||||||
*/
|
|
||||||
void setTimePerFrame(uint16_t time);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the approx. time a transition will take
|
|
||||||
*/
|
|
||||||
void setTimePerTransition(uint16_t time);
|
|
||||||
|
|
||||||
// Customize indicator position and style
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Draw the indicator.
|
|
||||||
* This is the defaut state for all frames if
|
|
||||||
* the indicator was hidden on the previous frame
|
|
||||||
* it will be slided in.
|
|
||||||
*/
|
|
||||||
void enableIndicator();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Don't draw the indicator.
|
|
||||||
* This will slide out the indicator
|
|
||||||
* when transitioning to the next frame.
|
|
||||||
*/
|
|
||||||
void disableIndicator();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enable drawing of indicators
|
|
||||||
*/
|
|
||||||
void enableAllIndicators();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Disable draw of indicators.
|
|
||||||
*/
|
|
||||||
void disableAllIndicators();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the position of the indicator bar.
|
|
||||||
*/
|
|
||||||
void setIndicatorPosition(IndicatorPosition pos);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the direction of the indicator bar. Defining the order of frames ASCENDING / DESCENDING
|
|
||||||
*/
|
|
||||||
void setIndicatorDirection(IndicatorDirection dir);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the symbol to indicate an active frame in the indicator bar.
|
|
||||||
*/
|
|
||||||
void setActiveSymbol(const uint8_t* symbol);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the symbol to indicate an inactive frame in the indicator bar.
|
|
||||||
*/
|
|
||||||
void setInactiveSymbol(const uint8_t* symbol);
|
|
||||||
|
|
||||||
|
|
||||||
// Frame settings
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Configure what animation is used to transition from one frame to another
|
|
||||||
*/
|
|
||||||
void setFrameAnimation(AnimationDirection dir);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add frame drawing functions
|
|
||||||
*/
|
|
||||||
void setFrames(FrameCallback* frameFunctions, uint8_t frameCount);
|
|
||||||
|
|
||||||
// Overlay
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Add overlays drawing functions that are draw independent of the Frames
|
|
||||||
*/
|
|
||||||
void setOverlays(OverlayCallback* overlayFunctions, uint8_t overlayCount);
|
|
||||||
|
|
||||||
|
|
||||||
// Loading animation
|
|
||||||
/**
|
|
||||||
* Set the function that will draw each step
|
|
||||||
* in the loading animation
|
|
||||||
*/
|
|
||||||
void setLoadingDrawFunction(LoadingDrawFunction loadingFunction);
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Run the loading process
|
|
||||||
*/
|
|
||||||
void runLoadingProcess(LoadingStage* stages, uint8_t stagesCount);
|
|
||||||
|
|
||||||
|
|
||||||
// Manual Control
|
|
||||||
void nextFrame();
|
|
||||||
void previousFrame();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Switch without transition to frame `frame`.
|
|
||||||
*/
|
|
||||||
void switchToFrame(uint8_t frame);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Transition to frame `frame`, when the `frame` number is bigger than the current
|
|
||||||
* frame the forward animation will be used, otherwise the backwards animation is used.
|
|
||||||
*/
|
|
||||||
void transitionToFrame(uint8_t frame);
|
|
||||||
|
|
||||||
// State Info
|
|
||||||
OLEDDisplayUiState* getUiState();
|
|
||||||
|
|
||||||
int8_t update();
|
|
||||||
};
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,39 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SH1106_h
|
|
||||||
#define SH1106_h
|
|
||||||
#include "SH1106Wire.h"
|
|
||||||
|
|
||||||
// For make SH1106 an alias for SH1106Wire
|
|
||||||
typedef SH1106Wire SH1106;
|
|
||||||
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,138 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SH1106Brzo_h
|
|
||||||
#define SH1106Brzo_h
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
#include <brzo_i2c.h>
|
|
||||||
|
|
||||||
#if F_CPU == 160000000L
|
|
||||||
#define BRZO_I2C_SPEED 1000
|
|
||||||
#else
|
|
||||||
#define BRZO_I2C_SPEED 800
|
|
||||||
#endif
|
|
||||||
|
|
||||||
class SH1106Brzo : public OLEDDisplay {
|
|
||||||
private:
|
|
||||||
uint8_t _address;
|
|
||||||
uint8_t _sda;
|
|
||||||
uint8_t _scl;
|
|
||||||
|
|
||||||
public:
|
|
||||||
SH1106Brzo(uint8_t _address, uint8_t _sda, uint8_t _scl, OLEDDISPLAY_GEOMETRY g = GEOMETRY_128_64) {
|
|
||||||
setGeometry(g);
|
|
||||||
|
|
||||||
this->_address = _address;
|
|
||||||
this->_sda = _sda;
|
|
||||||
this->_scl = _scl;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool connect(){
|
|
||||||
brzo_i2c_setup(_sda, _scl, 0);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void display(void) {
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t minBoundY = UINT8_MAX;
|
|
||||||
uint8_t maxBoundY = 0;
|
|
||||||
|
|
||||||
uint8_t minBoundX = UINT8_MAX;
|
|
||||||
uint8_t maxBoundX = 0;
|
|
||||||
uint8_t x, y;
|
|
||||||
|
|
||||||
// Calculate the Y bounding box of changes
|
|
||||||
// and copy buffer[pos] to buffer_back[pos];
|
|
||||||
for (y = 0; y < (displayHeight / 8); y++) {
|
|
||||||
for (x = 0; x < displayWidth; x++) {
|
|
||||||
uint16_t pos = x + y * displayWidth;
|
|
||||||
if (buffer[pos] != buffer_back[pos]) {
|
|
||||||
minBoundY = _min(minBoundY, y);
|
|
||||||
maxBoundY = _max(maxBoundY, y);
|
|
||||||
minBoundX = _min(minBoundX, x);
|
|
||||||
maxBoundX = _max(maxBoundX, x);
|
|
||||||
}
|
|
||||||
buffer_back[pos] = buffer[pos];
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the minBoundY wasn't updated
|
|
||||||
// we can savely assume that buffer_back[pos] == buffer[pos]
|
|
||||||
// holdes true for all values of pos
|
|
||||||
if (minBoundY == UINT8_MAX) return;
|
|
||||||
|
|
||||||
byte k = 0;
|
|
||||||
uint8_t sendBuffer[17];
|
|
||||||
sendBuffer[0] = 0x40;
|
|
||||||
|
|
||||||
// Calculate the colum offset
|
|
||||||
uint8_t minBoundXp2H = (minBoundX + 2) & 0x0F;
|
|
||||||
uint8_t minBoundXp2L = 0x10 | ((minBoundX + 2) >> 4 );
|
|
||||||
|
|
||||||
brzo_i2c_start_transaction(this->_address, BRZO_I2C_SPEED);
|
|
||||||
|
|
||||||
for (y = minBoundY; y <= maxBoundY; y++) {
|
|
||||||
sendCommand(0xB0 + y);
|
|
||||||
sendCommand(minBoundXp2H);
|
|
||||||
sendCommand(minBoundXp2L);
|
|
||||||
for (x = minBoundX; x <= maxBoundX; x++) {
|
|
||||||
k++;
|
|
||||||
sendBuffer[k] = buffer[x + y * displayWidth];
|
|
||||||
if (k == 16) {
|
|
||||||
brzo_i2c_write(sendBuffer, 17, true);
|
|
||||||
k = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (k != 0) {
|
|
||||||
brzo_i2c_write(sendBuffer, k + 1, true);
|
|
||||||
k = 0;
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
if (k != 0) {
|
|
||||||
brzo_i2c_write(sendBuffer, k + 1, true);
|
|
||||||
}
|
|
||||||
brzo_i2c_end_transaction();
|
|
||||||
#else
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
inline void sendCommand(uint8_t com) __attribute__((always_inline)){
|
|
||||||
uint8_t command[2] = {0x80 /* command mode */, com};
|
|
||||||
brzo_i2c_start_transaction(_address, BRZO_I2C_SPEED);
|
|
||||||
brzo_i2c_write(command, 2, true);
|
|
||||||
brzo_i2c_end_transaction();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,132 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SH1106Spi_h
|
|
||||||
#define SH1106Spi_h
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
#include <SPI.h>
|
|
||||||
|
|
||||||
class SH1106Spi : public OLEDDisplay {
|
|
||||||
private:
|
|
||||||
uint8_t _rst;
|
|
||||||
uint8_t _dc;
|
|
||||||
|
|
||||||
public:
|
|
||||||
SH1106Spi(uint8_t _rst, uint8_t _dc, uint8_t _cs, OLEDDISPLAY_GEOMETRY g = GEOMETRY_128_64) {
|
|
||||||
setGeometry(g);
|
|
||||||
|
|
||||||
this->_rst = _rst;
|
|
||||||
this->_dc = _dc;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool connect(){
|
|
||||||
pinMode(_dc, OUTPUT);
|
|
||||||
pinMode(_rst, OUTPUT);
|
|
||||||
|
|
||||||
SPI.begin ();
|
|
||||||
SPI.setClockDivider (SPI_CLOCK_DIV2);
|
|
||||||
|
|
||||||
// Pulse Reset low for 10ms
|
|
||||||
digitalWrite(_rst, HIGH);
|
|
||||||
delay(1);
|
|
||||||
digitalWrite(_rst, LOW);
|
|
||||||
delay(10);
|
|
||||||
digitalWrite(_rst, HIGH);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void display(void) {
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t minBoundY = UINT8_MAX;
|
|
||||||
uint8_t maxBoundY = 0;
|
|
||||||
|
|
||||||
uint8_t minBoundX = UINT8_MAX;
|
|
||||||
uint8_t maxBoundX = 0;
|
|
||||||
|
|
||||||
uint8_t x, y;
|
|
||||||
|
|
||||||
// Calculate the Y bounding box of changes
|
|
||||||
// and copy buffer[pos] to buffer_back[pos];
|
|
||||||
for (y = 0; y < (displayHeight / 8); y++) {
|
|
||||||
for (x = 0; x < displayWidth; x++) {
|
|
||||||
uint16_t pos = x + y * displayWidth;
|
|
||||||
if (buffer[pos] != buffer_back[pos]) {
|
|
||||||
minBoundY = _min(minBoundY, y);
|
|
||||||
maxBoundY = _max(maxBoundY, y);
|
|
||||||
minBoundX = _min(minBoundX, x);
|
|
||||||
maxBoundX = _max(maxBoundX, x);
|
|
||||||
}
|
|
||||||
buffer_back[pos] = buffer[pos];
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the minBoundY wasn't updated
|
|
||||||
// we can savely assume that buffer_back[pos] == buffer[pos]
|
|
||||||
// holdes true for all values of pos
|
|
||||||
if (minBoundY == UINT8_MAX) return;
|
|
||||||
|
|
||||||
// Calculate the colum offset
|
|
||||||
uint8_t minBoundXp2H = (minBoundX + 2) & 0x0F;
|
|
||||||
uint8_t minBoundXp2L = 0x10 | ((minBoundX + 2) >> 4 );
|
|
||||||
|
|
||||||
for (y = minBoundY; y <= maxBoundY; y++) {
|
|
||||||
sendCommand(0xB0 + y);
|
|
||||||
sendCommand(minBoundXp2H);
|
|
||||||
sendCommand(minBoundXp2L);
|
|
||||||
digitalWrite(_dc, HIGH); // data mode
|
|
||||||
for (x = minBoundX; x <= maxBoundX; x++) {
|
|
||||||
SPI.transfer(buffer[x + y * displayWidth]);
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
#else
|
|
||||||
for (uint8_t y=0; y<displayHeight/8; y++) {
|
|
||||||
sendCommand(0xB0 + y);
|
|
||||||
sendCommand(0x02);
|
|
||||||
sendCommand(0x10);
|
|
||||||
digitalWrite(_dc, HIGH); // data mode
|
|
||||||
for( uint8_t x=0; x < displayWidth; x++) {
|
|
||||||
SPI.transfer(buffer[x + y * displayWidth]);
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
inline void sendCommand(uint8_t com) __attribute__((always_inline)){
|
|
||||||
digitalWrite(_dc, LOW);
|
|
||||||
SPI.transfer(com);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,157 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SH1106Wire_h
|
|
||||||
#define SH1106Wire_h
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
#include <Wire.h>
|
|
||||||
|
|
||||||
#define SH1106_SET_PUMP_VOLTAGE 0X30
|
|
||||||
#define SH1106_SET_PUMP_MODE 0XAD
|
|
||||||
#define SH1106_PUMP_ON 0X8B
|
|
||||||
#define SH1106_PUMP_OFF 0X8A
|
|
||||||
//--------------------------------------
|
|
||||||
|
|
||||||
class SH1106Wire : public OLEDDisplay {
|
|
||||||
private:
|
|
||||||
uint8_t _address;
|
|
||||||
uint8_t _sda;
|
|
||||||
uint8_t _scl;
|
|
||||||
|
|
||||||
public:
|
|
||||||
SH1106Wire(uint8_t _address, uint8_t _sda, uint8_t _scl, OLEDDISPLAY_GEOMETRY g = GEOMETRY_128_64) {
|
|
||||||
setGeometry(g);
|
|
||||||
|
|
||||||
this->_address = _address;
|
|
||||||
this->_sda = _sda;
|
|
||||||
this->_scl = _scl;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool connect() {
|
|
||||||
Wire.begin(this->_sda, this->_scl);
|
|
||||||
// Let's use ~700khz if ESP8266 is in 160Mhz mode
|
|
||||||
// this will be limited to ~400khz if the ESP8266 in 80Mhz mode.
|
|
||||||
Wire.setClock(700000);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void display(void) {
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t minBoundY = UINT8_MAX;
|
|
||||||
uint8_t maxBoundY = 0;
|
|
||||||
|
|
||||||
uint8_t minBoundX = UINT8_MAX;
|
|
||||||
uint8_t maxBoundX = 0;
|
|
||||||
|
|
||||||
uint8_t x, y;
|
|
||||||
|
|
||||||
// Calculate the Y bounding box of changes
|
|
||||||
// and copy buffer[pos] to buffer_back[pos];
|
|
||||||
for (y = 0; y < (displayHeight / 8); y++) {
|
|
||||||
for (x = 0; x < displayWidth; x++) {
|
|
||||||
uint16_t pos = x + y * displayWidth;
|
|
||||||
if (buffer[pos] != buffer_back[pos]) {
|
|
||||||
minBoundY = _min(minBoundY, y);
|
|
||||||
maxBoundY = _max(maxBoundY, y);
|
|
||||||
minBoundX = _min(minBoundX, x);
|
|
||||||
maxBoundX = _max(maxBoundX, x);
|
|
||||||
}
|
|
||||||
buffer_back[pos] = buffer[pos];
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the minBoundY wasn't updated
|
|
||||||
// we can savely assume that buffer_back[pos] == buffer[pos]
|
|
||||||
// holdes true for all values of pos
|
|
||||||
if (minBoundY == UINT8_MAX) return;
|
|
||||||
|
|
||||||
// Calculate the colum offset
|
|
||||||
uint8_t minBoundXp2H = (minBoundX + 2) & 0x0F;
|
|
||||||
uint8_t minBoundXp2L = 0x10 | ((minBoundX + 2) >> 4 );
|
|
||||||
|
|
||||||
byte k = 0;
|
|
||||||
for (y = minBoundY; y <= maxBoundY; y++) {
|
|
||||||
sendCommand(0xB0 + y);
|
|
||||||
sendCommand(minBoundXp2H);
|
|
||||||
sendCommand(minBoundXp2L);
|
|
||||||
for (x = minBoundX; x <= maxBoundX; x++) {
|
|
||||||
if (k == 0) {
|
|
||||||
Wire.beginTransmission(_address);
|
|
||||||
Wire.write(0x40);
|
|
||||||
}
|
|
||||||
Wire.write(buffer[x + y * displayWidth]);
|
|
||||||
k++;
|
|
||||||
if (k == 16) {
|
|
||||||
Wire.endTransmission();
|
|
||||||
k = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (k != 0) {
|
|
||||||
Wire.endTransmission();
|
|
||||||
k = 0;
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (k != 0) {
|
|
||||||
Wire.endTransmission();
|
|
||||||
}
|
|
||||||
#else
|
|
||||||
uint8_t * p = &buffer[0];
|
|
||||||
for (uint8_t y=0; y<8; y++) {
|
|
||||||
sendCommand(0xB0+y);
|
|
||||||
sendCommand(0x02);
|
|
||||||
sendCommand(0x10);
|
|
||||||
for( uint8_t x=0; x<8; x++) {
|
|
||||||
Wire.beginTransmission(_address);
|
|
||||||
Wire.write(0x40);
|
|
||||||
for (uint8_t k = 0; k < 16; k++) {
|
|
||||||
Wire.write(*p++);
|
|
||||||
}
|
|
||||||
Wire.endTransmission();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
inline void sendCommand(uint8_t command) __attribute__((always_inline)){
|
|
||||||
Wire.beginTransmission(_address);
|
|
||||||
Wire.write(0x80);
|
|
||||||
Wire.write(command);
|
|
||||||
Wire.endTransmission();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,39 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SSD1306_h
|
|
||||||
#define SSD1306_h
|
|
||||||
#include "SSD1306Wire.h"
|
|
||||||
|
|
||||||
// For legacy support make SSD1306 an alias for SSD1306
|
|
||||||
typedef SSD1306Wire SSD1306;
|
|
||||||
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,159 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SSD1306Brzo_h
|
|
||||||
#define SSD1306Brzo_h
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
#include <brzo_i2c.h>
|
|
||||||
|
|
||||||
#if F_CPU == 160000000L
|
|
||||||
#define BRZO_I2C_SPEED 1000
|
|
||||||
#else
|
|
||||||
#define BRZO_I2C_SPEED 800
|
|
||||||
#endif
|
|
||||||
|
|
||||||
class SSD1306Brzo : public OLEDDisplay {
|
|
||||||
private:
|
|
||||||
uint8_t _address;
|
|
||||||
uint8_t _sda;
|
|
||||||
uint8_t _scl;
|
|
||||||
|
|
||||||
public:
|
|
||||||
SSD1306Brzo(uint8_t _address, uint8_t _sda, uint8_t _scl, OLEDDISPLAY_GEOMETRY g = GEOMETRY_128_64) {
|
|
||||||
setGeometry(g);
|
|
||||||
|
|
||||||
this->_address = _address;
|
|
||||||
this->_sda = _sda;
|
|
||||||
this->_scl = _scl;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool connect(){
|
|
||||||
brzo_i2c_setup(_sda, _scl, 0);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void display(void) {
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t minBoundY = UINT8_MAX;
|
|
||||||
uint8_t maxBoundY = 0;
|
|
||||||
|
|
||||||
uint8_t minBoundX = UINT8_MAX;
|
|
||||||
uint8_t maxBoundX = 0;
|
|
||||||
|
|
||||||
uint8_t x, y;
|
|
||||||
|
|
||||||
// Calculate the Y bounding box of changes
|
|
||||||
// and copy buffer[pos] to buffer_back[pos];
|
|
||||||
for (y = 0; y < (displayHeight / 8); y++) {
|
|
||||||
for (x = 0; x < displayWidth; x++) {
|
|
||||||
uint16_t pos = x + y * displayWidth;
|
|
||||||
if (buffer[pos] != buffer_back[pos]) {
|
|
||||||
minBoundY = _min(minBoundY, y);
|
|
||||||
maxBoundY = _max(maxBoundY, y);
|
|
||||||
minBoundX = _min(minBoundX, x);
|
|
||||||
maxBoundX = _max(maxBoundX, x);
|
|
||||||
}
|
|
||||||
buffer_back[pos] = buffer[pos];
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the minBoundY wasn't updated
|
|
||||||
// we can savely assume that buffer_back[pos] == buffer[pos]
|
|
||||||
// holdes true for all values of pos
|
|
||||||
if (minBoundY == UINT8_MAX) return;
|
|
||||||
|
|
||||||
sendCommand(COLUMNADDR);
|
|
||||||
sendCommand(minBoundX);
|
|
||||||
sendCommand(maxBoundX);
|
|
||||||
|
|
||||||
sendCommand(PAGEADDR);
|
|
||||||
sendCommand(minBoundY);
|
|
||||||
sendCommand(maxBoundY);
|
|
||||||
|
|
||||||
byte k = 0;
|
|
||||||
uint8_t sendBuffer[17];
|
|
||||||
sendBuffer[0] = 0x40;
|
|
||||||
brzo_i2c_start_transaction(this->_address, BRZO_I2C_SPEED);
|
|
||||||
for (y = minBoundY; y <= maxBoundY; y++) {
|
|
||||||
for (x = minBoundX; x <= maxBoundX; x++) {
|
|
||||||
k++;
|
|
||||||
sendBuffer[k] = buffer[x + y * displayWidth];
|
|
||||||
if (k == 16) {
|
|
||||||
brzo_i2c_write(sendBuffer, 17, true);
|
|
||||||
k = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
brzo_i2c_write(sendBuffer, k + 1, true);
|
|
||||||
brzo_i2c_end_transaction();
|
|
||||||
#else
|
|
||||||
// No double buffering
|
|
||||||
sendCommand(COLUMNADDR);
|
|
||||||
sendCommand(0x0);
|
|
||||||
sendCommand(0x7F);
|
|
||||||
|
|
||||||
sendCommand(PAGEADDR);
|
|
||||||
sendCommand(0x0);
|
|
||||||
|
|
||||||
if (geometry == GEOMETRY_128_64) {
|
|
||||||
sendCommand(0x7);
|
|
||||||
} else if (geometry == GEOMETRY_128_32) {
|
|
||||||
sendCommand(0x3);
|
|
||||||
}
|
|
||||||
|
|
||||||
uint8_t sendBuffer[17];
|
|
||||||
sendBuffer[0] = 0x40;
|
|
||||||
brzo_i2c_start_transaction(this->_address, BRZO_I2C_SPEED);
|
|
||||||
for (uint16_t i=0; i<displayBufferSize; i++) {
|
|
||||||
for (uint8_t x=1; x<17; x++) {
|
|
||||||
sendBuffer[x] = buffer[i];
|
|
||||||
i++;
|
|
||||||
}
|
|
||||||
i--;
|
|
||||||
brzo_i2c_write(sendBuffer, 17, true);
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
brzo_i2c_end_transaction();
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
inline void sendCommand(uint8_t com) __attribute__((always_inline)){
|
|
||||||
uint8_t command[2] = {0x80 /* command mode */, com};
|
|
||||||
brzo_i2c_start_transaction(_address, BRZO_I2C_SPEED);
|
|
||||||
brzo_i2c_write(command, 2, true);
|
|
||||||
brzo_i2c_end_transaction();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,160 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SSD1306Spi_h
|
|
||||||
#define SSD1306Spi_h
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
#include <SPI.h>
|
|
||||||
|
|
||||||
#if F_CPU == 160000000L
|
|
||||||
#define BRZO_I2C_SPEED 1000
|
|
||||||
#else
|
|
||||||
#define BRZO_I2C_SPEED 800
|
|
||||||
#endif
|
|
||||||
|
|
||||||
class SSD1306Spi : public OLEDDisplay {
|
|
||||||
private:
|
|
||||||
uint8_t _rst;
|
|
||||||
uint8_t _dc;
|
|
||||||
uint8_t _cs;
|
|
||||||
|
|
||||||
public:
|
|
||||||
SSD1306Spi(uint8_t _rst, uint8_t _dc, uint8_t _cs, OLEDDISPLAY_GEOMETRY g = GEOMETRY_128_64) {
|
|
||||||
setGeometry(g);
|
|
||||||
|
|
||||||
this->_rst = _rst;
|
|
||||||
this->_dc = _dc;
|
|
||||||
this->_cs = _cs;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool connect(){
|
|
||||||
pinMode(_dc, OUTPUT);
|
|
||||||
pinMode(_cs, OUTPUT);
|
|
||||||
pinMode(_rst, OUTPUT);
|
|
||||||
|
|
||||||
SPI.begin ();
|
|
||||||
SPI.setClockDivider (SPI_CLOCK_DIV2);
|
|
||||||
|
|
||||||
// Pulse Reset low for 10ms
|
|
||||||
digitalWrite(_rst, HIGH);
|
|
||||||
delay(1);
|
|
||||||
digitalWrite(_rst, LOW);
|
|
||||||
delay(10);
|
|
||||||
digitalWrite(_rst, HIGH);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void display(void) {
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t minBoundY = UINT8_MAX;
|
|
||||||
uint8_t maxBoundY = 0;
|
|
||||||
|
|
||||||
uint8_t minBoundX = UINT8_MAX;
|
|
||||||
uint8_t maxBoundX = 0;
|
|
||||||
|
|
||||||
uint8_t x, y;
|
|
||||||
|
|
||||||
// Calculate the Y bounding box of changes
|
|
||||||
// and copy buffer[pos] to buffer_back[pos];
|
|
||||||
for (y = 0; y < (displayHeight / 8); y++) {
|
|
||||||
for (x = 0; x < displayWidth; x++) {
|
|
||||||
uint16_t pos = x + y * displayWidth;
|
|
||||||
if (buffer[pos] != buffer_back[pos]) {
|
|
||||||
minBoundY = _min(minBoundY, y);
|
|
||||||
maxBoundY = _max(maxBoundY, y);
|
|
||||||
minBoundX = _min(minBoundX, x);
|
|
||||||
maxBoundX = _max(maxBoundX, x);
|
|
||||||
}
|
|
||||||
buffer_back[pos] = buffer[pos];
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the minBoundY wasn't updated
|
|
||||||
// we can savely assume that buffer_back[pos] == buffer[pos]
|
|
||||||
// holdes true for all values of pos
|
|
||||||
if (minBoundY == UINT8_MAX) return;
|
|
||||||
|
|
||||||
sendCommand(COLUMNADDR);
|
|
||||||
sendCommand(minBoundX);
|
|
||||||
sendCommand(maxBoundX);
|
|
||||||
|
|
||||||
sendCommand(PAGEADDR);
|
|
||||||
sendCommand(minBoundY);
|
|
||||||
sendCommand(maxBoundY);
|
|
||||||
|
|
||||||
digitalWrite(_cs, HIGH);
|
|
||||||
digitalWrite(_dc, HIGH); // data mode
|
|
||||||
digitalWrite(_cs, LOW);
|
|
||||||
for (y = minBoundY; y <= maxBoundY; y++) {
|
|
||||||
for (x = minBoundX; x <= maxBoundX; x++) {
|
|
||||||
SPI.transfer(buffer[x + y * displayWidth]);
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
digitalWrite(_cs, HIGH);
|
|
||||||
#else
|
|
||||||
// No double buffering
|
|
||||||
sendCommand(COLUMNADDR);
|
|
||||||
sendCommand(0x0);
|
|
||||||
sendCommand(0x7F);
|
|
||||||
|
|
||||||
sendCommand(PAGEADDR);
|
|
||||||
sendCommand(0x0);
|
|
||||||
|
|
||||||
if (geometry == GEOMETRY_128_64) {
|
|
||||||
sendCommand(0x7);
|
|
||||||
} else if (geometry == GEOMETRY_128_32) {
|
|
||||||
sendCommand(0x3);
|
|
||||||
}
|
|
||||||
|
|
||||||
digitalWrite(_cs, HIGH);
|
|
||||||
digitalWrite(_dc, HIGH); // data mode
|
|
||||||
digitalWrite(_cs, LOW);
|
|
||||||
for (uint16_t i=0; i<displayBufferSize; i++) {
|
|
||||||
SPI.transfer(buffer[i]);
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
digitalWrite(_cs, HIGH);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
inline void sendCommand(uint8_t com) __attribute__((always_inline)){
|
|
||||||
digitalWrite(_cs, HIGH);
|
|
||||||
digitalWrite(_dc, LOW);
|
|
||||||
digitalWrite(_cs, LOW);
|
|
||||||
SPI.transfer(com);
|
|
||||||
digitalWrite(_cs, HIGH);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
@ -1,173 +0,0 @@
|
||||||
/**
|
|
||||||
* The MIT License (MIT)
|
|
||||||
*
|
|
||||||
* Copyright (c) 2018 by ThingPulse, Daniel Eichhorn
|
|
||||||
* Copyright (c) 2018 by Fabrice Weinberg
|
|
||||||
*
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* ThingPulse invests considerable time and money to develop these open source libraries.
|
|
||||||
* Please support us by buying our products (and not the clones) from
|
|
||||||
* https://thingpulse.com
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SSD1306Wire_h
|
|
||||||
#define SSD1306Wire_h
|
|
||||||
|
|
||||||
#include "OLEDDisplay.h"
|
|
||||||
#include <Wire.h>
|
|
||||||
|
|
||||||
class SSD1306Wire : public OLEDDisplay {
|
|
||||||
private:
|
|
||||||
uint8_t _address;
|
|
||||||
uint8_t _sda;
|
|
||||||
uint8_t _scl;
|
|
||||||
bool _doI2cAutoInit = false;
|
|
||||||
|
|
||||||
public:
|
|
||||||
SSD1306Wire(uint8_t _address, uint8_t _sda, uint8_t _scl, OLEDDISPLAY_GEOMETRY g = GEOMETRY_128_64) {
|
|
||||||
setGeometry(g);
|
|
||||||
|
|
||||||
this->_address = _address;
|
|
||||||
this->_sda = _sda;
|
|
||||||
this->_scl = _scl;
|
|
||||||
}
|
|
||||||
|
|
||||||
bool connect() {
|
|
||||||
Wire.begin(this->_sda, this->_scl);
|
|
||||||
// Let's use ~700khz if ESP8266 is in 160Mhz mode
|
|
||||||
// this will be limited to ~400khz if the ESP8266 in 80Mhz mode.
|
|
||||||
Wire.setClock(700000);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
void display(void) {
|
|
||||||
initI2cIfNeccesary();
|
|
||||||
const int x_offset = (128 - this->width()) / 2;
|
|
||||||
#ifdef OLEDDISPLAY_DOUBLE_BUFFER
|
|
||||||
uint8_t minBoundY = UINT8_MAX;
|
|
||||||
uint8_t maxBoundY = 0;
|
|
||||||
|
|
||||||
uint8_t minBoundX = UINT8_MAX;
|
|
||||||
uint8_t maxBoundX = 0;
|
|
||||||
uint8_t x, y;
|
|
||||||
|
|
||||||
// Calculate the Y bounding box of changes
|
|
||||||
// and copy buffer[pos] to buffer_back[pos];
|
|
||||||
for (y = 0; y < (this->height() / 8); y++) {
|
|
||||||
for (x = 0; x < this->width(); x++) {
|
|
||||||
uint16_t pos = x + y * this->width();
|
|
||||||
if (buffer[pos] != buffer_back[pos]) {
|
|
||||||
minBoundY = _min(minBoundY, y);
|
|
||||||
maxBoundY = _max(maxBoundY, y);
|
|
||||||
minBoundX = _min(minBoundX, x);
|
|
||||||
maxBoundX = _max(maxBoundX, x);
|
|
||||||
}
|
|
||||||
buffer_back[pos] = buffer[pos];
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the minBoundY wasn't updated
|
|
||||||
// we can savely assume that buffer_back[pos] == buffer[pos]
|
|
||||||
// holdes true for all values of pos
|
|
||||||
|
|
||||||
if (minBoundY == UINT8_MAX) return;
|
|
||||||
|
|
||||||
sendCommand(COLUMNADDR);
|
|
||||||
sendCommand(x_offset + minBoundX);
|
|
||||||
sendCommand(x_offset + maxBoundX);
|
|
||||||
|
|
||||||
sendCommand(PAGEADDR);
|
|
||||||
sendCommand(minBoundY);
|
|
||||||
sendCommand(maxBoundY);
|
|
||||||
|
|
||||||
byte k = 0;
|
|
||||||
for (y = minBoundY; y <= maxBoundY; y++) {
|
|
||||||
for (x = minBoundX; x <= maxBoundX; x++) {
|
|
||||||
if (k == 0) {
|
|
||||||
Wire.beginTransmission(_address);
|
|
||||||
Wire.write(0x40);
|
|
||||||
}
|
|
||||||
|
|
||||||
Wire.write(buffer[x + y * this->width()]);
|
|
||||||
k++;
|
|
||||||
if (k == 16) {
|
|
||||||
Wire.endTransmission();
|
|
||||||
k = 0;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
yield();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (k != 0) {
|
|
||||||
Wire.endTransmission();
|
|
||||||
}
|
|
||||||
#else
|
|
||||||
|
|
||||||
sendCommand(COLUMNADDR);
|
|
||||||
sendCommand(x_offset);
|
|
||||||
sendCommand(x_offset + (this->width() - 1));
|
|
||||||
|
|
||||||
sendCommand(PAGEADDR);
|
|
||||||
sendCommand(0x0);
|
|
||||||
sendCommand((this->height() / 8) - 1);
|
|
||||||
|
|
||||||
if (geometry == GEOMETRY_128_64) {
|
|
||||||
sendCommand(0x7);
|
|
||||||
} else if (geometry == GEOMETRY_128_32) {
|
|
||||||
sendCommand(0x3);
|
|
||||||
}
|
|
||||||
|
|
||||||
for (uint16_t i=0; i < displayBufferSize; i++) {
|
|
||||||
Wire.beginTransmission(this->_address);
|
|
||||||
Wire.write(0x40);
|
|
||||||
for (uint8_t x = 0; x < 16; x++) {
|
|
||||||
Wire.write(buffer[i]);
|
|
||||||
i++;
|
|
||||||
}
|
|
||||||
i--;
|
|
||||||
Wire.endTransmission();
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
void setI2cAutoInit(bool doI2cAutoInit) {
|
|
||||||
_doI2cAutoInit = doI2cAutoInit;
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
inline void sendCommand(uint8_t command) __attribute__((always_inline)){
|
|
||||||
initI2cIfNeccesary();
|
|
||||||
Wire.beginTransmission(_address);
|
|
||||||
Wire.write(0x80);
|
|
||||||
Wire.write(command);
|
|
||||||
Wire.endTransmission();
|
|
||||||
}
|
|
||||||
|
|
||||||
void initI2cIfNeccesary() {
|
|
||||||
if (_doI2cAutoInit) {
|
|
||||||
Wire.begin(this->_sda, this->_scl);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
};
|
|
||||||
|
|
||||||
#endif
|
|
||||||
Loading…
Reference in New Issue