|
|
|
|
|
Prerequisites
An account is needed in order to use Home Connect and thus remotely control and manage home appliances via the app.
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:
kitman.install "<kit_ID>"
where <kit_ID> is the ID of the component's install script. The following scripts for automated installation of the Home Connect module are available:
If you want to view or edit 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 from other modules as well. All the bundles for this module can be found in the /runtime/osgi/bundles directory.
In order to install the Home Connect module, please install and start the following bundles:
fw.i -f -s xml-apis.jar
fw.i -f -s javax.annotation.jar
fw.i -f -s javax.activation.compact.jar
fw.i -f -s javax.inject.jar
fw.i -f -s javax.validation.jar
fw.i -f -s javax.xml.bind.compact.jar
fw.i -f -s javax.ws.rs-2.1.jar
fw.i -f -s jakarta.json.jar
fw.i -f -s javax.json.bind.jar
fw.i -f -s jaxrs-ri.compact.jar
fw.i -f -s com.prosyst.mbs.homeconnect.driver.api.jar
fw.i -f -s com.prosyst.mbs.homeconnect.driver.core.jar
In order to install the Home Connect module with added integration for the Device Access module, please install and start the following bundles:
kitman.i "Device Access"
kitman.i "Home Connect Driver"
fw.i -f -s com.prosyst.mbs.homeconnect.da.hdm.adapter.api.jar
fw.i -f -s com.prosyst.mbs.homeconnect.da.items.api.jar
fw.i -f -s com.prosyst.mbs.homeconnect.da.items.provider.jar
fw.i -f -s com.prosyst.mbs.homeconnect.da.hdm.adapter.jar
In order to install the Home Connect module with added HDM integration for the Device Access module, please install and start the following bundles:
kitman.i "Device Access HDM"
kitman.i "Home Connect Driver"
fw.i -f -s com.prosyst.mbs.homeconnect.da.hdm.adapter.api.jar
fw.i -f -s com.prosyst.mbs.homeconnect.da.hdm.dc.api.jar
fw.i -f -s com.prosyst.mbs.homeconnect.da.hdm.dco.provider.jar
fw.i -f -s com.prosyst.mbs.homeconnect.da.hdm.adapter.jar
System Properties
Property Name |
Default Value |
Description |
Used Modules |
|---|---|---|---|
mbs.homeconnect.driver.delay |
2000 |
Home Connect cloud has defined request rate limits. When Home Connect adapter is started, there can be multiple requests by the adapter in order to synchronize the current state of the appliances. This property defines a delay between two consecutive requests to the Home Connect server. |
Home Connect Driver |
mbs.homeconnect.driver.connectTimeout |
300000 |
Socket connection timeout in milliseconds, passed to the Jersey client. |
Home Connect Driver |
mbs.homeconnect.driver.readTimeout |
80000 |
Socket read timeout in milliseconds, passed to the Jersey client. |
Home Connect Driver |
mbs.homeconnect.appliance.skipConnectedCheck |
false |
By default, when it is known that an appliance is not connected to the cloud at the moment, any requests for this appliance will not result in REST request to the cloud, but they will immediately throw HomeConnectException. Setting this property to true will make the driver send REST requests and normally error codes will be returned by the cloud. |
Home Connect Driver |
mbs.homeconnect.driver.sseReconnectTimeout |
60000 |
Timeout in milliseconds to wait for a new SSE subscription request to the cloud. The driver will first wait for the Retry-After HTTP header reported by the cloud. The property will take effect for any further retries. |
Home Connect Driver |
mbs.homeconnect.adapter.includeSSESubsriptionInDeviceStatus |
true |
By default, the DA/HDM Device representation of a Home Connect appliance does not show any indication if currently the driver is receiving server-sent events from the Home Connect cloud or not. If SSE channel is not opened at the moment, the device item / device class properties may have values that are not synchronized with the real appliance state. Setting this property to true makes the adapter show user-defined status value when SSE channel is broken. See next property too. |
Home Connect Adapter |
mbs.homeconnect.adapter.noSSESubsriptionDeviceStatus |
0 |
This property is used only when mbs.homeconnect.adapter.includeSSESubsriptionInDeviceStatus has value true. The value of this property is reported as the value of the Device status. Default value 0 means STATUS_NOT_INITIALIZED. |
Home Connect Adapter |
mbs.homeconnect.adapter.autoAddAppliance |
true (if Home Connect DCO provider is not running) |
When the Home Connect DCO provider is running, Home Connect appliances will not be represented automatically as HDM devices. They will first appear in the Controller device and it will require explicit user interaction to add them as HDM devices. If Home Connect DCO provider is not running (the default case with Device Access), then the Home Connect appliances will automatically be added as DA devices. |
Home Connect Adapter |
Troubleshooting
No troubleshooting information is available for this module.