Platforms to show: All Mac Windows Linux Cross-Platform

Back to PhidgetEncoderMBS class.

PhidgetEncoderMBS.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 channel will fire another PositionChange event.

The data interval is bounded by MinDataInterval and MaxDataInterval.
The timing between PositionChange events can also affected by the PositionChangeTrigger.

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

PhidgetEncoderMBS.Enabled 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
The enabled state of the encoder.

(Read and Write property)

PhidgetEncoderMBS.IndexPosition as Int64

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 of the index channel calculated by the Phidgets library.

The index channel will usually pulse once per rotation.
Setting the encoder position will move the index position the same amount so their relative position stays the same.
Index position is tracked locally as the last position at which the index was triggered. Setting position will only affect the local copy of the index position value. This means that index positions seen by multiple network applications may not agree.
(Read only property)

PhidgetEncoderMBS.IOMode 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
The encoder interface mode. Match the mode to the type of encoder you have attached.

It is recommended to only change this when the encoder disabled in order to avoid unexpected results.
(Read and Write property)

PhidgetEncoderMBS.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)

PhidgetEncoderMBS.MaxPositionChangeTrigger 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 PositionChangeTrigger can be set to.

(Read only property)

PhidgetEncoderMBS.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)

PhidgetEncoderMBS.MinPositionChangeTrigger 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 PositionChangeTrigger can be set to.

(Read only property)

PhidgetEncoderMBS.Position as Int64

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 calculated by the Phidgets library.

Position counts quadrature edges within a quadrature cycle. This means there are four counts per full quadrature cycle.
Position is tracked locally as the total position change from the time the channel is opened. Setting position will only affect the local copy of the position value. This means that positions seen by multiple network applications may not agree.
(Read and Write property)

PhidgetEncoderMBS.PositionChangeTrigger 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 channel will not issue a PositionChange event until the position value has changed by the amount specified by the PositionChangeTrigger.

Setting the PositionChangeTrigger to 0 will result in the channel firing events every DataInterval. This is useful for applications that implement their own data filtering
(Read and Write property)

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


The biggest plugin in space...