Struct AnalogInput

pub struct AnalogInput { /* private fields */ }

An analog input on the RoboRIO

Implementations

impl AnalogInput

pub fn new(channel: i32) -> HalResult<AnalogInput>

Create a new analog input on the specified channel, returning an error if initialization fails.

Errors

Returns Err(HalError(0)) if the channel is invalid.

pub fn value(&self) -> HalResult<i32>

Read a value from the analog input.

pub fn average_value(&self) -> HalResult<i32>

Read the average value of the analog input over some defined time period.

pub fn voltage(&self) -> HalResult<f64>

Read the raw value of the analog input in volts.

pub fn average_voltage(&self) -> HalResult<f64>

Read the average raw value of the analog input in volts over some defined time period.

pub fn channel(&self) -> i32

Get the channel number for this analog input.

pub fn set_average_bits(&mut self, bits: i32) -> HalResult<()>

Set the number of bits to use in averaging. Averaging will sample 2^bits actual reads.

pub fn average_bits(&self) -> HalResult<i32>

Get the previously-set number of average bits.

pub fn set_oversample_bits(&mut self, bits: i32) -> HalResult<()>

Set the number of bits to use in oversampling to improve resolution with a slower rate. Oversampling will use 2^bits actual reads.

pub fn oversample_bits(&self) -> HalResult<i32>

Get the previously-set number of oversample bits.

pub fn lsb_weight(&self) -> HalResult<i32>

Get the factory scaling LSB weight constant: voltage = ((lsb_weight * 1e-9) * raw) - (offset * 1e-9)

pub fn offset(&self) -> HalResult<i32>

Get the factory scaling offset constant: voltage = ((lsb_weight * 1e-9) * raw) - (offset * 1e-9)

pub fn is_accumulator_channel(&self) -> HalResult<bool>

Returns true if this analog input is attached to an accumulator

pub fn init_accumulator(&mut self) -> HalResult<()>

Initialize an accumulator on this channel.

pub fn set_accumulator_offset(&mut self, value: i64)

Set the offset for the accumulator.

pub fn reset_accumulator(&mut self) -> HalResult<()>

Reset the accumulator and wait for the next sample. This blocks until new values are potentially available.

pub fn set_accumulator_center(&mut self, center: i32) -> HalResult<()>

Set the center of the accumulator. This value will be subtracted from all accumulated reads.

pub fn set_accumulator_deadband(&self, deadband: i32) -> HalResult<()>

Set the deadband for the accumulator. Anything within deadband of the accumulator center will be ignored in the accumulator.

pub fn accumulator_value(&self) -> HalResult<i64>

Get a value from the accumulator.

pub fn accumulator_count(&self) -> HalResult<i64>

Get the number of accumulated values.

pub fn accumulator_output(&self) -> HalResult<(i64, i64)>

Read the accumulator’s value and the count of samples at the same time. Returns a tuple of (value, count).

pub fn set_sample_rate(samples_per_second: f64) -> HalResult<()>

Set the sample rate for analog inputs.

pub fn sample_rate() -> HalResult<f64>

Get the sample rate for analog inputs.

Trait Implementations

impl Debug for AnalogInput

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

Formats the value using the given formatter.

impl Drop for AnalogInput

fn drop(&mut self)

Executes the destructor for this type.