A B C D E F G H I L M N O R S T V W

A

addKey(SecondaryAddress, byte[]) - Method in interface org.openmuc.jmbus.wireless.WMBusConnection

Stores a pair of secondary address and cryptographic key.

asBlob() - Method in class org.openmuc.jmbus.wireless.WMBusMessage

Get the message as binary large object (byte array).

asByteArray() - Method in class org.openmuc.jmbus.SecondaryAddress

The SecondaryAddress as byte array.

B

Bcd - Class in org.openmuc.jmbus

This class represents a binary-coded decimal (BCD) number as defined by the M-Bus standard.

Bcd(byte[]) - Constructor for class org.openmuc.jmbus.Bcd

Constructs a Bcd from the given bytes.

build() - Method in class org.openmuc.jmbus.MBusConnection.MBusSerialBuilder

build() - Method in class org.openmuc.jmbus.MBusConnection.MBusTcpBuilder

build() - Method in class org.openmuc.jmbus.transportlayer.Builder

This return an active M-Bus connection.

build() - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusSerialBuilder

build() - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusTcpBuilder

Builder<C,B extends Builder<C,B>> - Class in org.openmuc.jmbus.transportlayer

A abstract builder to an active M-Bus connection.

Builder() - Constructor for class org.openmuc.jmbus.transportlayer.Builder

buildTransportLayer() - Method in class org.openmuc.jmbus.transportlayer.Builder

Build the TransportLayer with the given settings.

buildTransportLayer() - Method in class org.openmuc.jmbus.transportlayer.SerialBuilder

buildTransportLayer() - Method in class org.openmuc.jmbus.transportlayer.TcpBuilder

bytesToHex(byte[]) - Static method in class org.openmuc.jmbus.HexUtils

C

close() - Method in class org.openmuc.jmbus.MBusConnection

Closes the service access point.

close() - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Closes the transport layer.

close() - Method in interface org.openmuc.jmbus.wireless.WMBusConnection

Closes the service access point.

compareTo(SecondaryAddress) - Method in class org.openmuc.jmbus.SecondaryAddress

D

DataRecord - Class in org.openmuc.jmbus

Representation of a data record (sometimes called variable data block).

DataRecord() - Constructor for class org.openmuc.jmbus.DataRecord

DataRecord.DataValueType - Enum in org.openmuc.jmbus

The data value type

DataRecord.Description - Enum in org.openmuc.jmbus

Data description stored in the VIB

DataRecord.FunctionField - Enum in org.openmuc.jmbus

Function coded in the DIB

decode(byte[], int) - Static method in class org.openmuc.jmbus.MBusMessage

decode() - Method in class org.openmuc.jmbus.VariableDataStructure

This method is used to

DecodingException - Exception in org.openmuc.jmbus

Signals that a M-Bus message could not be decoded.

DecodingException(String) - Constructor for exception org.openmuc.jmbus.DecodingException

DecodingException(Throwable) - Constructor for exception org.openmuc.jmbus.DecodingException

DecodingException(String, Throwable) - Constructor for exception org.openmuc.jmbus.DecodingException

decryptMessage(byte[]) - Method in class org.openmuc.jmbus.VariableDataStructure

deselectComponent() - Method in class org.openmuc.jmbus.MBusConnection

Deselects the previously selected meter.

DeviceType - Enum in org.openmuc.jmbus

The device type that is part of the data header of a Variable Data Response.

discardedBytes(byte[]) - Method in interface org.openmuc.jmbus.wireless.WMBusListener

Callback, when noisy data has been discarded.

DlmsUnit - Enum in org.openmuc.jmbus

The units as defined in IEC 62056-6-2.

doubleValue() - Method in class org.openmuc.jmbus.Bcd

E

EncryptionMode - Enum in org.openmuc.jmbus

The encryption modes.

equals(Object) - Method in class org.openmuc.jmbus.SecondaryAddress

