org.openmuc.jmbus

Class MBusConnection

java.lang.Object

org.openmuc.jmbus.MBusConnection

All Implemented Interfaces:

java.lang.AutoCloseable

public class MBusConnection
extends java.lang.Object
implements java.lang.AutoCloseable

M-Bus Application Layer connection.

Use this access point to communicate using the M-Bus wired protocol.

See Also:

newSerialBuilder(String), newTcpBuilder(String, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MBusConnection.MBusSerialBuilder
static class	MBusConnection.MBusTcpBuilder

Method Summary

Modifier and Type	Method and Description
void	close() Closes the service access point.
void	deselectComponent() Deselects the previously selected meter.
void	linkReset(int primaryAddress) Sends a SND_NKE message to reset the FCB (frame counter bit).
static MBusConnection.MBusSerialBuilder	newSerialBuilder(java.lang.String serialPortName) Create a new builder to connect to a serial.
static MBusConnection.MBusTcpBuilder	newTcpBuilder(java.lang.String hostAddress, int port)
VariableDataStructure	read(int primaryAddress) Reads a meter using primary addressing.
void	resetReadout(int primaryAddress) Sends a application reset to the slave with specified primary address.
java.util.List<SecondaryAddress>	scan(java.lang.String wildcardMask, SecondaryAddressListener secondaryAddressListener, long delay) Scans for secondary addresses and returns all detected devices in a list and if SecondaryAddressListener not null to the listen listener.
void	selectComponent(SecondaryAddress secondaryAddress) Selects the meter with the specified secondary address.
void	selectForReadout(int primaryAddress, java.util.List<DataRecord> dataRecords) Selection of wanted records.
MBusMessage	sendLongMessage(int primaryAddr, int controlField, int ci, byte[] data, boolean responseExpected) Sends a long message with individual parameters.
MBusMessage	sendShortMessage(int primaryAddr, int cmd, boolean responseExpected) Sends a short message with individual parameters.
void	setVerboseMessageListener(VerboseMessageListener verboseMessageListener) Sets the verbose mode on if a implementation of debugMessageListener has been set.
void	write(int primaryAddress, byte[] data) Writes to a meter using primary addressing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public void close()

Closes the service access point.

Specified by:

close in interface java.lang.AutoCloseable

setVerboseMessageListener

public void setVerboseMessageListener(VerboseMessageListener verboseMessageListener)

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

Parameters:

verboseMessageListener - Implementation of debugMessageListener

scan

public java.util.List<SecondaryAddress> scan(java.lang.String wildcardMask,
                                             SecondaryAddressListener secondaryAddressListener,
                                             long delay)
                                      throws java.io.IOException

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

Parameters:

wildcardMask - a wildcard mask for masking

secondaryAddressListener - listener to get scan messages and scanned secondary address just at time.
If null, all detected address will only returned if finished.

delay - delay between every sent message. Sometimes needed for slow devices. Deactivated if 0 or less.

Returns:

a list of secondary addresses of all detected devices

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while writing to the remote device. Note that the connection is not closed when an IOException is thrown.

read

public VariableDataStructure read(int primaryAddress)
                           throws java.io.IOException

Reads a meter using primary addressing. Sends a data request (REQ_UD2) to the remote device and returns the variable data structure from the received RSP_UD frame.

Parameters:

primaryAddress - the primary address of the meter to read. For secondary address use 0xfd.

Returns:

the variable data structure from the received RSP_UD frame

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while trying to read the remote device. Note that the connection is not closed when an IOException is thrown.

sendLongMessage

public MBusMessage sendLongMessage(int primaryAddr,
                                   int controlField,
                                   int ci,
                                   byte[] data,
                                   boolean responseExpected)
                            throws java.io.IOException

Sends a long message with individual parameters. Used for messages which arn't not predefined in MBusConnection.
If no response message is expected, set hasResponse to false. Returns null if hasResponse is false

Parameters:

primaryAddr - the primary address of the meter to read. For secondary address use 0xfd.

controlField - control field (C Field) has the size of 1 byte.

ci - control information field (CI Field) has the size of 1 byte.

data - the data to sends to the meter.

responseExpected - set this flag to false if no response is expected else true. If false returns null

Returns:

returns null if boolean hasResponse is false.
returns the MBusMessage if a message received.

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while trying to send to or read the remote device. Note that the connection is not closed when an IOException is thrown.

sendShortMessage

public MBusMessage sendShortMessage(int primaryAddr,
                                    int cmd,
                                    boolean responseExpected)
                             throws java.io.IOException

Sends a short message with individual parameters. Used for messages which arn't not predefined in MBusConnection.
For normal readout use read(int).
If no response message is expected, set hasResponse to false. Returns null if hasResponse is false

Parameters:

primaryAddr - the primary address of the meter to read. For secondary address use 0xfd.

cmd - the command to send to the meter.

responseExpected - set this flag to false if no response is expected else true. If false returns null

Returns:

returns null if boolean hasResponse is false.
returns the MBusMessage if a message received.

Throws:

java.io.IOException - f any kind of error (including timeout) occurs while trying to send to or read the remote device. Note that the connection is not closed when an IOException is thrown.

write

public void write(int primaryAddress,
                  byte[] data)
           throws java.io.IOException

Writes to a meter using primary addressing. Sends a data send (SND_UD) to the remote device and returns a true if slave sends a 0x7e else false

Parameters:

primaryAddress - the primary address of the meter to write. For secondary address use 0xfd.

data - the data to sends to the meter.

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while writing to the remote device. Note that the connection is not closed when an IOException is thrown.

selectComponent

public void selectComponent(SecondaryAddress secondaryAddress)
                     throws java.io.IOException

Selects the meter with the specified secondary address. After this the meter can be read on primary address 0xfd.

Parameters:

secondaryAddress - the secondary address of the meter to select.

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while trying to read the remote device. Note that the connection is not closed when an IOException is thrown.

deselectComponent

public void deselectComponent()
                       throws java.io.IOException

Deselects the previously selected meter.

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while trying to read the remote device. Note that the connection is not closed when an IOException is thrown.

selectForReadout

public void selectForReadout(int primaryAddress,
                             java.util.List<DataRecord> dataRecords)
                      throws java.io.IOException

Selection of wanted records.

Parameters:

primaryAddress - primary address of the slave

dataRecords - data record to select

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while trying to read the remote device. Note that the connection is not closed when an IOException is thrown.

resetReadout

public void resetReadout(int primaryAddress)
                  throws java.io.IOException

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

Parameters:

primaryAddress - primary address of the slave

Throws:

java.io.IOException - if any kind of error (including timeout) occurs while trying to read the remote device. Note that the connection is not closed when an IOException is thrown.

linkReset

public void linkReset(int primaryAddress)
               throws java.io.IOException

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

Parameters:

primaryAddress - the primary address of the meter to reset.

Throws:

java.io.IOException - if an error occurs during the reset process.

newTcpBuilder

public static MBusConnection.MBusTcpBuilder newTcpBuilder(java.lang.String hostAddress,
                                                          int port)

newSerialBuilder

public static MBusConnection.MBusSerialBuilder newSerialBuilder(java.lang.String serialPortName)

Create a new builder to connect to a serial.

Parameters:

serialPortName - the serial port. e.g. /dev/ttyS0.

Returns:

a new connection builder.