net.sf.mbus4j.master

Class MBusMaster

java.lang.Object

net.sf.mbus4j.master.MBusMaster

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<GenericDevice>, Sender, JSONSerializable

public class MBusMaster
extends Object
implements Iterable<GenericDevice>, Sender, JSONSerializable, Closeable

Handles the MBus devices connected via inputStream/OutputStream.

Version:

$Id: MBusMaster.java 111 2014-04-23 13:38:22Z arnep $ TODO: Handle multi Resoṕonses ClassXData (connect or chaon them together)

Author:

arnep@users.sourceforge.net

Field Summary

Fields inherited from interface net.sf.mbus4j.devices.Sender

DEFAULT_SEND_TRIES

Constructor Summary

Constructors

Constructor and Description
MBusMaster()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDevice(GenericDevice device)
GenericDevice	addDeviceByAddress(byte address)
void	cancel()
void	clearDevices()
void	close()
void	deselectBySecondaryAddress()
int	deviceCount()
int	deviceIndexOf(GenericDevice d)
void	fromJSON(net.sf.json.JSONObject json)
Connection	getConnection()
static DataBlock	getDataBlock(Frame frame, ValueRequestPointLocator locator)
GenericDevice	getDevice(int i)
static GenericDevice	getDevice(Iterable<GenericDevice> deviceList, ValueRequestPointLocator locator)
GenericDevice[]	getDevices()
long	getIdleTime() Idle time is 33 bit periods see M-Bus doc chaper 5.4
long	getLastByteSended()
long	getResponseTimeout() Timeout is 330 bit periods + 50ms see M-Bus doc chaper 5.4 2 times max (256) packet size added
long	getShortResponseTimeout()
Iterator<GenericDevice>	iterator()
Closeable	open()
static MBusMaster	readJsonStream(InputStream is)
UserDataResponse	readResponse(byte address)
UserDataResponse	readResponseBySecondary(int bcdId, String man, Byte version, MBusMedium medium, int maxTries)
void	readValues(ValueRequest<?> requests)
GenericDevice[]	searchDevicesByPrimaryAddress() Search by primary address (0..250) 253 is for slave select 254 broadcast addres to all devices
GenericDevice[]	searchDevicesByPrimaryAddress(byte first, byte last)
GenericDevice[]	searchDevicesBySecondaryAddressing(int maxTries)
boolean	selectDevice(int bcdMaskedId, short maskedMan, byte maskedVersion, byte maskedMedium, int maxTries)
boolean	selectDevice(MBusResponseFramesContainer dev)
Frame	send(Frame frame, int maxTries, long timeout)
Frame	sendInitSlave(byte address)
Frame	sendRequestUserData(byte address)
Map<GenericDevice,Frame>	sendRequestUserData(Map<GenericDevice,MBusAddressing> devices)
Map<GenericDevice,Frame>	sendRequestUserData(MBusAddressing addressing)
int	sendSlaveSelect(int bcdMaskedId, short maskedMan, byte maskedVersion, byte maskedMedium, int maxTries)
void	setConnection(Connection conn)
net.sf.json.JSONObject	toJSON(JsonSerializeType jsonSerializeType)
GenericDevice[]	widcardSearch(int bcdMaskedId, short bcdMaskedMan, byte bcdMaskedVersion, byte bcdMaskedMedium, int maxTries)
void	writeJsonStream(FileOutputStream os)

Methods inherited from class java.lang.Object

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

Constructor Detail

MBusMaster

public MBusMaster()

Method Detail

cancel

public void cancel()

getDevice

public static GenericDevice getDevice(Iterable<GenericDevice> deviceList,
                      ValueRequestPointLocator locator)

getDataBlock

public static DataBlock getDataBlock(Frame frame,
                     ValueRequestPointLocator locator)

getConnection

public Connection getConnection()

writeJsonStream

public void writeJsonStream(FileOutputStream os)
                     throws UnsupportedEncodingException,
                            IOException

Throws:

UnsupportedEncodingException

IOException

getLastByteSended

public long getLastByteSended()

Returns:

the lastByteSended

addDevice

public boolean addDevice(GenericDevice device)

Parameters:

device -

Returns:

true if the device is not Already in the List Identnumber, Manufacturer and Medium

addDeviceByAddress

public GenericDevice addDeviceByAddress(byte address)
                                 throws InterruptedException,
                                        IOException

