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 |
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:
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
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 |
(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 |
(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 |
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 |
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 |
(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 |
(Read only property)
PhidgetMBS.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 |
Unit: milliseconds (ms)
(Read and Write property)
PhidgetMBS.DataRate as Double New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
The data rate is bounded by MinDataRate and MaxDataRate.
Changing DataRate will change the channel's DataInterval to a corresponding value, rounded to the nearest integer number of milliseconds.
The timing between events can also affected by the change trigger.
(Read and Write property)
PhidgetMBS.DeviceClass 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 |
(Read only property)
PhidgetMBS.DeviceClassName 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 |
(Read only property)
PhidgetMBS.DeviceID 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 |
(Read only property)
PhidgetMBS.DeviceLabel 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 label of the Phidget which this channel is a part of. A device label is a custom string used to more easily identify a Phidget. Labels are written to a Phidget using writeDeviceLabel(), or by right-clicking the device and setting a label in the Phidget Control Panel for Windows.
Specifies the label of the Phidget to be opened. Leave un-set to open any label. A device label is a custom string used to more easily identify a Phidget. Labels are written to a Phidget using Phidget_writeDeviceLabel(), or by right-clicking the device and setting a label in the Phidget Control Panel for Windows.
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)
Some examples using this property:
PhidgetMBS.DeviceName 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 |
(Read only property)
PhidgetMBS.DeviceSerialNumber 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 |
If the channel is part of a VINT device, this will be the serial number of the VINT Hub the device is attached to.
Specifies the serial number of the Phidget to be opened. Leave un-set, or set to kSerialNumberAny to open any serial number.
If the channel is part of a VINT device, this will be the serial number of the VINT Hub the device is attached to.
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)
Some examples using this property:
PhidgetMBS.DeviceSKU 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 |
(Read only property)
PhidgetMBS.DeviceVersion 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 |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read only property)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
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 |
(Read only property)
PhidgetMBS.HubPortSpeed as UInt32 New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
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 New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read only property)
PhidgetMBS.HubPortSupportsSetSpeed as Boolean New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(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 |
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 |
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)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 22.1 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
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 New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(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 |
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 New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read only property)
PhidgetMBS.MaxDataRate as Double New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read only property)
PhidgetMBS.MaxHubPortSpeed as UInt32 New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(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 |
(Read and Write property)
PhidgetMBS.MinDataInterval as UInt32 New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(Read only property)
PhidgetMBS.MinDataRate as Double New in 25.0
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Phidgets | MBS Phidgets Plugin | 25.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
(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 |
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 |
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 |
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 (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 |
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 |
(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 |
(Read only property)
The items on this page are in the following plugins: MBS Phidgets Plugin.
