git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.modbus.internal.handler;
  14
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import java.util.Set;
  18
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.openhab.binding.modbus.discovery.internal.ModbusEndpointDiscoveryService;
  21 import org.openhab.binding.modbus.handler.EndpointNotInitializedException;
  22 import org.openhab.binding.modbus.internal.ModbusConfigurationException;
  23 import org.openhab.binding.modbus.internal.config.ModbusTcpConfiguration;
  24 import org.openhab.core.io.transport.modbus.ModbusManager;
  25 import org.openhab.core.io.transport.modbus.endpoint.EndpointPoolConfiguration;
  26 import org.openhab.core.io.transport.modbus.endpoint.ModbusTCPSlaveEndpoint;
  27 import org.openhab.core.thing.Bridge;
  28 import org.openhab.core.thing.ThingUID;
  29 import org.openhab.core.thing.binding.ThingHandlerService;
  30
  31 /**
  32  * Endpoint thing handler for TCP slaves
  33  *
  34  * @author Sami Salonen - Initial contribution
  35  */
  36 @NonNullByDefault
  37 public class ModbusTcpThingHandler
  38         extends AbstractModbusEndpointThingHandler<ModbusTCPSlaveEndpoint, ModbusTcpConfiguration> {
  39
  40     public ModbusTcpThingHandler(Bridge bridge, ModbusManager manager) {
  41         super(bridge, manager);
  42     }
  43
  44     @Override
  45     protected void configure() throws ModbusConfigurationException {
  46         ModbusTcpConfiguration config = getConfigAs(ModbusTcpConfiguration.class);
  47
  48         String host = config.getHost();
  49         if (host == null) {
  50             throw new ModbusConfigurationException("host must be non-null!");
  51         }
  52
  53         this.config = config;
  54         endpoint = new ModbusTCPSlaveEndpoint(host, config.getPort(), config.getRtuEncoded());
  55
  56         EndpointPoolConfiguration poolConfiguration = new EndpointPoolConfiguration();
  57         this.poolConfiguration = poolConfiguration;
  58         poolConfiguration.setConnectMaxTries(config.getConnectMaxTries());
  59         poolConfiguration.setAfterConnectionDelayMillis(config.getAfterConnectionDelayMillis());
  60         poolConfiguration.setConnectTimeoutMillis(config.getConnectTimeoutMillis());
  61         poolConfiguration.setInterConnectDelayMillis(config.getTimeBetweenReconnectMillis());
  62         poolConfiguration.setInterTransactionDelayMillis(config.getTimeBetweenTransactionsMillis());
  63         poolConfiguration.setReconnectAfterMillis(config.getReconnectAfterMillis());
  64     }
  65
  66     @SuppressWarnings("null") // since Optional.map is always called with NonNull argument
  67     @Override
  68     protected String formatConflictingParameterError() {
  69         return String.format(
  70                 "Endpoint '%s' has conflicting parameters: parameters of this thing (%s '%s') are different from some other thing's parameter. Ensure that all endpoints pointing to tcp slave '%s:%s' have same parameters.",
  71                 endpoint, thing.getUID(), this.thing.getLabel(),
  72                 Optional.ofNullable(this.endpoint).map(e -> e.getAddress()).orElse("<null>"),
  73                 Optional.ofNullable(this.endpoint).map(e -> String.valueOf(e.getPort())).orElse("<null>"));
  74     }
  75
  76     @Override
  77     public int getSlaveId() throws EndpointNotInitializedException {
  78         ModbusTcpConfiguration localConfig = config;
  79         if (localConfig == null) {
  80             throw new EndpointNotInitializedException();
  81         }
  82         return localConfig.getId();
  83     }
  84
  85     @Override
  86     public ThingUID getUID() {
  87         return getThing().getUID();
  88     }
  89
  90     /**
  91      * Returns true if discovery is enabled
  92      */
  93     @Override
  94     public boolean isDiscoveryEnabled() {
  95         if (config != null) {
  96             return config.isDiscoveryEnabled();
  97         } else {
  98             return false;
  99         }
 100     }
 101
 102     @Override
 103     public Collection<Class<? extends ThingHandlerService>> getServices() {
 104         return Set.of(ModbusEndpointDiscoveryService.class);
 105     }
 106 }