Setup Guide (Deprecated)

Installation and configuration of the Automation ESH Module in the OSGi environment.

Prerequisites

There are no prerequisites for this module.

Installation

There are two ways to install the desired module components: through the Kit Manager or manually.

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 the Kit Manager bundle is available on your runtime.
To initiate the installation type:
kitman.install "<kit_ID>"

where <kit_ID> is the ID of the component's install script. The following scripts are available in the bin/pscripts directory:

"Automation ESH" (automation.esh.txt) – Starts the Automation ESH modules plus core and FI handlers, core providers and console commands. Type the following command in the console to install the kit:
kitman.install "Automation ESH"
"Automation ESH Web Admin" (automation.esh.web.txt) – Starts the Automation ESH module and Web Console and Automation ESH Web Console Plugin. Type the following command in the console to install the kit:
kitman.install "Automation ESH Web Admin"
"Automation ESH REST"(automation.esh.rest.txt) – Starts the Automation ESH module with RESTfull Web Services functionality. Type the following command in the console to install the kit.
kitman.install "Automation ESH REST"
"Automation ESH REST Compact" (automation.esh.rest.compact.txt) – Starts the Automation ESH module only with the compact version of bundles.
kitman.install "Automation ESH REST Compact"
"Automation ESH Provider File" (automation.esh.provider.file.txt) – Starts the Automation ESH module with File Provider functionalities. Type the following command in the console to install the kit.
kitman.install "Automation ESH Provider File"

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

Manual Installation

You can install only the needed bundles from the Automation ESH module taking into account their dependencies both from this module and also from other modules. All Automation ESH modules can be found in the <bosch-iot-gateway-sdk_home>/runtime/osgi/bundles directory.

com.prosyst.mbs.fim.api.jar
com.prosyst.mbs.fim.core.jar
gson.jar
guava.jar
com.prosyst.mbs.automation.esh.api.jar
com.prosyst.mbs.automation.esh.storage.jar
com.prosyst.mbs.automation.esh.core.jar
com.prosyst.mbs.automation.esh.handler.core.jar
com.prosyst.mbs.automation.esh.handler.item.jar
com.prosyst.mbs.automation.esh.commands.jar
com.prosyst.mbs.util.systemtime.jar
org.eclipse.smarthome.automation.api.jar
org.eclipse.smarthome.automation.core.jar
org.eclipse.smarthome.automation.parser.gson.jar
org.eclipse.smarthome.automation.provider.jar

System Properties

There are no system properties that influence the operation of the module.

Configuration Properties

Name	PID	Property	Type	Default Value	Description
Rule Registry Configuration	org.eclipse.smarthome.automation.ruleregistry	Rule Reinitialization Delay	Long	500	Delay between rule's re-initialization tries.
Locale Provider Config	org.eclipse.smarthome.core.localeprovider	Language	String	en	An ISO 639 alpha-2 or alpha-3 language code.
Locale Provider Config	org.eclipse.smarthome.core.localeprovider	Script	String	Latin	ISO 15924 alpha-4 script code.
Locale Provider Config	org.eclipse.smarthome.core.localeprovider	Region	String	UK	An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code.
Locale Provider Config	org.eclipse.smarthome.core.localeprovider	Variant	String		Any arbitrary value used to indicate a variation of a Locale.
Rules File Provider Config	org.eclipse.smarthome.automation.provider.file.LoadEventHandler	Automation ESH Rules Root	String	../../../automation	Specifies the parent directory in the file system for automation rule resources.
Module Types File Provider Config	org.eclipse.smarthome.automation.provider.file.ModuleTypeFileProvider	Automation ESH Module Types Root	String	../../../automation	Specifies the parent directory in the file system for automation module type resources.
Templates File Provider Config	org.eclipse.smarthome.automation.provider.file.TemplateFileProvider	Automation ESH Templates Root	String	../../../automation	Specifies the parent directory in the file system for automation rule template resources.

Troubleshooting

No troubleshooting information is available for this module.