Struct DistanceSensor 

pub struct DistanceSensor { /* private fields */ }

A physical distance sensor plugged into a port. Distance sensors can only keep track of one object at a time.

Implementations

impl DistanceSensor

pub const fn new(port: SmartPort) -> Self

Create a new distance sensor from a smart port index.

pub fn distance(&self) -> Result<u32, PortError>

Returns the distance to the object the sensor detects in millimeters.

pub fn velocity(&self) -> Result<f64, PortError>

Returns the velocity of the object the sensor detects in m/s

pub fn relative_size(&self) -> Result<u32, PortError>

Get the current guess at relative “object size”.

This is a value that has a range of 0 to 400. A 18“ x 30“ grey card will return a value of approximately 75 in typical room lighting.

This sensor reading is unusual, as it is entirely unitless with the seemingly arbitrary range of 0-400 existing due to VEXCode’s vex::sizeType enum having four variants. It’s unknown what the sensor is actually measuring here either, so use this data with a grain of salt.

pub fn distance_confidence(&self) -> Result<f64, PortError>

Returns the confidence in the distance measurement from 0.0 to 1.0.

Trait Implementations

impl Debug for DistanceSensor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DistanceSensor

fn eq(&self, other: &DistanceSensor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SmartDevice for DistanceSensor

fn port_index(&self) -> u8

Get the index of the SmartPort this device is registered on.

fn device_type(&self) -> SmartDeviceType

Get the variant of SmartDeviceType that this device is associated with.

fn port_connected(&self) -> bool

Determine if this device type is currently connected to the SmartPort that it’s registered to.

impl Eq for DistanceSensor

impl StructuralPartialEq for DistanceSensor