1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
//! Controller support.
//!
//! This module allows you to read from the buttons and joysticks on the controller and write to the controller's display.
use alloc::ffi::CString;
use core::time::Duration;
use snafu::Snafu;
use vex_sdk::{
vexControllerConnectionStatusGet, vexControllerGet, vexControllerTextSet, V5_ControllerId,
V5_ControllerIndex, V5_ControllerStatus,
};
use vexide_core::{competition, competition::CompetitionMode};
use crate::adi::digital::LogicLevel;
fn validate_connection(id: ControllerId) -> Result<(), ControllerError> {
if unsafe {
vexControllerConnectionStatusGet(id.into()) == V5_ControllerStatus::kV5ControllerOffline
} {
return Err(ControllerError::Offline);
}
Ok(())
}
/// Digital Controller Button
#[derive(Debug, Eq, PartialEq)]
pub struct Button {
id: ControllerId,
channel: V5_ControllerIndex,
was_pressed: bool,
}
impl Button {
/// Gets the current logic level of a digital input pin.
pub fn level(&self) -> Result<LogicLevel, ControllerError> {
if competition::mode() != CompetitionMode::Driver {
return Err(ControllerError::CompetitionControl);
}
validate_connection(self.id)?;
let value = unsafe { vexControllerGet(self.id.into(), self.channel) != 0 };
let level = match value {
true => LogicLevel::High,
false => LogicLevel::Low,
};
Ok(level)
}
/// Returrns `true` if the button is currently being pressed.
///
/// This is equivalent shorthand to calling `Self::level().is_high()`.
pub fn is_pressed(&self) -> Result<bool, ControllerError> {
Ok(self.level()?.is_high())
}
/// Returns `true` if the button has been pressed again since the last time this
/// function was called.
pub fn was_pressed(&mut self) -> Result<bool, ControllerError> {
if self.is_pressed()? {
self.was_pressed = false;
} else if !self.was_pressed {
self.was_pressed = true;
return Ok(true);
}
Ok(false)
}
}
/// Stores how far the joystick is away from the center (at *(0, 0)*) from -1 to 1.
/// On the x axis left is negative, and right is positive.
/// On the y axis down is negative, and up is positive.
#[derive(Debug, Eq, PartialEq)]
pub struct Joystick {
id: ControllerId,
x_channel: V5_ControllerIndex,
y_channel: V5_ControllerIndex,
}
impl Joystick {
/// Gets the value of the joystick position on its x-axis from [-1, 1].
pub fn x(&self) -> Result<f32, ControllerError> {
validate_connection(self.id)?;
Ok(self.x_raw()? as f32 / 127.0)
}
/// Gets the value of the joystick position on its y-axis from [-1, 1].
pub fn y(&self) -> Result<f32, ControllerError> {
validate_connection(self.id)?;
Ok(self.y_raw()? as f32 / 127.0)
}
/// Gets the raw value of the joystick position on its x-axis from [-128, 127].
pub fn x_raw(&self) -> Result<i8, ControllerError> {
validate_connection(self.id)?;
if competition::mode() != CompetitionMode::Driver {
return Err(ControllerError::CompetitionControl);
}
Ok(unsafe { vexControllerGet(self.id.into(), self.x_channel) } as _)
}
/// Gets the raw value of the joystick position on its x-axis from [-128, 127].
pub fn y_raw(&self) -> Result<i8, ControllerError> {
validate_connection(self.id)?;
if competition::mode() != CompetitionMode::Driver {
return Err(ControllerError::CompetitionControl);
}
Ok(unsafe { vexControllerGet(self.id.into(), self.y_channel) } as _)
}
}
/// The basic type for a controller.
/// Used to get the state of its joysticks and controllers.
#[derive(Debug, Eq, PartialEq)]
pub struct Controller {
id: ControllerId,
/// Controller Screen
pub screen: ControllerScreen,
/// Left Joystick
pub left_stick: Joystick,
/// Right Joystick
pub right_stick: Joystick,
/// Button A
pub button_a: Button,
/// Button B
pub button_b: Button,
/// Button X
pub button_x: Button,
/// Button Y
pub button_y: Button,
/// Button Up
pub button_up: Button,
/// Button Down
pub button_down: Button,
/// Button Left
pub button_left: Button,
/// Button Right
pub button_right: Button,
/// Top Left Trigger
pub left_trigger_1: Button,
/// Bottom Left Trigger
pub left_trigger_2: Button,
/// Top Right Trigger
pub right_trigger_1: Button,
/// Bottom Right Trigger
pub right_trigger_2: Button,
}
/// Controller LCD Console
#[derive(Debug, Eq, PartialEq)]
pub struct ControllerScreen {
id: ControllerId,
}
impl ControllerScreen {
/// Maximum number of characters that can be drawn to a text line.
pub const MAX_LINE_LENGTH: usize = 14;
/// Number of available text lines on the controller before clearing the screen.
pub const MAX_LINES: usize = 2;
/// Clear the contents of a specific text line.
pub fn clear_line(&mut self, line: u8) -> Result<(), ControllerError> {
//TODO: Older versions of VexOS clear the controller by setting the line to " ".
//TODO: We should check the version and change behavior based on it.
self.set_text("", line, 0)?;
Ok(())
}
/// Clear the whole screen.
pub fn clear_screen(&mut self) -> Result<(), ControllerError> {
for line in 0..Self::MAX_LINES as u8 {
self.clear_line(line)?;
}
Ok(())
}
/// Set the text contents at a specific row/column offset.
pub fn set_text(&mut self, text: &str, line: u8, col: u8) -> Result<(), ControllerError> {
validate_connection(self.id)?;
if col >= Self::MAX_LINE_LENGTH as u8 {
return Err(ControllerError::InvalidLine);
}
let id: V5_ControllerId = self.id.into();
let text = CString::new(text)
.map_err(|_| ControllerError::NonTerminatingNul)?
.into_raw();
unsafe {
vexControllerTextSet(id.0, (line + 1) as _, (col + 1) as _, text as *const _);
}
// stop rust from leaking the CString
drop(unsafe { CString::from_raw(text) });
Ok(())
}
}
/// Represents an identifier for one of the two possible controllers
/// connected to the V5 brain.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ControllerId {
/// Primary ("Master") Controller
Primary,
/// Partner Controller
Partner,
}
impl From<ControllerId> for V5_ControllerId {
fn from(id: ControllerId) -> Self {
match id {
ControllerId::Primary => V5_ControllerId::kControllerMaster,
ControllerId::Partner => V5_ControllerId::kControllerPartner,
}
}
}
impl Controller {
/// The update rate of the controller.
pub const UPDATE_INTERVAL: Duration = Duration::from_millis(25);
/// Create a new controller.
///
/// # Safety
///
/// Creating new `Controller`s is inherently unsafe due to the possibility of constructing
/// more than one screen at once allowing multiple mutable references to the same
/// hardware device. Prefer using [`Peripherals`](crate::peripherals::Peripherals) to register devices if possible.
pub const unsafe fn new(id: ControllerId) -> Self {
Self {
id,
screen: ControllerScreen { id },
left_stick: Joystick {
id,
x_channel: V5_ControllerIndex::Axis1,
y_channel: V5_ControllerIndex::Axis2,
},
right_stick: Joystick {
id,
x_channel: V5_ControllerIndex::Axis3,
y_channel: V5_ControllerIndex::Axis4,
},
button_a: Button {
id,
channel: V5_ControllerIndex::ButtonA,
was_pressed: false,
},
button_b: Button {
id,
channel: V5_ControllerIndex::ButtonB,
was_pressed: false,
},
button_x: Button {
id,
channel: V5_ControllerIndex::ButtonX,
was_pressed: false,
},
button_y: Button {
id,
channel: V5_ControllerIndex::ButtonY,
was_pressed: false,
},
button_up: Button {
id,
channel: V5_ControllerIndex::ButtonUp,
was_pressed: false,
},
button_down: Button {
id,
channel: V5_ControllerIndex::ButtonDown,
was_pressed: false,
},
button_left: Button {
id,
channel: V5_ControllerIndex::ButtonLeft,
was_pressed: false,
},
button_right: Button {
id,
channel: V5_ControllerIndex::ButtonRight,
was_pressed: false,
},
left_trigger_1: Button {
id,
channel: V5_ControllerIndex::ButtonL1,
was_pressed: false,
},
left_trigger_2: Button {
id,
channel: V5_ControllerIndex::ButtonL2,
was_pressed: false,
},
right_trigger_1: Button {
id,
channel: V5_ControllerIndex::ButtonR1,
was_pressed: false,
},
right_trigger_2: Button {
id,
channel: V5_ControllerIndex::ButtonR2,
was_pressed: false,
},
}
}
/// Gets the controller's connection type.
pub fn connection(&self) -> ControllerConnection {
unsafe { vexControllerConnectionStatusGet(self.id.into()) }.into()
}
/// Gets the controller's battery capacity.
pub fn battery_capacity(&self) -> Result<i32, ControllerError> {
validate_connection(self.id)?;
Ok(unsafe { vexControllerGet(self.id.into(), V5_ControllerIndex::BatteryCapacity) })
}
/// Gets the controller's battery level.
pub fn battery_level(&self) -> Result<i32, ControllerError> {
validate_connection(self.id)?;
Ok(unsafe { vexControllerGet(self.id.into(), V5_ControllerIndex::BatteryLevel) })
}
/// Gets the controller's flags.
pub fn flags(&self) -> Result<i32, ControllerError> {
validate_connection(self.id)?;
Ok(unsafe { vexControllerGet(self.id.into(), V5_ControllerIndex::Flags) })
}
/// Send a rumble pattern to the controller's vibration motor.
///
/// This function takes a string consisting of the characters '.', '-', and ' ', where
/// dots are short rumbles, dashes are long rumbles, and spaces are pauses. Maximum
/// supported length is 8 characters.
pub fn rumble(&mut self, pattern: &str) -> Result<(), ControllerError> {
self.screen.set_text(pattern, 3, 0)
}
}
/// Represents the state of a controller's connection.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ControllerConnection {
/// No controller is connected.
Offline,
/// Controller is tethered through a wired smartport connection.
Tethered,
/// Controller is wirelessly connected over a VEXNet radio
Vexnet,
}
impl From<V5_ControllerStatus> for ControllerConnection {
fn from(value: V5_ControllerStatus) -> Self {
match value {
V5_ControllerStatus::kV5ControllerOffline => Self::Offline,
V5_ControllerStatus::kV5ControllerTethered => Self::Tethered,
V5_ControllerStatus::kV5ControllerVexnet => Self::Vexnet,
_ => unreachable!(),
}
}
}
impl From<ControllerConnection> for V5_ControllerStatus {
fn from(value: ControllerConnection) -> Self {
match value {
ControllerConnection::Offline => Self::kV5ControllerOffline,
ControllerConnection::Tethered => Self::kV5ControllerTethered,
ControllerConnection::Vexnet => Self::kV5ControllerVexnet,
}
}
}
#[derive(Debug, Snafu)]
/// Errors that can occur when interacting with the controller.
pub enum ControllerError {
/// The controller is not connected to the brain.
Offline,
/// CString::new encountered NUL (U+0000) byte in non-terminating position.
NonTerminatingNul,
/// Access to controller data is restricted by competition control.
CompetitionControl,
/// An invalid line number was given.
InvalidLine,
}