com.github.niqdev.openwebnet.message

Class Automation

java.lang.Object

com.github.niqdev.openwebnet.message.Automation

All Implemented Interfaces:

OpenMessage

public class Automation
extends java.lang.Object

OpenWebNet Automation.

 

 import static com.github.niqdev.openwebnet.OpenWebNet.defaultGateway;

 // move shutter up
 OpenWebNet
    .newClient(defaultGateway("IP_ADDRESS"))
    .send(Automation.requestMoveUp("WHERE"))
    .map(Automation.handleResponse(() -> System.out.println("success"), () -> System.out.println("fail")))
    .subscribe(System.out::println);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Automation.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	FORMAT_BUS
protected static java.lang.String	FORMAT_DIMENSION
protected static java.lang.String	FORMAT_PREFIX_DIMENSION
protected static java.lang.String	FORMAT_PREFIX_DIMENSION_WHO
protected static java.lang.String	FORMAT_PREFIX_REQUEST_WHO
protected static java.lang.String	FORMAT_PREFIX_RESPONSE
protected static java.lang.String	FORMAT_PREFIX_STATUS_WHO
protected static java.lang.String	FORMAT_REQUEST
protected static java.lang.String	FORMAT_STATUS
static java.lang.String	NO_BUS
static java.lang.String	WHERE_GENERAL_VALUE
protected static java.lang.String	WHERE_GROUP_PREFIX
protected static int	WHERE_MAX_VALUE
protected static int	WHERE_MIN_VALUE

Fields inherited from interface com.github.niqdev.openwebnet.message.OpenMessage

ACK, FRAME_END, FRAME_START, NACK

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	checkBus(java.lang.String bus)
protected static int	checkIsInteger(java.lang.String value)
protected static void	checkRange(java.lang.Integer from, java.lang.Integer to, java.lang.Integer value)
protected static void	checkRangeType(java.lang.String where, Automation.Type type, java.lang.String bus)
java.lang.String	getValue() Raw message value.
static rx.functions.Func1<OpenSession,OpenSession>	handleResponse(rx.functions.Action0 onSuccess, rx.functions.Action0 onFail) Handle response from requestMoveUp(String), requestMoveDown(String) and requestStop(String).
protected static rx.functions.Func1<OpenSession,OpenSession>	handleResponse(rx.functions.Action0 onSuccess, rx.functions.Action0 onFail, int who)
static rx.functions.Func1<OpenSession,OpenSession>	handleStatus(rx.functions.Action0 stopAction, rx.functions.Action0 upAction, rx.functions.Action0 downAction) Handle response from requestStatus(String).
protected static boolean	isInRange(java.lang.Integer from, java.lang.Integer to, java.lang.Integer value)
protected static java.lang.Boolean	isValidBus(java.lang.String bus)
protected static void	isValidPrefixType(OpenMessage request, java.lang.String format, int who)
static boolean	isValidRangeType(java.lang.String where, Automation.Type type, java.lang.String bus)
static Automation	requestMoveDown(java.lang.String where) Deprecated. use requestMoveDown(String, Type, String)
static Automation	requestMoveDown(java.lang.String where, Automation.Type type, java.lang.String bus) OpenWebNet message request to send the DOWN automation command with value *2*2*WHERE##.
static Automation	requestMoveUp(java.lang.String where) Deprecated. use requestMoveUp(String, Type, String)
static Automation	requestMoveUp(java.lang.String where, Automation.Type type, java.lang.String bus) OpenWebNet message request to send the UP automation command with value *2*1*WHERE##.
static Automation	requestStatus(java.lang.String where) Deprecated. use requestStatus(String, Type, String)
static Automation	requestStatus(java.lang.String where, Automation.Type type, java.lang.String bus) OpenWebNet message request automation status with value *#2*WHERE##.
static Automation	requestStop(java.lang.String where) Deprecated. use requestStop(String, Type, String)
static Automation	requestStop(java.lang.String where, Automation.Type type, java.lang.String bus) OpenWebNet message request to send the STOP automation command with value *2*0*WHERE##.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_PREFIX_REQUEST_WHO

protected static final java.lang.String FORMAT_PREFIX_REQUEST_WHO

See Also:

Constant Field Values

FORMAT_PREFIX_DIMENSION_WHO

protected static final java.lang.String FORMAT_PREFIX_DIMENSION_WHO

See Also:

Constant Field Values

FORMAT_PREFIX_STATUS_WHO

protected static final java.lang.String FORMAT_PREFIX_STATUS_WHO

See Also:

Constant Field Values

FORMAT_REQUEST

protected static final java.lang.String FORMAT_REQUEST

See Also:

Constant Field Values

FORMAT_DIMENSION

protected static final java.lang.String FORMAT_DIMENSION

See Also:

Constant Field Values

FORMAT_STATUS

protected static final java.lang.String FORMAT_STATUS

See Also:

Constant Field Values

FORMAT_PREFIX_RESPONSE

protected static final java.lang.String FORMAT_PREFIX_RESPONSE

