com.github.niqdev.openwebnet.message

Class Lighting

java.lang.Object

com.github.niqdev.openwebnet.message.Lighting

All Implemented Interfaces:

OpenMessage

public class Lighting
extends java.lang.Object

OpenWebNet Lighting.

 

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

 OpenWebNet client = OpenWebNet.newClient(defaultGateway("IP_ADDRESS"));

 // requests status light 21
 client
    .send(Lighting.requestStatus("21", Lighting.Type.POINT_TO_POINT, Lighting.NO_BUS))
    .map(Lighting.handleStatus(() -> System.out.println("ON"), () -> System.out.println("OFF")))
    .subscribe(System.out::println);

 // turns light 21 on
 client
    .send(Lighting.requestTurnOn("21", Lighting.Type.POINT_TO_POINT, Lighting.NO_BUS))
    .map(Lighting.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	Lighting.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, Lighting.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 requestTurnOn(String) and requestTurnOff(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 onStatus, rx.functions.Action0 offStatus) 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, Lighting.Type type, java.lang.String bus)
static Lighting	requestStatus(java.lang.String where) Deprecated. use requestStatus(String, Type, String)
static Lighting	requestStatus(java.lang.String where, Lighting.Type type, java.lang.String bus) OpenWebNet message request light status with value *#1*WHERE##.
static Lighting	requestTurnOff(java.lang.String where) Deprecated. use requestTurnOff(String, Type, String)
static Lighting	requestTurnOff(java.lang.String where, Lighting.Type type, java.lang.String bus) OpenWebNet message request to turn light OFF with value *1*0*WHERE##.
static Lighting	requestTurnOn(java.lang.String where) Deprecated. use requestTurnOn(String, Type, String)
static Lighting	requestTurnOn(java.lang.String where, Lighting.Type type, java.lang.String bus) OpenWebNet message request to turn light ON with value *1*1*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

requestTurnOn

public static Lighting requestTurnOn(java.lang.String where)

Deprecated. use requestTurnOn(String, Type, String)

OpenWebNet message request to turn light ON with value *1*1*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestTurnOn

public static Lighting requestTurnOn(java.lang.String where,
                                     Lighting.Type type,
                                     java.lang.String bus)

OpenWebNet message request to turn light ON with value *1*1*WHERE##.

Parameters:

where - Value

type - Type Lighting.Type

bus - Value

Returns:

message

requestTurnOff

public static Lighting requestTurnOff(java.lang.String where)

Deprecated. use requestTurnOff(String, Type, String)

OpenWebNet message request to turn light OFF with value *1*0*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestTurnOff

public static Lighting requestTurnOff(java.lang.String where,
                                      Lighting.Type type,
                                      java.lang.String bus)

OpenWebNet message request to turn light OFF with value *1*0*WHERE##.

Parameters:

where - Value

type - Type Lighting.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 requestTurnOn(String) and requestTurnOff(String).

Parameters:

onSuccess - invoked if the request has been successfully received

onFail - invoked otherwise

Returns:

Observable<OpenSession>

requestStatus

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

Deprecated. use requestStatus(String, Type, String)

OpenWebNet message request light status with value *#1*WHERE##.

Parameters:

where - Value between 0 and 9999

Returns:

message

requestStatus

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

OpenWebNet message request light status with value *#1*WHERE##.

Parameters:

where - Value

type - Type Lighting.Type

bus - Value

Returns:

message

handleStatus

public static rx.functions.Func1<OpenSession,OpenSession> handleStatus(rx.functions.Action0 onStatus,
                                                                       rx.functions.Action0 offStatus)

Handle response from requestStatus(String).

Parameters:

onStatus - invoked if light is on

offStatus - invoked if light is off

Returns:

Observable<OpenSession>

checkRangeType

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

isValidRangeType

public static boolean isValidRangeType(java.lang.String where,
                                       Lighting.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)