PhidgetMBS.Attach
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The event called when a device is attached.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

class PhidgetMBS
class, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The base class of all Phidget device classes.
Notes: Check http://www.phidgets.com/ for information on this devices.

PhidgetMBS.Close
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Closes the file handles for this device.
Notes:
You can call this while reads and writes are still outstanding; they will fail quickly.
Lasterror is set.
The destructor does a close if you forget it.

PhidgetMBS.Detach
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The event called when a device is detached.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

PhidgetMBS.disableLogging
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Disables logging on the library.
Notes: The Lasterror property is set.

PhidgetMBS.enableLogging(level as integer, outputFile as string)
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Enables logging on the library.
Notes:
The Lasterror property is set.
Data is written to the file specified with the output file path.
Not sure how the path must be specified. This is depending on the library used.

The levels:

PHIDGET_LOG_CRITICAL	1
PHIDGET_LOG_ERROR	2
PHIDGET_LOG_WARNING	3
PHIDGET_LOG_DEBUG	4
PHIDGET_LOG_INFO	5
PHIDGET_LOG_VERBOSE	6

PhidgetMBS.Error(errorCode as integer, errorDescription as string)
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function:
This event is used for reporting asynchronous errors - mostly related to opening
remote Phidgets.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

PhidgetMBS.GetDeviceLabel as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the Label for the Phidget.
Notes:
The Label is a user programmable serial number stored on the Phidget - it can be used to implement a serial numbering scheme, or describe the functionality of the Phidget in a specific application.

Lasterror is set.

PhidgetMBS.GetDeviceName as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns string describing the name of the Phidget.
Notes:
For example, “Phidget InterfaceKit 8/8/8”, “Phidget InterfaceKit 0/0/4”, etc.
The Lasterror property is set.

PhidgetMBS.GetDeviceStatus as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns an integer indicating the status of the device.
Notes:
Returns:
PHIDGET_ATTACHED 0x1
PHIDGET_NOTATTACHED 0x0

Lasterror is set.

PhidgetMBS.GetDeviceType as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns a string describing the type of the Phidget.
Notes:
All PhidgetInterfaceKits will return "PhidgetInterfaceKit", PhidgetRFID returns "PhidgetRFID" and so on.

Lasterror is set.

PhidgetMBS.GetDeviceVersion as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns a string describing the Device Version of the Phidget.
Notes: Lasterror is set.

PhidgetMBS.GetErrorDescription(errorcode as integer) as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns a string describing the ErrorCode passed.
Notes:
Lasterror is set.

The list of the error codes:

0 EPHIDGET_OK
1 EPHIDGET_NOTFOUND
2 EPHIDGET_NOMEMORY
3 EPHIDGET_UNEXPECTED
4 EPHIDGET_INVALIDARG
5 EPHIDGET_NOTATTACHED
6 EPHIDGET_INTERRUPTED
7 EPHIDGET_INVALID
8 EPHIDGET_NETWORK
9 EPHIDGET_UNKNOWNVAL
10 EPHIDGET_BADPASSWORD
11 EPHIDGET_UNSUPPORTED
12 EPHIDGET_DUPLICATE
13 EPHIDGET_TIMEOUT
14 EPHIDGET_OUTOFBOUNDS
15 EPHIDGET_EVENT
16 EPHIDGET_NETWORK_NOTCONNECTED
17 EPHIDGET_WRONGDEVICE

PhidgetMBS.GetLibraryVersion as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: returns a string providing the version number of the API library.
Notes: Lasterror is set.

PhidgetMBS.GetSerialNumber as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the unique serial number of this Phidget.
Notes:
Lasterror is set.
This number is set during manufacturing, and is unique across all Phidgets.

PhidgetMBS.GetServerAddress(byref port as integer) as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the IP Address and Port of a remote Phidget device.
Notes:
This should only be called on Phidgets that were opened with openRemote or openRemoteIP.
Lasterror is set.

PhidgetMBS.GetServerID as string
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns the Server ID for a remote Phidget device.
Notes:
This method is not yet implemented and will return EPHIDGET_UNSUPPORTED.

This should only be called on Phidgets that were opened with openRemote or openRemoteIP.
The Lasterror property is set.

PhidgetMBS.GetServerStatus as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Returns an integer indicating the connection status of a Webservice.
Notes:
Returns one of the following values:
1 CONNECTED
0 NOTCONNECTED

Lasterror is set.

PhidgetMBS.Handle as Integer
property, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The internal used CPhidgetHandle.
Notes: (Read and Write property)

PhidgetMBS.Lasterror as Integer
property, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: The last error code.
Notes:

