Miscellaneous C++ API module

Controller(controller_id_e_t id) explicit

#include <pros/misc.hpp>

Creates a controller object for the given controller id.

std::int32_t is_connected(void)

#include <pros/misc.hpp>

Checks if the controller is connected.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void status_display_controller(){
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  if(!master.is_connected()) {
       pros::lcd::print(0, "Main controller is not connected!");
  }
}

std::int32_t get_analog(controller_analog_e_t channel)

#include <pros/misc.hpp>

Gets the value of an analog channel (joystick) on a controller.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  while (true) {
    motor_move(1, master.get_analog(E_CONTROLLER_ANALOG_LEFT_Y));
    delay(2);
  }
}

std::int32_t get_battery_capacity(void)

#include <pros/misc.hpp>

Gets the battery capacity of the controller.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void initialize() {
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  printf("Battery Capacity: %d\n", master.get_battery_capacity());
}

std::int32_t get_battery_level(void)

#include <pros/misc.hpp>

Gets the battery level of the controller.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void initialize() {
     pros::Controller master(pros::E_CONTROLLER_MASTER);
  printf("Battery Level: %d\n", master.get_battery_level());
}

std::int32_t get_digital(controller_digital_e_t button)

#include <pros/misc.hpp>

Checks if a digital channel (button) on the controller is currently pressed.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  while (true) {
  if (master.get_digital(pros::E_CONTROLLER_DIGITAL_A)) {
    motor_set(1, 100);
  }
  else {
    motor_set(1, 0);
  }
    delay(2);
  }
}

std::int32_t get_digital_new_press(controller_digital_e_t button)

#include <pros/misc.hpp>

Returns a rising-edge case for a controller button press.

This function is not thread-safe. Multiple tasks polling a single button may return different results under the same circumstances, so only one task should call this function for any given button. E.g., Task A calls this function for buttons 1 and 2. Task B may call this function for button 3, but should not for buttons 1 or 2. A typical use-case for this function is to call inside opcontrol to detect new button presses, and not in any other tasks.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
    pros::Controller master(pros::E_CONTROLLER_MASTER);
    while (true) {
  if (master.get_digital_new_press(pros::E_CONTROLLER_DIGITAL_A)) {
    // Toggle pneumatics or other similar actions
  }

  delay(2);
  }
}

#include <pros/misc.hpp>

template<typename T>

T convert_args(T arg)

const char* convert_args(const std::string& arg)

#include <pros/misc.hpp>

#include <pros/misc.hpp>

template<typename... Params>

std::int32_t print(std::uint8_t line, std::uint8_t col, const char* fmt, Params... args)

Sets text to the controller LCD screen.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
  int count = 0;
     pros::Controller master(pros::E_CONTROLLER_MASTER);
  while (true) {
  if (!(count % 25)) {
    // Only print every 50ms, the controller text update rate is slow
    master.print(0, 0, "Counter: %d", count);
  }
    count++;
    delay(2);
  }
}

std::int32_t set_text(std::uint8_t line, std::uint8_t col, const char* str)

#include <pros/misc.hpp>

Sets text to the controller LCD screen.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
  int count = 0;
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  while (true) {
    if (!(count % 25)) {
      // Only print every 50ms, the controller text update rate is slow
      master.set_text(0, 0, "Example text");
    }
  count++;
  delay(2);
  }
}

std::int32_t set_text(std::uint8_t line, std::uint8_t col, const std::string& str)

#include <pros/misc.hpp>

std::int32_t clear_line(std::uint8_t line)

#include <pros/misc.hpp>

Clears an individual line of the controller screen.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  master.set_text(0, 0, "Example");
  delay(100);
  master.clear_line(0);
}

std::int32_t rumble(const char* rumble_pattern)

#include <pros/misc.hpp>

Rumble the controller.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
  int count = 0;
  pros::Controller master(pros::E_CONTROLLER_MASTER);
  while (true) {
  if (!(count % 25)) {
    // Only send every 50ms, the controller update rate is slow
    master.rumble(". - . -");
  }
  count++;
  delay(2);
  }
}

std::int32_t clear(void)

#include <pros/misc.hpp>

Clears all of the lines on the controller screen.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the controller port.

Example

void opcontrol() {
     pros::Controller master(pros::E_CONTROLLER_MASTER);
  master.set_text(0, 0, "Example");
  delay(100);
  master.clear();
}

double get_capacity(void)

#include <pros/misc.hpp>

Gets the current voltage of the battery, as reported by VEXos.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the battery port.

Example

void initialize() {
  printf("Battery Level: %.2f\n", get_capacity());
}

int32_t get_current(void)

#include <pros/misc.hpp>

Gets the current current of the battery in milliamps, as reported by VEXos.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the battery port.

Example

void initialize() {
  printf("Battery Current: %d\n", get_current());
}

double get_temperature(void)

#include <pros/misc.hpp>

Gets the current temperature of the battery, as reported by VEXos.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the battery port.

Example

void initialize() {
  printf("Battery's Temperature: %.2f\n", get_temperature());
}

int32_t get_voltage(void)

#include <pros/misc.hpp>

Gets the current capacity of the battery in millivolts, as reported by VEXos.

This function uses the following values of errno when an error state is reached: EACCES - Another resource is currently trying to access the battery port.

Example

void initialize() {
  printf("Battery's Voltage: %d\n", get_voltage());
}

controller_id_e_t _id

#include <pros/misc.hpp>