Struct DistanceSensor 

pub struct DistanceSensor { /* private fields */ }

A struct which represents a V5 smart port configured as a distance sensor.

Implementations

impl DistanceSensor

pub unsafe fn new(port: u8) -> DistanceSensor

Constructs a new distance sensor.

Safety

This function is unsafe because it allows the user to create multiple mutable references to the same distance sensor. You likely want to implement Robot::new() instead.

pub fn get_distance(&self) -> Result<i32, DistanceSensorError>

Gets the currently measured distance from the sensor in millimetres.

pub fn get_confidence(&self) -> Result<i32, DistanceSensorError>

Gets the confidence in the distance reading.

This is a value that has a range of 0 to 63. 63 means high confidence, lower values imply less confidence. Confidence is only available when distance is > 200mm (the value 10 is returned in this scenario).

pub fn get_object_size(&self) -> Result<i32, DistanceSensorError>

Gets the current estimated 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.

pub fn get_object_velocity(&self) -> Result<f64, DistanceSensorError>

Gets the object velocity in metres per second.

Trait Implementations

impl DataSource for DistanceSensor

type Data = DistanceData

The type of data produced by the data source.

type Error = DistanceSensorError

The type of errors which could occur while reading data.

fn read(&self) -> Result<Self::Data, Self::Error>

Tries to read a new value form the data source.

impl From<SmartPort> for DistanceSensor

fn from(port: SmartPort) -> Self

Converts to this type from the input type.