F

floatValue() - Method in class org.openmuc.jmbus.Bcd

G

getAccessNumber() - Method in class org.openmuc.jmbus.VariableDataStructure

getAddressField() - Method in class org.openmuc.jmbus.MBusMessage

getBytes() - Method in class org.openmuc.jmbus.Bcd

getControlField() - Method in class org.openmuc.jmbus.wireless.WMBusMessage

getDataLength() - Method in class org.openmuc.jmbus.DataRecord

getDataRecords() - Method in class org.openmuc.jmbus.VariableDataStructure

getDataValue() - Method in class org.openmuc.jmbus.DataRecord

Returns the decoded data field of the data record as an Object.

getDataValueType() - Method in class org.openmuc.jmbus.DataRecord

getDescription() - Method in class org.openmuc.jmbus.DataRecord

getDeviceId() - Method in class org.openmuc.jmbus.SecondaryAddress

Returns the device ID.

getDeviceType() - Method in class org.openmuc.jmbus.SecondaryAddress

Returns the device type (e.g. gas, water etc.)

getDib() - Method in class org.openmuc.jmbus.DataRecord

Returns a byte array containing the DIB (i.e. the DIF and the DIFEs) contained in the data record.

getEncryptionMode() - Method in class org.openmuc.jmbus.VariableDataStructure

getFunctionField() - Method in class org.openmuc.jmbus.DataRecord

getHeader() - Method in class org.openmuc.jmbus.VariableDataStructure

getId() - Method in enum org.openmuc.jmbus.DeviceType

Returns the ID of this DeviceType.

getId() - Method in enum org.openmuc.jmbus.DlmsUnit

Returns the ID of this DlmsUnit.

getId() - Method in enum org.openmuc.jmbus.EncryptionMode

Returns the ID of this EncryptionMode.

getInputStream() - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Get the input stream of the layer.

getInstance(int) - Static method in enum org.openmuc.jmbus.DeviceType

Returns the DeviceType that corresponds to the given ID.

getInstance(int) - Static method in enum org.openmuc.jmbus.DlmsUnit

Returns the DlmsUnit that corresponds to the given ID.

getInstance(int) - Static method in enum org.openmuc.jmbus.EncryptionMode

Returns the EncryptionMode that corresponds to the given ID.

getManufacturerData() - Method in class org.openmuc.jmbus.VariableDataStructure

getManufacturerId() - Method in class org.openmuc.jmbus.SecondaryAddress

Get the manufacturer ID.

getMessage() - Method in class org.openmuc.jmbus.VerboseMessage

Get the message data.

getMessageDirection() - Method in class org.openmuc.jmbus.VerboseMessage

Get the direction of the message.

getMessageType() - Method in class org.openmuc.jmbus.MBusMessage

getMultiplierExponent() - Method in class org.openmuc.jmbus.DataRecord

The multiplier is coded in the VIF.

getNumberOfEncryptedBlocks() - Method in class org.openmuc.jmbus.VariableDataStructure

getOutputStream() - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Get the output stream of the layer.

getRssi() - Method in class org.openmuc.jmbus.wireless.WMBusMessage

Returns the received signal string indication (RSSI) in dBm.

getScaledDataValue() - Method in class org.openmuc.jmbus.DataRecord

Returns the data (value) multiplied by the multiplier as a Double.

getSecondaryAddress() - Method in class org.openmuc.jmbus.VariableDataStructure

getSecondaryAddress() - Method in class org.openmuc.jmbus.wireless.WMBusMessage

Get the secondary address.

getStatus() - Method in class org.openmuc.jmbus.VariableDataStructure

getStorageNumber() - Method in class org.openmuc.jmbus.DataRecord

getSubunit() - Method in class org.openmuc.jmbus.DataRecord

getTariff() - Method in class org.openmuc.jmbus.DataRecord

getTimeout() - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Get the response timeout in MILLIS.

