ssd1306_generic.h

Go to the documentation of this file.

/*
    MIT License

    Copyright (c) 2016-2019, Alexey Dynda

    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.
*/
#ifndef _SSD1306_GENERIC_H_
#define _SSD1306_GENERIC_H_

#include "nano_gfx_types.h"

#ifdef __cplusplus
extern "C" {
#endif

//                 GENERIC GRAPH FUNCTIONS

#define SSD1306_MORE_CHARS_REQUIRED  0xffff

void         ssd1306_setPos(uint8_t x, uint8_t y);

void ssd1306_setCursor(lcdint_t x, lcdint_t y);

void ssd1306_setFixedFont(const uint8_t * progmemFont);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
void ssd1306_setFixedFont_oldStyle(const uint8_t * progmemFont);
#endif

void ssd1306_setFreeFont(const uint8_t * progmemFont);

void ssd1306_setSecondaryFont(const uint8_t * progmemUnicode);

void ssd1306_setFont6x8(const uint8_t * progmemFont) __attribute__ ((deprecated));

void ssd1306_getCharBitmap(uint16_t ch, SCharInfo *info);

void ssd1306_enableUtf8Mode(void);

void ssd1306_enableAsciiMode(void);

#ifndef DOXYGEN_SHOULD_SKIP_THIS

void ssd1306_setSquixFont(const uint8_t * progmemFont);

uint16_t ssd1306_unicode16FromUtf8(uint8_t ch);
#endif

lcduint_t ssd1306_getTextSize(const char *text, lcduint_t *height);


//                 HIGH-LEVEL GRAPH FUNCTIONS

typedef struct
{
    const char **items;
    uint8_t     count;
    uint8_t     selection;
    uint8_t     oldSelection;
    uint8_t     scrollPosition;
} SAppMenu;

void ssd1306_createMenu(SAppMenu *menu, const char **items, uint8_t count);

void ssd1306_showMenu(SAppMenu *menu);

void ssd1306_showMenu8(SAppMenu *menu);

void ssd1306_showMenu16(SAppMenu *menu);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
static inline void ssd1331_showMenu8(SAppMenu *menu)
{
    ssd1306_showMenu8(menu);
}
#endif

void ssd1306_updateMenu(SAppMenu *menu);

void ssd1306_updateMenu8(SAppMenu *menu);

void ssd1306_updateMenu16(SAppMenu *menu);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
static inline void ssd1331_updateMenu8(SAppMenu *menu)
{
    ssd1306_updateMenu8(menu);
}
#endif

uint8_t ssd1306_menuSelection(SAppMenu *menu);

void ssd1306_menuDown(SAppMenu *menu);

void ssd1306_menuUp(SAppMenu *menu);

void ssd1306_drawProgressBar(int8_t progress);

void ssd1306_drawProgressBar8(int8_t progress);

#ifdef __cplusplus
}
#endif

#endif // _SSD1306_GENERIC_H_