All Classes and Interfaces
Class
Description
AbstractHTTPServerAgent<T extends AbstractHTTPServerAgent<T,U,V>,U extends AbstractHTTPServerProtocol<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>
AbstractHTTPServerProtocol<T extends AbstractHTTPServerProtocol<T,U,V>,U extends AbstractHTTPServerAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>
This is an abstract protocol for creating JAX-RS deployments; a concrete implementation should be created for each
required JAX-RS deployment.
AbstractIOClientProtocol<T extends AbstractIOClientProtocol<T,U,V,W,X>,U extends IOAgent<U,T,X>,V,W extends IOClient<V>,X extends org.openremote.model.asset.agent.AgentLink<?>>
This is an abstract
Protocol for protocols that require an IOClient.AbstractMQTTClientProtocol<T extends AbstractMQTTClientProtocol<T,U,V,W,X>,U extends IOAgent<U,T,X>,V,W extends AbstractMQTT_IOClient<V>,X extends org.openremote.model.asset.agent.AgentLink<?>>
This is a
IOClient implementation for netty.This is intended to be used at the end of a decoder chain where the previous decoder outputs a
ByteBuf;
the provided AbstractNettyIOClient.ByteToMessageDecoder.decoder should extract the messages of type <T> from the ByteBuf and add them
to the List and they will then be passed to the IOClient.Concrete implementations must provide an encoder to fill the
ByteBuf ready to be sent `over the wire`.This is intended to be used at the end of a decoder chain where the previous decoder outputs messages of type <T>.
AbstractNettyIOClientProtocol<T extends AbstractIOClientProtocol<T,U,V,W,X>,U extends IOAgent<U,T,X>,V,W extends NettyIOClient<V>,X extends org.openremote.model.asset.agent.AgentLink<?>>
This is an abstract
Protocol for protocols that require an NettyIOClient.AbstractNettyIOServer<T,U extends io.netty.channel.Channel,V extends io.netty.bootstrap.AbstractBootstrap<?,?>,W extends SocketAddress>
Abstract implementation of
IOServer that uses the Netty library.AbstractProtocol<T extends org.openremote.model.asset.agent.Agent<T,?,U>,U extends org.openremote.model.asset.agent.AgentLink<?>>
Thread-safe base implementation for protocols.
AbstractSerialProtocol<T extends AbstractNettyIOClientProtocol<T,U,W,X,V>,U extends IOAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>,W,X extends SerialIOClient<W>>
This is an abstract TCP client protocol for communicating with TCP servers; concrete implementations must provide
an
for handling over the wire communication AbstractTCPClientProtocol<T extends AbstractNettyIOClientProtocol<T,U,W,X,V>,U extends IOAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>,W,X extends TCPIOClient<W>>
This is an abstract TCP client protocol for communicating with TCP servers; concrete implementations must provide
an
for handling over the wire communication Abstract IO Server for creating TCP socket servers that clients can connect to.
AbstractTCPServerAgent<T extends AbstractTCPServerAgent<T,U,V>,U extends AbstractTCPServerProtocol<?,?,U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>
AbstractTCPServerProtocol<R,S extends AbstractTCPServer<R>,T extends AbstractTCPServerProtocol<R,S,T,U,V>,U extends AbstractTCPServerAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>
This is an abstract protocol for creating TCP Server protocols.
AbstractUDPProtocol<T extends AbstractNettyIOClientProtocol<T,U,W,X,V>,U extends IOAgent<U,T,V>,V extends org.openremote.model.asset.agent.AgentLink<?>,W,X extends UDPIOClient<W>>
This is an abstract UDP client protocol for communicating with UDP servers; concrete implementations must implement
AbstractNettyIOClientProtocol.getEncoderDecoderProvider() to provide encoders/decoders for messages of type <T>.UDP in Netty is crap; everything goes through the single server channel as it is connectionless but there is no way
of tracking packet origin across decoders.
Wrapper class for addresses
Address types
Enables scanning of descriptors in the agent module
The class that contains constants to find codes for the properties in the requests and responses for the IKEA TRÃ…DFRI API
The class that contains helper functions and constants to find CoAP endpoints for the IKEA TRÃ…DFRI gateway
Wrapper class for application key
Contains the configuration required when exporting a selected number of Application Keys in a mesh network.
Use this class to configure when exporting all the Application Keys.
The class that contains the payload for a request to authenticate to the IKEA TRÃ…DFRI gateway
The class that contains the payload of a response to the authenticate request from the IKEA TRÃ…DFRI gateway
Abstract class that handles mesh messages
Abstract processor for channel related operations
The class that is used to communicate with the IKEA TRÃ…DFRI gateway using the CoAP protocol
The class that contains XY values that make up a colour
To be used as a wrapper class to create the ConfigAppKeyAdd message.
To be used as a wrapper class to create the ConfigAppKeyAdd message.
Creates the ConfigAppKeyList Message.
To be used as a wrapper class for when creating the ConfigAppKeyStatus Message.
Creates the ConfigAppKeyUpdate message.
Creates the ConfigBeaconStatus message.
To be used as a wrapper class for when creating the ConfigCompositionDataStatus Message.
Creates the ConfigDefaultTtlSet message.
Creates the ConfigFriendStatus message.
ConfigHeartbeatPublicationStatus message.
ConfigHeartbeatPublicationStatus message.
Creates the ConfigKeyRefreshPhaseSet message.
To be used as a wrapper class for when creating the ConfigAppKeyStatus Message.
Creates the ConfigLowPowerNodePollTimeoutStatus message.
To be used as a wrapper class to create ConfigModelAppBind message.
To be used as a wrapper class to create a ConfigModelPublicationSet message.
To be used as a wrapper class to create a ConfigModelPublicationSet message.
To be used as a wrapper class for when creating the ConfigModelAppStatus Message.
This is the message class for setting a virtual address as a publication address
Creates the ConfigModelSubscriptionAdd message
Creates the ConfigModelSubscriptionDelete message
Creates the ConfigModelSubscriptionDeleteAll message
This class handles subscribing a model to subscription address.
Creates the ConfigModelSubscriptionStatus Message.
Creates the ConfigModelSubscriptionVirtualAddressAdd Message.
Creates the ConfigModelSubscriptionVirtualAddressDelete Message.
Creates the ConfigModelSubscriptionVirtualAddressOverwrite Message.
Creates the ConfigNetKeyList Message.
Creates the ConfigNetKeyStatus Message.
Creates the ConfigNetKeyUpdate message.
To be used as a wrapper class for when creating the ConfigNetworkTransmitStatus message.
Creates the ConfigNodeIdentityStatus message.
To be used as a wrapper class for when creating the ConfigAppKeyStatus Message.
To be used as a wrapper class to create a ConfigProxySet message.
To be used as a wrapper class for when creating the ConfigRelayStatus message.
To be used as a wrapper class for when creating the ConfigRelayStatus message.
Creates the ConfigAppKeyList Message.
Creates the ConfigModelSubscriptionStatus Message.
Creates the ConfigAppKeyList Message.
Creates the ConfigModelSubscriptionStatus Message.
Controller class represent a Controller defined in a Manager Agent and store all sensors and commands linked to that Controller agent
ControllerCommand represent an executable command on the Controller
A ControllerCommandBasic represent a configuration to execute a Controller 2.5 command with just a command name
(command parameter is managed at launch depending on linked attribute value
org.openremote.agent.protocol.controller.ControllerProtocol#executeAttributeWriteRequest(HTTPProtocol.HttpClientRequest, AttributeRef, Consumer)).A ControllerCommandMapped represent a configuration to execute a Controller 2.5 command where exact command name to execute depend on a linked
attribute value and the match between linked attribute value and command name is stored in a map where key is attribute value and value is the
command name to execute
This is a Controller 2.5 protocol to communicate with a running Controller 2.5 instance and getting sensor's status
and executing commands.
ControllerSensor represents a sensor on a device
The class that contains the credentials used to authenticate to the IKEA TRÃ…DFRI gateway
The class that represents an IKEA TRÃ…DFRI device
The class that represents a device event that occurred to an IKEA TRÃ…DFRI device
The class that contains the information of an IKEA TRÃ…DFRI device
The class that observes a device to automagically detect changes
The class that contains the properties of an IKEA TRÃ…DFRI device
The class that contains the payload for a request to update a IKEA TRÃ…DFRI device
The class that contains the payload for a response of an IKEA TRÃ…DFRI device
The class that handles events for IKEA TRÃ…DFRI devices
Base class for reading/writing a set of device properties that relate to a feature/capability.
Defines the features supported by a
ProvisionedMeshNodeThe class that is used to communicate with the IKEA TRÃ…DFRI gateway
The class that represents an event that occurred to an IKEA TRÃ…DFRI gateway
The class that observes an IKEA TRÃ…DFRI gateway to automagically detect changes
To be used as a wrapper class to create generic level get message.
To be used as a wrapper class when creating a GenericLevelSet message.
To be used as a wrapper class when creating a GenericLevelSetUnacknowledged message.
To be used as a wrapper class to create generic level status message.
To be used as a wrapper class when creating a GenericOnOffGet message.
To be used as a wrapper class when creating a GenericOnOffSet message.
To be used as a wrapper class when creating a GenericOnOffSetUnacknowledged message.
To be used as a wrapper class for when creating the GenericOnOffStatus Message.
Contains the configuration required when exporting a selected number of Groups in a mesh network.
Use this class to configure when exporting all the Groups.
Use this class to configure when exporting the related Groups, which means that the exported
configuration will only contain those groups that any exported model is subscribed or publishing to
Use this class to configure when exporting some of the groups.
This is a HTTP client protocol for communicating with HTTP servers; it uses the
WebTargetBuilder factory to
generate JAX-RS WebTargets that can be used to make arbitrary calls to endpoints on a HTTP
server but it can also be extended and used as a JAX-RS client proxy.Callbacks to notify the mesh message handler to notify events from transport layers.
Internal provisioning callbacks
IOAgent<T extends IOAgent<T,U,V>,U extends AbstractIOClientProtocol<U,T,?,?,V>,V extends org.openremote.model.asset.agent.AgentLink<?>>
Represents an IO client that communicates with a server
Represents an IO server that accepts incoming clients.
Class containing the current IV Index State of the network.
A channel to a serial device using the jSerialComm library.
Configuration interface for jSerialComm device connections.
Option for configuring a serial port connection.
A SocketAddress subclass to wrap the serial port address of a jSerialComm device (e.g.
This protocol is used to connect to a KNX bus via an IP interface.
The class that represents an IKEA TRÃ…DFRI light
The class that represents a light brightness changed event that occurred to an IKEA TRÃ…DFRI light
The class that represents a light colour changed event that occurred to an IKEA TRÃ…DFRI light
The class that represents a light colour temperature changed event that occurred to an IKEA TRÃ…DFRI light
The class that represents a light changed event that occurred to an IKEA TRÃ…DFRI light
The class that represents a light on / off state changed event that occurred to an IKEA TRÃ…DFRI light
To be used as a wrapper class to create generic level status message.
The class that represents a light event that occurred to an IKEA TRÃ…DFRI light
To be used as a wrapper class to create generic level status message.
To be used as a wrapper class to create generic level status message.
The class that contains the properties of an IKEA TRÃ…DFRI light
Abstract class containing mesh beacon information
Implement this class in order to get the transport callbacks from the
MeshManagerApiAbstract wrapper class for mesh message.
Mesh message handler api
Base mesh model class
Callbacks to notify status during the provisioning process
Callbacks to notify the status of the mesh messages
This is for IO clients that use Netty and are based on
ChannelHandlers for
encoding/decoding messages of type <T>.Wrapper class for network key
Contains the configuration required when exporting a selected number of Network Keys in a mesh network.
Use this class to configure when exporting all the Network Keys.
Use this class to configure when exporting some of the Network Keys in network.
Class containing Network Transmit values in a
ProvisionedMeshNodeContains the configuration required when exporting a selected number of mesh nodes in a mesh network.
Use this class to configure when exporting some of the Nodes.
Use this class to configure when exporting some of the Nodes with their device keys.
Use this class to configure when exporting some of the Nodes without their device keys.
The class that observes a device to automagically detect changes
Covers OLED specific features:
Abstract processor for channel related operations
The class that represents an IKEA TRÃ…DFRI plug
The class that represents a change event that occurred to an IKEA TRÃ…DFRI plug
The class that represents a plug on / off state changed event that occurred to an IKEA TRÃ…DFRI plug
The class that represents a plug event that occurred to an IKEA TRÃ…DFRI plug
The class that contains the properties of an IKEA TRÃ…DFRI plug
Interface for protocols to perform limited asset related operations.
Options when merging and storing assets from protocols.
Class definition of a Provisioner of mesh network
Contains the configuration required when exporting a selected number of Provisioners in a mesh network.
Use this class to configure when exporting all the Provisioners.
Use this class to configure when exporting some of the Provisioners.
To be used as a wrapper class to create the ProxyConfigSetFilterType message.
To be used as a wrapper class to create the ProxyConfigSetFilterType message.
To be used as a wrapper class to create the ProxyConfigSetFilterType message.
To be used as a wrapper class to create the ProxyConfigSetFilterType message.
Contains the proxy filter configuration set to a node
Wrapper class for proxy filter types
Class containing Relay Settings values in a
ProvisionedMeshNodeRequest's builder created for
ControllerProtocolClass definitions for creating scenes in a mesh network
To be used as a wrapper class when creating a SceneDelete message.
To be used as a wrapper class when creating a SceneStore message.
To be used as a wrapper class for when creating the GenericOnOffStatus Message.
Use this class to configure all Scenes.
Use this class to configure when exporting the related Scenes, the scenes will not contain addresses of excluded nodes.
Use this class to configure when exporting some of the Scenes.
To be used as a wrapper class for when creating the GenericOnOffStatus Message.
To be used as a wrapper class when creating a SceneStore message.
Contains the information related to a secure network beacon.
This is a
IOClient implementation for serial ports.This is a generic Serial client protocol for communicating with Serial ports; it uses the
SerialIOClient to
handle the communication and all messages are processed as strings; if you require custom message type handling
then please sub class the AbstractSerialProtocol).This is a SNMP client protocol for receiving SNMP traps.
This is a
IOClient implementation for TCP.This is a generic TCP client protocol for communicating with TCP servers; it uses the
TCPIOClient to
handle the communication and all messages are processed as strings; if you require custom message type handling or
more specific handling then sub class the AbstractTCPClientProtocol).This is an
AbstractTCPServer implementation that handles String messages.The class that represents the configuration for the IKEA TRÃ…DFRI connection.
Protocol for communicating with the IKEA TRÃ…DFRI gateway; devices are represented as
Assets under the linked
Agent; Assets are automatically added/removed depending on whether they are available on the gateway,
for a given Agent a device Asset will have a consistent ID.This is a
IOClient implementation for UDP.This is a UDP client protocol for communicating with UDP servers; it uses the
UDPIOClient to handle the
communication and all messages are processed as strings; if you require custom message type handling then
sub class the AbstractUDPProtocol).This is an
AbstractUDPServer implementation that handles String messages.UpperTransportLayer implementation of the mesh network architecture as per the mesh profile specification.
Upper transport layer call backs
Command for inbound packets
Command for outbound packets
Packet priority.
To be used as a wrapper class when creating an acknowledged VendorMode message.
To be used as a wrapper class for when creating the VendorModelMessageStatus Message.
To be used as a wrapper class when creating a unacknowledged VendorModel message.
This is a generic
Protocol for communicating with a Websocket server
using String based messages.This is an
IOClient implementation based on AbstractNettyIOClient.Wrapper around
SerialIOClient to allow compatibility with Z Wave library