EPHIDGET_NOTFOUND	1	"A Phidget matching the type and or serial number could not be found." This indicates that a Phidget being searched for (ie. via Open) could not be located.
EPHIDGET_NOMEMORY	2	"Memory could not be allocated." This indicates that there is not enough memory for the Phidgets library to create the object requested.
EPHIDGET_UNEXPECTED	3	"Unexpected Error. Contact Phidgets Inc. for support." Indicates that a serious error has occurred, or a severe bug exists within the library.
EPHIDGET_INVALIDARG	4	"Invalid argument passed to function." An argument is not valid to the requirements of the function. In many cases this refers to an invalid Phidget Handle.
EPHIDGET_NOTATTACHED	5	"Phidget not physically attached." Indicates the function requires an attached Phidget to operate.
EPHIDGET_INTERRUPTED	6	"Read/Write operation was interrupted" An error occurred while attempting to communicate with the Phidget over USB.
EPHIDGET_INVALID	7	"The Error Code is not defined." Indicates that a serious error has occurred, or a severe bug exists within the library.
EPHIDGET_NETWORK	8	"Network Error." Attempting to communicate with the Phidget via the Network has failed.
EPHIDGET_UNKNOWNVAL	9	"Value is Unknown (State not yet received from device)." A query to a value on the Phidget device has failed as the Phidget has not returned data yet.
EPHIDGET_BADPASSWORD	10	"Authorization Failed." The remote access method has failed it’s authorization.
EPHIDGET_UNSUPPORTED	11	"Not Supported" This is a bad or unsupported function call.
EPHIDGET_DUPLICATE	12	"Duplicated request" A previous request to the device has already performed this function, and it is not valid to perform twice.
EPHIDGET_TIMEOUT	13	"Given timeout has been exceeded" A synchronous request has failed it’s time limits. Usually this is returned when attempting WaitForConnect.
EPHIDGET_OUTOFBOUNDS	14	"Index out of Bounds" An index into the function is above or below the recognized bounds of the device. ie. when accessing a single sensor on a multisensor device.
EPHIDGET_EVENT	15	"A non-null error code was returned from an event handler" An error code was passed to a function handler. Note that correct decoding of the actual error would have to be done within the event handler itself.
EPHIDGET_NETWORK_NOTCONNECTED	16	"A connection to the server does not ex-ist." An attempt to connect to a remotely connected device or service failed due to network connectivity problems.
EPHIDGET_WRONGDEVICE	17	"Function is not applicable for this device." The wrong type of device handle was passed as an argument to a function. (ie. calling CPhidgetWeightSensor_getWeight with an Accelerometer handle)

(Read and Write property)

PhidgetMBS.Open(serialNumber as integer=-1)
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Creates a connection between an PhidgetMBS object and a physical Phidget.
Example:

dim p as new PhidgetInterfaceKitMBS

p.open -1
p.waitForAttachment 0
// use the phidget

Notes:
Open is pervasive. What this means is that you can call open on a device before it is plugged in, and keep the device opened across device dis- and re-connections.
Open is Asynchronous. What this means is that open will return immediately - before the device being opened is actually available.
What this means is that you need to either poll getDeviceStatus for an attached status, or handle the attach event, in order to wait for the device to become available before trying to use it.

SerialNumber specifies the desired serial number, allowing the call to open a specific Phidget. Specifying -1 for the serial number will cause it to open the first available device.
Lasterror is set.

PhidgetMBS.openRemote(serial as integer, serverID as string, password as string) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This method is not yet implemented and will return EPHIDGET_UNSUPPORTED.
Notes: Lasterror is set.

PhidgetMBS.openRemoteIP(serial as integer, addr as string, port as integer, password as string) as integer
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Attempts to open a connection to a Phidget Webservice, and waits for a phidget on that connection.
Notes:
OpenRemoteIP will block until it connects to the server, which means that when it returns with EPHIDGET_OK, this means that the connection is active. If the server is unavailable, this will return an error code. If the connection to a webservice is disrupted while in use, an error event will be thrown, and it is recommended that an error event listener be registered for this reason.
As with the regular open, openRemoteIP is pervasive and asynchronous – so long as the connection to the Webservice remains active.
SerialNumber specifies the desired serial number, allowing the call to open a specific Phidget. Specifying -1 for the serial number will cause it to open the first available device.
Address is the address of the computer running the Phidget Webservice. This can be either an IP address or a hostname.
Port specifies the port of the Webservice on the remote computer.
Password specifies the password, which is required if authentication is active on the Webservice. If authentication is not active, this can be set to "".
Lasterror is set.

PhidgetMBS.ServerConnect
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This event is used for opening Phidgets remotely, and is called when a connection to the sever has been made.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

PhidgetMBS.ServerDisconnect
event, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: This event is used for opening Phidgets remotely, and is called when a connection to the server has been lost.
Notes:
With plugin version 8.5 and newer this event is executed on the main thread of your application to avoid crashes with REALbasic. Events are buffered until you the main thread has time available.
Older plugins execute the event on the thread where the event was created which may lead into problems described in the ThreadMBS class documentation.

PhidgetMBS.SetDeviceLabel(label as string)
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Writes a Label – a string up to 10 characters long – to the Phidget associated with this handle.
Notes:
SetDeviceLabel may not be available on all operating systems.
Currently it is available on MacOS X, Linux, and Windows CE.
Calling this on Windows will return EPHIDGET_UNSUPPORTED
Lasterror is set.

PhidgetMBS.waitForAttachment(milliseconds as integer)
method, Phidget, MBS USB Plugin (Phidgets), class PhidgetMBS, Console safe, Plugin version: 7.7, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.

Function: Waits the given time till a device has been attached.
Example:

dim p as new PhidgetInterfaceKitMBS

p.open -1
p.waitForAttachment 0
// use the phidget

Notes:
Lasterror is set to EPHIDGET_OK when the device is available, or to EPHIDGET_TIMEOUT if the device is not attached before the timeout expires.
Timeouts below about 300ms cannot be trusted because of initialization time, and sometimes an even larger timeout is required – ie. the first time a device is plugged into a windows machine.
A timeout of 0 is infinite.
This function can be used in conjunction with (or instead of) an attach event handler.
The Lasterror property is set.