V2 Apps

Details on Version 2 Applications

#ifndef MYAPP_H //Must Include Section:
#define MYAPP_H
#include "App.h"
extern bool inTransition;extern bool pauseRender;extern bool watchSwipe;extern bool otherSwipe;extern UWORD* BlackImage; //Other
extern std::list appPermissions;extern std::string appTitle;extern std::string appDesc;extern std::string appPub;extern std::string appOthInfo;extern float appVersion;extern int appDatePub;extern std::string appHash; //Config
extern uint16_t deviceMainColorTheme;extern uint16_t deviceSecondColorTheme;extern uint16_t deviceThirdColorTheme; // Device Customization Settings [Optional]

//Extra Libs
#include 

// Settings:
extern bool systemDisplayUpdates; // Default = True

class myApp : public App {
public:
  void sysConfig() override {                    // Triggers randomly when device needs info
    appPermissions = {};                                   //Permissions app needs in order to warn user about apps
    //Specify App Settings here

    appTitle = "Test App";                                 // Title
    appDesc = "Testing Reasons";                           // Description
    appPub = "Kaiyo";                                      // Publisher
    appOthInfo = "Website: kaiyo.dev";                     // Other Info
    appVersion = 1.0;                                      // Version
    appDatePub = 1716084259;                               // Unix Timestamp
    appHash = "6017612eb90d5b39b27a12e756a61be852971e8e";  // More Unique Identifier (SHA1)
  }

  void launch() override {  // Triggers upon first time opening app
    // ...
  }

  void update() override {  // Triggers on each frame
    Paint_DrawRectangle(0, 0, 100, 100, RED, DOT_PIXEL_1X1, DRAW_FILL_FULL);
  }
};

#endif

bool systemDisplayUpdates; //Default = True

appTitle = "Test App";                                 // Title
appDesc = "Testing Reasons";                           // Description
appPub = "Kaiyo";                                      // Publisher
appOthInfo = "Website: kaiyo.dev";                     // Other Info
appVersion = 1.0;                                      // Version
appDatePub = 1716084259;                               // Unix Timestamp
appHash = "6017612eb90d5b39b27a12e756a61be852971e8e";  // More Unique Identifier (SHA1)

void launch() override {  // Triggers upon first time opening app
  // ...
}

void update() override {
  Paint_DrawRectangle(0, 0, 100, 100, RED, DOT_PIXEL_1X1, DRAW_FILL_FULL);
}

if (inTransition == false) {
  if (pauseRender == false) {
    LCD_1IN28_DisplayWindows(0, 0, 240, 240, BlackImage);
  }
}

void update() override {
  Paint_DrawRectangle(0, 0, 100, 100, RED, DOT_PIXEL_1X1, DRAW_FILL_FULL);

  if (inTransition == false) {
    if (pauseRender == false) {
      LCD_1IN28_DisplayWindows(0, 0, 240, 240, BlackImage);
    }
  }
}

In RP2040-Touch-LCD-1.28.ino include your app at the start of the code.

//Apps V1
#include "flappyBird.h"
#include "CountSteps.h"
//...

//Apps V2
#include "appVersTwo.h"
#include "appVersTwoTestTwo.h"
//...

#include "myApp.h" //ADD YOUR APP

Then find the following lines in setup

//Apps V1
apps["FindMyPhone"] = &findMyPhone;
apps["Alarms"] = &alarms;
//...

//Apps V2
apps["appVersTwo"] = &appV2;
appsV2["appVersTwo"] = new appVersTwo();
apps["appVersTwoTestTwo"] = &appV2;
appsV2["appVersTwoTestTwo"] = new appVersTwoTestTwo();
//...

and add your app

//Apps V1
apps["FindMyPhone"] = &findMyPhone;
apps["Alarms"] = &alarms;
//...

//Apps V2
apps["appVersTwo"] = &appV2;
appsV2["appVersTwo"] = new appVersTwo();
apps["appVersTwoTestTwo"] = &appV2;
appsV2["appVersTwoTestTwo"] = new appVersTwoTestTwo();
//...

