modbus4J-src

/* * ============================================================================ * GNU General Public License * ============================================================================ * * Copyright (C) 2006-2011 Serotonin Software Technologies Inc. http://serotoninsoftware.com * @author Matthew Lohbihler * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ package com.serotonin.modbus4j; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import com.serotonin.messaging.MessageControl; import com.serotonin.modbus4j.base.KeyedModbusLocator; import com.serotonin.modbus4j.base.RangeAndOffset; import com.serotonin.modbus4j.base.ReadFunctionGroup; import com.serotonin.modbus4j.base.SlaveProfile; import com.serotonin.modbus4j.code.DataType; import com.serotonin.modbus4j.code.ExceptionCode; import com.serotonin.modbus4j.code.FunctionCode; import com.serotonin.modbus4j.code.RegisterRange; import com.serotonin.modbus4j.exception.ErrorResponseException; import com.serotonin.modbus4j.exception.InvalidDataConversionException; import com.serotonin.modbus4j.exception.ModbusInitException; import com.serotonin.modbus4j.exception.ModbusTransportException; import com.serotonin.modbus4j.msg.ModbusRequest; import com.serotonin.modbus4j.msg.ModbusResponse; import com.serotonin.modbus4j.msg.ReadCoilsRequest; import com.serotonin.modbus4j.msg.ReadDiscreteInputsRequest; import com.serotonin.modbus4j.msg.ReadHoldingRegistersRequest; import com.serotonin.modbus4j.msg.ReadInputRegistersRequest; import com.serotonin.modbus4j.msg.ReadResponse; import com.serotonin.modbus4j.msg.WriteCoilRequest; import com.serotonin.modbus4j.msg.WriteMaskRegisterRequest; import com.serotonin.modbus4j.msg.WriteRegisterRequest; import com.serotonin.modbus4j.msg.WriteRegistersRequest; import com.serotonin.util.ArrayUtils; import com.serotonin.util.ProgressiveTask; abstract public class ModbusMaster extends Modbus { private int timeout = 500; private int retries = 2; private final Map<Integer, SlaveProfile> slaveProfiles = new HashMap<Integer, SlaveProfile>(); protected boolean initialized; abstract public void init() throws ModbusInitException; public boolean isInitialized() { return initialized; } abstract public void destroy(); abstract public ModbusResponse send(ModbusRequest request) throws ModbusTransportException; /** * Convenience method. See getValue(ModbusLocator) */ public Object getValue(int slaveId, int registerId, int dataType) throws ModbusTransportException, ErrorResponseException { RangeAndOffset rao = new RangeAndOffset(registerId); return getValue(slaveId, rao.getRange(), rao.getOffset(), dataType); } /** * Convenience method. See getValue(ModbusLocator) */ public Object getValue(int slaveId, int range, int offset, int dataType) throws ModbusTransportException, ErrorResponseException { return getValue(new ModbusLocator(slaveId, range, offset, dataType)); } /** * Convenience method. See getValue(ModbusLocator) */ public Boolean getValue(int slaveId, int registerId, byte bit) throws ModbusTransportException, ErrorResponseException { RangeAndOffset rao = new RangeAndOffset(registerId); return getValue(slaveId, rao.getRange(), rao.getOffset(), bit); } /** * Convenience method. See getValue(ModbusLocator) */ public Boolean getValue(int slaveId, int range, int offset, byte bit) throws ModbusTransportException, ErrorResponseException { return (Boolean) getValue(new ModbusLocator(slaveId, range, offset, bit)); } /** * Returns a value from the modbus network according to the given locator information. Various data types are * allowed to be requested including multi-word types. The determination of the correct request message to send is * handled automatically. * * @param locator * the information required to locate the value in the modbus network. * @return an object representing the value found. This will be one of Boolean, Short, Integer, Long, BigInteger, * Float, or Double. See the DataType enumeration for details on which type to expect. * @throws ModbusTransportException * if there was an IO error or other technical failure while sending the message * @throws ErrorResponseException * if the response returned from the slave was an exception. */ public Object getValue(ModbusLocator locator) throws ModbusTransportException, ErrorResponseException { BatchRead<String> batch = new BatchRead<String>(); batch.addLocator("", locator); BatchResults<String> result = send(batch); return result.getValue(""); } /** * Convenience method. See setValue(ModbusLocator, Object) */ public void setValue(int slaveId, int registerId, int dataType, Object value) throws ModbusTransportException, ErrorResponseException { RangeAndOffset rao = new RangeAndOffset(registerId); setValue(slaveId, rao.getRange(), rao.getOffset(), dataType, value); } /** * Convenience method. See setValue(ModbusLocator, Object) */ public void setValue(int slaveId, int range, int offset, int dataType, Object value) throws ModbusTransportException, ErrorResponseException { setValue(new ModbusLocator(slaveId, range, offset, dataType), value); } /** * Convenience method. See setValue(ModbusLocator, Object) */ public void setValue(int slaveId, int registerId, byte bit, boolean value) throws ModbusTransportException, ErrorResponseException { RangeAndOffset rao = new RangeAndOffset(registerId); setValue(slaveId, rao.getRange(), rao.getOffset(), bit, value); } /** * Convenience method. See setValue(ModbusLocator, Object) */ public void setValue(int slaveId, int range, int offset, byte bit, boolean value) throws ModbusTransportException, ErrorResponseException { setValue(new ModbusLocator(slaveId, range, offset, bit), value); } /** * Sets the given value in the modbus network according to the given locator information. Various data types are * allowed to be set including including multi-word types. The determination of the correct write message to send is * handled automatically. * * @param locator * the information required to locate the value in the modbus network. * @value an object representing the value to be set. This will be one of Boolean, Short, Integer, Long, BigInteger, * Float, or Double. See the DataType enumeration for details on which type to expect. * @throws ModbusTransportException * if there was an IO error or other technical failure while sending the message * @throws ErrorResponseException * if the response returned from the slave was an exception. */ public void setValue(ModbusLocator locator, Object value) throws ModbusTra