getUnit() - Method in class org.openmuc.jmbus.DataRecord

getUnit() - Method in enum org.openmuc.jmbus.DlmsUnit

Returns the unit sign of this DlmsUnit.

getUserDefinedDescription() - Method in class org.openmuc.jmbus.DataRecord

getVariableDataResponse() - Method in class org.openmuc.jmbus.MBusMessage

getVariableDataResponse() - Method in class org.openmuc.jmbus.wireless.WMBusMessage

Get the variable data structure of the message.

getVersion() - Method in class org.openmuc.jmbus.SecondaryAddress

Get the version.

getVib() - Method in class org.openmuc.jmbus.DataRecord

Returns a byte array containing the VIB (i.e. the VIF and the VIFEs) contained in the data record.

H

hashCode() - Method in class org.openmuc.jmbus.SecondaryAddress

hexToBytes(String) - Static method in class org.openmuc.jmbus.HexUtils

HexUtils - Class in org.openmuc.jmbus

I

intValue() - Method in class org.openmuc.jmbus.Bcd

isClosed() - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Check if the layer is open.

isLongHeader() - Method in class org.openmuc.jmbus.SecondaryAddress

L

linkReset(int) - Method in class org.openmuc.jmbus.MBusConnection

Sends a SND_NKE message to reset the FCB (frame counter bit).

longValue() - Method in class org.openmuc.jmbus.Bcd

M

MBusConnection - Class in org.openmuc.jmbus

M-Bus Application Layer connection.

MBusConnection.MBusSerialBuilder - Class in org.openmuc.jmbus

MBusConnection.MBusTcpBuilder - Class in org.openmuc.jmbus

MBusMessage - Class in org.openmuc.jmbus

Represents a wired M-Bus link layer message according to EN 13757-2.

MBusMessage.MessageType - Enum in org.openmuc.jmbus

MBusSerialBuilder(String) - Constructor for class org.openmuc.jmbus.MBusConnection.MBusSerialBuilder

MBusTcpBuilder(String, int) - Constructor for class org.openmuc.jmbus.MBusConnection.MBusTcpBuilder

moreRecordsFollow() - Method in class org.openmuc.jmbus.VariableDataStructure

N

newDeviceFound(SecondaryAddress) - Method in interface org.openmuc.jmbus.SecondaryAddressListener

New device found.

newFromLongHeader(byte[], int) - Static method in class org.openmuc.jmbus.SecondaryAddress

Instantiate a new secondary address within a long header.

newFromManufactureId(byte[], String, byte, byte, boolean) - Static method in class org.openmuc.jmbus.SecondaryAddress

Instantiate a new secondary address for a manufacturer ID.

newFromWMBusHeader(byte[], int) - Static method in class org.openmuc.jmbus.SecondaryAddress

Instantiate a new secondary address within a wireless M-Bus link layer header.

newMessage(WMBusMessage) - Method in interface org.openmuc.jmbus.wireless.WMBusListener

Received a new wireless M-Bus message.

newScanMessage(String) - Method in interface org.openmuc.jmbus.SecondaryAddressListener

New scan message.

newSerialBuilder(String) - Static method in class org.openmuc.jmbus.MBusConnection

Create a new builder to connect to a serial.

newTcpBuilder(String, int) - Static method in class org.openmuc.jmbus.MBusConnection

newVerboseMessage(VerboseMessage) - Method in interface org.openmuc.jmbus.VerboseMessageListener

O

open() - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Opens the transport layer.

org.openmuc.jmbus - package org.openmuc.jmbus

Main jmbus package.

org.openmuc.jmbus.transportlayer - package org.openmuc.jmbus.transportlayer

This package contains the transport layers and their builders.

org.openmuc.jmbus.wireless - package org.openmuc.jmbus.wireless

This package contain relevant classes to receive wireless M-Bus messages.

R

