VEX Link C API module

uint32_t link_init(uint8_t port, const char* link_id, link_type_e_t type)

#include <pros/link.h>

Initializes a link on a radio port, with an indicated type.

There might be a 1 to 2 second delay from when this function is called to when the link is initializes. PROS currently only supports the use of one radio per brain.

Example

#define LINK_TRANSMITTER_PORT 1
#define LINK_ID "ROBOT1"

void initialize() {
  link_init(LINK_TRANSMITTER_PORT, LINK_ID, E_LINK_TRANSMITTER);
}

uint32_t link_init_override(uint8_t port, const char* link_id, link_type_e_t type)

#include <pros/link.h>

Initializes a link on a radio port, with an indicated type and the ability for vexlink to override the controller radio.

There might be a 1 to 2 second delay from when this function is called to when the link is initializes. PROS currently only supports the use of one radio per brain.

Example

#define LINK_PORT 1
#define LINK_ID "ROBOT1"

void initialize() {
  link_init(LINK_PORT, LINK_ID, E_LINK_TRANSMITTER);
  link_init_override(LINK_PORT, LINK_ID, E_LINK_TRANSMITTER);
}

bool link_connected(uint8_t port)

#include <pros/link.h>

Checks if a radio link on a port is active or not.

Example

#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
  while (true) {
    if (link_connected(LINK_TRANSMITTER_PORT)) {
      screen_print(TEXT_MEDIUM, 1, "Link connected!");
    }
  delay(20);
  }
}

uint32_t link_raw_receivable_size(uint8_t port)

#include <pros/link.h>

Returns the bytes of data available to be read.

Example

#define LINK_RECIVER_PORT 1

void opcontrol() {
  while (true) {
    uint32_t receiveable_size = link_raw_receivable_size(LINK_RECIVER_PORT);
    screen_print(TEXT_MEDIUM, 1, "link_raw_receiveable_size: %d", receiveable_size);
    delay(20);
  }
}

uint32_t link_raw_transmittable_size(uint8_t port)

#include <pros/link.h>

Returns the bytes of data available in transmission buffer.

Example

#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
  while (true) {
    uint32_t transmittable_size = link_raw_transmittable_size(LINK_TRANSMITTER_PORT);
    screen_print(TEXT_MEDIUM, 1, "link_raw_transmittable_size: %d", transmittable_size);
    delay(20);
  }
}

uint32_t link_transmit_raw(uint8_t port, void* data, uint16_t data_size)

#include <pros/link.h>

Send raw serial data through vexlink.

Example

#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
  while (true) {
    char* data = "Hello!";
    link_transmit_raw(LINK_TRANSMITTER_PORT, (void*)data, sizeof(*data) * sizeof(data));
    delay(20);
  }
}

uint32_t link_receive_raw(uint8_t port, void* dest, uint16_t data_size)

#include <pros/link.h>

Receive raw serial data through vexlink.

Example

#define LINK_RECIVER_PORT 1

void opcontrol() {
  while (true) {
    char* result;
    char* expected = "Hello!";
    link_receive_raw(LINK_RECIVER_PORT, (void*)result, sizeof(*expected) * sizeof(expected));
    delay(20);
  }
}

uint32_t link_transmit(uint8_t port, void* data, uint16_t data_size)

#include <pros/link.h>

Send packeted message through vexlink, with a checksum and start byte.

Example

#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
  while (true) {
    char* data = "Hello!";
    link_transmit(LINK_TRANSMITTER_PORT, (void*)data, sizeof(*data) * sizeof(data));
    delay(20);
  }
}

uint32_t link_receive(uint8_t port, void* dest, uint16_t data_size)

#include <pros/link.h>

Receive packeted message through vexlink, with a checksum and start byte.

Example

#define LINK_RECIVER_PORT 1

void opcontrol() {
  while (true) {
    char* result;
    char* expected = "Hello!";
    link_receive(LINK_RECIVER_PORT, (void*)result, sizeof(*expected) * sizeof(expected));
    delay(20);
  }
}

uint32_t link_clear_receive_buf(uint8_t port)

#include <pros/link.h>

Clear the receive buffer of the link, and discarding the data.

Example

#define LINK_TRANSMITTER_PORT 1

void opcontrol() {
  while (true) {
    char* data = "Hello!";
    link_transmit(LINK_TRANSMITTER_PORT, (void*)data, sizeof(*data) * sizeof(data));
    link_clear_receive_buf(LINK_TRANSMITTER_PORT);
    delay(20);
  }
}

enum link_type_e

#include <pros/link.h>

#define LINK_BUFFER_SIZE

#include <pros/link.h>

The maximum size of a link buffer.