com.github.niqdev.openwebnet.message

Class SoundSystem

java.lang.Object

com.github.niqdev.openwebnet.message.SoundSystem

All Implemented Interfaces:

OpenMessage

public class SoundSystem
extends java.lang.Object

OpenWebNet Sound System.

 

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

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

 // requests status amplifier 51
 client
    .send(SoundSystem.requestStatus("51", SoundSystem.Type.AMPLIFIER_P2P))
    .map(SoundSystem.handleStatus(() -> System.out.println("ON"), () -> System.out.println("OFF")))
    .subscribe(System.out::println);

 // turns group 5 on
 client
    .send(SoundSystem.requestTurnOn("5", SoundSystem.Type.AMPLIFIER_GROUP, SoundSystem.Source.STEREO_CHANNEL))
    .map(SoundSystem.handleResponse(() -> System.out.println("success"), () -> System.out.println("fail")))
    .subscribe(System.out::println);

 // turn volume up of amplifier 51
 client
    .send(SoundSystem.requestVolumeUp("51", SoundSystem.Type.AMPLIFIER_P2P))
    .map(SoundSystem.handleResponse(() -> System.out.println("success"), () -> System.out.println("fail")))
    .subscribe(System.out::println);

 // change station of source 103
 client
    .send(SoundSystem.requestStationUp("103", SoundSystem.Type.SOURCE_P2P))
    .map(SoundSystem.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	SoundSystem.Source Sound System source.
static class	SoundSystem.Type Sound System type: amplifier or source.

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 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SoundSystem(java.lang.String value)

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	buildWhereValue(java.lang.String where, SoundSystem.Type type)
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)
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, Type, Source) - requestTurnOff(String, Type, Source) - requestVolumeUp(String, Type) - requestVolumeDown(String, Type) - requestStationUp(String, Type) - requestStationDown(String, Type)
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, Type).
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 SoundSystem	requestStationDown(java.lang.String where, SoundSystem.Type type) OpenWebNet message request to change Source Station DOWN with value *16*6101*WHERE##.
static SoundSystem	requestStationUp(java.lang.String where, SoundSystem.Type type) OpenWebNet message request to change Source Station UP with value *16*6001*WHERE##.
static SoundSystem	requestStatus(java.lang.String where, SoundSystem.Type type) OpenWebNet message request Amplifier/Source status with value *#16*WHERE*5##.
static SoundSystem	requestTurnOff(java.lang.String where, SoundSystem.Type type, SoundSystem.Source source) OpenWebNet message request to turn Amplifier/Source OFF with value *16*10*WHERE## or *16*13*WHERE##.
static SoundSystem	requestTurnOn(java.lang.String where, SoundSystem.Type type, SoundSystem.Source source) OpenWebNet message request to turn Amplifier/Source ON with value *16*0*WHERE## or *16*3*WHERE##.
static SoundSystem	requestVolumeDown(java.lang.String where, SoundSystem.Type type) OpenWebNet message request to turn Amplifier Volume DOWN by step with value *16*1102*WHERE##.
static SoundSystem	requestVolumeUp(java.lang.String where, SoundSystem.Type type) OpenWebNet message request to turn Amplifier Volume UP by step with value *16*1002*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_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

Constructor Detail

SoundSystem

protected SoundSystem(java.lang.String value)

Method Detail

requestTurnOn

public static SoundSystem requestTurnOn(java.lang.String where,
                                        SoundSystem.Type type,
                                        SoundSystem.Source source)

OpenWebNet message request to turn Amplifier/Source ON with value *16*0*WHERE## or *16*3*WHERE##.

Parameters:

where - Value

type - Type SoundSystem.Type

source - Source SoundSystem.Source

Returns:

message

requestTurnOff

public static SoundSystem requestTurnOff(java.lang.String where,
                                         SoundSystem.Type type,
                                         SoundSystem.Source source)

OpenWebNet message request to turn Amplifier/Source OFF with value *16*10*WHERE## or *16*13*WHERE##.

Parameters:

where - Value

type - Type SoundSystem.Type

source - Source SoundSystem.Source

Returns:

message

handleResponse

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

Handle response from: - requestTurnOn(String, Type, Source) - requestTurnOff(String, Type, Source) - requestVolumeUp(String, Type) - requestVolumeDown(String, Type) - requestStationUp(String, Type) - requestStationDown(String, Type)

Parameters:

onSuccess - invoked if the request has been successfully received

onFail - invoked otherwise

Returns:

Observable<OpenSession>

requestStatus

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

OpenWebNet message request Amplifier/Source status with value *#16*WHERE*5##.

Parameters:

where - Value

type - Type SoundSystem.Type

Returns:

message

handleStatus

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

Handle response from requestStatus(String, Type).

NOTE: this is a best effort

Parameters:

onStatus - invoked if Amplifier/Source is on

offStatus - invoked if Amplifier/Source is off

Returns:

Observable<OpenSession>

buildWhereValue

protected static java.lang.String buildWhereValue(java.lang.String where,
                                                  SoundSystem.Type type)

requestVolumeUp

public static SoundSystem requestVolumeUp(java.lang.String where,
                                          SoundSystem.Type type)

OpenWebNet message request to turn Amplifier Volume UP by step with value *16*1002*WHERE##.

Parameters:

where - Value

type - Type SoundSystem.Type

Returns:

message

requestVolumeDown

public static SoundSystem requestVolumeDown(java.lang.String where,
                                            SoundSystem.Type type)

OpenWebNet message request to turn Amplifier Volume DOWN by step with value *16*1102*WHERE##.

Parameters:

where - Value

type - Type SoundSystem.Type

Returns:

message

requestStationUp

public static SoundSystem requestStationUp(java.lang.String where,
                                           SoundSystem.Type type)

OpenWebNet message request to change Source Station UP with value *16*6001*WHERE##.

Parameters:

where - Value

type - Type SoundSystem.Type

Returns:

message

requestStationDown

public static SoundSystem requestStationDown(java.lang.String where,
                                             SoundSystem.Type type)

OpenWebNet message request to change Source Station DOWN with value *16*6101*WHERE##.

Parameters:

where - Value

type - Type SoundSystem.Type

Returns:

message

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)