Loading...
This chapter gives an overview of the members available for the Phidgets Stepper device.
Please read the chapter "Phidgets - Stepper" if you would like to know how to add and use this device. As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.
Project.Phidgets_Stepper(deviceName or ID) |
Example: Alternative Example: |
This gives access to all further members of the device "Phidgets_Stepper" from the Configuration dialog. Using the Project object is an alternative to addressing the device directly by entering its name. The Project object allows to address the device through its name or ID. Substituting the ID with a dynamic variable allows automation. Actions can be performed on many devices of the same type simultaneously, e.g. by using for-loops: |
Phidgets_StepperName.Channel |
Example: Alternative Example: |
This member sets and returns the channel which is displayed next to "Channel" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.Channel Example2: The second example shows, how to set the channel to a value of 2. |
Phidgets_StepperName.CurrentLimit |
Example: Alternative Example: |
Sets or returns "Current Limit A", also displayed in Configuration dialog Example2: |
Phidgets_StepperName.DeviceSerial |
Example: Alternative Example: |
This member sets and returns the serial number which is displayed next to "Serial" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.DeviceSerial Example2: The second example shows, how to set the channel of the digital output 1 to a value of 530161. |
Phidgets_StepperName.Disable |
Example: Alternative Example: |
This disables the Phidgets_Stepper1 device in the Configuration dialog as if the "Enable" check box in the window was unchecked. Use the .Enable member to reverse this command. |
Phidgets_StepperName.Disengage |
Example: Alternative Example: |
Disengages the Stepper |
Phidgets_StepperName.Enable |
Example: Alternative Example: |
This enables the Phidgets_Stepper1 device in the Configuration dialog as if the "Enable" check box in the window was checked. Use the .Disable member to reverse this command. |
Phidgets_StepperName.Engage |
Example: Alternative Example: |
Engages the Stepper |
Phidgets_StepperName.GetCurrentLimit |
Example: Alternative Example: |
Returns "Current Limit A", also displayed in Configuration dialog |
Phidgets_StepperName.GetHoldingCurrentLimit |
Example: Alternative Example: |
Returns "Holding Current Limit", also displayed in Configuration dialog |
Phidgets_StepperName.GetInterval |
Example: Alternative Example: |
This member returns the interval time which is displayed next to "Interval (ms)" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.GetInterval |
Phidgets_StepperName.GetMaxAcceleration |
Example: Alternative Example: |
Reads out "Max Acceleration", also displayed in Configuration dialog |
Phidgets_StepperName.GetMaxPosition |
Example: Alternative Example: |
Reads out "Max Position", also displayed in Configuration dialog |
Phidgets_StepperName.GetMaxVelocityLimit |
Example: Alternative Example: |
Reads out "Max Velocity Limit", also displayed in Configuration dialog |
Phidgets_StepperName.GetMinAcceleration |
Example: Alternative Example: |
Reads out "Min Acceleration", also displayed in Configuration dialog |
Phidgets_StepperName.GetMinPosition |
Example: Alternative Example: |
Reads out "Min Position", also displayed in Configuration dialog |
Phidgets_StepperName.GetMinVelocityLimit |
Example: Alternative Example: |
Reads out "Min Velocity Limit", also displayed in Configuration dialog |
Phidgets_StepperName.GetPosition |
Example: Alternative Example: |
Reads out "Current (Motor) Postion", also displayed in Configuration dialog |
Phidgets_StepperName.GetRescaleFactor |
Example: Alternative Example: |
Returns "Rescale Factor", also displayed in Configuration dialog |
Phidgets_StepperName.GetTargetPosition |
Example: Alternative Example: |
reads out TargetPosition |
Phidgets_StepperName.GetVelocity |
Example: Alternative Example: |
Reads out "Current Velocity", also displayed in Configuration dialog |
Phidgets_StepperName.HoldingCurrentLimit |
Example: Alternative Example: |
Sets or returns "Holding Current Limit", also displayed in Configuration dialog Example2: |
Phidgets_StepperName.HubPort |
Example: Alternative Example: |
This member sets and returns the hub port number which is displayed next to "Hub Port" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.HubPort Example2: The second example shows, how to set the hub port to a value of 2. |
Phidgets_StepperName.Interval |
Example: Alternative Example: |
This member sets and returns the interval time which is displayed next to "Interval (ms)" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.Interval Example2: The second example shows, how to set the interval time to a value of 500ms. |
Phidgets_StepperName.IsConnected |
Example: Alternative Example: |
This member returns the connection status for the Phidgets_Stepper1 device as a Boolean value. The result is "True" if the device is connected and "False" if it is currently disconnected. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.IsConnected |
Phidgets_StepperName.IsEnabled |
Example: Alternative Example: |
This member returns the status of the check box "Enable" of the configuration dialog when selecting the according Phidget device. The result, a Boolean value (or string), is "True" if the device is enabled and "False" if it is currently not enabled. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.IsEnabled |
Phidgets_StepperName.IsEngaged |
Example: Alternative Example: |
returns if Motor is engaged |
Phidgets_StepperName.IsHubPortDevice |
Example: Alternative Example: |
This member returns the status of the check box "Is Hub Port Device" of the configuration dialog when selecting the according Phidget device. The result, a Boolean value (or string), is "True" if the device is a hub port device and "False" if it is not. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Stepper1.IsHubPortDevice |
Phidgets_StepperName.IsMoving |
Example: Alternative Example: |
returns if Motor is moving |
Phidgets_StepperName.MaxAcceleration |
Example: Alternative Example: |
Reads out "Max Acceleration", also displayed in Configuration dialog |
Phidgets_StepperName.MaxPosition |
Example: Alternative Example: |
Reads out "Max Position", also displayed in Configuration dialog |
Phidgets_StepperName.MaxVelocityLimit |
Example: Alternative Example: |
Reads out "Max Velocity Limit", also displayed in Configuration dialog |
Phidgets_StepperName.MinAcceleration |
Example: Alternative Example: |
Reads out "Min Acceleration", also displayed in Configuration dialog |
Phidgets_StepperName.MinPosition |
Example: Alternative Example: |
Reads out "Min Position", also displayed in Configuration dialog |
Phidgets_StepperName.MinVelocityLimit |
Example: Alternative Example: |
Reads out "Min Velocity Limit", also displayed in Configuration dialog |
Phidgets_StepperName.MoveContinous(Accel, Velo) |
Example: Alternative Example: |
Sets a continuous movement with acceleration and velocity |
Phidgets_StepperName.Position |
Example: Alternative Example: |
Reads out "Current (Motor) Postion", also displayed in Configuration dialog |
Phidgets_StepperName.RescaleFactor |
Example: Alternative Example: |
Sets or returns "Rescale Factor", also displayed in Configuration dialog Example2: |
Phidgets_StepperName.SetCurrentLimit(value) |
Example: Alternative Example: |
Sets "Current Limit A", also displayed in Configuration dialog |
Phidgets_StepperName.SetHoldingCurrentLimit(value) |
Example: Alternative Example: |
Sets "Holding Current Limit", also displayed in Configuration dialog |
Phidgets_StepperName.SetInterval(value) |
Example: Alternative Example: |
This member sets the interval time which is displayed next to "Interval (ms)" in the Configuration menu when selecting the according Phidget device. |
Phidgets_StepperName.SetRescaleFactor(value) |
Example: Alternative Example: |
Sets "Rescale Factor", also displayed in Configuration dialog |
Phidgets_StepperName.SetZeroPosition |
Example: Alternative Example: |
Sets the current Position as 0 |
Phidgets_StepperName.StepToPosition(target,accel,velo) |
Example: Alternative Example: |
Sets a target position with acceleration and velocity |
Phidgets_StepperName.StopMoving |
Example: Alternative Example: |
stops Motor if moving |
Phidgets_StepperName.TargetPosition |
Example: Alternative Example: |
reads out TargetPosition |
Phidgets_StepperName.Velocity |
Example: Alternative Example: |
Reads out "Current Velocity", also displayed in Configuration dialog |