Platforms to show: All Mac Windows Linux Cross-Platform

Back to PhidgetMBS class.

PhidgetMBS.Attached 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
Gets the attached status of channel.

A Phidget is attached after it has been opened and the Phidget library finds and connects to the corresponding hardware device.
Most API calls are only valid on attached Phidgets.
(Read only property)

See also:

PhidgetMBS.Channel 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 channel index of the channel on the device.

Specifies the channel index to be opened. The default channel is 0. Set to kChannelAny to open any channel on the specified device.

If setting this property, it must be set before the channel is opened. The behaviour of setting this property while the channel is open is undefined.
(Read and Write property)

PhidgetMBS.ChannelClass 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
Gets the channel class of the channel.

(Read only property)

Some examples using this property:

PhidgetMBS.ChannelClassName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the name of the channel class the channel belongs to.

(Read only property)

Some examples using this property:

PhidgetMBS.ChannelName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the channel's name.

This name serves as a description of the specific nature of the channel.
(Read only property)

PhidgetMBS.ChannelSubclass 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
Gets the subclass for this channel.

Allows for identifying channels with specific characteristics without needing to know the exact device and channel index.
(Read only property)

Some examples using this property:

PhidgetMBS.ClientVersionMajor 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 major version of the client.

(Read only property)

PhidgetMBS.ClientVersionMinor 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 minor version of the client.

(Read only property)

PhidgetMBS.Handle 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 internal object reference.

(Read only property)

PhidgetMBS.Hub as PhidgetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the hub that this channel is attached to.

(Read only property)

PhidgetMBS.HubPort 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
Gets the hub port index of the VINT Hub port that the channel is attached to.

Specifies the hub port index of the VINT Hub port to open this channel on. Leave un-set, or set to kHubPortAny to open the channel on any VINT Hub port

If setting this property, it must be set before the channel is opened. The behaviour of setting this property while the channel is open is undefined.
(Read and Write property)

PhidgetMBS.HubPortCount 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
Gets the number of VINT ports present on the VINT Hub that the channel is attached to.

(Read only property)

PhidgetMBS.HubPortSpeed as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Configures the communication speed for this VINT device.

Both the HubPortSupportsSetSpeed and VINTDeviceSupportsSetSpeed must be true in order to set the hub port speed.Available speeds are: 100000, 160000, 250000, 400000, 500000, 800000 and 1000000. Setting any other speed will select the nearest lower supported speed. The upper speed is bound by the lesser of MaxHubPortSpeed and MaxVINTDeviceSpeed. Set the speed to PHIDGET_HUBPORTSPEED_AUTO to enable Auto Set Speed on Hubs that support it (enabled by default).
(Read and Write property)

PhidgetMBS.HubPortSupportsAutoSetSpeed as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Indicates that the communication speed of this VINT port can be set automatically.

(Read only property)

PhidgetMBS.HubPortSupportsSetSpeed as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Indicates that the communication speed of this VINT port can be set.

(Read only property)

PhidgetMBS.IsChannel 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
True if the handle is for a channel.

Returns true if the PhidgetHandle is for a channel. Mostly for use alongside Phidget_getParent() to distinguish channel handles from device handles.
(Read only property)

PhidgetMBS.IsHubPortDevice 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
Whether this channel is a VINT Hub port channel, or part of a VINT device attached to a hub port.

Specifies whether this channel should be opened on a VINT Hub port directly, or on a VINT device attached to a hub port.

If setting this property, it must be set before the channel is opened. The behaviour of setting this property while the channel is open is undefined.
(Read and Write property)

PhidgetMBS.IsLocal 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
True when this channel is attached directly on the local machine, or false otherwise.

Set to True if the channel is to be opened locally, and not over a network. If both this and IsRemote are set to False (the default), the channel will be opened either locally or remotely, on whichever matching channel is found first.

If setting this property, it must be set before the channel is opened. The behaviour of setting this property while the channel is open is undefined.
(Read and Write property)

PhidgetMBS.IsOpen as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Returns true if Phidget_open() has been called on this channel.

(Read only property)

PhidgetMBS.IsRemote 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
True when this channel is attached via a Phidget network server, or false otherwise.

Set to True if the channel is to be opened remotely, rather than locally. If both this and IsLocal are set to False (the default), the channel will be opened either locally or remotely, on whichever matching channel is found first.

In order for your program to have access to remote Phidgets, you must use the Networking API to EnableServerDiscovery or AddServer.

If setting this property, it must be set before the channel is opened. The behaviour of setting this property while the channel is open is undefined.
(Read and Write property)

PhidgetMBS.MaxDataInterval as UInt32

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

(Read only property)

PhidgetMBS.MaxDataRate as Double

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

(Read only property)

PhidgetMBS.MaxHubPortSpeed as UInt32

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 25.0 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
The max communication speed of a high-speed capable VINT Port.

(Read only property)

PhidgetMBS.MeshMode 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 mesh mode.

(Read and Write property)

PhidgetMBS.MinDataInterval as UInt32

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

(Read only property)

PhidgetMBS.MinDataRate as Double

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

(Read only property)

PhidgetMBS.Parent as PhidgetMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the handle of the parent device of the given Phidget handle.

For example, this would refer to the device the channel is a part of, or the Hub that a device is plugged into.

This is useful when used alongside a Phidget Manager to create device trees like the one in the Phidget Control Panel.

Phidget_release() must be called on the handle returned by this function to release the reference created by this call.

This can be used to travel up the device tree and get device information at each step.
The root device will return a null handle
Parent handles always refer to devices. See IsChannel()
(Read only property)

PhidgetMBS.ServerHostname as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the hostname of the Phidget network server for network attached Phidgets.

Fails if the channel is not connected to a Phidget network server.
(Read only property)

PhidgetMBS.ServerName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the name of the Phidget network server the channel is attached to, if any.

Fails if the channel is not connected to a Phidget network server.
(Read and Write property)

PhidgetMBS.ServerPeerName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the peer name of the channel's server.

Gets the peer name (address and port) of the Phidget server for network attached Phidgets, formatted as: address:port
Fails if the channel is not connected to a Phidget network server.
(Read only property)

PhidgetMBS.ServerUniqueName as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Phidgets MBS Phidgets Plugin 22.1 ✅ Yes ✅ Yes ✅ Yes ❌ No Desktop, Console & Web
Gets the unique name for the server the channel is attached to, if any.

This is either a unique mDNS name, or the name specified in addServer
Fails if the channel is not connected to a Phidget network server.
(Read only property)

PhidgetMBS.ServerVersionMajor 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 major version of the server.

(Read only property)

PhidgetMBS.ServerVersionMinor 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 minor version of the server.

(Read only property)

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


The biggest plugin in space...