Struct ev3dev_lang_rust::motors::LargeMotor

pub struct LargeMotor { /* fields omitted */ }

EV3/NXT large servo motor

Trait Implementations

impl Device for LargeMotor

fn get_attribute(&self, name: &str) -> Attribute

fn get_address(&self) -> Ev3Result<String>

Returns the name of the port that the motor is connected to.

fn set_command(&self, command: &str) -> Ev3Result<()>

Sends a command to the device controller.

fn get_commands(&self) -> Ev3Result<Vec<String>>

Returns a space separated list of commands that are supported by the device controller.

fn get_driver_name(&self) -> Ev3Result<String>

Returns the name of the driver that provides this device.

impl Findable<MotorPort> for LargeMotor

fn get(port: MotorPort) -> Ev3Result<Self>

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

fn find() -> Ev3Result<Self>

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

fn list() -> Ev3Result<Vec<Self>>

Extract list of connected 'Self'

impl TachoMotor for LargeMotor

fn get_count_per_rot(&self) -> Ev3Result<i32>

Returns the number of tacho counts in one rotation of the motor. Tacho counts are used by the position and speed attributes, so you can use this value to convert from rotations or degrees to tacho counts. (rotation motors only)

fn get_count_per_m(&self) -> Ev3Result<i32>

Returns the number of tacho counts in one meter of travel of the motor. Tacho counts are used by the position and speed attributes, so you can use this value to convert from distance to tacho counts. (linear motors only)

fn get_full_travel_count(&self) -> Ev3Result<i32>

Returns the number of tacho counts in the full travel of the motor. When combined with the count_per_m atribute, you can use this value to calculate the maximum travel distance of the motor. (linear motors only)

fn get_duty_cycle(&self) -> Ev3Result<i32>

Returns the current duty cycle of the motor. Units are percent. Values are -100 to 100.

fn get_duty_cycle_sp(&self) -> Ev3Result<i32>

Returns the current duty cycle setpoint of the motor. Units are in percent. Valid values are -100 to 100. A negative value causes the motor to rotate in reverse.

fn set_duty_cycle_sp(&self, duty_cycle: i32) -> Ev3Result<()>

Sets the duty cycle setpoint of the motor. Units are in percent. Valid values are -100 to 100. A negative value causes the motor to rotate in reverse.

fn get_polarity(&self) -> Ev3Result<String>

Returns the current polarity of the motor.

fn set_polarity(&self, polarity: &str) -> Ev3Result<()>

Sets the polarity of the motor.

fn get_position(&self) -> Ev3Result<i32>

Returns the current position of the motor in pulses of the rotary encoder. When the motor rotates clockwise, the position will increase. Likewise, rotating counter-clockwise causes the position to decrease. The range is -2,147,483,648 and +2,147,483,647 tachometer counts (32-bit signed integer)

fn set_position(&self, position: i32) -> Ev3Result<()>

Sets the current position of the motor in pulses of the rotary encoder. When the motor rotates clockwise, the position will increase. Likewise, rotating counter-clockwise causes the position to decrease. The range is -2,147,483,648 and +2,147,483,647 tachometer counts (32-bit signed integer)

fn get_hold_pid_kp(&self) -> Ev3Result<f32>

Returns the proportional pub constant for the position PID.

fn set_hold_pid_kp(&self, kp: f32) -> Ev3Result<()>

Sets the proportional pub constant for the position PID.

fn get_hold_pid_ki(&self) -> Ev3Result<f32>

Returns the integral pub constant for the position PID.

fn set_hold_pid_ki(&self, ki: f32) -> Ev3Result<()>

Sets the integral pub constant for the position PID.

fn get_hold_pid_kd(&self) -> Ev3Result<f32>

Returns the derivative pub constant for the position PID.

fn set_hold_pid_kd(&self, kd: f32) -> Ev3Result<()>

Sets the derivative pub constant for the position PID.

fn get_max_speed(&self) -> Ev3Result<i32>

