Platforms to show: All Mac Windows Linux Cross-Platform

Back to PhidgetStepperMBS class.

PhidgetStepperMBS.addPositionOffset(positionOffset as double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Adds an offset (positive or negative) to the current position and target position.

This is especially useful for zeroing position.

PhidgetStepperMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The constructor.

PhidgetStepperMBS.enableFailsafe(failsafeTime as UInt32)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Enables the failsafe feature for the channel, with a given failsafe time.

The failsafe feature is intended for use in applications where it is important for the channel to enter a known safe state if the program controlling it locks up or crashes. If you do not enable the failsafe feature, the channel will carry out whatever instructions it was last given until it is explicitly told to stop.

Enabling the failsafe feature starts a recurring failsafe timer for the channel. Once the failsafe timer is enabled, it must be reset within the specified time or the channel will enter a failsafe state. The failsafe timer may be reset either by calling this function again, or using the ResetFailsafe function. Resetting the failsafe timer will reload the timer with the specified failsafe time, starting when the message to reset the timer is received by the Phidget.

For example: if the failsafe is enabled with a failsafe time of 1000ms, you will have 1000ms to reset the failsafe timer. Every time the failsafe timer is reset, you will have 1000ms from that time to reset the failsafe again.

If the failsafe timer is not reset before it runs out, the channel will enter a failsafe state. For Stepper channels, this will disengage the motor. Once the channel enters the failsafe state, it will reject any further input until the channel is reopened.

To prevent the channel from falsely entering the failsafe state, we recommend resetting the failsafe timer as frequently as is practical for your applicaiton. A good rule of thumb is to not let more than a third of the failsafe time pass before resetting the timer.

Once the failsafe timer has been set, it cannot be disabled by any means other than closing and reopening the channel.

PhidgetStepperMBS.resetFailsafe

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Resets the failsafe timer, if one has been set. See EnableFailsafe for details.

This function will fail if no failsafe timer has been set for the channel.

PhidgetStepperMBS.setTargetPositionAsync(targetPosition as double)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Sets target position asynchronously.

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.

Calls setTargetPositionAsyncCompleted event later when done.

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


The biggest plugin in space...