The SHIP HDM Adapter module is an implementation of the SHIP HDM adapter that represents SHIP nodes as HomeDevices. It is only available with HDM DCO implementations, and not with Device Access device items. Protocol-specific device class interfaces are being deprecated, to be replaced by device item interfaces for future releases.

Each known SHIP node is mapped to a HomeDevice instance. mDNS TXT record data of the SHIP node is provided as HomeDevice properties.

A SHIP HomeDevice instance can have one of the following statuses:

• HomeDevice.STATUS_NOT_CONFIGURED - The device is discovered by the SHIP discovery mechanism, but it is not paired/registered to the OSGi framework's SHIP node.
• HomeDevice.ONLINE - The device is paired and it is known to be available in the network. Online does not necessary mean that there is an established connection to the device. It means that there MAY be such a connection, or that the device has just been discovered by the SHIP Discovery (mDNS) and a connection can be established when needed. As a default, the connection is kept open.
• HomeDevice.NOT_INITIALIZED - The device is paired and its mDNS record is available, but at the moment there is no SHIP connection to it. This status is optional, activated by a system property and disabled by default.
• HomeDevice.OFFLINE- The device is paired but there isn't an established connection at the moment, and the device is not discoverable by SHIP discovery (mDNS). This can happen if an ONLINE device is powered off.

Each external SHIP node has a PairingControl device class object that is used to pair/unpair the SHIP node.

The SHIP protocol driver (the local SHIP node, OSGi framework as SHIP node) may also be represented as an HDM HomeDevice instance. This is a configurable option, it is not enabled by default.

• To enable it you have to set the following key to TRUE:

  set mbs.ship.hdm.adapter.addControllerDevice=true

• Then, you need to restart the HDM Adapter bundle by typing in the command console:

  restart com.prosyst.mbs.ship.da.hdm.adapter

ALternatively, you can restart the bundle from the Web Admin Console HDM. Go to OSGI > Bundles, find the HDM Adapter bundle in the list, and press the "STOP/START" button.

Now the controller should be visible, and its status will be ONLINE:

If enabled, the HDM HomeDevice representation of the SHIP protocol driver has a NetworkControllerExt device class object. Setting it to pairing mode means switching the SHIP protocol driver to auto-accept mode. Execution of the reset operation of the NetworkControllerExt is equivalent to resetting the SHIP protocol driver.