Returns the maximum value that is accepted by the speed_sp attribute. This value is the speed of the motor at 9V with no load. Note: The actual maximum obtainable speed will be less than this and will depend on battery voltage and mechanical load on the motor.

fn get_position_sp(&self) -> Ev3Result<i32>

Returns the current target position for the run-to-abs-pos and run-to-rel-pos commands. Units are in tacho counts. You can use the value returned by counts_per_rot to convert tacho counts to/from rotations or degrees. The range is -2,147,483,648 and +2,147,483,647 tachometer counts (32-bit signed integer).

fn set_position_sp(&self, position_sp: i32) -> Ev3Result<()>

Sets the target position for the run-to-abs-pos and run-to-rel-pos commands. Units are in tacho counts. You can use the value returned by counts_per_rot to convert tacho counts to/from rotations or degrees. The range is -2,147,483,648 and +2,147,483,647 tachometer counts (32-bit signed integer).

fn get_speed(&self) -> Ev3Result<i32>

Returns the current motor speed in tacho counts per second. Note, this is not necessarily degrees (although it is for LEGO motors). Use the count_per_rot attribute to convert this value to RPM or deg/sec.

fn get_speed_sp(&self) -> Ev3Result<i32>

Returns the target speed in tacho counts per second used for all run-* commands except run-direct. A negative value causes the motor to rotate in reverse with the exception of run-to-*-pos commands where the sign is ignored. Use the count_per_rot attribute to convert RPM or deg/sec to tacho counts per second. Use the count_per_m attribute to convert m/s to tacho counts per second.

fn set_speed_sp(&self, speed_sp: i32) -> Ev3Result<()>

Sets the target speed in tacho counts per second used for all run-* commands except run-direct. A negative value causes the motor to rotate in reverse with the exception of run-to-*-pos commands where the sign is ignored. Use the count_per_rot attribute to convert RPM or deg/sec to tacho counts per second. Use the count_per_m attribute to convert m/s to tacho counts per second.

fn get_ramp_up_sp(&self) -> Ev3Result<i32>

Returns the current ramp up setpoint. Units are in milliseconds and must be positive. When set to a non-zero value, the motor speed will increase from 0 to 100% of max_speed over the span of this setpoint. The actual ramp time is the ratio of the difference between the speed_sp and the current speed and max_speed multiplied by ramp_up_sp. Values must not be negative.

fn set_ramp_up_sp(&self, ramp_up_sp: i32) -> Ev3Result<()>

Sets the ramp up setpoint. Units are in milliseconds and must be positive. When set to a non-zero value, the motor speed will increase from 0 to 100% of max_speed over the span of this setpoint. The actual ramp time is the ratio of the difference between the speed_sp and the current speed and max_speed multiplied by ramp_up_sp. Values must not be negative.

fn get_ramp_down_sp(&self) -> Ev3Result<i32>

Returns the current ramp down setpoint. Units are in milliseconds and must be positive. When set to a non-zero value, the motor speed will decrease from 100% down to 0 of max_speed over the span of this setpoint. The actual ramp time is the ratio of the difference between the speed_sp and the current speed and 0 multiplied by ramp_down_sp. Values must not be negative.

fn set_ramp_down_sp(&self, ramp_down_sp: i32) -> Ev3Result<()>

Sets the ramp down setpoint. Units are in milliseconds and must be positive. When set to a non-zero value, the motor speed will decrease from 100% down to 0 of max_speed over the span of this setpoint. The actual ramp time is the ratio of the difference between the speed_sp and the current speed and 0 multiplied by ramp_down_sp. Values must not be negative.

fn get_speed_pid_kp(&self) -> Ev3Result<f32>

Returns the proportional pub constant for the speed regulation PID.

fn set_speed_pid_kp(&self, kp: f32) -> Ev3Result<()>

Sets the proportional pub constant for the speed regulation PID.

fn get_speed_pid_ki(&self) -> Ev3Result<f32>

Returns the integral pub constant for the speed regulation PID.

