org.eclipse.kura.driver

Interface ChannelDescriptor

@ProviderType
public interface ChannelDescriptor

The Interface ChannelDescriptor is mainly used to provide the protocol specific channel descriptions which will be used by the assets in the Kura Wires Visualization model. It would enable asset to provide its protocol specific configurable properties.

Since:

1.2

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getDescriptor() Returns the protocol specific descriptor.

Method Detail

getDescriptor

java.lang.Object getDescriptor()

Returns the protocol specific descriptor. For using drivers in cooperation with Kura Wires Visualization, the implementors can return list of ADs to provide configurable properties for a ConfigurableComponent.

This method is essentially needed by Kura Wires Visualization model and in case the implementors need to use specific driver implementation in complete isolation, the implementors can return null.

Furthermore, some implementors can also provide custom objects. In such case, implementors must also provide another implementation for providing configurable properties of a ConfigurableComponent using the provided custom object. As currently the AD uses OSGi Configuration Admin service to provide configurable properties, the custom object class needs to use OSGi Configuration Admin service for that same purpose.

Returns:

the protocol specific descriptor