com.github.niqdev.openwebnet

Class OpenWebNet

java.lang.Object

com.github.niqdev.openwebnet.OpenWebNet

public class OpenWebNet
extends java.lang.Object

OpenWebNet client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpenWebNet.OpenGateway OpenWebNet gateway.

Method Summary

Modifier and Type	Method and Description
static OpenWebNet.OpenGateway	defaultGateway(java.lang.String host) Helper method to create a new gateway on port OpenWebNet.OpenGateway.DEFAULT_PORT without password.
static OpenWebNet.OpenGateway	gateway(java.lang.String host, int port) Helper method to create a new gateway without password.
static OpenWebNet.OpenGateway	gateway(java.lang.String host, int port, java.lang.String password) Helper method to create a new gateway.
rx.Observable<java.util.List<OpenSession>>	listen(OpenMessage... requests) Not implemented yet.
static OpenWebNet	newClient(OpenWebNet.OpenGateway gateway) Helper method to create a new client.
rx.Observable<java.util.List<OpenSession>>	send(java.util.List<OpenMessage> requests) Open a connection and send a list of Channel#COMMAND messages.
rx.Observable<OpenSession>	send(OpenMessage request) Open a connection and send a Channel#COMMAND message.

Methods inherited from class java.lang.Object

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

Method Detail

newClient

public static OpenWebNet newClient(OpenWebNet.OpenGateway gateway)

Helper method to create a new client.

Parameters:

gateway - The gateway

Returns:

client

send

public rx.Observable<OpenSession> send(OpenMessage request)

Open a connection and send a Channel#COMMAND message.

Parameters:

request - The message to be sent

Returns:

Observable<OpenSession>

send

public rx.Observable<java.util.List<OpenSession>> send(java.util.List<OpenMessage> requests)

Open a connection and send a list of Channel#COMMAND messages.

Parameters:

requests - The messages to be sent

Returns:

Observable<OpenSession>

listen

public rx.Observable<java.util.List<OpenSession>> listen(OpenMessage... requests)

Not implemented yet.

Throws:

java.lang.UnsupportedOperationException

gateway

public static OpenWebNet.OpenGateway gateway(java.lang.String host,
                                             int port,
                                             java.lang.String password)

Helper method to create a new gateway.

Parameters:

host - Gateway ip address or domain

port - Gateway port

password - Gateway password

Returns:

gateway

gateway

public static OpenWebNet.OpenGateway gateway(java.lang.String host,
                                             int port)

Helper method to create a new gateway without password.

Parameters:

host - Gateway ip address or domain

port - Gateway port

Returns:

gateway

defaultGateway

public static OpenWebNet.OpenGateway defaultGateway(java.lang.String host)

Helper method to create a new gateway on port OpenWebNet.OpenGateway.DEFAULT_PORT without password.

Parameters:

host - Gateway ip address or domain

Returns:

gateway