Platforms to show: All Mac Windows Linux Cross-Platform
HIDAPIDeviceMBS class
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| class | USB | MBS USB Plugin | 16.0 | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No | Desktop, Console & Web |
For HIDAPI see website:
https://github.com/signal11/hidapi
The MBS Plugin includes a copy of hidapi for Mac, Windows and Linux.
The linux version needs libudev installed.
You can optionally load a different version of hidapi with LoadLibrary methods.
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.
- 11 properties
- property DeviceHandle as Integer
- property DeviceInfo as HIDAPIDeviceInfoMBS
- property Error as String
- property FeatureReportLength as Integer
- property Handle as Integer
- property InputReportLength as Integer
- property ManufacturerString as String
- property NonBlocking as Boolean
- property OutputReportLength as Integer
- property ProductString as String
- property SerialNumber as String
- shared property GlobalError as String
- 12 methods
- method Close
- method Constructor Private
- method GetFeatureReport(ReportID as Integer, MaxLength as Integer) as MemoryBlock
- method GetInputReport(ReportID as Integer, MaxLength as Integer) as MemoryBlock
- method GetReportDescriptor as MemoryBlock
- method IndexedString(Index as Integer, MaxLen as Integer = 1024) as String
- method Read(MaxLength as Integer) as MemoryBlock
- method ReadTimeOut(MaxLength as Integer, TimeoutMS as Integer) as MemoryBlock
- method SendFeatureReport(data as MemoryBlock) as Integer
- method SendFeatureReport(data as String) as Integer
- method Write(data as MemoryBlock) as Integer
- method Write(data as String) as Integer
- 9 shared methods
- shared method Enumerate(VendorID as Integer = 0, ProduceID as Integer = 0) as HIDAPIDeviceInfoMBS
- shared method Init as Integer
- shared method LoadError as String
- shared method LoadLibrary(File as FolderItem) as boolean
- shared method LoadLibrary(Path as string) as boolean
- shared method Open(VendorID as Integer, ProduceID as Integer, SerialNumber as String = "") as HIDAPIDeviceMBS
- shared method OpenPath(path as string) as HIDAPIDeviceMBS
- shared method Shutdown as Integer
- shared method VersionString as String
This class has no sub classes.
Blog Entries
- News from the MBS Xojo Plugins Version 24.1
- Get started with HIDAPI classes in Xojo
- MonkeyBread Software Releases the MBS Xojo Plugins in version 24.1
- MBS Xojo Plugins, version 24.1pr4
- MBS Xojo Plugins, version 21.2pr3
- MBS Xojo Plugins, version 19.1pr2
- MBS Xojo / Real Studio Plugins, version 16.1pr3
Release notes
- Version 24.1
- Added DeviceInfo and GetReportDescriptor functions to HIDAPIDeviceMBS class.
- Version 21.2
- Added GetInputReport and VersionString methods to HIDAPIDeviceMBS class.
- Removed WriteAsync for HIDAPIDeviceMBS class.
- Version 19.1
- Added HIDAPIDeviceMBS.WriteAsync method.
Some examples using this class:
Some related classes:
The items on this page are in the following plugins: MBS USB Plugin.
HIDAPIDeviceInfoMBS - HotKeyMBS