apps["myApp"] = &appV2;
appsV2["myApp"] = new myApp();

Rectangle

void Paint_DrawRectangle(UWORD Xstart, UWORD Ystart, UWORD Xend, UWORD Yend, UWORD Color, DOT_PIXEL Line_width, DRAW_FILL Draw_Fill);

Rectangle Arguments

• UWORD Xstart, Ystart: Starting position of the rectangle.
• UWORD Xend, Yend: Ending position of the rectangle.
• UWORD Color: Color of the rectangle (e.g., RED, GREEN).
• DOT_PIXEL Line_width: Thickness of the rectangle's border.
• DRAW_FILL Draw_Fill: Specifies whether the rectangle is filled or empty.

Example

Paint_DrawRectangle(0, 0, 100, 100, RED, DOT_PIXEL_5X5, DRAW_FILL_EMPTY);

Transparent Rectangles

void Paint_DrawRectangleTrans(UWORD Xstart, UWORD Ystart, UWORD Xend, UWORD Yend, uint8_t transparency, DOT_PIXEL Line_width, DRAW_FILL Draw_Fill);

Transparent Rectangle Arguments

• UWORD Xstart, Ystart: Starting position of the rectangle.
• UWORD Xend, Yend: Ending position of the rectangle.
• uint8_t transparency: Transparency level (0 to 100).
• DOT_PIXEL Line_width: Thickness of the rectangle's border.
• DRAW_FILL Draw_Fill: Specifies whether the rectangle is filled or empty.

Transparency is a value from 0 to 100 and affects the shade or tint of what is below the rectangle.

Example

Paint_DrawRectangleTrans(0, 0, 100, 100, 50, DOT_PIXEL_1X1, DRAW_FILL_FULL);

Circle

void Paint_DrawCircle(UWORD X_Center, UWORD Y_Center, UWORD Radius, UWORD Color, DOT_PIXEL Line_width, DRAW_FILL Draw_Fill);

Circle Arguments

• UWORD X_Center, Y_Center: Center position of the circle.
• UWORD Radius: Radius of the circle.
• UWORD Color: Color of the circle (e.g., RED, GREEN).
• DOT_PIXEL Line_width: Thickness of the circle's border.
• DRAW_FILL Draw_Fill: Specifies whether the circle is filled or empty.

Drawing circles requires more CPU time compared to other shapes.

Example

Paint_DrawCircle(120, 120, 50, RED, DOT_PIXEL_1X1, DRAW_FILL_FULL);

Transparent Circles

void Paint_DrawCircleTrans(UWORD Xcenter, UWORD Ycenter, UWORD Radius, uint8_t transparency, DOT_PIXEL Line_width, DRAW_FILL Draw_Fill);

Transparent Circle Arguments

• UWORD Xcenter, Ycenter: Center position of the circle.
• UWORD Radius: Radius of the circle.
• uint8_t transparency: Transparency level (0 to 100).
• DOT_PIXEL Line_width: Thickness of the circle's border.
• DRAW_FILL Draw_Fill: Specifies whether the circle is filled or empty.

Line

void Paint_DrawLine(UWORD Xstart, UWORD Ystart, UWORD Xend, UWORD Yend, UWORD Color, DOT_PIXEL Line_width, LINE_STYLE Line_Style);

Line Arguments

• UWORD Xstart, Ystart: Starting position of the line.
• UWORD Xend, Yend: Ending position of the line.
• UWORD Color: Color of the line (e.g., RED, GREEN).
• DOT_PIXEL Line_width: Thickness of the line.
• LINE_STYLE Line_Style: Style of the line (e.g., LINE_STYLE_SOLID).

Example

Paint_DrawLine(120, 120, 240, 240, 0x009688, DOT_PIXEL_2X2, LINE_STYLE_SOLID);

Point

void Paint_DrawPoint(UWORD Xpoint, UWORD Ypoint, UWORD Color, DOT_PIXEL Dot_Pixel, DOT_STYLE Dot_FillWay);

Point Arguments

• UWORD Xpoint, Ypoint: Position of the point.
• UWORD Color: Color of the point (e.g., RED, GREEN).
• DOT_PIXEL Dot_Pixel: Size of the point.
• DOT_STYLE Dot_FillWay: Style of the point (e.g., filled or not filled).

Example

Paint_DrawPoint(50, 50, BLUE, DOT_PIXEL_3X3, DOT_STYLE_FILL);

Buttons

bool button(int x, int y, const char *text, sFONT *Font, UWORD Color_Foreground, UWORD Color_Background, int size);

Button Arguments

• int x, y: The position coordinates of the button.
• const char *text: The text displayed on the button.
• sFONT *Font: The font used for the button text.
• UWORD Color_Foreground: The color of the button text.
• UWORD Color_Background: The color of the button background.
• int size: The size of the button, where 0 represents small and 1 represents large (dynamic scaling will be available later).

Example

button(10, 20, "Click Me", &Font16, WHITE, BLUE, 1);

Checkboxes

bool checkBox(int x, int y, UWORD OutlineColor, UWORD XColor, std::string id, int size);

Checkbox Arguments

• int x, y: The position coordinates of the checkbox.
• UWORD OutlineColor: The color of the checkbox outline when unchecked.
• UWORD XColor: The color of the checkmark when the checkbox is checked.
• std::string id: A unique identifier for the checkbox.
• int size: The size of the checkbox.

Example

checkBox(30, 40, BLACK, GREEN, "checkbox1", 30);

Radio Groups

bool radio(int x, int y, UWORD OutlineColor, UWORD XColor, std::string id, int size, std::string group);

Radio Button Arguments

• int x, y: The position coordinates of the radio button.
• UWORD OutlineColor: The base color of the radio button when not selected.
• UWORD XColor: The color of the radio button when selected.
• std::string id: A unique identifier for the radio button.
• int size: The size of the radio button.
• std::string group: The group name to which the radio button belongs.

Example

radio(50, 60, RED, BLUE, "radio1", 30, "group1");

Sliders

int slider(int x, int y, UWORD OutlineColor, UWORD InsideColor, std::string id, int width, int height);

Slider Arguments

• int x, y: The position coordinates of the slider.
• UWORD OutlineColor: The base color of the slider.
• UWORD InsideColor: The color of the slider track that indicates progress.
• std::string id: A unique identifier for the slider.
• int width, height: The dimensions of the slider.

Example

slider(50, 150, GRAY, PURPLE, "slider1", 120, 20);

Switches

bool toggle(int x, int y, UWORD OutlineColor, UWORD ToggleColor, std::string id, int size);

Switches, also known as toggles, are used to represent on/off states.

Switch Arguments

• int x, y: The position coordinates of the switch.
• UWORD OutlineColor: The base color of the switch when it is off.
• UWORD ToggleColor: The color of the switch when it is on.
• std::string id: A unique identifier for the switch.
• int size: The size of the switch.

Example

toggle(50, 10, GRAY, BLUE, "switch1", 30);

Swipe

bool swipe(std::string dir, int thresh);

Returns whether or not the user swiped in a specified direction.

Swipe Arguments

• std::string dir: The direction of the swipe. Valid values are "up", "down", "left", or "right". It indicates the direction your finger moves towards.
• int thresh: The threshold value (0 to 240) that the user must swipe past to trigger the swipe event.

Example

if (swipe("down", 70)) {
  openApp("main", "UD", Touch_CTS816.y_point);
}

Scroll

std::list scrollFunction(int numberOfItems, std::string itemHeaders[], bool visible);

Manages a scroll bar for navigating through a list of items.

Scroll Arguments

• int numberOfItems: The number of items to scroll through. Only needed if itemHeaders is used.
• std::string itemHeaders[]: A list of names of items. Currently deprecated and may not function as expected, but intended for future use.
• bool visible: Whether or not to show the circular scroll bar.

Returned Values

The returned values are a list of integers including:

