Setup Guide (Deprecated)

Installation and configuration of the Home Automation Manager 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 HAM" (automation.ham.txt) - Installs the Home Automation Manager core bundles together with the Config Tree module core components. Type the following command in the console to install the kit:
  kitman.install "Automation HAM"
- "Automation HAM JSON-RPC" (automation.ham.jsonrpc.txt) - Installs the remote handler for access over JSON-RPC. Type the following command in the console to install the kit:
  kitman.install "Automation HAM JSON-RPC"
- "Automation HAM Web Admin" (automation.ham.web.txt) - Installs the Web Admin plugin for automation management. Type the following command in the console to install the kit:
  kitman.install "Automation HAM Web Admin"

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

Manual Installation

You can install only the needed bundles from the module taking into account their dependencies both from this module and also from other modules.

Install the Web Services JSON RPC Provider Bundles if you need a JSON RPC API to the Home Automation Manager.
Install the Working with web console if you want to use the Home Automation Manager functionalities through a Web interface.
Install the Config Tree Module if you want to manage HAM configurations via the Config Tree.
Install and start the following bundles from the Home Automation Manager Module in the following order:
- com.prosyst.mbs.automation.ham.api.jar (HAM API Bundle)
- com.prosyst.mbs.automation.ham.core.jar (HAM Core Bundle)
- com.prosyst.mbs.automation.ham.commands.jar (HAM Console Commands Bundle)
- com.prosyst.mbs.automation.ham.astro.sunriset.jar ( HAM Astro Sunriset Bundle)
- com.prosyst.mbs.automation.ham.jsonrpc.jar (HAM JSON-RPC Bundle)
- com.prosyst.mbs.automation.ham.webconsole.jar (HAM Plugin for Web Console Bundle)
- com.prosyst.mbs.automation.ham.inventory.jar (HAM Inventory Bundle)

System Properties

The HAM module has the following system properties.

Property	Type	Default Value	Description
ham.status.event	String	not set	Determines which command types fire status events. When it is set its value should be either a comma separated list of command types, or a wildcard (*) for enabling status events from all command types.
ham.events.handlerPriority	int	1	Defines the priority of the OSGi Event Handlers registered by the Home Automation Manger. The lower number means that these components will receive event information faster than other runtime components.
ham.security.permission.enable	boolean	false	Turns on/off the security mode for the Home Automation Manager.
ham.secuirty.accadmin.enable	boolean	false	Defines the behavior of the Home Automation Manager when the com.prosyst.util.acc.ACCAdmin service is available but there is no Access Control Context associated to the application ID of the rule. If you set this property to "true" commands included in a rule but without an Access Control Context associated with their application ID will not be executed. For backward compatibility the default value is set to "false" which allows the execution of all commands.
ham.applications.backward.compatible.enable	boolean	true	It is used for backward compatibility by the application abstraction layer. If "false" - if your application has an ID and it does not have the necessary access permissions a security exception is thrown. If "true" - if your application has no ID it has full access, else it needs the respective access permissions.

For further information on how to setup system properties please follow the instructions on System Properties & Configurations.

Configuration Properties

