Skip to content

Commit 1499928

Browse files
lolodomololodomo
authored
[freeboxos] Remove macAddress as thing configuration parameter (openhab#17088)
For server, revolution, player, active-player, repeater and vm thing types Replace it by a thing property. Fix openhab#17076 Signed-off-by: Laurent Garnier <[email protected]>
1 parent 8c29b59 commit 1499928

15 files changed

+105
-57
lines changed

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/ApiConsumerHandler.java

+6-8
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,12 @@ public void initialize() {
8585

8686
private void initializeOnceBridgeOnline(FreeboxOsHandler bridgeHandler) {
8787
Map<String, String> properties = editProperties();
88-
if (properties.isEmpty()) {
89-
try {
90-
initializeProperties(properties);
91-
checkAirMediaCapabilities(properties);
92-
updateProperties(properties);
93-
} catch (FreeboxException e) {
94-
logger.warn("Error getting thing {} properties: {}", thing.getUID(), e.getMessage());
95-
}
88+
try {
89+
initializeProperties(properties);
90+
checkAirMediaCapabilities(properties);
91+
updateProperties(properties);
92+
} catch (FreeboxException e) {
93+
logger.warn("Error getting thing {} properties: {}", thing.getUID(), e.getMessage());
9694
}
9795

9896
boolean isAudioReceiver = Boolean.parseBoolean(properties.get(MediaType.AUDIO.name()));

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/ApiConsumerIntf.java

+5-2
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,11 @@ default int getClientId() {
5555
return ((BigDecimal) getConfig().get(ClientConfiguration.ID)).intValue();
5656
}
5757

58-
default MACAddress getMac() {
58+
default @Nullable MACAddress getMac() {
5959
String mac = (String) getConfig().get(Thing.PROPERTY_MAC_ADDRESS);
60-
return new MACAddressString(mac).getAddress();
60+
if (mac == null) {
61+
mac = editProperties().get(Thing.PROPERTY_MAC_ADDRESS);
62+
}
63+
return mac == null ? null : new MACAddressString(mac).getAddress();
6164
}
6265
}

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/FreeplugHandler.java

+28-6
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
import org.slf4j.Logger;
3434
import org.slf4j.LoggerFactory;
3535

36+
import inet.ipaddr.mac.MACAddress;
37+
3638
/**
3739
* The {@link FreeplugHandler} is responsible for handling everything associated to a
3840
* powerline gateway managed by the freebox server
@@ -49,7 +51,13 @@ public FreeplugHandler(Thing thing) {
4951

5052
@Override
5153
void initializeProperties(Map<String, String> properties) throws FreeboxException {
52-
getManager(FreeplugManager.class).getPlug(getMac()).ifPresent(plug -> {
54+
MACAddress mac = getMac();
55+
if (mac == null) {
56+
throw new FreeboxException(
57+
"initializeProperties is not possible because MAC address is undefined for the thing "
58+
+ thing.getUID());
59+
}
60+
getManager(FreeplugManager.class).getPlug(mac).ifPresent(plug -> {
5361
properties.put(Thing.PROPERTY_MODEL_ID, plug.model());
5462
properties.put(ROLE, plug.netRole().name());
5563
properties.put(NET_ID, plug.netId());
@@ -59,15 +67,23 @@ void initializeProperties(Map<String, String> properties) throws FreeboxExceptio
5967

6068
if (plug.local()) { // Plug connected to the freebox does not provide rate up or down
6169
List<Channel> channels = new ArrayList<>(getThing().getChannels());
70+
int nbInit = channels.size();
6271
channels.removeIf(channel -> channel.getUID().getId().contains(RATE));
63-
updateThing(editThing().withChannels(channels).build());
72+
if (nbInit != channels.size()) {
73+
updateThing(editThing().withChannels(channels).build());
74+
}
6475
}
6576
});
6677
}
6778

6879
@Override
6980
protected void internalPoll() throws FreeboxException {
70-
getManager(FreeplugManager.class).getPlug(getMac()).ifPresent(plug -> {
81+
MACAddress mac = getMac();
82+
if (mac == null) {
83+
throw new FreeboxException(
84+
"internalPoll is not possible because MAC address is undefined for the thing " + thing.getUID());
85+
}
86+
getManager(FreeplugManager.class).getPlug(mac).ifPresent(plug -> {
7187
updateChannelDateTimeState(LAST_SEEN, ZonedDateTime.now().minusSeconds(plug.inactive()));
7288

7389
updateChannelString(LINE_STATUS, plug.ethPortStatus());
@@ -84,11 +100,17 @@ private void updateRateChannel(String channel, int rate) {
84100
}
85101

86102
public void reset() {
103+
MACAddress mac = getMac();
104+
if (mac == null) {
105+
logger.warn("Freeplug restart is not possible because MAC address is undefined for the thing {}",
106+
thing.getUID());
107+
return;
108+
}
87109
try {
88-
getManager(FreeplugManager.class).reboot(getMac());
89-
logger.debug("Freeplug {} succesfully restarted", getMac());
110+
getManager(FreeplugManager.class).reboot(mac);
111+
logger.debug("Freeplug {} succesfully restarted", mac);
90112
} catch (FreeboxException e) {
91-
logger.warn("Error restarting freeplug {}: {}", getMac(), e.getMessage());
113+
logger.warn("Error restarting freeplug {}: {}", mac, e.getMessage());
92114
}
93115
}
94116

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/HostHandler.java

+18-5
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
import org.slf4j.Logger;
3333
import org.slf4j.LoggerFactory;
3434

35+
import inet.ipaddr.mac.MACAddress;
36+
3537
/**
3638
* The {@link HostHandler} is responsible for all network equipments hosted on the network
3739
*
@@ -63,9 +65,10 @@ public void dispose() {
6365
}
6466

6567
protected void cancelPushSubscription() {
66-
if (pushSubscribed) {
68+
MACAddress mac = getMac();
69+
if (pushSubscribed && mac != null) {
6770
try {
68-
getManager(WebSocketManager.class).unregisterListener(getMac());
71+
getManager(WebSocketManager.class).unregisterListener(mac);
6972
} catch (FreeboxException e) {
7073
logger.warn("Error unregistering host from the websocket: {}", e.getMessage());
7174
}
@@ -92,7 +95,12 @@ protected void internalForcePoll() throws FreeboxException {
9295
}
9396

9497
protected LanHost getLanHost() throws FreeboxException {
95-
return getManager(LanBrowserManager.class).getHost(getMac()).map(hostIntf -> hostIntf.host())
98+
MACAddress mac = getMac();
99+
if (mac == null) {
100+
throw new FreeboxException(
101+
"getLanHost is not possible because MAC address is undefined for the thing " + thing.getUID());
102+
}
103+
return getManager(LanBrowserManager.class).getHost(mac).map(hostIntf -> hostIntf.host())
96104
.orElseThrow(() -> new FreeboxException("Host data not found"));
97105
}
98106

@@ -104,9 +112,14 @@ public void updateConnectivityChannels(LanHost host) {
104112
}
105113

106114
public void wol() {
115+
MACAddress mac = getMac();
116+
if (mac == null) {
117+
logger.warn("Waking up host is not possible because MAC address is undefined for the thing {}",
118+
thing.getUID());
119+
return;
120+
}
107121
try {
108-
getManager(LanBrowserManager.class).wakeOnLan(getMac(),
109-
getConfigAs(ApiConsumerConfiguration.class).password);
122+
getManager(LanBrowserManager.class).wakeOnLan(mac, getConfigAs(ApiConsumerConfiguration.class).password);
110123
} catch (FreeboxException e) {
111124
logger.warn("Error waking up host: {}", e.getMessage());
112125
}

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/PlayerHandler.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,12 @@ public PlayerHandler(Thing thing) {
5757

5858
@Override
5959
void initializeProperties(Map<String, String> properties) throws FreeboxException {
60-
super.initializeProperties(properties);
60+
// We need to get and set the MAC address before calling super.initializeProperties
6161
Player player = getManager(PlayerManager.class).getDevice(getClientId());
62+
properties.put(Thing.PROPERTY_MAC_ADDRESS, player.mac().toColonDelimitedString());
6263
properties.put(Thing.PROPERTY_MODEL_ID, player.deviceModel().name());
64+
updateProperties(properties);
65+
super.initializeProperties(properties);
6366
}
6467

6568
@Override

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/RepeaterHandler.java

+4-2
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,14 @@ public RepeaterHandler(Thing thing) {
5353

5454
@Override
5555
void initializeProperties(Map<String, String> properties) throws FreeboxException {
56-
super.initializeProperties(properties);
57-
56+
// We need to get and set the MAC address before calling super.initializeProperties
5857
Repeater repeater = getManager(RepeaterManager.class).getDevice(getClientId());
58+
properties.put(Thing.PROPERTY_MAC_ADDRESS, repeater.mainMac().toColonDelimitedString());
5959
properties.put(Thing.PROPERTY_SERIAL_NUMBER, repeater.sn());
6060
properties.put(Thing.PROPERTY_FIRMWARE_VERSION, repeater.firmwareVersion());
6161
properties.put(Thing.PROPERTY_MODEL_ID, repeater.model().name());
62+
updateProperties(properties);
63+
super.initializeProperties(properties);
6264
}
6365

6466
@Override

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/ServerHandler.java

+15-7
Original file line numberDiff line numberDiff line change
@@ -79,22 +79,30 @@ void initializeProperties(Map<String, String> properties) throws FreeboxExceptio
7979
properties.put(Thing.PROPERTY_SERIAL_NUMBER, config.serial());
8080
properties.put(Thing.PROPERTY_FIRMWARE_VERSION, config.firmwareVersion());
8181
properties.put(Thing.PROPERTY_HARDWARE_VERSION, config.modelInfo().prettyName());
82+
properties.put(Thing.PROPERTY_MAC_ADDRESS, config.mac().toColonDelimitedString());
8283
properties.put(Source.UPNP.name(), lanConfig.name());
8384

8485
List<Channel> channels = new ArrayList<>(getThing().getChannels());
86+
int nbInit = channels.size();
8587
config.sensors().forEach(sensor -> {
8688
ChannelUID sensorId = new ChannelUID(thing.getUID(), GROUP_SENSORS, sensor.id());
87-
channels.add(
88-
ChannelBuilder.create(sensorId).withLabel(sensor.name()).withAcceptedItemType("Number:Temperature")
89-
.withType(new ChannelTypeUID(BINDING_ID + ":temperature")).build());
89+
if (getThing().getChannel(sensorId) == null) {
90+
channels.add(ChannelBuilder.create(sensorId).withLabel(sensor.name())
91+
.withAcceptedItemType("Number:Temperature")
92+
.withType(new ChannelTypeUID(BINDING_ID + ":temperature")).build());
93+
}
9094
});
9195
config.fans().forEach(sensor -> {
9296
ChannelUID sensorId = new ChannelUID(thing.getUID(), GROUP_FANS, sensor.id());
93-
channels.add(ChannelBuilder.create(sensorId).withLabel(sensor.name())
94-
.withAcceptedItemType(CoreItemFactory.NUMBER).withType(new ChannelTypeUID(BINDING_ID + ":fanspeed"))
95-
.build());
97+
if (getThing().getChannel(sensorId) == null) {
98+
channels.add(ChannelBuilder.create(sensorId).withLabel(sensor.name())
99+
.withAcceptedItemType(CoreItemFactory.NUMBER)
100+
.withType(new ChannelTypeUID(BINDING_ID + ":fanspeed")).build());
101+
}
96102
});
97-
updateThing(editThing().withChannels(channels).build());
103+
if (nbInit != channels.size()) {
104+
updateThing(editThing().withChannels(channels).build());
105+
}
98106
}
99107

100108
@Override

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/VmHandler.java

+11
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
import static org.openhab.binding.freeboxos.internal.FreeboxOsBindingConstants.*;
1616

17+
import java.util.Map;
18+
1719
import org.eclipse.jdt.annotation.NonNullByDefault;
1820
import org.openhab.binding.freeboxos.internal.api.FreeboxException;
1921
import org.openhab.binding.freeboxos.internal.api.rest.VmManager;
@@ -40,6 +42,15 @@ public VmHandler(Thing thing) {
4042
super(thing);
4143
}
4244

45+
@Override
46+
void initializeProperties(Map<String, String> properties) throws FreeboxException {
47+
// We need to get and set the MAC address before calling super.initializeProperties
48+
VirtualMachine vm = getManager(VmManager.class).getDevice(getClientId());
49+
properties.put(Thing.PROPERTY_MAC_ADDRESS, vm.mac().toColonDelimitedString());
50+
updateProperties(properties);
51+
super.initializeProperties(properties);
52+
}
53+
4354
@Override
4455
protected void internalPoll() throws FreeboxException {
4556
super.internalPoll();

‎bundles/org.openhab.binding.freeboxos/src/main/java/org/openhab/binding/freeboxos/internal/handler/WifiStationHandler.java

+10-2
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636
import org.slf4j.Logger;
3737
import org.slf4j.LoggerFactory;
3838

39+
import inet.ipaddr.mac.MACAddress;
40+
3941
/**
4042
* The {@link WifiStationHandler} is responsible for handling everything associated to
4143
* any Freebox thing types except the bridge thing type.
@@ -56,8 +58,14 @@ public WifiStationHandler(Thing thing) {
5658
protected void internalPoll() throws FreeboxException {
5759
super.internalPoll();
5860

61+
MACAddress mac = getMac();
62+
if (mac == null) {
63+
throw new FreeboxException(
64+
"internalPoll is not possible because MAC address is undefined for the thing " + thing.getUID());
65+
}
66+
5967
// Search if the wifi-host is hosted on server access-points
60-
Optional<Station> station = getManager(APManager.class).getStation(getMac());
68+
Optional<Station> station = getManager(APManager.class).getStation(mac);
6169
if (station.isPresent()) {
6270
Station data = station.get();
6371
updateChannelDateTimeState(CONNECTIVITY, LAST_SEEN, data.getLastSeen());
@@ -67,7 +75,7 @@ protected void internalPoll() throws FreeboxException {
6775
}
6876

6977
// Search if it is hosted by a repeater
70-
Optional<LanHost> wifiHost = getManager(RepeaterManager.class).getHost(getMac());
78+
Optional<LanHost> wifiHost = getManager(RepeaterManager.class).getHost(mac);
7179
if (wifiHost.isPresent()) {
7280
updateChannelDateTimeState(CONNECTIVITY, LAST_SEEN, wifiHost.get().getLastSeen());
7381
LanAccessPoint lanAp = wifiHost.get().accessPoint();

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/player-config.xml

-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55
xsi:schemaLocation="https://openhab.org/schemas/config-description/v1.0.0 https://openhab.org/schemas/config-description-1.0.0.xsd">
66

77
<config-description uri="thing-type:freeboxos:player">
8-
<parameter name="macAddress" type="text" required="true" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})">
9-
<label>MAC Address</label>
10-
<description>The MAC address of the player device</description>
11-
</parameter>
128
<parameter name="id" type="integer">
139
<label>ID</label>
1410
<description>Id of the player</description>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/repeater-config.xml

-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111
<description>The refresh interval in seconds which is used to poll the repeater</description>
1212
<default>30</default>
1313
</parameter>
14-
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">
15-
<label>MAC Address</label>
16-
<description>The MAC address of the network device</description>
17-
</parameter>
1814
<parameter name="id" type="integer" required="true">
1915
<label>ID</label>
2016
<description>Id of the repeater</description>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/server-config.xml

-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111
<description>The refresh interval in seconds which is used to poll given Freebox Server</description>
1212
<default>30</default>
1313
</parameter>
14-
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">
15-
<label>MAC Address</label>
16-
<description>The MAC address of the network device</description>
17-
</parameter>
1814
</config-description>
1915

2016
</config-description:config-descriptions>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/config/vm-config.xml

-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111
<description>The refresh interval in seconds which is used to poll given virtual machine</description>
1212
<default>30</default>
1313
</parameter>
14-
<parameter name="macAddress" type="text" pattern="([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" required="true">
15-
<label>MAC Address</label>
16-
<description>The MAC address of the network device</description>
17-
</parameter>
1814
<parameter name="id" type="integer" required="true">
1915
<label>ID</label>
2016
<description>Id of the Virtual Machine</description>

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/i18n/freeboxos.properties

-8
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,6 @@ thing-type.config.freeboxos.player.acceptAllMp3.label = Accept All MP3
9393
thing-type.config.freeboxos.player.acceptAllMp3.description = Accept any bitrate for MP3 audio or only bitrates greater than 64 kbps
9494
thing-type.config.freeboxos.player.id.label = ID
9595
thing-type.config.freeboxos.player.id.description = Id of the player
96-
thing-type.config.freeboxos.player.macAddress.label = MAC Address
97-
thing-type.config.freeboxos.player.macAddress.description = The MAC address of the player device
9896
thing-type.config.freeboxos.player.password.label = Password
9997
thing-type.config.freeboxos.player.password.description = AirPlay password
10098
thing-type.config.freeboxos.player.port.label = Player port
@@ -104,18 +102,12 @@ thing-type.config.freeboxos.player.remoteCode.label = Remote Code
104102
thing-type.config.freeboxos.player.remoteCode.description = Code associated to remote control
105103
thing-type.config.freeboxos.repeater.id.label = ID
106104
thing-type.config.freeboxos.repeater.id.description = Id of the repeater
107-
thing-type.config.freeboxos.repeater.macAddress.label = MAC Address
108-
thing-type.config.freeboxos.repeater.macAddress.description = The MAC address of the network device
109105
thing-type.config.freeboxos.repeater.refreshInterval.label = Refresh Interval
110106
thing-type.config.freeboxos.repeater.refreshInterval.description = The refresh interval in seconds which is used to poll the repeater
111-
thing-type.config.freeboxos.server.macAddress.label = MAC Address
112-
thing-type.config.freeboxos.server.macAddress.description = The MAC address of the network device
113107
thing-type.config.freeboxos.server.refreshInterval.label = Refresh Interval
114108
thing-type.config.freeboxos.server.refreshInterval.description = The refresh interval in seconds which is used to poll given Freebox Server
115109
thing-type.config.freeboxos.vm.id.label = ID
116110
thing-type.config.freeboxos.vm.id.description = Id of the Virtual Machine
117-
thing-type.config.freeboxos.vm.macAddress.label = MAC Address
118-
thing-type.config.freeboxos.vm.macAddress.description = The MAC address of the network device
119111
thing-type.config.freeboxos.vm.refreshInterval.label = Refresh Interval
120112
thing-type.config.freeboxos.vm.refreshInterval.description = The refresh interval in seconds which is used to poll given virtual machine
121113
thing-type.config.freeboxos.wifi-host.mDNS.label = mDNS Name

‎bundles/org.openhab.binding.freeboxos/src/main/resources/OH-INF/thing/server-thing-type.xml

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
<channel-group typeId="connection-status" id="connection-status"/>
2323
</channel-groups>
2424

25+
<representation-property>macAddress</representation-property>
26+
2527
<config-description-ref uri="thing-type:freeboxos:server"/>
2628
</thing-type>
2729

@@ -42,6 +44,8 @@
4244
<channel-group typeId="connection-status" id="connection-status"/>
4345
</channel-groups>
4446

47+
<representation-property>macAddress</representation-property>
48+
4549
<config-description-ref uri="thing-type:freeboxos:server"/>
4650
</thing-type>
4751

0 commit comments

Comments
 (0)