read(int) - Method in class org.openmuc.jmbus.MBusConnection

Reads a meter using primary addressing.

removeKey(SecondaryAddress) - Method in interface org.openmuc.jmbus.wireless.WMBusConnection

Removes the stored key for the given secondary address.

resetReadout(int) - Method in class org.openmuc.jmbus.MBusConnection

Sends a application reset to the slave with specified primary address.

S

scan(String, SecondaryAddressListener, long) - Method in class org.openmuc.jmbus.MBusConnection

Scans for secondary addresses and returns all detected devices in a list and if SecondaryAddressListener not null to the listen listener.

SecondaryAddress - Class in org.openmuc.jmbus

This class represents a secondary address.

SecondaryAddressListener - Interface in org.openmuc.jmbus

Listener to get secondary address scan message e.g. for console tools and to get messages.

selectComponent(SecondaryAddress) - Method in class org.openmuc.jmbus.MBusConnection

Selects the meter with the specified secondary address.

selectForReadout(int, List<DataRecord>) - Method in class org.openmuc.jmbus.MBusConnection

Selection of wanted records.

self() - Method in class org.openmuc.jmbus.transportlayer.Builder

sendLongMessage(int, int, int, byte[], boolean) - Method in class org.openmuc.jmbus.MBusConnection

Sends a long message with individual parameters.

sendShortMessage(int, int, boolean) - Method in class org.openmuc.jmbus.MBusConnection

Sends a short message with individual parameters.

SerialBuilder<T,S extends SerialBuilder<T,S>> - Class in org.openmuc.jmbus.transportlayer

Connection builder for serial connections.

SerialBuilder(String) - Constructor for class org.openmuc.jmbus.transportlayer.SerialBuilder

Constructor of the Serial Settings Builder, for connecting M-Bus devices over serial connections like RS232 and RS485.

setBaudrate(int) - Method in class org.openmuc.jmbus.transportlayer.SerialBuilder

Sets the baudrate of the device

setConnectionTimeout(int) - Method in class org.openmuc.jmbus.transportlayer.TcpBuilder

Sets the TCP connection timeout.

setDataBits(DataBits) - Method in class org.openmuc.jmbus.transportlayer.SerialBuilder

Sets the number of DataBits, default is DataBits.DATABITS_8.

setHostAddress(String) - Method in class org.openmuc.jmbus.transportlayer.TcpBuilder

Sets the IP host address of the device

setListener(WMBusListener) - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusSerialBuilder

setListener(WMBusListener) - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusTcpBuilder

setMode(WMBusMode) - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusSerialBuilder

setMode(WMBusMode) - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusTcpBuilder

setParity(Parity) - Method in class org.openmuc.jmbus.transportlayer.SerialBuilder

Sets the parity, default is NONE

setPort(int) - Method in class org.openmuc.jmbus.transportlayer.TcpBuilder

Sets the TCP port of this communication

setSerialPortName(String) - Method in class org.openmuc.jmbus.transportlayer.SerialBuilder

Sets the serial port name of the device

setStopBits(StopBits) - Method in class org.openmuc.jmbus.transportlayer.SerialBuilder

Sets the stop bits, default is 1

setTimeout(int) - Method in class org.openmuc.jmbus.transportlayer.Builder

Set the connection timeout.

setTimeout(int) - Method in interface org.openmuc.jmbus.transportlayer.TransportLayer

Set the response timeout.

setVerboseMessageListener(VerboseMessageListener) - Method in class org.openmuc.jmbus.MBusConnection

Sets the verbose mode on if a implementation of debugMessageListener has been set.

setWmBusManufacturer(WMBusConnection.WMBusManufacturer) - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusSerialBuilder

setWmBusManufacturer(WMBusConnection.WMBusManufacturer) - Method in class org.openmuc.jmbus.wireless.WMBusConnection.WMBusTcpBuilder

