DA API Setup Guide

Installation of the DA API implementation in the OSGi environment.

Prerequisites

By default, the DA API implementation is available in the product.

Installation

Automated Installation

The Kit Manager is a utility that enables you to automatically install a component or a group of components by executing a predefined install script.

To use the Kit Manager to install a component:

Go to the text console and make sure that the Kit Manager bundle is available on your runtime.
Enter the kitman console command group to initiate the installation. Type
kitman.install "<kit_ID>"

where <kit_ID> is the ID of the component's install script. The following scripts for automated installation of the DA implementation are available:

"Device Access" - if you want to use the DA API implementation functionality.
"Device Access Web Admin" - if you want to use this module via Web interface.
"Device Access Config" - if the device configuration needs to be used via xml format.
"Device Access REST" - if Device Management RESTful Services need to be used.
"Functional Item Management JSON-RPC" - if the module needs to be used via JSON-RPC API.

If you want to view or edit these scripts you can find them in the <bosch.iot.sdk_home>/runtime/osgi/bin/pscripts directory.

Manual Installation

Only the bundles that are needed can be installed, taking into account their dependencies to other bundles. All bundles for this implementation can be found in the <bosch.iot.sdk_home>/runtime/osgi/bundles directory.

Install bundles related to "Functional Item Management JSON-RPC" if the module needs to be used via JSON-RPC API.
Install bundles related to "Functional Item Management Web Admin" and Units of Measurement FIM Web if the module needs to be used via Web interface.
Install bundles related to "Functional Item Management REST" if the module needs to be used via RESTful Web Services.

Install the following bundles:

com.prosyst.mbs.fim.api.jar
com.prosyst.mbs.fim.core.jar
com.prosyst.mbs.fim.commands.jar
com.prosyst.mbs.units.api.jar
com.prosyst.mbs.scripting.api.jar
com.prosyst.mbs.scripting.core.jar
com.prosyst.mbs.scripting.commands.jar
com.prosyst.mbs.da.api.jar
com.prosyst.mbs.hdm.api.jar
com.prosyst.mbs.da.xml.mapping.provider.jar
com.prosyst.mbs.da.xml.mapping.config.jar
com.prosyst.mbs.da.core.jar
com.prosyst.mbs.da.item.api.jar
com.prosyst.mbs.da.hdm.dc.api.jar
com.prosyst.mbs.da.config.jar
com.prosyst.mbs.da.rest.api.jar
com.prosyst.mbs.da.rest.core.jar

System Properties

Property	Type	Default Value	Description
da.device.item.strict	boolean	true	If the adapter does not support all properties and operations defined in the Device Item, it shouldn't be registered as a FunctionalItem in the OSGi service registry. When the value is true, the DA will check if all properties and operations are supported. When the value is false, the DA will not check and the Device Item will be registered as a FunctionalItem. The default value is true.
da.device.item.strict.all.metadata	boolean	false	This system property is an extension of the system property da.device.item.strict. If the adapter does not support all of the properties' metadata, it shouldn't be registered as a FunctionalItem in the OSGi service registry. The following metadata keys are compared: step, min, max and enum. When the value is true, the DA will check if all metadata is the same as the metadata specified with Functional Item Management annotations. When the value is false, the DA will not check these metadata keys.

Configuration Properties

PID : mbs.da.config.log

Name	Property	Type	Default Value	Description
Log Level	log.level	int	3	0 for no logs 1 for error 2 for warning 3 for info 4 for debug
Log Print Level	log.print.level	int	0	0 for no console messages 1 for error 2 for warning 3 for info 4 for debug
DA Config Bundle Handling	bundle.handling	boolean	true	The DA Config enables debug for DA Config Bundle Handling.
XML Parsing	xml.parsing	boolean	true	The DA Config enables debug for XML Parsing.
Database Storage	database.storage	boolean	true	The DA Config enables debug for Database Storage.
Bundle Activation	bundle	boolean	true	The DA Config enables debug for Bundle Activation.
Manifest Headers	manifest	boolean	true	The DA Config enables debug for Manifest Header.
Configuration	configuration	boolean	true	The DA Config enables debug for Configuration Processing.

PID : mbs.da.xml.mapping.provider.log

Name	Property	Type	Default Value	Description
Log Level	log.level	int	3	0 for no logs 1 for error 2 for warning 3 for info 4 for debug
Log Print Level	log.print.level	int	0	0 for no console messages 1 for error 2 for warning 3 for info 4 for debug
Mapping Provider Bundle Handling	bundle.handling	boolean	true	The DA enables debug for Mapping Provider Bundle Handling.
Mapping Provider Parser	mapping.provider.parser	boolean	true	The DA enables debug for Mapping Provider Parser.
Mapping Provider	mapping.provider	boolean	true	The DA enables debug for Mapping Provider.

PID : mbs.da.xml.mapping.config.log

Name	Property	Type	Default Value	Description
Log Level	log.level	int	3	0 for no logs 1 for error 2 for warning 3 for info 4 for debug
Log Print Level	log.print.level	int	0	0 for no console messages 1 for error 2 for warning 3 for info 4 for debug
Mapping Config Bundle Handling	bundle.handling	boolean	true	The DA enables debug for Mapping Config Bundle Handling.
Mapping Config Parser	mapping.config.parser	boolean	true	The DA enables debug for Mapping Config Bundle Parser.
Mapping Config	mapping.config	boolean	true	The DA enables debug for Mapping Config.