com.github.niqdev.openwebnet.message

Class EnergyManagement

java.lang.Object

com.github.niqdev.openwebnet.message.EnergyManagement

All Implemented Interfaces:

OpenMessage

public class EnergyManagement
extends java.lang.Object

OpenWebNet Energy Management.

 

 // reads powers (best effort)
 OpenWebNet
    .newClient(gateway("x.x.x.x", 20000, "12345"))
    .send(asList(
       EnergyManagement.requestInstantaneousPower("1", EnergyManagement.Version.MODEL_F523),
       EnergyManagement.requestDailyPower("1", EnergyManagement.Version.MODEL_F520),
       EnergyManagement.requestMonthlyPower("1", EnergyManagement.Version.MODEL_F522_A)))
    .map(EnergyManagement.handlePowers(System.out::println, () -> System.out.println("error")))
    .subscribe(System.out::println);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyManagement.Version

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)
java.lang.String	getValue() Raw message value.
static rx.functions.Func1<java.util.List<OpenSession>,java.util.List<OpenSession>>	handlePowers(rx.functions.Action1<java.util.List<java.lang.String>> onSuccess, rx.functions.Action0 onError) Handle response from requestInstantaneousPower(String, Version), requestDailyPower(String, Version) and requestMonthlyPower(String, Version).
protected static rx.functions.Func1<OpenSession,OpenSession>	handleResponse(rx.functions.Action0 onSuccess, rx.functions.Action0 onFail, int who)
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 EnergyManagement	requestDailyPower(java.lang.String where, EnergyManagement.Version version) OpenWebNet message request daily power in Watt.
static EnergyManagement	requestInstantaneousPower(java.lang.String where, EnergyManagement.Version version) OpenWebNet message request instantaneous power in Watt.
static EnergyManagement	requestMonthlyPower(java.lang.String where, EnergyManagement.Version version) OpenWebNet message request monthly power in Watt.

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

requestInstantaneousPower

public static EnergyManagement requestInstantaneousPower(java.lang.String where,
                                                         EnergyManagement.Version version)

OpenWebNet message request instantaneous power in Watt.

Parameters:

where - Value between 1 and 255

version - Energy management EnergyManagement.Version

Returns:

message

requestDailyPower

public static EnergyManagement requestDailyPower(java.lang.String where,
                                                 EnergyManagement.Version version)

OpenWebNet message request daily power in Watt.

Parameters:

where - Value between 1 and 255

version - Energy management EnergyManagement.Version

Returns:

message

requestMonthlyPower

public static EnergyManagement requestMonthlyPower(java.lang.String where,
                                                   EnergyManagement.Version version)

OpenWebNet message request monthly power in Watt.

Parameters:

where - Value between 1 and 255

version - Energy management EnergyManagement.Version

Returns:

message

handlePowers

public static rx.functions.Func1<java.util.List<OpenSession>,java.util.List<OpenSession>> handlePowers(rx.functions.Action1<java.util.List<java.lang.String>> onSuccess,
                                                                                                       rx.functions.Action0 onError)

Handle response from requestInstantaneousPower(String, Version), requestDailyPower(String, Version) and requestMonthlyPower(String, Version). This is a best effort: often the responses are incomplete or impossible to parse.

Parameters:

onSuccess - invoked if the powers have been read correctly

onError - invoked otherwise

Returns:

Observable<List<OpenSession>>

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)