[][src]Struct ev3dev_lang_rust::sensors::ColorSensor

pub struct ColorSensor { /* fields omitted */ }

LEGO EV3 color sensor.

Methods

impl ColorSensor[src]

pub fn get(port: SensorPort) -> Ev3Result<Self>[src]

Try to get a Self on the given port. Returns None if port is not used or another device is connected.

pub fn find() -> Ev3Result<Self>[src]

Try to find a Self. Only returns a motor if their is exactly one connected, Error::NotFound otherwise.

pub fn list() -> Ev3Result<Vec<Self>>[src]

Extract list of connected 'Self'

pub const MODE_COL_REFLECT: &'static str[src]

Reflected light - sets LED color to red

pub const MODE_COL_AMBIENT: &'static str[src]

Ambient light - sets LED color to blue (dimly lit)

pub const MODE_COL_COLOR: &'static str[src]

Color - sets LED color to white (all LEDs rapidly cycling)

pub const MODE_REF_RAW: &'static str[src]

Raw Reflected - sets LED color to red

pub const MODE_RGB_RAW: &'static str[src]

Raw Color Components - sets LED color to white (all LEDs rapidly cycling)

pub const MODE_COL_CAL: &'static str[src]

Calibration ??? - sets LED color to red, flashing every 4 seconds, then goes continuous

pub fn get_bin_data(&self) -> Ev3Result<String>[src]

Reading the file will give the unscaled raw values in the value<N> attributes. Use bin_data_format, num_values and the individual sensor documentation to determine how to interpret the data.

pub fn get_bin_data_format(&self) -> Ev3Result<String>[src]

Returns the format of the values in bin_data for the current mode. Possible values are:

pub fn get_decimals(&self) -> Ev3Result<i32>[src]

Returns the number of decimal places for the values in the value<N> attributes of the current mode.

pub fn get_fw_version(&self) -> Ev3Result<String>[src]

Returns the firmware version of the sensor if available. Currently only NXT/I2C sensors support this.

pub fn get_mode(&self) -> Ev3Result<String>[src]

Returns the current mode. See the individual sensor documentation for a description of the modes available for each type of sensor.

pub fn set_mode(&self, mode: &str) -> Ev3Result<()>[src]

Sets the sensor to that mode. See the individual sensor documentation for a description of the modes available for each type of sensor.

pub fn get_modes(&self) -> Ev3Result<Vec<String>>[src]

Returns a list of the valid modes for the sensor.

pub fn get_num_values(&self) -> Ev3Result<i32>[src]

Returns the number of value<N> attributes that will return a valid value for the current mode.

pub fn get_poll_ms(&self) -> Ev3Result<i32>[src]

Returns the polling period of the sensor in milliseconds. Returns -EOPNOTSUPP if changing polling is not supported. Note: Setting poll_ms too high can cause the input port autodetection to fail. If this happens, use the mode attribute of the port to force the port to nxt-i2c mode. Values must not be negative.

pub fn set_poll_ms(&self, poll_ms: i32) -> Ev3Result<()>[src]

Sets the polling period of the sensor in milliseconds. Setting to 0 disables polling. Note: Setting poll_ms too high can cause the input port autodetection to fail. If this happens, use the mode attribute of the port to force the port to nxt-i2c mode. Values must not be negative.

pub fn get_units(&self) -> Ev3Result<String>[src]

Returns the units of the measured value for the current mode. May return empty string if units are unknown.

pub fn get_value0(&self) -> Ev3Result<i32>[src]

Returns the current value0 value if available.

pub fn get_value1(&self) -> Ev3Result<i32>[src]

Returns the current value1 value if available.

pub fn get_value2(&self) -> Ev3Result<i32>[src]

Returns the current value2 value if available.

pub fn get_value3(&self) -> Ev3Result<i32>[src]

Returns the current value3 value if available.

pub fn get_value4(&self) -> Ev3Result<i32>[src]

Returns the current value4 value if available.

pub fn get_value5(&self) -> Ev3Result<i32>[src]

Returns the current value5 value if available.

pub fn get_value6(&self) -> Ev3Result<i32>[src]

Returns the current value6 value if available.

pub fn get_value7(&self) -> Ev3Result<i32>[src]

Returns the current value7 value if available.

pub fn get_text_value(&self) -> Ev3Result<String>[src]

Returns a space delimited string representing sensor-specific text values. Returns -EOPNOTSUPP if a sensor does not support text values.

pub fn set_mode_col_reflect(&self) -> Ev3Result<()>[src]

Reflected light - sets LED color to red

pub fn set_mode_col_ambient(&self) -> Ev3Result<()>[src]

Ambient light - sets LED color to blue (dimly lit)

pub fn set_mode_col_color(&self) -> Ev3Result<()>[src]

Color - sets LED color to white (all LEDs rapidly cycling)

pub fn set_mode_ref_raw(&self) -> Ev3Result<()>[src]

Raw Reflected - sets LED color to red

pub fn set_mode_rgb_raw(&self) -> Ev3Result<()>[src]

Raw Color Components - sets LED color to white (all LEDs rapidly cycling)

pub fn set_mode_col_cal(&self) -> Ev3Result<()>[src]

Calibration ??? - sets LED color to red, flashing every 4 seconds, then goes continuous

pub fn get_red(&self) -> Ev3Result<i32>[src]

Red component of the detected color, in the range 0-1020.

pub fn get_green(&self) -> Ev3Result<i32>[src]

Green component of the detected color, in the range 0-1020.

pub fn get_blue(&self) -> Ev3Result<i32>[src]

Blue component of the detected color, in the range 0-1020.

pub fn get_rgb(&self) -> Ev3Result<(i32, i32, i32)>[src]

Red, green and blue componets of the detected color, each in the range 0-1020

Trait Implementations

impl Clone for ColorSensor[src]

impl Debug for ColorSensor[src]

impl Device for ColorSensor[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.