Pokitto::Core Class Reference

#include <PokittoCore.h>

Public Member Functions

 Core ()
 

Static Public Member Functions

static void begin ()
 
static void init ()
 
static void init (uint8_t)
 
static bool isRunning ()
 
static void quit ()
 
static void initDisplay ()
 
static void initRandom ()
 
static void initGPIO ()
 
static void initLCD ()
 
static void initAudio ()
 
static void initBacklight ()
 
static void initClock ()
 
static uint32_t getTime ()
 
static void wait (uint16_t)
 
static void showLogo ()
 
static void showWarning ()
 
static void setVolLimit ()
 
static void initButtons ()
 
static void pollButtons ()
 
static uint8_t leftBtn ()
 
static uint8_t rightBtn ()
 
static uint8_t upBtn ()
 
static uint8_t downBtn ()
 
static uint8_t aBtn ()
 
static uint8_t bBtn ()
 
static uint8_t cBtn ()
 
static uint8_t leftHeld ()
 
static uint8_t rightHeld ()
 
static uint8_t upHeld ()
 
static uint8_t downHeld ()
 
static uint8_t aHeld ()
 
static uint8_t bHeld ()
 
static uint8_t cHeld ()
 
static uint8_t leftReleased ()
 
static uint8_t rightReleased ()
 
static uint8_t upReleased ()
 
static uint8_t downReleased ()
 
static uint8_t aReleased ()
 
static uint8_t bReleased ()
 
static uint8_t cReleased ()
 
static uint8_t ampIsOn ()
 
static void ampEnable (uint8_t)
 
static void readSettings ()
 
static void titleScreen (const char *name, const uint8_t *logo)
 
static void titleScreen (const char *name)
 
static void titleScreen (const uint8_t *logo)
 
static void titleScreen ()
 
static bool update (bool useDirectMode=false)
 
static int8_t menu (const char *const *items, uint8_t length)
 
static char * filemenu (char *)
 
static char * filemenu ()
 
static void keyboard (char *text, uint8_t length)
 
static void popup (const char *text, uint8_t duration)
 
static void setFrameRate (uint8_t fps)
 
static void pickRandomSeed ()
 
static uint8_t getCpuLoad ()
 
static uint16_t getFreeRam ()
 
static bool collidePointRect (int16_t x1, int16_t y1, int16_t x2, int16_t y2, int16_t w, int16_t h)
 
static bool collideRectRect (int16_t x1, int16_t y1, int16_t w1, int16_t h1, int16_t x2, int16_t y2, int16_t w2, int16_t h2)
 
static bool collideBitmapBitmap (int16_t x1, int16_t y1, const uint8_t *b1, int16_t x2, int16_t y2, const uint8_t *b2)
 
static void drawvolbar (int, int, int, bool)
 
static void askLoader ()
 
static void jumpToLoader ()
 

Static Public Attributes

static Backlight backlight
 
static Buttons buttons
 
static Battery battery
 
static Sound sound
 
static Display display
 
static uint8_t soundbyte
 
static uint32_t frameCount
 
static uint8_t volbar_visible =0
 

Detailed Description

Core class. The Core class is a class consisting of static data and methods. It handles the lowlevel hardware functions of the Pokitto. It is declared as static to prevent several instances running at same time. Example:

// A simple "Hello World!" program with Pokitto
#include "Pokitto.h"
int main() {
myApp.begin(); // This starts up the console (the display, buttons etc.)
while(myApp.isRunning()) {
if(myApp.Update()) {
myApp.display.print("Hello World!");
}
}
}

Constructor & Destructor Documentation

◆ Core()

Core::Core ( )

Create a Core runtime instance

Member Function Documentation

◆ begin()

void Core::begin ( )
static

Initialize runtime (use this one)

◆ getTime()

static uint32_t Pokitto::Core::getTime ( )
static

Get value of time elapsed during program in milliseconds

◆ init() [1/2]

void Core::init ( )
static

Initialize runtime (deprecated, avoid)

◆ init() [2/2]

void Core::init ( uint8_t  switches)
static

Initialize runtime with options (deprecated, avoid)

◆ initAudio()

static void Pokitto::Core::initAudio ( )
static

Initialize Audio

◆ initBacklight()

static void Pokitto::Core::initBacklight ( )
static

Initialize backlight

◆ initClock()

static void Pokitto::Core::initClock ( )
static

Initialize runtime clock

◆ initDisplay()

void Core::initDisplay ( )
static

Initialize display

◆ initGPIO()

static void Pokitto::Core::initGPIO ( )
static

Initialize GPIO

◆ initLCD()

static void Pokitto::Core::initLCD ( )
static

Initialize LCD

◆ initRandom()

static void Pokitto::Core::initRandom ( )
static

Initialize random generator

◆ isRunning()

bool Core::isRunning ( )
static

Return run state (1 = running, 0 = shutting down)

◆ quit()

static void Pokitto::Core::quit ( )
static

Stop running

◆ showLogo()

void Core::showLogo ( )
static

Display Pokitto logo

POKITTO CLEAN

POKITTO FADE IN

POKITTO WAIT

◆ wait()

static void Pokitto::Core::wait ( uint16_t  )
static

Wait for n milliseconds

Member Data Documentation

◆ backlight

Backlight Core::backlight
static

Backlight component of the Core runtime

Components

◆ battery

Battery Core::battery
static

Battery component of the Core runtime

◆ buttons

Buttons Core::buttons
static

Buttons component of the Core runtime

◆ display

Display Core::display
static

Display component of the Core runtime

◆ sound

Sound Pokitto::Core::sound
static

Sound component of the Core runtime


The documentation for this class was generated from the following files: