LLEMU C++ API module

#include <pros/llemu.hpp>

template<typename... Params>

bool print(std::int16_t line, const char* fmt, Params... args)

Displays a formatted string on the emulated three-button LCD screen.

This function uses the following values of errno when an error state is reached: ENXIO - The LCD has not been initialized. Call lcd_initialize() first. EINVAL - The line number specified is not in the range [0-7]

Example

#include "pros/llemu.hpp"

void initialize() {
  pros::lcd::initialize();
  pros::lcd::print(0, "My formatted text: %d!", 2);
}

bool is_initialized(void)

#include <liblvgl/include/liblvgl/llemu.hpp>

Checks whether the emulated three-button LCD has already been initialized.

Example

if (pros::lcd::is_initialized()) {
  pros::lcd::print("LLEMU!");
}
else {
  printf("Error: LLEMU is not initialized\n");
}

bool initialize(void)

#include <liblvgl/include/liblvgl/llemu.hpp>

Creates an emulation of the three-button, UART-based VEX LCD on the display.

Example

#include "pros/llemu.hpp"

void initialize() {
  if (pros::lcd::initialize()) {
    pros::lcd::print("LLEMU!"); 
  }
  else {
       printf("Error: LLEMU could not initailize\n");
  }
}

bool shutdown(void)

#include <liblvgl/include/liblvgl/llemu.hpp>

Turns off the Legacy LCD Emulator.

Calling this function will clear the entire display, and you will not be able to call any further LLEMU functions until another call to lcd_initialize.

This function uses the following values of errno when an error state is reached: ENXIO - The LCD has not been initialized. Call lcd_initialize() first.

Example

#include "pros/llemu.hpp"

void disabled() {
  pros::lcd::shutdown();
}

bool set_text(std::int16_t line, std::string text)

#include <liblvgl/include/liblvgl/llemu.hpp>

Displays a string on the emulated three-button LCD screen.

This function uses the following values of errno when an error state is reached: ENXIO - The LCD has not been initialized. Call lcd_initialize() first. EINVAL - The line number specified is not in the range [0-7]

Example

#include "pros/llemu.hpp"

void initialize() {
  pros::lcd::initialize();
  pros::lcd::set_text(0, "My custom LLEMU text!");
}

bool clear(void)

#include <liblvgl/include/liblvgl/llemu.hpp>

Clears the contents of the emulated three-button LCD screen.

This function uses the following values of errno when an error state is reached: ENXIO - The LCD has not been initialized. Call lcd_initialize() first. EINVAL - The line number specified is not in the range [0-7]

Example

#include "pros/llemu.hpp"

void initialize() {
  pros::lcd::initialize();
  pros::lcd::clear(); // Clear the LCD screen
}

bool clear_line(std::int16_t line)

#include <liblvgl/include/liblvgl/llemu.hpp>

Clears the contents of a line of the emulated three-button LCD screen.

This function uses the following values of errno when an error state is reached: ENXIO - The LCD has not been initialized. Call lcd_initialize() first. EINVAL - The line number specified is not in the range [0-7]

Example

#include "pros/llemu.hpp"

void initialize() {
  pros::lcd::initialize();
  pros::lcd::clear_line(0); // Clear line 0
}

void register_btn0_cb(lcd_btn_cb_fn_t cb)

#include <liblvgl/include/liblvgl/llemu.hpp>

Registers a callback function for the leftmost button.

When the leftmost button on the emulated three-button LCD is pressed, the user-provided callback function will be invoked.

Example

#include "pros/llemu.hpp"

void left_callback() {
  static int i = 0;
  
  pros::lcd::print(0, "Left button pressed %i times", i);
  i++
}

void initialize() {
  pros::lcd::initialize();
  pros::lcd::register_btn0_cb();
}

void register_btn1_cb(lcd_btn_cb_fn_t cb)

#include <liblvgl/include/liblvgl/llemu.hpp>

Registers a callback function for the center button.

When the center button on the emulated three-button LCD is pressed, the user-provided callback function will be invoked.

Example

#include "pros/llemu.hpp"

void center_callback() {
  static int i = 0;
  
  pros::lcd::print(0, "Center button pressed %i times", i);
  i++
}

void initialize() {
  pros::lcd::initialize();
  pros::lcd::register_btn1_cb();
}

void register_btn2_cb(lcd_btn_cb_fn_t cb)

#include <liblvgl/include/liblvgl/llemu.hpp>

Registers a callback function for the rightmost button.

When the rightmost button on the emulated three-button LCD is pressed, the user-provided callback function will be invoked.

Example

#include "pros/llemu.hpp"

void right_callback() {
  static int i = 0;
  
  pros::lcd::print(0, "Right button pressed %i times", i);
  i++
}

void initialize() {
  pros::lcd::initialize();
  pros::lcd::register_btn2_cb();
}

void set_text_align(Text_Align alignment)

#include <liblvgl/include/liblvgl/llemu.hpp>

Sets the alignment to use for subsequent calls that print text to a line.

Example

#include "pros/llemu.hpp"

void initialize() {
  pros::lcd::initialize();
  pros::lcd::set_alignment(pros::lcd::Text_Align::LEFT);
  pros::lcd::print(0, "Left Aligned Text");
  pros::lcd::set_alignment(pros::lcd::Text_Align::CENTER);
  pros::lcd::print(1, "Center Aligned Text");
  pros::lcd::set_alignment(pros::lcd::Text_Align::RIGHT);
  pros::lcd::print(2, "Right Aligned Text");
}

std::uint8_t read_buttons(void)

#include <liblvgl/include/liblvgl/llemu.hpp>

Gets the button status from the emulated three-button LCD.

The value returned is a 3-bit integer where 1 0 0 indicates the left button is pressed, 0 1 0 indicates the center button is pressed, and 0 0 1 indicates the right button is pressed. 0 is returned if no buttons are currently being pressed.

Note that this function is provided for legacy API compatibility purposes, with the caveat that the V5 touch screen does not actually support pressing multiple points on the screen at the same time.

Example

#include "pros/llemu.hpp"

void initialize() {
  pros::lcd::initialize();
}

void opcontrol() {
  while(true) {
    std::uint8_t state = pros::lcd::read_buttons();
    pros::lcd::print(0, "%d %d %d", 
      (state & LCD_BTN_LEFT) >> 2
      (state & LCD_BTN_CENTER) >> 1,
      (state & LCD_BTN_RIGHT) >> 0
    );
    
    pros::delay(10);
  }
}

enum class Text_Align

#include <liblvgl/include/liblvgl/llemu.hpp>

Represents how to align the text in the LCD.

typedef void(*)(void) lcd_btn_cb_fn_t

#include <pros/llemu.hpp>

#define LCD_BTN_LEFT

#include <pros/llemu.hpp>

#define LCD_BTN_CENTER

#include <pros/llemu.hpp>

#define LCD_BTN_RIGHT

#include <pros/llemu.hpp>