Skip to content

Commit 3389210

Browse files
author
udaw
committed
Add custom min/max constructors to remaining range characteristics (#162)
Add DEFAULT_MIN_VALUE/DEFAULT_MAX_VALUE (and DEFAULT_STEP for float characteristics) and a constructor taking min/max (and step) to 19 characteristics that only supported fixed ranges, following the pattern of RotationSpeedCharacteristic. Existing constructors delegate with the previous values, so their serialized output is unchanged.
1 parent 7c7678a commit 3389210

21 files changed

Lines changed: 574 additions & 46 deletions

‎CHANGES.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# HAP-Java 2.0.10
2+
* Add constructors with custom min/max (and step for float values) to the remaining range characteristics [#162](https://github.com/hap-java/HAP-Java/issues/162)
3+
14
# HAP-Java 2.0.9
25
* Fix Set Duration and Remaining Duration characteristics to advertise format `uint32` instead of `int` [#202](https://github.com/hap-java/HAP-Java/issues/202)
36
* Stop logging the SRP shared secret, derived key and M5 message data during pairing at DEBUG level

‎src/main/java/io/github/hapjava/characteristics/impl/audio/VolumeCharacteristic.java‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,33 @@
1111

1212
/** Volume characteristic to control audio volume. */
1313
public class VolumeCharacteristic extends IntegerCharacteristic implements EventableCharacteristic {
14+
public static final int DEFAULT_MIN_VALUE = 0;
15+
public static final int DEFAULT_MAX_VALUE = 100;
1416

1517
public VolumeCharacteristic(
18+
int minValue,
19+
int maxValue,
1620
Supplier<CompletableFuture<Integer>> getter,
1721
ExceptionalConsumer<Integer> setter,
1822
Consumer<HomekitCharacteristicChangeCallback> subscriber,
1923
Runnable unsubscriber) {
2024
super(
2125
"00000119-0000-1000-8000-0026BB765291",
2226
"volume",
23-
0,
24-
100,
27+
minValue,
28+
maxValue,
2529
"percentage",
2630
Optional.of(getter),
2731
Optional.of(setter),
2832
Optional.of(subscriber),
2933
Optional.of(unsubscriber));
3034
}
35+
36+
public VolumeCharacteristic(
37+
Supplier<CompletableFuture<Integer>> getter,
38+
ExceptionalConsumer<Integer> setter,
39+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
40+
Runnable unsubscriber) {
41+
this(DEFAULT_MIN_VALUE, DEFAULT_MAX_VALUE, getter, setter, subscriber, unsubscriber);
42+
}
3143
}

‎src/main/java/io/github/hapjava/characteristics/impl/battery/BatteryLevelCharacteristic.java‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,31 @@
1111
/** This characteristic describes the current level of the battery. */
1212
public class BatteryLevelCharacteristic extends IntegerCharacteristic
1313
implements EventableCharacteristic {
14+
public static final int DEFAULT_MIN_VALUE = 0;
15+
public static final int DEFAULT_MAX_VALUE = 100;
1416

1517
public BatteryLevelCharacteristic(
18+
int minValue,
19+
int maxValue,
1620
Supplier<CompletableFuture<Integer>> getter,
1721
Consumer<HomekitCharacteristicChangeCallback> subscriber,
1822
Runnable unsubscriber) {
1923
super(
2024
"00000068-0000-1000-8000-0026BB765291",
2125
"battery level",
22-
0,
23-
100,
26+
minValue,
27+
maxValue,
2428
"%",
2529
Optional.of(getter),
2630
Optional.empty(),
2731
Optional.of(subscriber),
2832
Optional.of(unsubscriber));
2933
}
34+
35+
public BatteryLevelCharacteristic(
36+
Supplier<CompletableFuture<Integer>> getter,
37+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
38+
Runnable unsubscriber) {
39+
this(DEFAULT_MIN_VALUE, DEFAULT_MAX_VALUE, getter, subscriber, unsubscriber);
40+
}
3041
}

‎src/main/java/io/github/hapjava/characteristics/impl/common/WaterLavelCharacteristic.java‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,34 @@
1111
/** This characteristic describes the water level. */
1212
public class WaterLavelCharacteristic extends FloatCharacteristic
1313
implements EventableCharacteristic {
14+
public static final double DEFAULT_MIN_VALUE = 0;
15+
public static final double DEFAULT_MAX_VALUE = 100;
16+
public static final double DEFAULT_STEP = 1;
1417

1518
public WaterLavelCharacteristic(
19+
double minValue,
20+
double maxValue,
21+
double minStep,
1622
Supplier<CompletableFuture<Double>> getter,
1723
Consumer<HomekitCharacteristicChangeCallback> subscriber,
1824
Runnable unsubscriber) {
1925
super(
2026
"000000B5-0000-1000-8000-0026BB765291",
2127
"water level",
22-
0,
23-
100,
24-
1,
28+
minValue,
29+
maxValue,
30+
minStep,
2531
"%",
2632
Optional.of(getter),
2733
Optional.empty(),
2834
Optional.of(subscriber),
2935
Optional.of(unsubscriber));
3036
}
37+
38+
public WaterLavelCharacteristic(
39+
Supplier<CompletableFuture<Double>> getter,
40+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
41+
Runnable unsubscriber) {
42+
this(DEFAULT_MIN_VALUE, DEFAULT_MAX_VALUE, DEFAULT_STEP, getter, subscriber, unsubscriber);
43+
}
3144
}

‎src/main/java/io/github/hapjava/characteristics/impl/filtermaintenance/FilterLifeLevelCharacteristic.java‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,34 @@
1010

1111
public class FilterLifeLevelCharacteristic extends FloatCharacteristic
1212
implements EventableCharacteristic {
13+
public static final double DEFAULT_MIN_VALUE = 0;
14+
public static final double DEFAULT_MAX_VALUE = 100;
15+
public static final double DEFAULT_STEP = 1;
1316

1417
public FilterLifeLevelCharacteristic(
18+
double minValue,
19+
double maxValue,
20+
double minStep,
1521
Supplier<CompletableFuture<Double>> getter,
1622
Consumer<HomekitCharacteristicChangeCallback> subscriber,
1723
Runnable unsubscriber) {
1824
super(
1925
"000000AB-0000-1000-8000-0026BB765291",
2026
"Filter Life Level",
21-
0,
22-
100,
23-
1,
27+
minValue,
28+
maxValue,
29+
minStep,
2430
"%",
2531
Optional.of(getter),
2632
Optional.empty(),
2733
Optional.of(subscriber),
2834
Optional.of(unsubscriber));
2935
}
36+
37+
public FilterLifeLevelCharacteristic(
38+
Supplier<CompletableFuture<Double>> getter,
39+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
40+
Runnable unsubscriber) {
41+
this(DEFAULT_MIN_VALUE, DEFAULT_MAX_VALUE, DEFAULT_STEP, getter, subscriber, unsubscriber);
42+
}
3043
}

‎src/main/java/io/github/hapjava/characteristics/impl/humidifier/HumidityDehumidifierThresholdCharacteristic.java‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,43 @@
1313
* turns on.
1414
*/
1515
public class HumidityDehumidifierThresholdCharacteristic extends FloatCharacteristic {
16+
public static final double DEFAULT_MIN_VALUE = 0;
17+
public static final double DEFAULT_MAX_VALUE = 100;
18+
public static final double DEFAULT_STEP = 1;
1619

1720
public HumidityDehumidifierThresholdCharacteristic(
21+
double minValue,
22+
double maxValue,
23+
double minStep,
1824
Supplier<CompletableFuture<Double>> getter,
1925
ExceptionalConsumer<Double> setter,
2026
Consumer<HomekitCharacteristicChangeCallback> subscriber,
2127
Runnable unsubscriber) {
2228
super(
2329
"000000C9-0000-1000-8000-0026BB765291",
2430
"humidity threshold dehumidifier",
25-
0,
26-
100,
27-
1,
31+
minValue,
32+
maxValue,
33+
minStep,
2834
"%",
2935
Optional.of(getter),
3036
Optional.of(setter),
3137
Optional.of(subscriber),
3238
Optional.of(unsubscriber));
3339
}
40+
41+
public HumidityDehumidifierThresholdCharacteristic(
42+
Supplier<CompletableFuture<Double>> getter,
43+
ExceptionalConsumer<Double> setter,
44+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
45+
Runnable unsubscriber) {
46+
this(
47+
DEFAULT_MIN_VALUE,
48+
DEFAULT_MAX_VALUE,
49+
DEFAULT_STEP,
50+
getter,
51+
setter,
52+
subscriber,
53+
unsubscriber);
54+
}
3455
}

‎src/main/java/io/github/hapjava/characteristics/impl/humidifier/HumidityHumidifierThresholdCharacteristic.java‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,43 @@
1313
* turns on.
1414
*/
1515
public class HumidityHumidifierThresholdCharacteristic extends FloatCharacteristic {
16+
public static final double DEFAULT_MIN_VALUE = 0;
17+
public static final double DEFAULT_MAX_VALUE = 100;
18+
public static final double DEFAULT_STEP = 1;
1619

1720
public HumidityHumidifierThresholdCharacteristic(
21+
double minValue,
22+
double maxValue,
23+
double minStep,
1824
Supplier<CompletableFuture<Double>> getter,
1925
ExceptionalConsumer<Double> setter,
2026
Consumer<HomekitCharacteristicChangeCallback> subscriber,
2127
Runnable unsubscriber) {
2228
super(
2329
"000000CA-0000-1000-8000-0026BB765291",
2430
"humidity threshold humidifier",
25-
0,
26-
100,
27-
1,
31+
minValue,
32+
maxValue,
33+
minStep,
2834
"%",
2935
Optional.of(getter),
3036
Optional.of(setter),
3137
Optional.of(subscriber),
3238
Optional.of(unsubscriber));
3339
}
40+
41+
public HumidityHumidifierThresholdCharacteristic(
42+
Supplier<CompletableFuture<Double>> getter,
43+
ExceptionalConsumer<Double> setter,
44+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
45+
Runnable unsubscriber) {
46+
this(
47+
DEFAULT_MIN_VALUE,
48+
DEFAULT_MAX_VALUE,
49+
DEFAULT_STEP,
50+
getter,
51+
setter,
52+
subscriber,
53+
unsubscriber);
54+
}
3455
}

‎src/main/java/io/github/hapjava/characteristics/impl/humiditysensor/CurrentRelativeHumidityCharacteristic.java‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,34 @@
99

1010
/** This characteristic describes the current relative humidity. */
1111
public class CurrentRelativeHumidityCharacteristic extends FloatCharacteristic {
12+
public static final double DEFAULT_MIN_VALUE = 0;
13+
public static final double DEFAULT_MAX_VALUE = 100;
14+
public static final double DEFAULT_STEP = 1;
1215

1316
public CurrentRelativeHumidityCharacteristic(
17+
double minValue,
18+
double maxValue,
19+
double minStep,
1420
Supplier<CompletableFuture<Double>> getter,
1521
Consumer<HomekitCharacteristicChangeCallback> subscriber,
1622
Runnable unsubscriber) {
1723
super(
1824
"00000010-0000-1000-8000-0026BB765291",
1925
"Current Relative Humidity",
20-
0,
21-
100,
22-
1,
26+
minValue,
27+
maxValue,
28+
minStep,
2329
"%",
2430
Optional.of(getter),
2531
Optional.empty(),
2632
Optional.of(subscriber),
2733
Optional.of(unsubscriber));
2834
}
35+
36+
public CurrentRelativeHumidityCharacteristic(
37+
Supplier<CompletableFuture<Double>> getter,
38+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
39+
Runnable unsubscriber) {
40+
this(DEFAULT_MIN_VALUE, DEFAULT_MAX_VALUE, DEFAULT_STEP, getter, subscriber, unsubscriber);
41+
}
2942
}

‎src/main/java/io/github/hapjava/characteristics/impl/humiditysensor/TargetRelativeHumidityCharacteristic.java‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,43 @@
1010

1111
/** This characteristic describes the target relative humidity. */
1212
public class TargetRelativeHumidityCharacteristic extends FloatCharacteristic {
13+
public static final double DEFAULT_MIN_VALUE = 0;
14+
public static final double DEFAULT_MAX_VALUE = 100;
15+
public static final double DEFAULT_STEP = 1;
1316

1417
public TargetRelativeHumidityCharacteristic(
18+
double minValue,
19+
double maxValue,
20+
double minStep,
1521
Supplier<CompletableFuture<Double>> getter,
1622
ExceptionalConsumer<Double> setter,
1723
Consumer<HomekitCharacteristicChangeCallback> subscriber,
1824
Runnable unsubscriber) {
1925
super(
2026
"00000034-0000-1000-8000-0026BB765291",
2127
"Target Relative Humidity",
22-
0,
23-
100,
24-
1,
28+
minValue,
29+
maxValue,
30+
minStep,
2531
"%",
2632
Optional.of(getter),
2733
Optional.of(setter),
2834
Optional.of(subscriber),
2935
Optional.of(unsubscriber));
3036
}
37+
38+
public TargetRelativeHumidityCharacteristic(
39+
Supplier<CompletableFuture<Double>> getter,
40+
ExceptionalConsumer<Double> setter,
41+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
42+
Runnable unsubscriber) {
43+
this(
44+
DEFAULT_MIN_VALUE,
45+
DEFAULT_MAX_VALUE,
46+
DEFAULT_STEP,
47+
getter,
48+
setter,
49+
subscriber,
50+
unsubscriber);
51+
}
3152
}

‎src/main/java/io/github/hapjava/characteristics/impl/lightbulb/BrightnessCharacteristic.java‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,33 @@
1515
*/
1616
public class BrightnessCharacteristic extends IntegerCharacteristic
1717
implements EventableCharacteristic {
18+
public static final int DEFAULT_MIN_VALUE = 0;
19+
public static final int DEFAULT_MAX_VALUE = 100;
1820

1921
public BrightnessCharacteristic(
22+
int minValue,
23+
int maxValue,
2024
Supplier<CompletableFuture<Integer>> getter,
2125
ExceptionalConsumer<Integer> setter,
2226
Consumer<HomekitCharacteristicChangeCallback> subscriber,
2327
Runnable unsubscriber) {
2428
super(
2529
"00000008-0000-1000-8000-0026BB765291",
2630
"level of brightness",
27-
0,
28-
100,
31+
minValue,
32+
maxValue,
2933
"%",
3034
Optional.of(getter),
3135
Optional.of(setter),
3236
Optional.of(subscriber),
3337
Optional.of(unsubscriber));
3438
}
39+
40+
public BrightnessCharacteristic(
41+
Supplier<CompletableFuture<Integer>> getter,
42+
ExceptionalConsumer<Integer> setter,
43+
Consumer<HomekitCharacteristicChangeCallback> subscriber,
44+
Runnable unsubscriber) {
45+
this(DEFAULT_MIN_VALUE, DEFAULT_MAX_VALUE, getter, setter, subscriber, unsubscriber);
46+
}
3547
}

0 commit comments

Comments
 (0)