Skip to content

Commit

Permalink
[homekit] delay starting until a particular StartLevel (openhab#13877)
Browse files Browse the repository at this point in the history 
* [homekit] delay starting until a particular StartLevel

instead of a blind "delay by seconds", the new default won't even
attempt to start until items are loaded (both file-based and UI-based),
with an additional config to let the user delay it any further (in
case they have items coming from JSR223 scripts that can't run until
at least SL20 anyway).

Signed-off-by: Cody Cutrer <cody@cutrer.us>
Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>
  • Loading branch information
@ccutrer @andrasU
ccutrer authored and andrasU committed Jan 5, 2024
1 parent 8ca8e2e commit 5a12fc3
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 50 deletions.
31 changes: 15 additions & 16 deletions bundles/org.openhab.io.homekit/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,22 +105,21 @@ Some settings are only visible in UI if the checkbox "Show advanced" is activate

### Overview of all settings

| Setting | Description | Default value |
|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|
| networkInterface | IP address or domain name under which the HomeKit bridge can be reached. If no value is configured, the add-on uses the primary IP address configured for openHAB. If unsure, keep it empty | (none) |
| port | Port under which the HomeKit bridge can be reached. | 9123 |
| useOHmDNS | mDNS service is used to advertise openHAB as HomeKit bridge in the network so that HomeKit clients can find it. openHAB has already mDNS service running. This option defines whether the mDNS service of openHAB or a separate service should be used. | false |
| blockUserDeletion | Blocks HomeKit user deletion in openHAB and as result unpairing of devices. If you experience an issue with accessories becoming non-responsive after some time, try to enable this setting. You can also enable this setting if your HomeKit setup is done and you will not re-pair ios devices. | false |
| pin | Pin code used for pairing with iOS devices. Apparently, pin codes are provided by Apple and represent specific device types, so they cannot be chosen freely. The pin code 031-45-154 is used in sample applications and known to work. | 031-45-154 |
| startDelay | HomeKit start delay in seconds in case the number of accessories is lower than last time. This helps to avoid resetting home app in case not all items have been initialised properly before HomeKit integration start. Ignored if `useDummyAccessories` is on. | 30 |
| useFahrenheitTemperature | Set to true to use Fahrenheit degrees, or false to use Celsius degrees. Note if an item has a QuantityType as its state, this configuration is ignored and it's always converted properly. | false |
| thermostatTargetModeCool | Word used for activating the cooling mode of the device (if applicable). It can be overwritten at item level. | CoolOn |
| thermostatTargetModeHeat | Word used for activating the heating mode of the device (if applicable). It can be overwritten at item level. | HeatOn |
| thermostatTargetModeAuto | Word used for activating the automatic mode of the device (if applicable). It can be overwritten at item level. | Auto |
| thermostatTargetModeOff | Word used to set the thermostat mode of the device to off (if applicable). It can be overwritten at item level. | Off |
| name | Name under which this HomeKit bridge is announced on the network. This is also the name displayed on the iOS device when searching for available bridges. | openHAB |
| instances | Defines how many bridges to expose. Necessary if you have more than 149 accessories. Accessories must be assigned to additional instances via metadata. Additional bridges will use incrementing port numbers. | 1 |
| useDummyAccessories | When an accessory is missing, substitute a dummy in its place instead of removing it. See [Dummy Accessories](#dummy-accessories). | false |
| Setting | Description | Default value |
|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------|
| networkInterface | IP address or domain name under which the HomeKit bridge can be reached. If no value is configured, the add-on uses the primary IP address configured for openHAB. If unsure, keep it empty | (none) |
| port | Port under which the HomeKit bridge can be reached. | 9123 |
| useOHmDNS | mDNS service is used to advertise openHAB as HomeKit bridge in the network so that HomeKit clients can find it. openHAB has already mDNS service running. This option defines whether the mDNS service of openHAB or a separate service should be used. | false |
| blockUserDeletion | Blocks HomeKit user deletion in openHAB and as result unpairing of devices. If you experience an issue with accessories becoming non-responsive after some time, try to enable this setting. You can also enable this setting if your HomeKit setup is done and you will not re-pair ios devices. | false |
| pin | Pin code used for pairing with iOS devices. Apparently, pin codes are provided by Apple and represent specific device types, so they cannot be chosen freely. The pin code 031-45-154 is used in sample applications and known to work. | 031-45-154 |
| useFahrenheitTemperature | Set to true to use Fahrenheit degrees, or false to use Celsius degrees. Note if an item has a QuantityType as its state, this configuration is ignored and it's always converted properly. | false |
| thermostatTargetModeCool | Word used for activating the cooling mode of the device (if applicable). It can be overwritten at item level. | CoolOn |
| thermostatTargetModeHeat | Word used for activating the heating mode of the device (if applicable). It can be overwritten at item level. | HeatOn |
| thermostatTargetModeAuto | Word used for activating the automatic mode of the device (if applicable). It can be overwritten at item level. | Auto |
| thermostatTargetModeOff | Word used to set the thermostat mode of the device to off (if applicable). It can be overwritten at item level. | Off |
| name | Name under which this HomeKit bridge is announced on the network. This is also the name displayed on the iOS device when searching for available bridges. | openHAB |
| instances | Defines how many bridges to expose. Necessary if you have more than 149 accessories. Accessories must be assigned to additional instances via metadata. Additional bridges will use incrementing port numbers. | 1 |
| useDummyAccessories | When an accessory is missing, substitute a dummy in its place instead of removing it. See [Dummy Accessories](#dummy-accessories). | false |

## Item Configuration

Expand Down
73 changes: 48 additions & 25 deletions ...les/org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/HomekitImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
import java.util.List;
import java.util.Map;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

import javax.jmdns.JmDNS;

Expand All @@ -37,6 +36,10 @@
import org.openhab.core.net.CidrAddress;
import org.openhab.core.net.NetworkAddressChangeListener;
import org.openhab.core.net.NetworkAddressService;
import org.openhab.core.service.ReadyMarker;
import org.openhab.core.service.ReadyMarkerFilter;
import org.openhab.core.service.ReadyService;
import org.openhab.core.service.StartLevelService;
import org.openhab.core.storage.Storage;
import org.openhab.core.storage.StorageService;
import org.openhab.io.homekit.Homekit;
Expand Down Expand Up @@ -66,21 +69,23 @@
Constants.SERVICE_PID + "=org.openhab.homekit", "port:Integer=9123" })
@ConfigurableService(category = "io", label = "HomeKit Integration", description_uri = "io:homekit")
@NonNullByDefault
public class HomekitImpl implements Homekit, NetworkAddressChangeListener {
public class HomekitImpl implements Homekit, NetworkAddressChangeListener, ReadyService.ReadyTracker {
private final Logger logger = LoggerFactory.getLogger(HomekitImpl.class);

private final StorageService storageService;
private final NetworkAddressService networkAddressService;
private final ConfigurationAdmin configAdmin;
private final ItemRegistry itemRegistry;
private final MetadataRegistry metadataRegistry;
private final ReadyService readyService;

private final List<HomekitAuthInfoImpl> authInfos = new ArrayList<>();
private HomekitSettings settings;
private @Nullable InetAddress networkInterface;
private final List<HomekitServer> homekitServers = new ArrayList<>();
private final List<HomekitRoot> bridges = new ArrayList<>();
private MDNSClient mdnsClient;
private int currentStartLevel = 0;

private final List<HomekitChangeListener> changeListeners = new ArrayList<>();

Expand All @@ -90,7 +95,8 @@ public class HomekitImpl implements Homekit, NetworkAddressChangeListener {
@Activate
public HomekitImpl(@Reference StorageService storageService, @Reference ItemRegistry itemRegistry,
@Reference NetworkAddressService networkAddressService, @Reference MetadataRegistry metadataRegistry,
@Reference ConfigurationAdmin configAdmin, @Reference MDNSClient mdnsClient, Map<String, Object> properties)
@Reference ConfigurationAdmin configAdmin, @Reference MDNSClient mdnsClient,
@Reference ReadyService readyService, Map<String, Object> properties)
throws IOException, InvalidAlgorithmParameterException {
this.storageService = storageService;
this.networkAddressService = networkAddressService;
Expand All @@ -99,13 +105,9 @@ public HomekitImpl(@Reference StorageService storageService, @Reference ItemRegi
this.mdnsClient = mdnsClient;
this.itemRegistry = itemRegistry;
this.metadataRegistry = metadataRegistry;
this.readyService = readyService;
networkAddressService.addNetworkAddressChangeListener(this);
try {
startHomekitServer();
} catch (IOException | InvalidAlgorithmParameterException e) {
logger.warn("cannot activate HomeKit binding. {}", e.getMessage());
throw e;
}
readyService.registerTracker(this, new ReadyMarkerFilter().withType(StartLevelService.STARTLEVEL_MARKER_TYPE));
}

private HomekitSettings processConfig(Map<String, Object> properties) {
Expand Down Expand Up @@ -160,7 +162,9 @@ protected synchronized void modified(Map<String, Object> config) {
|| oldSettings.instances != settings.instances) {
// the HomeKit server settings changed. we do a complete re-init
stopHomekitServer();
startHomekitServer();
if (currentStartLevel >= StartLevelService.STARTLEVEL_STATES) {
startHomekitServer();
}
} else {
for (HomekitChangeListener changeListener : changeListeners) {
changeListener.updateSettings(settings);
Expand All @@ -171,6 +175,36 @@ protected synchronized void modified(Map<String, Object> config) {
}
}

@Override
public synchronized void onReadyMarkerAdded(ReadyMarker readyMarker) {
int newLevel = Integer.parseInt(readyMarker.getIdentifier());
currentStartLevel = newLevel;

if (newLevel >= StartLevelService.STARTLEVEL_STATES) {
try {
startHomekitServer();
} catch (IOException | InvalidAlgorithmParameterException e) {
logger.warn("could not initialize HomeKit bridge: {}", e.getMessage());
}
}
}

@Override
@SuppressWarnings("PMD.EmptyWhileStmt")
public synchronized void onReadyMarkerRemoved(ReadyMarker readyMarker) {
int newLevel = Integer.parseInt(readyMarker.getIdentifier());

if (currentStartLevel > newLevel) {
while (newLevel-- > 0 && !readyService
.isReady(new ReadyMarker(StartLevelService.STARTLEVEL_MARKER_TYPE, Integer.toString(newLevel)))) {
}
currentStartLevel = newLevel;
if (currentStartLevel < StartLevelService.STARTLEVEL_STATES) {
stopHomekitServer();
}
}
}

private HomekitRoot startBridge(HomekitServer homekitServer, HomekitAuthInfoImpl authInfo,
HomekitChangeListener changeListener, int instance) throws IOException {
String name = settings.name;
Expand All @@ -187,21 +221,7 @@ private HomekitRoot startBridge(HomekitServer homekitServer, HomekitAuthInfoImpl

final int lastAccessoryCount = changeListener.getLastAccessoryCount();
int currentAccessoryCount = changeListener.getAccessories().size();
if (!settings.useDummyAccessories && currentAccessoryCount < lastAccessoryCount) {
logger.debug(
"it looks like not all items were initialized yet. Old configuration had {} accessories, the current one has only {} accessories. Delay HomeKit bridge start for {} seconds.",
lastAccessoryCount, currentAccessoryCount, settings.startDelay);
scheduler.schedule(() -> {
if (currentAccessoryCount < lastAccessoryCount) {
// the number of items is still different, maybe it is desired.
// make new configuration revision.
changeListener.makeNewConfigurationRevision();
}
bridge.start();
}, settings.startDelay, TimeUnit.SECONDS);
} else { // start bridge immediately.
bridge.start();
}
bridge.start();
return bridge;
}

Expand Down Expand Up @@ -319,6 +339,9 @@ public void pruneDummyAccessories() {
@Override
public synchronized void onChanged(final List<CidrAddress> added, final List<CidrAddress> removed) {
logger.trace("HomeKit bridge reacting on network interface changes.");
if (currentStartLevel < StartLevelService.STARTLEVEL_STATES) {
return;
}
removed.forEach(i -> {
logger.trace("removed interface {}", i.getAddress().toString());
if (i.getAddress().equals(networkInterface)) {
Expand Down
1 change: 0 additions & 1 deletion ...org.openhab.io.homekit/src/main/java/org/openhab/io/homekit/internal/HomekitSettings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ public class HomekitSettings {
public String pin = "031-45-154";
public String setupId;
public String qrCode;
public int startDelay = 30;
public boolean useDummyAccessories = false;
public boolean useFahrenheitTemperature = false;
public boolean useOHmDNS = false;
Expand Down
6 changes: 0 additions & 6 deletions bundles/org.openhab.io.homekit/src/main/resources/OH-INF/config/config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@
<description>Defines the IP address of the network interface to expose the HomeKit integration on.</description>
<advanced>true</advanced>
</parameter>
<parameter name="startDelay" type="integer" required="true" groupName="core" unit="s">
<label>Start Delay</label>
<description>HomeKit start delay in case of item configuration differences.</description>
<default>30</default>
<advanced>true</advanced>
</parameter>
<parameter name="useDummyAccessories" type="boolean" required="true" groupName="core">
<label>Use Dummy Accessories</label>
<description><![CDATA[Create dummy accessories when an item is missing. See <a href="https://www.openhab.org/addons/integrations/homekit/#dummy-accessories">the documentation</a> for more information.
Expand Down
Loading

0 comments on commit 5a12fc3

Please sign in to comment.