stoppedListening(IOException) - Method in interface org.openmuc.jmbus.wireless.WMBusListener

Callback, if the connection has been interrupted.

T

TcpBuilder<T,S extends TcpBuilder<T,S>> - Class in org.openmuc.jmbus.transportlayer

Connection builder for TCP connections.

TcpBuilder(String, int) - Constructor for class org.openmuc.jmbus.transportlayer.TcpBuilder

Constructor of the TCP/IP Settings Builder, for connecting M-Bus devices over TCP/IP.

toString() - Method in class org.openmuc.jmbus.Bcd

toString() - Method in class org.openmuc.jmbus.DataRecord

toString() - Method in class org.openmuc.jmbus.MBusMessage

toString() - Method in class org.openmuc.jmbus.SecondaryAddress

toString() - Method in class org.openmuc.jmbus.VariableDataStructure

toString() - Method in class org.openmuc.jmbus.wireless.WMBusMessage

TransportLayer - Interface in org.openmuc.jmbus.transportlayer

The MBus transport layer interface.

V

valueOf(String) - Static method in enum org.openmuc.jmbus.DataRecord.DataValueType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.DataRecord.Description

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.DataRecord.FunctionField

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.DeviceType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.DlmsUnit

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.EncryptionMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.MBusMessage.MessageType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.VerboseMessage.MessageDirection

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.wireless.WMBusConnection.WMBusManufacturer

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.openmuc.jmbus.wireless.WMBusMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.openmuc.jmbus.DataRecord.DataValueType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.DataRecord.Description

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.DataRecord.FunctionField

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.DeviceType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.DlmsUnit

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.EncryptionMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.MBusMessage.MessageType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.VerboseMessage.MessageDirection

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.wireless.WMBusConnection.WMBusManufacturer

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.openmuc.jmbus.wireless.WMBusMode

Returns an array containing the constants of this enum type, in the order they are declared.

VariableDataStructure - Class in org.openmuc.jmbus

Representation of the data transmitted in RESP-UD (M-Bus) and SND-NR (wM-Bus) messages.

VariableDataStructure(byte[], int, int, SecondaryAddress, Map<SecondaryAddress, byte[]>) - Constructor for class org.openmuc.jmbus.VariableDataStructure

VerboseMessage - Class in org.openmuc.jmbus

This class represents a verbose message.

VerboseMessage.MessageDirection - Enum in org.openmuc.jmbus

The direction of message.

VerboseMessageListener - Interface in org.openmuc.jmbus

W

WMBusConnection - Interface in org.openmuc.jmbus.wireless

A Wireless Mbus Connection.

WMBusConnection.Builder - Class in org.openmuc.jmbus.wireless

WMBusConnection.WMBusManufacturer - Enum in org.openmuc.jmbus.wireless

WMBusConnection.WMBusSerialBuilder - Class in org.openmuc.jmbus.wireless

WMBusConnection.WMBusTcpBuilder - Class in org.openmuc.jmbus.wireless

WMBusListener - Interface in org.openmuc.jmbus.wireless

The wireless M-Bus event/new message listener interface.

WMBusMessage - Class in org.openmuc.jmbus.wireless

Represents a wireless M-Bus link layer message without the CRC checksum.

WMBusMode - Enum in org.openmuc.jmbus.wireless

The wireless M-Bus modes.

WMBusSerialBuilder(WMBusConnection.WMBusManufacturer, WMBusListener, String) - Constructor for class org.openmuc.jmbus.wireless.WMBusConnection.WMBusSerialBuilder

WMBusTcpBuilder(WMBusConnection.WMBusManufacturer, WMBusListener, String, int) - Constructor for class org.openmuc.jmbus.wireless.WMBusConnection.WMBusTcpBuilder

write(int, byte[]) - Method in class org.openmuc.jmbus.MBusConnection

Writes to a meter using primary addressing.

A B C D E F G H I L M N O R S T V W