|
|
|
|
|
Installation
Automated Installation
The installation of the USB Module can be performed through execution of a Kit Manager installation script. In the bin/pscripts folder of the USB Module you will find the following script file, which will install all required components for the USB module depending on the operating system you are using (this script identifies your platform and automatically selects the correct components):
To install the USB Module using a Kit Manager installation script execute the console command from the kitman command group kitman.install "<script name>" where <script name> is the name of the script to be installed. For example in this case you would need to execute the following command:
kitman.install "USB"
The kitman command group is exported by the Kit Manager Bundle. You may also write your own install scripts for easier installation (and start) of a certain set of bundles. The required bundles for the USB Module are listed in the Manual Installation section.
Manual Installation
If you want to install the USB Module without using a Kit Manager installation script Kit Manager installation scripts follow the steps below:
For Windows operating systems: com.prosyst.mbs.usb.core-natives.win_x86.jar (or com.prosyst.mbs.usb.core-natives.win_x86_64.jar - for 64-bit operating systems and JVMs)
For Mac OS X operating systems: com.prosyst.mbs.usb.core-natives.macosx_x86.jar (or com.prosyst.mbs.usb.core-natives.macosx_x86.jar - for 64-bit operating systems and JVMs)
For Linux operating systems: com.prosyst.mbs.usb.core-natives.linux_x86_generic.jar (or com.prosyst.mbs.usb.core-natives.linux_x86_64_generic.jar - for 64-bit operating systems and JVMs)To install and start a bundle execute the console command from the fw command group:
install -s <bundle_name>.jar
Console Commands
The USB module provides the list command under the usb commands group.
System Properties
Property |
Type |
Default Value |
Description |
|||
|---|---|---|---|---|---|---|
mbs.services.usb.debug |
boolean |
false |
If set to true, the debug level messages will be stored through the Log Service. |
|||
mbs.services.usb.console |
boolean |
false |
If set to true, the log information messages will be printed in the runtime console. |
|||
javax.usb libusb related properties: |
||||||
mbs.services.usb.topologyPollingTimeout |
integer |
1000 |
The period of polling in milliseconds. |
|||
mbs.services.usb.handleEventTimeout |
integer |
1000 |
The length of time in milliseconds to block HandleEvent thread in the native nativeHandleEvents() function. |
|||
mbs.services.usb.newDeviceDelay |
integer |
600 |
The length of time in milliseconds to delay sending a notification event that there is a new device, starting from the moment the device was found. |
|||
mbs.services.usb.controlTimeout |
integer |
5000 |
Communication timeout in milliseconds during control transfer. |
|||
mbs.services.usb.bulkTimeout |
integer |
6000 |
Communication timeout in milliseconds during bulk transfer. |
|||
mbs.services.usb.interruptTimeout |
integer |
6000 |
Communication timeout in milliseconds during interrupt transfer. |
|||
mbs.services.usb.isochronousTimeout |
integer |
6000 |
Communication timeout in milliseconds during isochronous transfer. |
|||
mbs.services.usb.driverDetach |
boolean |
false |
If set to true, a detach mechanism will be enabled which tries to detach the kernel driver if there is an error on the first attempt to claim an interface. |
|||
mbs.services.usb.libusb.logLevel |
integer |
0 |
Determines the least severe level of log messages created by the libusb. The property can be set to one of the following values:
|
|||
mbs.services.usb.jni.logLevel |
integer |
0 |
Determines the least severe level of log messages created by the JNI of libusb. The property can be set to one of the following values:
|
|||
USB Linux Bundle
System Property |
Default Value |
Description |
|---|---|---|
runner.pipe.in |
.runner.ipc_i |
Points to input pipe filename, used by both – Linux Native Runtime bundle and the mBSA native agent for communication. |
runner.pipe.out |
.runner.ipc_o |
Points to output pipe filename, used by both – Linux Native Runtime bundle and the mBSA native agent for communication. |
Configuration Properties
None.
Troubleshooting
No troubleshooting information is available for this module.