Platforms to show: All Mac Windows Linux Cross-Platform

Back to PhidgetStepperMBS class.

PhidgetStepperMBS.Acceleration as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The rate at which the controller can change the motor's Velocity.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
Changing the acceleration value while the stepper is in motion (especially at speeds higher than 1000 1/16th steps/s) can cause unpredictable results due to the inability of the processor tocalculate a new acceleration curve quickly enough. Generally you should wait until the motor is stationary until calling this function.
(Read and Write property)

PhidgetStepperMBS.ControlMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Use step mode when you want to set a TargetPosition for the Stepper motor.

Use run mode when you simply want the Stepper motor to rotate continuously in a specific direction.Changing the control mode while the motor is running will result in the following behaviour:
Step -> Run : The motor will keep moving in the direction it's currently going, and will accelerate to max velocity.
Run -> Step : The motor will set the target position to infinity in the direction it's currently going, at the current velocity.
(Read and Write property)

PhidgetStepperMBS.CurrentLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The current through the motor will be limited by the CurrentLimit.

See your Stepper motor's data sheet for more information about what value the CurrentLimit should be.

Unit: amperes (A)
(Read and Write property)

PhidgetStepperMBS.DataInterval as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The DataInterval is the time that must elapse before the controller will fire another PositionChange/VelocityChange event.

The data interval is bounded by MinDataInterval and MaxDataInterval.

Unit: milliseconds (ms)
(Read and Write property)

PhidgetStepperMBS.Engaged as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
When this property is true, the controller will supply power to the motor coils.

The controller must be Engaged in order to move the Stepper motor, or have it hold position.
(Read and Write property)

PhidgetStepperMBS.HoldingCurrentLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The HoldingCurrentLimit will activate when the TargetPosition has been reached.

It will limit current through the motor.
When the motor is not stopped, the current through the motor is limited by the CurrentLimit.
If no HoldingCurrentLimit is specified, the CurrentLimit value will persist when the motor is stopped.
Reference your controller's User Guide for more information about how the HoldingCurrentLimit and CurrentLimit can be used in your application.
(Read and Write property)

PhidgetStepperMBS.IsMoving as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
IsMoving returns true while the controller is sending commands to the motor.

Note: there is no feedback to the controller, so it does not know whether the motor shaft is actually moving or not.
(Read only property)

PhidgetStepperMBS.MaxAcceleration as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The maximum value that Acceleration can be set to.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.MaxCurrentLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The maximum value that CurrentLimit and HoldingCurrentLimit can be set to.

Reference your controller's User Guide for more information about how the HoldingCurrentLimit and CurrentLimit can be used in your application.

Unit: amperes (A)
(Read only property)

PhidgetStepperMBS.MaxDataInterval as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The maximum value that DataInterval can be set to.

Unit: milliseconds (ms)
(Read only property)

PhidgetStepperMBS.MaxFailsafeTime as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The maximum value that failsafeTime can be set to when calling EnableFailsafe.

in milliseconds.
(Read only property)

PhidgetStepperMBS.MaxPosition as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The maximum value that TargetPosition can be set to.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.MaxVelocityLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The maximum value that VelocityLimit can be set to.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.MinAcceleration as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The minimum value that Acceleration can be set to.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.MinCurrentLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The minimum value that CurrentLimit and HoldingCurrentLimit can be set to.

Reference your controller's User Guide for more information about how the HoldingCurrentLimit and CurrentLimit can be used in your application.

Unit: amperes (A)
(Read only property)

PhidgetStepperMBS.MinDataInterval as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The minimum value that DataInterval can be set to.

Unit: milliseconds (ms)
(Read only property)

PhidgetStepperMBS.MinFailsafeTime as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The minimum value that failsafeTime can be set to when calling EnableFailsafe.

in milliseconds.
(Read only property)

PhidgetStepperMBS.MinPosition as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The minimum value that TargetPosition can be set to.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.MinVelocityLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The minimum value that VelocityLimit can be set to.

Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.Position as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The most recent position value that the controller has reported.

This value will always be between MinPosition and MaxPosition.
Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.RescaleFactor as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Applies a factor to the [user units] per step to all movement parameters to make the units in your application is more intuitive.

For example, starting from position 0 and setting a new position with a rescale factor, the stepper will move Position / RescaleFactor steps.
In this way, units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor. The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read and Write property)

PhidgetStepperMBS.TargetPosition as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
If the controller is configured and the TargetPosition is set, the Stepper motor will move towards the TargetPosition at the specified Acceleration and Velocity.

TargetPosition is only used when the ControlMode is set to step mode.
Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read and Write property)

PhidgetStepperMBS.Velocity as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The most recent velocity value that the controller has reported.

This value is bounded by MinVelocityLimit and MaxVelocityLimit.
Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read only property)

PhidgetStepperMBS.VelocityLimit as Double

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
When moving, the Stepper motor velocity will be limited by this value.

The VelocityLimit is bounded by MinVelocityLimit and MaxVelocityLimit.
When in step mode, the MinVelocityLimit has a value of 0. This is because the sign (±) of the TargetPosition will indicate the direction.
When in run mode, the MinVelocityLimit has a value of -MaxVelocityLimit. This is because there is no target position, so the direction is defined by the sign (±) of the VelocityLimit.
Units for Position, Velocity, and Acceleration can be set by the user through the RescaleFactor.The RescaleFactor allows you to use more intuitive units such as rotations, or degrees.
The default units for this motor controller are 1/16steps per count.
(Read and Write property)

The items on this page are in the following plugins: MBS Phidgets Plugin.


The biggest plugin in space...