gurux.dlms.objects.GXDLMSIecTwistedPairSetup Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gurux.dlms Show documentation
Show all versions of gurux.dlms Show documentation
gurux.dlms.java package is used to communicate with DLMS devices.
//
// --------------------------------------------------------------------------
// Gurux Ltd
//
//
//
// Filename: $HeadURL$
//
// Version: $Revision$,
// $Date$
// $Author$
//
// Copyright (c) Gurux Ltd
//
//---------------------------------------------------------------------------
//
// DESCRIPTION
//
// This file is a part of Gurux Device Framework.
//
// Gurux Device Framework is Open Source 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; version 2 of the License.
// Gurux Device Framework 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.
//
// More information of Gurux products: https://www.gurux.org
//
// This code is licensed under the GNU General Public License v2.
// Full text may be retrieved at http://www.gnu.org/licenses/gpl-2.0.txt
//---------------------------------------------------------------------------
//
//--------------------------------------------------------------------------
//Gurux Ltd
//
//
//
package gurux.dlms.objects;
import java.util.ArrayList;
import java.util.List;
import javax.xml.stream.XMLStreamException;
import gurux.dlms.GXByteBuffer;
import gurux.dlms.GXDLMSSettings;
import gurux.dlms.GXDLMSTranslator;
import gurux.dlms.ValueEventArgs;
import gurux.dlms.enums.DataType;
import gurux.dlms.enums.ErrorCode;
import gurux.dlms.enums.ObjectType;
import gurux.dlms.internal.GXCommon;
import gurux.dlms.objects.enums.BaudRate;
import gurux.dlms.objects.enums.IecTwistedPairSetupMode;
/**
* Online help:
* https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSIecTwistedPairSetup
*/
public class GXDLMSIecTwistedPairSetup extends GXDLMSObject implements IGXDLMSBase {
/**
* Working mode.
*/
private IecTwistedPairSetupMode mode;
/**
* Communication speed.
*/
private BaudRate speed;
/**
* List of Primary Station Addresses.
*/
private byte[] primaryAddresses;
/**
* List of the TAB(i) for which the real equipment has been programmed in the
* case of forgotten station call.
*/
private byte[] tabis;
/**
* Constructor.
*/
public GXDLMSIecTwistedPairSetup() {
this("0.0.23.0.0.255", 0);
}
/**
* Constructor.
*
* @param ln Logical Name of the object.
*/
public GXDLMSIecTwistedPairSetup(final String ln) {
this(ln, 0);
}
/**
* Constructor.
*
* @param ln Logical Name of the object.
* @param sn Short Name of the object.
*/
public GXDLMSIecTwistedPairSetup(final String ln, final int sn) {
super(ObjectType.IEC_TWISTED_PAIR_SETUP, ln, sn);
mode = IecTwistedPairSetupMode.INACTIVE;
speed = BaudRate.BAUDRATE_9600;
}
/**
* Gets Working mode.
*
* @return Working mode.
*/
public final IecTwistedPairSetupMode getMode() {
return mode;
}
/**
* Sets working mode.
*
* @param value Working mode.
*/
public final void setMode(final IecTwistedPairSetupMode value) {
mode = value;
}
/**
* Gets communication speed.
*
* @return Communication speed.
*/
public final BaudRate getSpeed() {
return speed;
}
/**
* Gets communication speed.
*
* @param value Communication speed.
*/
public final void setSpeed(final BaudRate value) {
speed = value;
}
/**
* Gets list of Primary Station Addresses.
*
* @return List of Primary Station Addresses.
*/
public final byte[] getPrimaryAddresses() {
return primaryAddresses;
}
/**
* Sets list of Primary Station Addresses.
*
* @param value List of Primary Station Addresses.
*/
public final void setPrimaryAddresses(final byte[] value) {
primaryAddresses = value;
}
/**
* Gets list of the TABis.
*
* @return List of the TABis.
*/
public final byte[] getTabis() {
return tabis;
}
/**
* Sets list of the TABis.
*
* @param value List of the TABis.
*/
public final void setTabis(final byte[] value) {
tabis = value;
}
@Override
public final Object[] getValues() {
return new Object[] { getLogicalName(), getMode(), getSpeed(), getPrimaryAddresses(), getTabis() };
}
/*
* Returns collection of attributes to read. If attribute is static and already
* read or device is returned HW error it is not returned.
*/
@Override
public final int[] getAttributeIndexToRead(final boolean all) {
java.util.ArrayList attributes = new java.util.ArrayList();
// LN is static and read only once.
if (all || getLogicalName() == null || getLogicalName().compareTo("") == 0) {
attributes.add(1);
}
// Mode
if (all || canRead(2)) {
attributes.add(2);
}
// Speed
if (all || canRead(3)) {
attributes.add(3);
}
// PrimaryAddresses
if (all || canRead(4)) {
attributes.add(4);
}
// Tabis
if (all || canRead(5)) {
attributes.add(5);
}
return GXDLMSObjectHelpers.toIntArray(attributes);
}
/*
* Returns amount of attributes.
*/
@Override
public final int getAttributeCount() {
return 5;
}
/*
* Returns amount of methods.
*/
@Override
public final int getMethodCount() {
return 0;
}
@Override
public final DataType getDataType(final int index) {
DataType ret;
switch (index) {
case 1:
ret = DataType.OCTET_STRING;
break;
case 2:
case 3:
ret = DataType.ENUM;
break;
case 4:
case 5:
ret = DataType.ARRAY;
break;
default:
throw new IllegalArgumentException("getDataType failed. Invalid attribute index.");
}
return ret;
}
/*
* Returns value of given attribute.
*/
@Override
public final Object getValue(final GXDLMSSettings settings, final ValueEventArgs e) {
Object ret;
switch (e.getIndex()) {
case 1:
ret = GXCommon.logicalNameToBytes(getLogicalName());
break;
case 2:
ret = mode.ordinal();
break;
case 3:
ret = speed.ordinal();
break;
case 4: {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY);
if (primaryAddresses == null) {
data.setUInt8(0);
} else {
data.setUInt8((byte) primaryAddresses.length);
for (byte it : primaryAddresses) {
data.setUInt8(DataType.UINT8);
data.setUInt8(it);
}
}
ret = data.array();
break;
}
case 5: {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY);
if (tabis == null) {
data.setUInt8(0);
} else {
data.setUInt8(tabis.length);
for (byte it : tabis) {
data.setUInt8(DataType.INT8);
data.setUInt8(it);
}
}
ret = data.array();
break;
}
default:
e.setError(ErrorCode.READ_WRITE_DENIED);
ret = null;
break;
}
return ret;
}
/*
* Set value of given attribute.
*/
@Override
public final void setValue(final GXDLMSSettings settings, final ValueEventArgs e) {
if (e.getIndex() == 1) {
setLogicalName(GXCommon.toLogicalName(e.getValue()));
} else if (e.getIndex() == 2) {
setMode(IecTwistedPairSetupMode.values()[((Number) e.getValue()).intValue()]);
} else if (e.getIndex() == 3) {
setSpeed(BaudRate.values()[((Number) e.getValue()).intValue()]);
} else if (e.getIndex() == 4) {
List list = new ArrayList();
for (Object it : (List) e.getValue()) {
list.add(((Number) it).byteValue());
}
setPrimaryAddresses(toByteArray(list));
} else if (e.getIndex() == 5) {
List list = new ArrayList();
for (Object it : (List) e.getValue()) {
list.add(((Number) it).byteValue());
}
setTabis(toByteArray(list));
} else {
e.setError(ErrorCode.READ_WRITE_DENIED);
}
}
@Override
public final void load(final GXXmlReader reader) throws XMLStreamException {
mode = IecTwistedPairSetupMode.values()[reader.readElementContentAsInt("Mode")];
speed = BaudRate.values()[reader.readElementContentAsInt("Speed")];
primaryAddresses = GXDLMSTranslator.hexToBytes(reader.readElementContentAsString("PrimaryAddresses"));
tabis = GXDLMSTranslator.hexToBytes(reader.readElementContentAsString("Tabis"));
}
@Override
public final void save(final GXXmlWriter writer) throws XMLStreamException {
writer.writeElementString("Mode", mode.ordinal());
writer.writeElementString("Speed", speed.ordinal());
writer.writeElementString("PrimaryAddresses", GXDLMSTranslator.toHex(primaryAddresses));
if (tabis != null) {
writer.writeElementString("Tabis", GXDLMSTranslator.toHex(tabis));
}
}
@Override
public final void postLoad(final GXXmlReader reader) {
// Not needed for this object.
}
@Override
public String[] getNames() {
return new String[] { "Logical Name", "Mode", "Speed", "PrimaryAddresses", "Tabis" };
}
@Override
public String[] getMethodNames() {
return new String[0];
}
}