ModbusSerialSlave.java

/**
 * Copyright (c) 2010-2020 Contributors to the openHAB project
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.openhab.binding.modbus.internal;

import org.apache.commons.pool2.KeyedObjectPool;
import org.openhab.binding.modbus.internal.pooling.ModbusSerialSlaveEndpoint;
import org.openhab.binding.modbus.internal.pooling.ModbusSlaveEndpoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import net.wimpi.modbus.Modbus;
import net.wimpi.modbus.io.ModbusSerialTransaction;
import net.wimpi.modbus.net.ModbusSlaveConnection;
import net.wimpi.modbus.net.SerialConnection;
import net.wimpi.modbus.util.SerialParameters;

/**
 * ModbusSlave class instantiates physical Modbus slave.
 * It is responsible for polling data from physical device using TCPConnection.
 * It is also responsible for updating physical devices according to OpenHAB commands
 *
 * @author Dmitry Krasnov
 * @since 1.1.0
 */
public class ModbusSerialSlave extends ModbusSlave {

    private static final Logger logger = LoggerFactory.getLogger(ModbusSerialSlave.class);
    private SerialParameters serialParameters = new SerialParameters();

    public ModbusSerialSlave(String slave, KeyedObjectPool<ModbusSlaveEndpoint, ModbusSlaveConnection> connectionPool) {
        super(slave, connectionPool);
        transaction = new ModbusSerialTransaction();
        endpoint = new ModbusSerialSlaveEndpoint(serialParameters);
    }

    public void setSerialParameters(SerialParameters serialParameters) {
        if (isEncodingValid(serialParameters.getEncoding())) {
            this.serialParameters = serialParameters;
        } else {
            logger.warn("Encoding '{}' is unknown. Ignoring configured serial parameters",
                    serialParameters.getEncoding());
        }
        endpoint = new ModbusSerialSlaveEndpoint(this.serialParameters);
    }

    private boolean isEncodingValid(String serialEncoding) {
        for (String str : Modbus.validSerialEncodings) {
            if (str.trim().contains(serialEncoding)) {
                return true;
            }
        }
        return false;
    }

    @Override
    protected ModbusSlaveConnection getConnection(ModbusSlaveEndpoint endpoint) {
        ModbusSlaveConnection connection = super.getConnection(endpoint);
        if (connection == null) {
            return null;
        }
        if (!(connection instanceof SerialConnection)) {
            throw new IllegalStateException("Should not happen: wrong connection type for slave " + name);
        }
        SerialConnection serialConnection = (SerialConnection) connection;
        ((ModbusSerialTransaction) transaction).setSerialConnection(serialConnection);
        return connection;

    }

}