Throws:

InterruptedException

IOException

deviceIndexOf

public int deviceIndexOf(GenericDevice d)

clearDevices

public void clearDevices()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

deselectBySecondaryAddress

public void deselectBySecondaryAddress()

deviceCount

public int deviceCount()

getDevice

public GenericDevice getDevice(int i)

getDevices

public GenericDevice[] getDevices()

getIdleTime

public long getIdleTime()

Idle time is 33 bit periods see M-Bus doc chaper 5.4

Returns:

getResponseTimeout

public long getResponseTimeout()

Timeout is 330 bit periods + 50ms see M-Bus doc chaper 5.4 2 times max (256) packet size added

Returns:

getShortResponseTimeout

public long getShortResponseTimeout()

iterator

public Iterator<GenericDevice> iterator()

Specified by:

iterator in interface Iterable<GenericDevice>

searchDevicesBySecondaryAddressing

public GenericDevice[] searchDevicesBySecondaryAddressing(int maxTries)
                                                   throws IOException,
                                                          InterruptedException

Throws:

IOException

InterruptedException

searchDevicesByPrimaryAddress

public GenericDevice[] searchDevicesByPrimaryAddress()
                                              throws IOException,
                                                     InterruptedException

Search by primary address (0..250) 253 is for slave select 254 broadcast addres to all devices

Returns:

Throws:

IOException

InterruptedException

searchDevicesByPrimaryAddress

public GenericDevice[] searchDevicesByPrimaryAddress(byte first,
                                            byte last)
                                              throws IOException,
                                                     InterruptedException

Throws:

IOException

InterruptedException

send

public Frame send(Frame frame,
         int maxTries,
         long timeout)
           throws IOException,
                  InterruptedException

Specified by:

send in interface Sender

Throws:

IOException

InterruptedException

sendRequestUserData

public Map<GenericDevice,Frame> sendRequestUserData(MBusAddressing addressing)
                                             throws IOException,
                                                    InterruptedException

Throws:

IOException

InterruptedException

sendInitSlave

public Frame sendInitSlave(byte address)
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

sendRequestUserData

public Frame sendRequestUserData(byte address)
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException

sendRequestUserData

public Map<GenericDevice,Frame> sendRequestUserData(Map<GenericDevice,MBusAddressing> devices)
                                             throws IOException,
                                                    InterruptedException

Throws:

IOException

InterruptedException

sendSlaveSelect

public int sendSlaveSelect(int bcdMaskedId,
                  short maskedMan,
                  byte maskedVersion,
                  byte maskedMedium,
                  int maxTries)
                    throws IOException,
                           InterruptedException

Throws:

IOException

InterruptedException

setConnection

public void setConnection(Connection conn)

open

public Closeable open()
               throws IOException

Throws:

IOException

widcardSearch

public GenericDevice[] widcardSearch(int bcdMaskedId,
                            short bcdMaskedMan,
                            byte bcdMaskedVersion,
                            byte bcdMaskedMedium,
                            int maxTries)
                              throws IOException,
                                     InterruptedException

Throws:

IOException

InterruptedException

readResponseBySecondary

public UserDataResponse readResponseBySecondary(int bcdId,
                                       String man,
                                       Byte version,
                                       MBusMedium medium,
                                       int maxTries)
                                         throws IOException,
                                                InterruptedException

Throws:

IOException

InterruptedException

readResponse

public UserDataResponse readResponse(byte address)
                              throws IOException,
                                     InterruptedException

Throws:

IOException

InterruptedException

selectDevice

public boolean selectDevice(int bcdMaskedId,
                   short maskedMan,
                   byte maskedVersion,
                   byte maskedMedium,
                   int maxTries)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

selectDevice

public boolean selectDevice(MBusResponseFramesContainer dev)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

readValues

public void readValues(ValueRequest<?> requests)
                throws IOException,
                       InterruptedException

Throws:

IOException

InterruptedException

readJsonStream

public static MBusMaster readJsonStream(InputStream is)
                                 throws IOException

Throws:

IOException

fromJSON

public void fromJSON(net.sf.json.JSONObject json)

Specified by:

fromJSON in interface JSONSerializable

toJSON

public net.sf.json.JSONObject toJSON(JsonSerializeType jsonSerializeType)

Specified by:

toJSON in interface JSONSerializable