gurux.dlms.objects.GXDLMSModemConfiguration 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
//---------------------------------------------------------------------------
package gurux.dlms.objects;
import java.util.ArrayList;
import java.util.List;
import javax.xml.stream.XMLStreamException;
import gurux.dlms.GXByteBuffer;
import gurux.dlms.GXDLMSClient;
import gurux.dlms.GXDLMSSettings;
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;
/**
* Online help:
* https://www.gurux.fi/Gurux.DLMS.Objects.GXDLMSModemConfiguration
*/
public class GXDLMSModemConfiguration extends GXDLMSObject implements IGXDLMSBase {
private GXDLMSModemInitialisation[] initialisationStrings;
private String[] modemProfile;
private BaudRate communicationSpeed;
static final String[] defultProfiles() {
return new String[] { "OK", "CONNECT", "RING", "NO CARRIER", "ERROR", "CONNECT 1200",
"NO DIAL TONE", "BUSY", "NO ANSWER", "CONNECT 600", "CONNECT 2400", "CONNECT 4800",
"CONNECT 9600", "CONNECT 14 400", "CONNECT 28 800", "CONNECT 33 600",
"CONNECT 56 000" };
}
/**
* Constructor.
*/
public GXDLMSModemConfiguration() {
super(ObjectType.MODEM_CONFIGURATION, "0.0.2.0.0.255", 0);
initialisationStrings = new GXDLMSModemInitialisation[0];
communicationSpeed = BaudRate.BAUDRATE_300;
modemProfile = defultProfiles();
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
*/
public GXDLMSModemConfiguration(final String ln) {
super(ObjectType.MODEM_CONFIGURATION, ln, 0);
initialisationStrings = new GXDLMSModemInitialisation[0];
communicationSpeed = BaudRate.BAUDRATE_300;
modemProfile = defultProfiles();
}
/**
* Constructor.
*
* @param ln
* Logical Name of the object.
* @param sn
* Short Name of the object.
*/
public GXDLMSModemConfiguration(final String ln, final int sn) {
super(ObjectType.MODEM_CONFIGURATION, ln, 0);
initialisationStrings = new GXDLMSModemInitialisation[0];
communicationSpeed = BaudRate.BAUDRATE_300;
modemProfile = defultProfiles();
}
public final BaudRate getCommunicationSpeed() {
return communicationSpeed;
}
public final void setCommunicationSpeed(final BaudRate value) {
communicationSpeed = value;
}
public final GXDLMSModemInitialisation[] getInitialisationStrings() {
return initialisationStrings;
}
public final void setInitialisationStrings(final GXDLMSModemInitialisation[] value) {
initialisationStrings = value;
}
public final String[] getModemProfile() {
return modemProfile;
}
public final void setModemProfile(final String[] value) {
modemProfile = value;
}
@Override
public final Object[] getValues() {
return new Object[] { getLogicalName(), getCommunicationSpeed(), getInitialisationStrings(),
getModemProfile() };
}
/*
* 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);
}
// CommunicationSpeed
if (all || !isRead(2)) {
attributes.add(2);
}
// InitialisationStrings
if (all || !isRead(3)) {
attributes.add(3);
}
// ModemProfile
if (all || !isRead(4)) {
attributes.add(4);
}
return GXDLMSObjectHelpers.toIntArray(attributes);
}
/*
* Returns amount of attributes.
*/
@Override
public final int getAttributeCount() {
return 4;
}
/*
* Returns amount of methods.
*/
@Override
public final int getMethodCount() {
return 0;
}
@Override
public final DataType getDataType(final int index) {
if (index == 1) {
return DataType.OCTET_STRING;
}
if (index == 2) {
return DataType.ENUM;
}
if (index == 3) {
return DataType.ARRAY;
}
if (index == 4) {
return DataType.ARRAY;
}
throw new IllegalArgumentException("getDataType failed. Invalid attribute index.");
}
/*
* Returns value of given attribute.
*/
@Override
public final Object getValue(final GXDLMSSettings settings, final ValueEventArgs e) {
if (e.getIndex() == 1) {
return GXCommon.logicalNameToBytes(getLogicalName());
}
if (e.getIndex() == 2) {
return communicationSpeed.ordinal();
}
if (e.getIndex() == 3) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY.getValue());
// Add count
int cnt = 0;
if (initialisationStrings != null) {
cnt = initialisationStrings.length;
}
GXCommon.setObjectCount(cnt, data);
if (cnt != 0) {
for (GXDLMSModemInitialisation it : initialisationStrings) {
data.setUInt8(DataType.STRUCTURE.getValue());
data.setUInt8(3); // Count
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.getBytes(it.getRequest()));
GXCommon.setData(settings, data, DataType.OCTET_STRING,
GXCommon.getBytes(it.getResponse()));
GXCommon.setData(settings, data, DataType.UINT16, it.getDelay());
}
}
return data.array();
}
if (e.getIndex() == 4) {
GXByteBuffer data = new GXByteBuffer();
data.setUInt8(DataType.ARRAY.getValue());
// Add count
int cnt = 0;
if (modemProfile != null) {
cnt = modemProfile.length;
}
GXCommon.setObjectCount(cnt, data);
if (cnt != 0) {
for (String it : modemProfile) {
GXCommon.setData(settings, data, DataType.OCTET_STRING, GXCommon.getBytes(it));
}
}
return data.array();
}
e.setError(ErrorCode.READ_WRITE_DENIED);
return null;
}
/*
* 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) {
communicationSpeed = BaudRate.values()[((Number) e.getValue()).intValue()];
} else if (e.getIndex() == 3) {
initialisationStrings = null;
if (e.getValue() != null) {
List items = new ArrayList();
for (Object it : (List) e.getValue()) {
List arr = (List) it;
GXDLMSModemInitialisation item = new GXDLMSModemInitialisation();
item.setRequest(GXDLMSClient
.changeType((byte[]) arr.get(0), DataType.STRING, e.getSettings())
.toString());
item.setResponse(GXDLMSClient
.changeType((byte[]) arr.get(1), DataType.STRING, e.getSettings())
.toString());
if (arr.size() > 2) {
item.setDelay(((Number) arr.get(2)).intValue());
}
items.add(item);
}
initialisationStrings = items.toArray(new GXDLMSModemInitialisation[items.size()]);
}
} else if (e.getIndex() == 4) {
modemProfile = null;
if (e.getValue() != null) {
List items = new ArrayList();
for (Object it : (List) e.getValue()) {
items.add(GXDLMSClient.changeType((byte[]) it, DataType.STRING, e.getSettings())
.toString());
}
modemProfile = items.toArray(new String[items.size()]);
}
} else {
e.setError(ErrorCode.READ_WRITE_DENIED);
}
}
@Override
public final void load(final GXXmlReader reader) throws XMLStreamException {
communicationSpeed =
BaudRate.values()[reader.readElementContentAsInt("CommunicationSpeed")];
if (reader.isStartElement("InitialisationStrings", true)) {
while (reader.isStartElement("Initialisation", true)) {
GXDLMSModemInitialisation it = new GXDLMSModemInitialisation();
it.setRequest(reader.readElementContentAsString("Request"));
it.setResponse(reader.readElementContentAsString("Response"));
it.setDelay(reader.readElementContentAsInt("Delay"));
}
reader.readEndElement("InitialisationStrings");
}
modemProfile = GXCommon.split(reader.readElementContentAsString("ModemProfile", ""), ';')
.toArray(new String[0]);
}
@Override
public final void save(final GXXmlWriter writer) throws XMLStreamException {
if (communicationSpeed != BaudRate.BAUDRATE_300) {
writer.writeElementString("CommunicationSpeed", communicationSpeed.ordinal());
}
if (initialisationStrings != null) {
writer.writeStartElement("InitialisationStrings");
for (GXDLMSModemInitialisation it : initialisationStrings) {
writer.writeStartElement("Initialisation");
writer.writeElementString("Request", it.getRequest());
writer.writeElementString("Response", it.getResponse());
writer.writeElementString("Delay", it.getDelay());
writer.writeEndElement();
}
writer.writeEndElement();
}
if (modemProfile != null) {
writer.writeElementString("ModemProfile", String.join(";", modemProfile));
}
}
@Override
public final void postLoad(final GXXmlReader reader) {
// Not needed for this object.
}
@Override
public String[] getNames() {
return new String[] { "Logical Name", "Communication Speed", "Initialisation Strings",
"Modem Profile" };
}
@Override
public String[] getMethodNames() {
return new String[0];
}
}