Setup Guide

Installation

Automated Installation

The installation of the Peripheral Module can be performed through the execution of a Kit Manager installation script. The Peripheral Module provides three such scripts in the bin/pscripts folder:

"Peripheral" (found in the file peripheral.txt) – For automatic installation of the Peripheral module
"Peripheral JSON RPC" (found in the file peripheral.remote.txt) – For automatic installation of the Peripheral module with JSON RPC remote service
"Peripheral Web Admin" (found in the file peripheral.web.txt) – For automatic installation of the Peripheral module with the Web console plugin

To install the Peripheral Module using one the above scripts execute the console command from the kitman command groupkitman.install "<script name>", where <script name> is the name of the script to be installed. For example:

To install automatically the Peripheral module, type:
kitman.install "Peripheral"
To install automatically the Peripheral module with JSON RPC remote service type:
kitman.install "Peripheral JSON RPC"
To install automatically the Peripheral module with the Web console plugin type:
kitman.install "Peripheral Web Admin"

The kitman command group is exported by the Kit Manager Bundle. You can also write your own install scripts for easier installation and starting of a certain set of bundles. The required bundles for the Peripheral Module are listed in the Manual Installation section.

Manual Installation

If you want to install the Peripheral Module without using one of the provided Kit Manager installation scripts follow the steps below:

Install the USB Module.
Install and start the com.prosyst.mbs.osgi.upnp.jar bundle.
Install the Web Admin Console, if you need a user friendly web interface and the Web Admin Console has not been installed yet.
Install the JSON RPC Module, if you want to use the Peripheral Module over JSON RPC.
Install and start the bundles from the Peripheral Module:
- com.prosyst.mbs.peripheral.api.jar
- com.prosyst.mbs.peripheral.core.jar
- com.prosyst.mbs.peripheral.commands.jar
- Chose the appropriate one according to your operating system/hardware architecture.
  - Windows: com.prosyst.mbs.services.peripheral.os-natives.win_x86.jar or com.prosyst.mbs.services.peripheral.os-natives.win_x86_64.jar
  - Linux: No need to install additional os-native bundles. Supported by default by the com.prosyst.mbs.services.peripheral.os.jar bundle.
  - OS X: com.prosyst.mbs.services.peripheral.os-natives.macosx_x86_64.jar (used for 32-bit and 64-bit systems)
- com.prosyst.mbs.services.peripheral.os.jar
- com.prosyst.mbs.peripheral.installer.noagent.jar
- com.prosyst.mbs.peripheral.specificinfo.jar
- com.prosyst.mbs.peripheral.descriptors.jar
- com.prosyst.mbs.peripheral.loader.jar
- com.prosyst.mbs.peripheral.jsonrpc.jar (if you need to use web console or another remote call method)
- com.prosyst.mbs.peripheral.inventory.jar
- com.prosyst.mbs.peripheral.webconsole.jar (if you need a user friendly web interface provided by the Web Admin Console)
- com.prosyst.mbs.peripheral.observer.usb.jar
- com.prosyst.mbs.peripheral.commands.upnp
- com.prosyst.mbs.peripheral.observer.upnp.jar

To install and start a bundle execute the console command from the fw command group: install -s <bundle_name>.jar

System Properties

Property	Type	Value	Description
peripheral.driver.op.scheduler.tick.minutes	int	10	Minutes before next poll for scheduled tasks.
peripheral.driver.uninstall.delay.minutes	int	180	Minutes before triggering the removal of the unused drivers.
peripheral.driver.update.hour.of.day	int	24	Hour of the day at which driver update is performed.
peripheral.driver.install.manual	boolean	true	Control for the manual installation of drivers for peripheral devices. If set to "true", drivers will be manually installed.
peripheral.driver.uninstall.auto	boolean	false	Control for the automatic driver removal when a peripheral device is detached. If set to "false" driver is NOT automatically uninstalled when the device is detached.
peripheral.driver.update.auto	boolean	false	Control for the automatic driver update at a desired hour of the day. If set to "false" NO automatic driver update will be performed.
com.prosyst.mbs.ham.core.logPrintLevel	int	0	Determines the least severe level of the log messages to appear in the runtime console. Set the following values: "0" for no logs "1" for errors "2" for errors and warnings "3" for errors, warnings and info messages "4" for errors, warnings, info and debug messages
peripheral.default.uid	String	peripheral.default.uid	The default peripheral UID for USB devices.
observer.usb.use.descr.uid	boolean	false	Control for the use of native UID or descriptor UID for naming the USB peripheral devices found by the USB observer. If set to "false" native UID is used.
peripheral.pending.timeout	int	300000	Timeout (in milliseconds) to change the status of a peripheral device from Pending to Offline if no start event has been passed.
installer.local.use.storage	int	false	Controls in which directory the Peripheral Local Driver Info and Installer Bundle bundle should check for driver element .prs files. If set to "false" the Peripheral Local Driver Info and Installer bundle will use the storage/data/<bundle_ID>/features directory. If set to "false" the Peripheral Local Driver Info and Installer bundle will create and use the features folder in the same directory as the bundles folder.
peripheral.write.enable	boolean	false	When set to true will set the configuration owned by the Peripheral.
peripheral.write.enable.compatibility	boolean	false	When set to true will force the old operation mode, in which the write enable property is not included
peripheral.hide.notAssociated	boolean	false	If set to true, the Not Associated peripherals will not be listed on the cmd console and web console.
peripheral.os.linux.wget.command	String	-	Sets a custom wget command, for example: "peripheral.os.linux.wget.command="wget -q""

Configuration Properties

Property	Type	Default Value	Description
com.prosyst.mbs.peripheral.core.logLevel	int	0	Determines the least severe level of log messages created by the Peripheral module. Set the following values: "0" for no logs "1" for errors "2" for errors and warnings "3" for errors, warnings and info messages "4" for errors, warnings, info and debug messages

Property

Type

Default Value

Description

com.prosyst.mbs.peripheral.core.logLevel

int

Determines the least severe level of log messages created by the Peripheral module. Set the following values:

"0" for no logs
"1" for errors
"2" for errors and warnings
"3" for errors, warnings and info messages
"4" for errors, warnings, info and debug messages