See Also:

Constant Field Values

FORMAT_PREFIX_DIMENSION

protected static final java.lang.String FORMAT_PREFIX_DIMENSION

See Also:

Constant Field Values

FORMAT_BUS

protected static final java.lang.String FORMAT_BUS

See Also:

Constant Field Values

WHERE_MIN_VALUE

protected static final int WHERE_MIN_VALUE

See Also:

Constant Field Values

WHERE_MAX_VALUE

protected static final int WHERE_MAX_VALUE

See Also:

Constant Field Values

WHERE_GROUP_PREFIX

protected static final java.lang.String WHERE_GROUP_PREFIX

See Also:

Constant Field Values

WHERE_GENERAL_VALUE

public static final java.lang.String WHERE_GENERAL_VALUE

See Also:

Constant Field Values

NO_BUS

public static final java.lang.String NO_BUS

See Also:

Constant Field Values

Method Detail

requestStop

public static Automation requestStop(java.lang.String where)

Deprecated. use requestStop(String, Type, String)

OpenWebNet message request to send the STOP automation command with value *2*0*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestStop

public static Automation requestStop(java.lang.String where,
                                     Automation.Type type,
                                     java.lang.String bus)

OpenWebNet message request to send the STOP automation command with value *2*0*WHERE##.

Parameters:

where - Value between 0 and 9999

type - Type Automation.Type

bus - Value

Returns:

message

requestMoveUp

public static Automation requestMoveUp(java.lang.String where)

Deprecated. use requestMoveUp(String, Type, String)

OpenWebNet message request to send the UP automation command with value *2*1*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestMoveUp

public static Automation requestMoveUp(java.lang.String where,
                                       Automation.Type type,
                                       java.lang.String bus)

OpenWebNet message request to send the UP automation command with value *2*1*WHERE##.

Parameters:

where - Value between 0 and 9999

type - Type Automation.Type

bus - Value

Returns:

message

requestMoveDown

public static Automation requestMoveDown(java.lang.String where)

Deprecated. use requestMoveDown(String, Type, String)

OpenWebNet message request to send the DOWN automation command with value *2*2*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestMoveDown

public static Automation requestMoveDown(java.lang.String where,
                                         Automation.Type type,
                                         java.lang.String bus)

OpenWebNet message request to send the DOWN automation command with value *2*2*WHERE##.

Parameters:

where - Value between 0 and 9999

type - Type Automation.Type

bus - Value

Returns:

message

handleResponse

public static rx.functions.Func1<OpenSession,OpenSession> handleResponse(rx.functions.Action0 onSuccess,
                                                                         rx.functions.Action0 onFail)

Handle response from requestMoveUp(String), requestMoveDown(String) and requestStop(String).

Parameters:

onSuccess - invoked if request has been successfully received

onFail - invoked otherwise

Returns:

Observable<OpenSession>

requestStatus

public static Automation requestStatus(java.lang.String where)

Deprecated. use requestStatus(String, Type, String)

OpenWebNet message request automation status with value *#2*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestStatus

public static Automation requestStatus(java.lang.String where,
                                       Automation.Type type,
                                       java.lang.String bus)

OpenWebNet message request automation status with value *#2*WHERE##.

Parameters:

where - Value between 0 and 9999

type - Type Automation.Type

bus - Value

Returns:

message

handleStatus

public static rx.functions.Func1<OpenSession,OpenSession> handleStatus(rx.functions.Action0 stopAction,
                                                                       rx.functions.Action0 upAction,
                                                                       rx.functions.Action0 downAction)

Handle response from requestStatus(String).

Parameters:

stopAction - invoked if automation is stopped

upAction - invoked if automation is processing the UP command

downAction - invoked if automation is processing the DOWN command

Returns:

Observable<OpenSession>

checkRangeType

protected static void checkRangeType(java.lang.String where,
                                     Automation.Type type,
                                     java.lang.String bus)

isValidRangeType

public static boolean isValidRangeType(java.lang.String where,
                                       Automation.Type type,
                                       java.lang.String bus)

getValue

public java.lang.String getValue()

Description copied from interface: OpenMessage

Raw message value.

Specified by:

getValue in interface OpenMessage

Returns:

value

checkRange

protected static void checkRange(java.lang.Integer from,
                                 java.lang.Integer to,
                                 java.lang.Integer value)

isInRange

protected static boolean isInRange(java.lang.Integer from,
                                   java.lang.Integer to,
                                   java.lang.Integer value)

checkIsInteger

protected static int checkIsInteger(java.lang.String value)

isValidPrefixType

protected static void isValidPrefixType(OpenMessage request,
                                        java.lang.String format,
                                        int who)

handleResponse

protected static rx.functions.Func1<OpenSession,OpenSession> handleResponse(rx.functions.Action0 onSuccess,
                                                                            rx.functions.Action0 onFail,
                                                                            int who)

checkBus

protected static java.lang.String checkBus(java.lang.String bus)

isValidBus

protected static java.lang.Boolean isValidBus(java.lang.String bus)