pros/link.h file

Contents

Contains prototypes for functions related to the robot to robot communications.

This file should not be modified by users, since it gets replaced whenever a kernel upgrade occurs.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Namespaces

namespace pros
LLEMU Conditional Include
namespace pros::c

Functions

uint32_t link_init(uint8_t port, const char* link_id, link_type_e_t type)
Initializes a link on a radio port, with an indicated type.
uint32_t link_init_override(uint8_t port, const char* link_id, link_type_e_t type)
Initializes a link on a radio port, with an indicated type and the ability for vexlink to override the controller radio.
bool link_connected(uint8_t port)
Checks if a radio link on a port is active or not.
uint32_t link_raw_receivable_size(uint8_t port)
Returns the bytes of data available to be read.
uint32_t link_raw_transmittable_size(uint8_t port)
Returns the bytes of data available in transmission buffer.
uint32_t link_transmit_raw(uint8_t port, void* data, uint16_t data_size)
Send raw serial data through vexlink.
uint32_t link_receive_raw(uint8_t port, void* dest, uint16_t data_size)
Receive raw serial data through vexlink.
uint32_t link_transmit(uint8_t port, void* data, uint16_t data_size)
Send packeted message through vexlink, with a checksum and start byte.
uint32_t link_receive(uint8_t port, void* dest, uint16_t data_size)
Receive packeted message through vexlink, with a checksum and start byte.
uint32_t link_clear_receive_buf(uint8_t port)
Clear the receive buffer of the link, and discarding the data.

Enums

enum link_type_e { E_LINK_RECIEVER = 0, E_LINK_TRANSMITTER, E_LINK_RX = E_LINK_RECIEVER, E_LINK_TX = E_LINK_TRANSMITTER }

Defines

#define LINK_BUFFER_SIZE
The maximum size of a link buffer.