Name	PID	Property	Type	Default Value	Description
Fail behavior	mbs.ham.command.scene	fail	String	interrupt	Defines the behavior of the scene when one of its commands fails to execute. There are two possible values for this property: "interrupt" - The scene execution will be stopped in case one of the commands fails to execute. "ignore" - The scene will ignore the failed command execution and continue with the next one. It is used only in case the scene is run with parameters or the parameters does not contain information about the fail behavior of the scene.
Log Level	mbs.ham.automationadmin.log.pid	log.level	int	0	Determines the least severe level of log messages created by the AutomationAdmin. 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
Log Print Level	mbs.ham.automationadmin.log.pid	log.print.level	int	0	Determines the least severe level of log messages created by the AutomationAdmin 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
HomeAutomationAdmin	mbs.ham.automationadmin.log.pid	HomeAutomationAdmin	boolean	true	Determines if the HAM Util should enable debug for HomeAutomationAdimn utility.
Log Level	mbs.ham.commands.log.pid	log.level	int		Determines the least severe level of log messages created by the Command Provider. 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
Log Print Level	mbs.ham.commands.log.pid	log.print.level	int		Determines the least severe level of log messages created by the Command Provider 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
Event Command	mbs.ham.commands.log.pid	EventCommand	boolean	true	Determines if the HAM Util should enable debug for Event Command utility.
Filter Rule State Command	mbs.ham.commands.log.pid	FilterRuleStateCommand	boolean	true	Determines if the HAM Util should enable debug for Filter Rule State Command utility.
Group	mbs.ham.commands.log.pid	GroupCommand	boolean	true	Determines if the HAM Util should enable debug for Group Command utility.
Log Command	mbs.ham.commands.log.pid	LogComman	boolean	true	Determines if the HAM Util should enable debug for Log Command utility.
Rule State Command	mbs.ham.commands.log.pid	RuleStateCommand	boolean	true	Determines if the HAM Util should enable debug for Rule State Command utility.
Scene Command	mbs.ham.commands.log.pid	SceneCommand	boolean	true	Determines if the HAM Util should enable debug for Scene Command utility.
Log Level	mbs.ham.conditions.log.pid	LogLevel	int	3	Determines the least severe level of log messages created by the Conditions Provider. 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
Log Print Level	mbs.ham.conditions.log.pid	LogPrintLevel	int	0	Determines the least severe level of log messages created by the Conditions Provider 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
AbsoluteTimer	mbs.ham.conditions.log.pid	AbsoluteTimerCondition	boolean	true	Determines if the HAM Util should enable debug for the AbsoluteTimerCondition utility.
AstroTimer	mbs.ham.conditions.log.pid	AstroTimerCondition	boolean	true	Determines if the HAM Util should enable debug for the AstroTimerCondition utility.
DailyPeriod	mbs.ham.conditions.log.pid	DailyPeriodCondition	boolean	true	Determines if the HAM Util should enable debug for the DailyPeriodCondition utility.
DailyTimer	mbs.ham.conditions.log.pid	DailyTimerCondition	boolean	true	Determines if the HAM Util should enable debug for the DailyTimerCondition utility.
Event Condition	mbs.ham.conditions.log.pid	EventCondition	boolean	true	Determines if the HAM Util should enable debug for the EventCondition utility.
IntervalTimer	mbs.ham.conditions.log.pid	IntervalTimerCondition	boolean	true	Determines if the HAM Util should enable debug for the IntervalTimerCondition utility.
Logic Condition	mbs.ham.conditions.log.pid	LogicCondition	boolean	true	Determines if the HAM Util should enable debug for the LogicCondition utility.
NthDayTimer	mbs.ham.conditions.log.pid	NthDayTimerCondition	boolean	true	Determines if the HAM Util should enable debug for the NthDayTimerCondition utility.
Postpone Condition	mbs.ham.conditions.log.pid	PostponeCondition	boolean	true	Determines if the HAM Util should enable debug for the PostponeCondition utility.
Status Condition	mbs.ham.conditions.log.pid	StatusCondition	boolean	true	Determines if the HAM Util should enable debug for the StatusCondition utility.
Log Level	mbs.ham.rules.log.pid	LogLevel	int	3	Determines the least severe level of log messages created by the Rules Provider. 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
Log Print Level	mbs.ham.rules.log.pid	LogPrintLevel	int	0	Determines the least severe level of log messages created by the Rules Provider 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
Rules	mbs.ham.rules.log.pid	Rule	boolean	true	Determines if the HAM Util should enable debug for the Rules utility.
Subscription	mbs.ham.statusreporter.pid	subscription	String	-	Determines for which command providers command status events should be thrown.
Load All HAObjects	mbs.ham.providers.pid	load_all_conf	boolean	true	Defines if the providers have to load HAObject of uninstalled applications.
Load HAObjects without appId	mbs.ham.providers.pid	Load_without_app_conf	boolean	true	Determines if the HAM Util should enable debug for the Rules utility.
Filter	mbs.ham.rule.pid	filter	String	-	HAM Rule Events Configuration. Defines LDAP Filter for Rule properties.

Troubleshooting

No troubleshooting information is available for this module.