Package org.openhab.core.io.transport.serial

Interface SerialPortProvider

@NonNullByDefault
public interface SerialPortProvider

Provides a concrete SerialPort which can handle remote (e.g. via rfc2217) or local ports.

Author:

Matthias Steigenberger - Initial contribution

Method Summary

Modifier and Type	Method	Description
Stream<ProtocolType>	getAcceptedProtocols()	Gets all protocol types which this provider is able to create.
@Nullable SerialPortIdentifier	getPortIdentifier(URI portName)	Gets the SerialPortIdentifier if it is available or null otherwise.
Stream<SerialPortIdentifier>	getSerialPortIdentifiers()	Gets all the available SerialPortIdentifiers for this SerialPortProvider.

Method Details

getPortIdentifier

@Nullable SerialPortIdentifier getPortIdentifier(URI portName)

Gets the SerialPortIdentifier if it is available or null otherwise.

Parameters:

portName - The ports name.

Returns:

The created SerialPort or null if the serial port does not exist.

Throws:

UnsupportedCommOperationException

PortInUseException

getAcceptedProtocols

Stream<ProtocolType> getAcceptedProtocols()

Gets all protocol types which this provider is able to create.

Returns:

The protocol type.

getSerialPortIdentifiers

Stream<SerialPortIdentifier> getSerialPortIdentifiers()

Gets all the available SerialPortIdentifiers for this SerialPortProvider. Please note: Discovery is not available necessarily, hence the getPortIdentifier(URI) must be used in this case.

Returns:

The available ports