• scrollY: The scrollSlider value.
• scrolling: 0 or 1, indicating if the user is scrolling or not.
• hoverObject: Partially deprecated, but indicates the object the scroll wheel would be hovering over.

Example

std::list scrollValues = scrollFunction(10, itemHeaders, true);

Snack Bar

void snackBar(std::string text, UWORD BGC, UWORD TXCOLOR);

A snack bar is a small popup at the bottom of the screen displaying information.

Snack Bar Arguments

• std::string text: The message to display in the snack bar.
• UWORD BGC: The background color of the snack bar.
• UWORD TXCOLOR: The text color of the snack bar.

Example

snackBar("Operation Successful", WHITE, BLACK);

Rendering the Snack Bar

Note: V2 apps auto render snack bar if systemDisplayUpdates is true.

In your code in order to render the snackBar you must include

renderSnack();

Example

renderSnack();
if (inTransition == false) {
  if (pauseRender == false) {
    LCD_1IN28_DisplayWindows(0, 0, 240, 240, BlackImage);
  }
}

Open Another App

void openApp(std::string app, std::string dir, int start);

Opens another application with optional animation.

openApp Arguments

• std::string app: The name of the app to open.
• std::string dir: The direction of the animation. Leave empty ("") if no animation is needed. Valid directions are "UD" (Up to Down), "DU" (Down to Up), "LR" (Left to Right), "RL" (Right to Left), and "RAND" (random pixels).
• int start: The starting point for the animation. For "RL" and "LR", use 0 or 240 (from the edge) or Touch_CTS816.x_point (from the finger). For "DU" and "UD", use Touch_CTS816.y_point. If "RAND", use 0.

Note: Opening another app cannot be called in setup/startup of an App

Example

openApp("main", "RAND", 0);

Touch / Tap

Detects touch or tap events on the screen.

Touch/Tap Variables

• Touch_CTS816.x_point: The x-coordinate of the touch point.
• Touch_CTS816.y_point: The y-coordinate of the touch point.
• extern bool tap: A boolean variable that is set to true when a tap is detected.

Usage

Use these variables and the tap boolean to detect and respond to touch events. Here is an example:

if (tap) {
    int x = Touch_CTS816.x_point;
    int y = Touch_CTS816.y_point;
    // Handle the tap event at (x, y)
}

Keyboard

To access the keyboard, you need to open the keyboard app:

openApp("keyboard", "RAND", 0);

When the user presses enter, the keyboardData variable will change from an empty string ("") to the input data. The keyboardData is a std::string. After processing the data, it is recommended to reset keyboardData to "" to prevent potential looping issues.

Keyboard Variables

• std::string keyboardData: Stores the data entered by the user. Reset to "" after processing.
• std::string keyboardTyped: Stores what is currently typed by the user, Resets after pressing Return.

Include the following extern declarations if needed:

extern std::string keyboardData;
extern std::string keyboardTyped;

Usage Example

Use the keyboardData variable to handle keyboard input:

if (keyboardData != "") {
    // Process the data
    std::string input = keyboardData;
    // Reset keyboardData to prevent looping
    keyboardData = "";
}

Internet GET Request

std::string internet_get(std::string url);

This function sends an internet GET request to https://ptsv3.com and returns the response as a string.

GET Request Arguments

• url: A string representing the endpoint for the GET request. Obtain a unique "toilet" URL at ptsv3.com. The request URL will be formatted as https://ptsv3.com/t/<toilet>/, where another service must handle the requests.

Example

std::string data = internet_get("myToilet");

Internet POST Request

void internet_post(std::string toilet, std::string data);

This function sends an internet POST request to https://ptsv3.com.

POST Request Arguments

• toilet: A string representing the endpoint for the POST request. Obtain a unique "toilet" URL at ptsv3.com. The request URL will be formatted as https://ptsv3.com/t/<toilet>/, where another service must handle the requests.
• data: A string containing the data to be posted. The maximum amount varies but is generally limited.

Example

internet_post("myToilet", "DATA");

BTLE Disconnect

void btleDiscon();

This function disconnects the current BTLE connection from the connected device.

Example

btleDiscon();