MacHIDMBS.Close

MacHIDMBS.Connect

Function OpenUSBDevice() As boolean
  dim i as Integer
  dim h as MacHIDMBS
  
  h=FindDevice // see FindFirst example
  
  if h=nil then
    MsgBox "No XYZ device found."
    Return false
  end if
  
  h.Connect
  
  if h.Lasterror<>0 then
    MsgBox "Failed to connect to USB Device."
    Return false
  end if
  
  h.InstallCallback
  
  Return true
  
End Function

Lasterror is set.

Lasterror values for this function:

-1	Not supported (Windows and Linux).
0	Everything okay.
1	Failed to get IOKit Plugin Interface for this IO object.
2	Failed to query interface
3	Failed to open interface
4	Failed to create async port
5	Failed to create async event source
6	no longer used
7	Failed to start queue

MacHIDMBS.Disconnect

Lasterror is set.

MacHIDMBS.FindFirstDevice as boolean

Function FindDevice() As MyMacHIDMBS
  dim h as MyMacHIDMBS
  dim p as string
  
  h=new MyMacHIDMBS // your own subclass of MacHIDMBS so you can get events
  
  if h.FindFirstDevice then
    
    p=h.Product
    if p="MyProduct" then
      Return h
    end if
    
    while h.FindNextDevice
      
      p=h.Product
      if p="MyProduct" then
        Return h
      end if
      
    wend
    
  end if
End Function

Returns true on success and false on failure.

MacHIDMBS.FindNextDevice as boolean

Returns true on success and false on failure.

MacHIDMBS.HIDProperties as Variant

Value is a CFDictionaryMBS with details about current device. Returned as Variant to reduce plugin dependencies.

The plugin queries this dictionary to return SerialNumber, ProductID, Manufacturer, Product, VendorID and VersionNumber.

MacHIDMBS.InstallCallback

Lasterror is set.
Please use after connect. For use with ReceivedData event.

Some examples using this method:

• /USB/HID Mac/USB HID IO Warrior Mac OS X LEDs
• /USB/HID Mac/USB HID Test Mac
• /USB/USBtest

MacHIDMBS.Manufacturer as string

On any error an empty string is returned.

MacHIDMBS.Product as string

Lasterror is set.

MacHIDMBS.ProductID as Integer

Lasterror is set.

MacHIDMBS.ReadMessage(ReportID as Integer, reportType as Integer, length as Integer) as string

This is for synchronously operation without the event/callback.
You can specify report id, report type and the maximum length to read.
Also set timeout property.

Doesn't work if InstallCallback with event is used.

MacHIDMBS.ReadMessageMemory(ReportID as Integer, reportType as Integer, length as Integer) as memoryblock

This is for synchronously operation without the event/callback.
You can specify report id, report type and the maximum length to read.
Also set timeout property.

Doesn't work if InstallCallback with event is used.

MacHIDMBS.SendMessage(data as string)

A connection must be open.
Lasterror is set. Lasterror -536854447 is an USB timeout.
Uses kIOHIDReportTypeOutput.

See also:

• SendMessage(ReportID as Integer, reportType as Integer, data as string)

MacHIDMBS.SendMessage(ReportID as Integer, reportType as Integer, data as string)

A connection must be open.
Lasterror is set. Lasterror -536854447 is an USB timeout.
ReportType can be kIOHIDReportTypeOutput or kIOHIDReportTypeFeature.

See also:

• SendMessage(data as string)

MacHIDMBS.SendMessageMemory(data as memoryblock, offset as Integer, length as Integer)

A connection must be open.
Lasterror is set. Lasterror -536854447 is an USB timeout.
Internally ReportID=0 is used.

While writing a crossplatform application for one specific device we saw the following thing: The data buffer for the SendMessageMemory call must be 8 bytes long on Mac (with MacHIDMBS) and 61 bytes long for Windows (with WinHIDMBS) for our HID device. We have 1 byte for the ReportID and 60 data bytes where the first 8 are set like on the Mac. So if the calls fail on Windows, try with a higher length and check the WinHIDMBS.OutputReportByteLength property.
Uses kIOHIDReportTypeOutput.

See also:

• SendMessageMemory(ReportID as Integer, reportType as Integer, data as memoryblock, offset as Integer, length as Integer)

MacHIDMBS.SendMessageMemory(ReportID as Integer, reportType as Integer, data as memoryblock, offset as Integer, length as Integer)

A connection must be open.
Lasterror is set. Lasterror -536854447 is an USB timeout.
ReportType can be kIOHIDReportTypeOutput or kIOHIDReportTypeFeature.

See also:

• SendMessageMemory(data as memoryblock, offset as Integer, length as Integer)

MacHIDMBS.SerialNumber as string

Lasterror is set.

MacHIDMBS.VendorID as Integer

Lasterror is set.

MacHIDMBS.VersionNumber as Integer

Value can be anything.
On any error, 0 is returned.