org.ogema.driver.modbus

Class ModbusDriver

java.lang.Object

org.ogema.driver.modbus.ModbusDriver

All Implemented Interfaces:

org.ogema.core.channelmanager.driverspi.ChannelDriver, org.ogema.core.hardwaremanager.HardwareListener

@Service(value=org.ogema.core.channelmanager.driverspi.ChannelDriver.class)
public class ModbusDriver
extends Object
implements org.ogema.core.channelmanager.driverspi.ChannelDriver, org.ogema.core.hardwaremanager.HardwareListener

This is a wrapper for the jamod api (http://jamod.sourceforge.net) On every connectDevice() a new Modbus connection is created. The Modbus connection is torn down on disconnectDevice() This driver offers Modbus RTU/TCP master transfers. The following channel addressing modes are supported by this driver: - access 16bit register(s) called Input Registers (read only) channelAddressString format: "<DEVICE_ID>:INPUT_REGISTERS:<REGISTERNUMBER>:<COUNT>" - access 16bit register(s) called Holding Registers (read / write) channelAddressString format: "<DEVICE_ID>:HOLDING_REGISTERS:<REGISTERNUMBER>:<COUNT>" - access 1bit called Discrete Input (read only) channelAddressString format: "<DEVICE_ID>:DISCRETE_INPUTS:<REGISTERNUMBER>:<COUNT>" - access 1bit called Coils (read / write) channelAddressString format: "<DEVICE_ID>:COILS:<REGISTERNUMBER>:<COUNT>" The parts of the addressString are: - Transfer type: which modbus function is used INPUT_REGISTERS read : function code 4 - Read Input Registers INPUT_REGISTERS write : read only! HOLDING_REGISTERS read : function code 3 - read holding registers HOLDING_REGISTERS write : function code 16 - write multiple holding registers DISCRETE_INPUTS read : function code 2 - read discrete inputs DISCRETE_INPUTS write : read only! COILS read : function code 1 - read coils COILS write : function code 15 - write multiple coils - Device Id: modbus device address (normally 0 for modbus/tcp) - Registernumber : address of first addressed register (0-65535) e.g. read holding register 0 -> modbus register address 400001 - Count : number of addressed coils/inputs/etc e.g. read holding register 0 count 5 -> modbus registers 400001 - 400005 - Datatype all read from a channel is an int[] array. Boolean values (COILS or DISCRETE_INPUTS) are converted to in (false -> 0, true -> 1). all data written to a channel must be an int[] array. Boolean values are interpreted (0 -> false, !0 -> true)

Author:

pau

Constructor Summary

Constructors

Constructor and Description
ModbusDriver()

Method Summary

Modifier and Type	Method and Description
void	abortDeviceScan(String interfaceId, String filter)
protected void	activate(org.osgi.framework.BundleContext ctx)
void	addDeviceListener(org.ogema.core.channelmanager.driverspi.DeviceListener listener)
void	channelAdded(org.ogema.core.channelmanager.driverspi.ChannelLocator channel)
void	channelRemoved(org.ogema.core.channelmanager.driverspi.ChannelLocator channel)
protected void	deactivate(org.osgi.framework.BundleContext ctx)
List<org.ogema.core.channelmanager.driverspi.ChannelLocator>	getChannelList(org.ogema.core.channelmanager.driverspi.DeviceLocator device) Method that returns all current channels of a device.
String	getDescription()
String	getDriverId()
void	hardwareAdded(org.ogema.core.hardwaremanager.HardwareDescriptor descriptor)
void	hardwareRemoved(org.ogema.core.hardwaremanager.HardwareDescriptor descriptor)
void	listenChannels(List<org.ogema.core.channelmanager.driverspi.SampledValueContainer> channels, org.ogema.core.channelmanager.driverspi.ChannelUpdateListener listener)
void	readChannels(List<org.ogema.core.channelmanager.driverspi.SampledValueContainer> channels) read all channels contained in the list.
void	removeDeviceListener(org.ogema.core.channelmanager.driverspi.DeviceListener listener)
void	shutdown() Frees all channels, devices and interfaces
void	startChannelScan(org.ogema.core.channelmanager.driverspi.DeviceLocator device, org.ogema.core.channelmanager.driverspi.ChannelScanListener listener) Scanning method that returns all channels of a device - not applicable for Modbus
void	startDeviceScan(String interfaceId, String filter, org.ogema.core.channelmanager.driverspi.DeviceScanListener listener) Scanning method that returns all connected devices - not applicable for Modbus
void	writeChannel(org.ogema.core.channelmanager.driverspi.ChannelLocator channelLocator, org.ogema.core.channelmanager.measurements.Value value)
void	writeChannels(List<org.ogema.core.channelmanager.driverspi.ValueContainer> channels)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModbusDriver

public ModbusDriver()

Method Detail

activate

@Activate
protected void activate(org.osgi.framework.BundleContext ctx)

deactivate

@Deactivate
protected void deactivate(org.osgi.framework.BundleContext ctx)

getDriverId

public String getDriverId()

Specified by:

getDriverId in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

getDescription

public String getDescription()

Specified by:

getDescription in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

startDeviceScan

public void startDeviceScan(String interfaceId,
                            String filter,
                            org.ogema.core.channelmanager.driverspi.DeviceScanListener listener)
                     throws UnsupportedOperationException,
                            org.ogema.core.channelmanager.driverspi.NoSuchInterfaceException,
                            IOException

Scanning method that returns all connected devices - not applicable for Modbus

Specified by:

startDeviceScan in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

org.ogema.core.channelmanager.driverspi.NoSuchInterfaceException

IOException

abortDeviceScan

public void abortDeviceScan(String interfaceId,
                            String filter)

Specified by:

abortDeviceScan in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

startChannelScan

public void startChannelScan(org.ogema.core.channelmanager.driverspi.DeviceLocator device,
                             org.ogema.core.channelmanager.driverspi.ChannelScanListener listener)
                      throws UnsupportedOperationException

Scanning method that returns all channels of a device - not applicable for Modbus

Specified by:

startChannelScan in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

getChannelList

public List<org.ogema.core.channelmanager.driverspi.ChannelLocator> getChannelList(org.ogema.core.channelmanager.driverspi.DeviceLocator device)
                                                                            throws UnsupportedOperationException

Method that returns all current channels of a device. Does not connect to the device.

Specified by:

getChannelList in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

readChannels

public void readChannels(List<org.ogema.core.channelmanager.driverspi.SampledValueContainer> channels)
                  throws UnsupportedOperationException,
                         IOException

read all channels contained in the list. If a channel is not known, create it. If either a channel cannot be created or read, print log entry and throw IOException.

Specified by:

readChannels in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

IOException

listenChannels

public void listenChannels(List<org.ogema.core.channelmanager.driverspi.SampledValueContainer> channels,
                           org.ogema.core.channelmanager.driverspi.ChannelUpdateListener listener)
                    throws UnsupportedOperationException

Specified by:

listenChannels in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

writeChannels

public void writeChannels(List<org.ogema.core.channelmanager.driverspi.ValueContainer> channels)
                   throws UnsupportedOperationException,
                          IOException,
                          org.ogema.core.channelmanager.driverspi.NoSuchDeviceException,
                          org.ogema.core.channelmanager.driverspi.NoSuchChannelException

Specified by:

writeChannels in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

IOException

org.ogema.core.channelmanager.driverspi.NoSuchDeviceException

org.ogema.core.channelmanager.driverspi.NoSuchChannelException

shutdown

public void shutdown()

Frees all channels, devices and interfaces

Specified by:

shutdown in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

channelAdded

public void channelAdded(org.ogema.core.channelmanager.driverspi.ChannelLocator channel)

Specified by:

channelAdded in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

channelRemoved

public void channelRemoved(org.ogema.core.channelmanager.driverspi.ChannelLocator channel)

Specified by:

channelRemoved in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

hardwareAdded

public void hardwareAdded(org.ogema.core.hardwaremanager.HardwareDescriptor descriptor)

Specified by:

hardwareAdded in interface org.ogema.core.hardwaremanager.HardwareListener

hardwareRemoved

public void hardwareRemoved(org.ogema.core.hardwaremanager.HardwareDescriptor descriptor)

Specified by:

hardwareRemoved in interface org.ogema.core.hardwaremanager.HardwareListener

addDeviceListener

public void addDeviceListener(org.ogema.core.channelmanager.driverspi.DeviceListener listener)

Specified by:

addDeviceListener in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

removeDeviceListener

public void removeDeviceListener(org.ogema.core.channelmanager.driverspi.DeviceListener listener)

Specified by:

removeDeviceListener in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

writeChannel

public void writeChannel(org.ogema.core.channelmanager.driverspi.ChannelLocator channelLocator,
                         org.ogema.core.channelmanager.measurements.Value value)
                  throws UnsupportedOperationException,
                         IOException,
                         org.ogema.core.channelmanager.driverspi.NoSuchDeviceException,
                         org.ogema.core.channelmanager.driverspi.NoSuchChannelException

Specified by:

writeChannel in interface org.ogema.core.channelmanager.driverspi.ChannelDriver

Throws:

UnsupportedOperationException

IOException

org.ogema.core.channelmanager.driverspi.NoSuchDeviceException

org.ogema.core.channelmanager.driverspi.NoSuchChannelException