fn set_speed_pid_ki(&self, ki: f32) -> Ev3Result<()>

Sets the integral pub constant for the speed regulation PID.

fn get_speed_pid_kd(&self) -> Ev3Result<f32>

Returns the derivative pub constant for the speed regulation PID.

fn set_speed_pid_kd(&self, kd: f32) -> Ev3Result<()>

Sets the derivative pub constant for the speed regulation PID.

fn get_state(&self) -> Ev3Result<Vec<String>>

Returns a list of state flags.

fn get_stop_action(&self) -> Ev3Result<String>

Returns the current stop action. The value determines the motors behavior when command is set to stop.

fn set_stop_action(&self, stop_action: &str) -> Ev3Result<()>

Sets the stop action. The value determines the motors behavior when command is set to stop.

fn get_stop_actions(&self) -> Ev3Result<Vec<String>>

Returns a list of stop actions supported by the motor controller.

fn get_time_sp(&self) -> Ev3Result<i32>

Returns the current amount of time the motor will run when using the run-timed command. Units are in milliseconds. Values must not be negative.

fn set_time_sp(&self, time_sp: i32) -> Ev3Result<()>

Sets the amount of time the motor will run when using the run-timed command. Units are in milliseconds. Values must not be negative.

fn run_direct(&self) -> Ev3Result<()>

Runs the motor using the duty cycle specified by duty_cycle_sp. Unlike other run commands, changing duty_cycle_sp while running will take effect immediately.

fn run_forever(&self) -> Ev3Result<()>

Causes the motor to run until another command is sent.

fn run_to_abs_pos(&self, position_sp: Option<i32>) -> Ev3Result<()>

Runs the motor to an absolute position specified by position_sp and then stops the motor using the command specified in stop_action.

fn run_to_rel_pos(&self, position_sp: Option<i32>) -> Ev3Result<()>

Runs the motor to a position relative to the current position value. The new position will be current position + position_sp. When the new position is reached, the motor will stop using the command specified by stop_action.

fn run_timed(&self, time_sp: Option<Duration>) -> Ev3Result<()>

Run the motor for the amount of time specified in time_sp and then stops the motor using the command specified by stop_action.

fn stop(&self) -> Ev3Result<()>

Stop any of the run commands before they are complete using the command specified by stop_action.

fn reset(&self) -> Ev3Result<()>

Resets all of the motor parameter attributes to their default values. This will also have the effect of stopping the motor.

fn is_running(&self) -> Ev3Result<bool>

Power is being sent to the motor.

fn is_ramping(&self) -> Ev3Result<bool>

The motor is ramping up or down and has not yet reached a pub constant output level.

fn is_holding(&self) -> Ev3Result<bool>

The motor is not turning, but rather attempting to hold a fixed position.

fn is_overloaded(&self) -> Ev3Result<bool>

The motor is turning as fast as possible, but cannot reach its speed_sp.

fn is_stalled(&self) -> Ev3Result<bool>

The motor is trying to run but is not turning at all.

fn wait<F>(&self, cond: F, timeout: Option<Duration>) -> bool where
    F: Fn() -> bool, 

Wait until condition cond returns true or the timeout is reached. The condition is checked when to the state attribute has changed. If the timeout is None it will wait an infinite time.

fn wait_while(&self, state: &str, timeout: Option<Duration>) -> bool

Wait while the state is in the vector self.get_state() or the timeout is reached. If the timeout is None it will wait an infinite time.

fn wait_until(&self, state: &str, timeout: Option<Duration>) -> bool

Wait until the state is in the vector self.get_state() or the timeout is reached. If the timeout is None it will wait an infinite time.

fn wait_until_not_moving(&self, timeout: Option<Duration>) -> bool

Wait until the motor is not moving or the timeout is reached. This is euqal to wait_until(STATE_RUNNING, timeout) If the timeout is None it will wait an infinite time.

impl Motor for LargeMotor

impl Clone for LargeMotor

fn clone(&self) -> LargeMotor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LargeMotor

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

Formats the value using the given formatter.