[modbus] Modbus transport API simplification

bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/SunSpecHandlerFactory.java

@@ -23,10 +23,7 @@
 import org.eclipse.smarthome.core.thing.binding.ThingHandlerFactory;
 import org.openhab.binding.modbus.sunspec.internal.handler.InverterHandler;
 import org.openhab.binding.modbus.sunspec.internal.handler.MeterHandler;
-import org.openhab.io.transport.modbus.ModbusManager;
-import org.osgi.service.component.annotations.Activate;
 import org.osgi.service.component.annotations.Component;
-import org.osgi.service.component.annotations.Reference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -45,23 +42,6 @@ public class SunSpecHandlerFactory extends BaseThingHandlerFactory {
  */
  private final Logger logger = LoggerFactory.getLogger(SunSpecHandlerFactory.class);
 
- /**
- * Reference to the modbus manager
- */
- private ModbusManager manager;
-
- /**
- * This factory needs a reference to the ModbusManager wich is provided
- * by the org.openhab.io.transport.modbus bundle. Please make
- * sure it's installed and enabled before using this bundle
- *
- * @param manager reference to the ModbusManager. We use this for modbus communication
- */
- @Activate
- public SunSpecHandlerFactory(@Reference ModbusManager manager) {
- this.manager = manager;
- }
-
  @Override
  public boolean supportsThingType(ThingTypeUID thingTypeUID) {
  return SUPPORTED_THING_TYPES_UIDS.containsValue(thingTypeUID);
@@ -75,12 +55,12 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) {
  || thingTypeUID.equals(THING_TYPE_INVERTER_SPLIT_PHASE)
  || thingTypeUID.equals(THING_TYPE_INVERTER_THREE_PHASE)) {
  logger.debug("New InverterHandler created");
- return new InverterHandler(thing, manager);
+ return new InverterHandler(thing);
  } else if (thingTypeUID.equals(THING_TYPE_METER_SINGLE_PHASE)
  || thingTypeUID.equals(THING_TYPE_METER_SPLIT_PHASE) || thingTypeUID.equals(THING_TYPE_METER_WYE_PHASE)
  || thingTypeUID.equals(THING_TYPE_METER_DELTA_PHASE)) {
  logger.debug("New MeterHandler created");
- return new MeterHandler(thing, manager);
+ return new MeterHandler(thing);
  }
 
  return null;

bundles/org.openhab.binding.modbus.sunspec/src/main/java/org/openhab/binding/modbus/sunspec/internal/discovery/SunspecDiscoveryProcess.java

@@ -32,18 +32,14 @@
 import org.openhab.binding.modbus.sunspec.internal.dto.CommonModelBlock;
 import org.openhab.binding.modbus.sunspec.internal.dto.ModelBlock;
 import org.openhab.binding.modbus.sunspec.internal.parser.CommonModelParser;
-import org.openhab.io.transport.modbus.BasicModbusReadRequestBlueprint;
-import org.openhab.io.transport.modbus.BasicPollTaskImpl;
-import org.openhab.io.transport.modbus.BitArray;
+import org.openhab.io.transport.modbus.AsyncModbusFailure;
 import org.openhab.io.transport.modbus.ModbusBitUtilities;
+import org.openhab.io.transport.modbus.ModbusCommunicationInterface;
 import org.openhab.io.transport.modbus.ModbusConstants.ValueType;
-import org.openhab.io.transport.modbus.ModbusReadCallback;
 import org.openhab.io.transport.modbus.ModbusReadFunctionCode;
 import org.openhab.io.transport.modbus.ModbusReadRequestBlueprint;
 import org.openhab.io.transport.modbus.ModbusRegisterArray;
-import org.openhab.io.transport.modbus.ModbusSlaveErrorResponseException;
-import org.openhab.io.transport.modbus.PollTask;
-import org.openhab.io.transport.modbus.endpoint.ModbusSlaveEndpoint;
+import org.openhab.io.transport.modbus.exception.ModbusSlaveErrorResponseException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -68,11 +64,6 @@ public class SunspecDiscoveryProcess {
  */
  private final ModbusEndpointThingHandler handler;
 
- /**
- * The endpoint where we can reach the device
- */
- private final ModbusSlaveEndpoint endpoint;
-
  /**
  * Listener for the discovered devices. We get this
  * from the main discovery service, and it is used to
@@ -116,6 +107,11 @@ public class SunspecDiscoveryProcess {
  */
  private @Nullable CommonModelBlock lastCommonBlock = null;
 
+ /**
+ * Communication interface to the endpoint
+ */
+ private ModbusCommunicationInterface comms;
+
  /**
  * New instances of this class should get a reference to the handler
  *
@@ -125,9 +121,9 @@ public SunspecDiscoveryProcess(ModbusEndpointThingHandler handler, ModbusDiscove
  throws EndpointNotInitializedException {
  this.handler = handler;
 
- ModbusSlaveEndpoint endpoint = this.handler.asSlaveEndpoint();
- if (endpoint != null) {
- this.endpoint = endpoint;
+ ModbusCommunicationInterface localComms = handler.getCommunicationInterface();
+ if (localComms != null) {
+ this.comms = localComms;
  } else {
  throw new EndpointNotInitializedException();
  }
@@ -158,30 +154,13 @@ public void detectModel() {
  baseAddress = possibleAddresses.poll();
  logger.trace("Beginning scan for SunSpec device at address {}", baseAddress);
 
- BasicModbusReadRequestBlueprint request = new BasicModbusReadRequestBlueprint(slaveId,
+ ModbusReadRequestBlueprint request = new ModbusReadRequestBlueprint(slaveId,
  ModbusReadFunctionCode.READ_MULTIPLE_REGISTERS, baseAddress, // Start address
  SUNSPEC_ID_SIZE, // number or words to return
  maxTries);
 
- PollTask task = new BasicPollTaskImpl(endpoint, request, new ModbusReadCallback() {
-
- @Override
- public void onRegisters(ModbusReadRequestBlueprint request, ModbusRegisterArray registers) {
- headerReceived(registers);
- }
-
- @Override
- public void onError(ModbusReadRequestBlueprint request, Exception error) {
- handleError(error);
- }
-
- @Override
- public void onBits(@Nullable ModbusReadRequestBlueprint request, @Nullable BitArray bits) {
- // don't care, we don't expect this result
- }
- });
-
- handler.getManagerRef().get().submitOneTimePoll(task);
+ comms.submitOneTimePoll(request, result -> result.getRegisters().ifPresent(this::headerReceived),
+ this::handleError);
  }
 
  /**
@@ -210,30 +189,13 @@ private void headerReceived(ModbusRegisterArray registers) {
  */
  private void lookForModelBlock() {
 
- BasicModbusReadRequestBlueprint request = new BasicModbusReadRequestBlueprint(slaveId,
+ ModbusReadRequestBlueprint request = new ModbusReadRequestBlueprint(slaveId,
  ModbusReadFunctionCode.READ_MULTIPLE_REGISTERS, baseAddress, // Start address
  MODEL_HEADER_SIZE, // number or words to return
  maxTries);
 
- PollTask task = new BasicPollTaskImpl(endpoint, request, new ModbusReadCallback() {
-
- @Override
- public void onRegisters(ModbusReadRequestBlueprint request, ModbusRegisterArray registers) {
- modelBlockReceived(registers);
- }
-
- @Override
- public void onError(ModbusReadRequestBlueprint request, Exception error) {
- handleError(error);
- }
-
- @Override
- public void onBits(@Nullable ModbusReadRequestBlueprint request, @Nullable BitArray bits) {
- // don't care, we don't expect this result
- }
- });
-
- handler.getManagerRef().get().submitOneTimePoll(task);
+ comms.submitOneTimePoll(request, result -> result.getRegisters().ifPresent(this::modelBlockReceived),
+ this::handleError);
  }
 
  /**
@@ -280,30 +242,13 @@ private void modelBlockReceived(ModbusRegisterArray registers) {
  * @param block
  */
  private void readCommonBlock(ModelBlock block) {
- BasicModbusReadRequestBlueprint request = new BasicModbusReadRequestBlueprint(slaveId,
+ ModbusReadRequestBlueprint request = new ModbusReadRequestBlueprint(slaveId,
  ModbusReadFunctionCode.READ_MULTIPLE_REGISTERS, block.address, // Start address
  block.length, // number or words to return
  maxTries);
 
- PollTask task = new BasicPollTaskImpl(endpoint, request, new ModbusReadCallback() {
-
- @Override
- public void onRegisters(ModbusReadRequestBlueprint request, ModbusRegisterArray registers) {
- parseCommonBlock(registers);
- }
-
- @Override
- public void onError(ModbusReadRequestBlueprint request, Exception error) {
- handleError(error);
- }
-
- @Override
- public void onBits(@Nullable ModbusReadRequestBlueprint request, @Nullable BitArray bits) {
- // don't care, we don't expect this result
- }
- });
-
- handler.getManagerRef().get().submitOneTimePoll(task);
+ comms.submitOneTimePoll(request, result -> result.getRegisters().ifPresent(this::parseCommonBlock),
+ this::handleError);
  }
 
  /**
@@ -367,25 +312,22 @@ private void parsingFinished() {
  /**
  * Handle errors received during communication
  */
- private void handleError(Exception error) {
- String msg = "";
- String cls = "";
-
- if (blocksFound > 1 && error instanceof ModbusSlaveErrorResponseException) {
- int code = ((ModbusSlaveErrorResponseException) error).getExceptionCode();
+ private void handleError(AsyncModbusFailure<ModbusReadRequestBlueprint> failure) {
+ if (blocksFound > 1 && failure.getCause() instanceof ModbusSlaveErrorResponseException) {
+ int code = ((ModbusSlaveErrorResponseException) failure.getCause()).getExceptionCode();
  if (code == ModbusSlaveErrorResponseException.ILLEGAL_DATA_ACCESS
  || code == ModbusSlaveErrorResponseException.ILLEGAL_DATA_VALUE) {
  // It is very likely that the slave does not report an end block (0xffff) after the main blocks
  // so we treat this situation as normal.
  logger.debug(
- "Seems like slave device does not report an end block. Continouing with the dectected blocks");
+ "Seems like slave device does not report an end block. Continuing with the dectected blocks");
  parsingFinished();
  return;
  }
  }
 
- cls = error.getClass().getName();
- msg = error.getMessage();
+ String cls = failure.getCause().getClass().getName();
+ String msg = failure.getCause().getMessage();
 
  logger.warn("Error with read at address {}: {} {}", baseAddress, cls, msg);