Package org.openremote.agent.protocol.velbus.device

Class InputProcessor

java.lang.Object

org.openremote.agent.protocol.velbus.device.FeatureProcessor

org.openremote.agent.protocol.velbus.device.ChannelProcessor

org.openremote.agent.protocol.velbus.device.InputProcessor

public class InputProcessor
extends ChannelProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InputProcessor.ChannelState
protected static enum	InputProcessor.PropertyType

Nested classes/interfaces inherited from class org.openremote.agent.protocol.velbus.device.FeatureProcessor

FeatureProcessor.LedState, FeatureProcessor.PropertyDescriptor

Field Summary

Fields inherited from class org.openremote.agent.protocol.velbus.device.ChannelProcessor

CHANNEL_REGEX

Constructor Summary

Constructors

Constructor	Description
InputProcessor()

Method Summary

Modifier and Type	Method	Description
protected Optional<org.openremote.model.util.Pair<Integer,InputProcessor.PropertyType>>	getChannelNumberAndPropertyType(VelbusDevice device, String propertyName)
protected static List<VelbusPacket>	getChannelStatePackets(VelbusDevice velbusDevice, int address, int channelNumber, InputProcessor.ChannelState channelState)
protected static List<VelbusPacket>	getLedStatePackets(VelbusDevice velbusDevice, int address, int channelNumber, FeatureProcessor.LedState ledState)
List<FeatureProcessor.PropertyDescriptor>	getPropertyDescriptors(VelbusDeviceType deviceType)
List<VelbusPacket>	getPropertyWritePackets(VelbusDevice device, String property, Object value)	Asks the processor to generate the packets required to write the requested value to this property.
List<VelbusPacket>	getStatusRequestPackets(VelbusDevice device)	Get the packets that need to be sent to the device to get the state data of this feature's properties
boolean	processReceivedPacket(VelbusDevice device, VelbusPacket packet)	Allows this feature processor to handle the inbound packet.

Methods inherited from class org.openremote.agent.protocol.velbus.device.ChannelProcessor

getAddressForChannel, getChannelNumberAndPropertySuffix, getMaxChannelNumber, getStartChannelNumber, isChannelEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

InputProcessor

public InputProcessor()

Method Details

getPropertyDescriptors

public List<FeatureProcessor.PropertyDescriptor> getPropertyDescriptors(VelbusDeviceType deviceType)

Specified by:

getPropertyDescriptors in class FeatureProcessor

getStatusRequestPackets

public List<VelbusPacket> getStatusRequestPackets(VelbusDevice device)

Description copied from class: FeatureProcessor

Get the packets that need to be sent to the device to get the state data of this feature's properties

Overrides:

getStatusRequestPackets in class FeatureProcessor

getPropertyWritePackets

public List<VelbusPacket> getPropertyWritePackets(VelbusDevice device,
 String property,
 Object value)

Description copied from class: FeatureProcessor

Asks the processor to generate the packets required to write the requested value to this property.

Once a processor returns a non null value then no other processors will be asked to handle the write

Specified by:

getPropertyWritePackets in class FeatureProcessor

processReceivedPacket

public boolean processReceivedPacket(VelbusDevice device,
 VelbusPacket packet)

Description copied from class: FeatureProcessor

Allows this feature processor to handle the inbound packet. If a processor handles a packet then it should set the packets VelbusPacket.isHandled() flag.

The processor can prevent other processors from processing the packet by returning true (processors should only do this if they are certain no other processor is interested in the packet).

Specified by:

processReceivedPacket in class FeatureProcessor

Returns:

whether or not to allow other processors to process the packet.

getChannelNumberAndPropertyType

protected Optional<org.openremote.model.util.Pair<Integer,InputProcessor.PropertyType>> getChannelNumberAndPropertyType(VelbusDevice device,
 String propertyName)

getChannelStatePackets

protected static List<VelbusPacket> getChannelStatePackets(VelbusDevice velbusDevice,
 int address,
 int channelNumber,
 InputProcessor.ChannelState channelState)

getLedStatePackets

protected static List<VelbusPacket> getLedStatePackets(VelbusDevice velbusDevice,
 int address,
 int channelNumber,
 FeatureProcessor.LedState ledState)