homebridge-ratgdo 2.3.0 → 2.3.2

package/README.md

@@ -14,7 +14,7 @@
 </DIV>
 </SPAN>
 
-`homebridge-ratgdo` is a [Homebridge](https://homebridge.io) plugin that makes Chamberlain, Liftmaster, and other garage door openers that utilize the Ratgdo hardware control board available to [Apple's](https://www.apple.com) [HomeKit](https://www.apple.com/ios/home) smart home platform. You can determine if your garage door opener by checking the [Ratgdo website](https://paulwieland.github.io/ratgdo/).
+`homebridge-ratgdo` is a [Homebridge](https://homebridge.io) plugin that makes Chamberlain, Liftmaster, and other garage door openers that utilize the [Ratgdo hardware control board](https://paulwieland.github.io/ratgdo/) and [commercial variants](https://konnected.io/products/smart-garage-door-opener-blaq-myq-alternative) to [Apple's](https://www.apple.com) [HomeKit](https://www.apple.com/ios/home) smart home platform. You can determine if your garage door opener by checking the [Ratgdo website](https://paulwieland.github.io/ratgdo/).
 
 ## Why use this plugin for Ratgdo support in HomeKit?
 In a nutshell, the aim of this plugin for things to *just work* with minimal required configuration by users. The goal is to provide as close to a streamlined experience as you would expect from a first-party or native HomeKit solution. For the adventurous, those additional granular options are, of course, available to support more esoteric use cases or other unique needs.
@@ -33,6 +33,7 @@ In the interest of the community seeking a solution outside of myQ, I've develop
   * Ability to lock and unlock the garage door opener through the ability to lockout wireless remotes.
   * Read-only garage door opener support.
   * Automation switch and dimmer support, allowing you to set the garage door to any position.
+  * Support for Ratgdo variants like [Konnected blaQ](https://konnected.io/products/smart-garage-door-opener-blaq-myq-alternative).
   * A rich webUI for configuration.
 
 ## Installation

package/dist/index.js

@@ -4,7 +4,7 @@
  */
 import { PLATFORM_NAME, PLUGIN_NAME } from "./settings.js";
 import { RatgdoPlatform } from "./ratgdo-platform.js";
-// Register our platform with homebridge.
+// Register our platform with Homebridge.
 export default (api) => {
     api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, RatgdoPlatform);
 };

package/dist/ratgdo-device.d.ts

@@ -1,6 +1,6 @@
 import { PlatformAccessory } from "homebridge";
-import { RatgdoDevice } from "./ratgdo-types.js";
 import { HomebridgePluginLogging } from "homebridge-plugin-utils";
+import { RatgdoDevice } from "./ratgdo-types.js";
 import { RatgdoPlatform } from "./ratgdo-platform.js";
 export declare class RatgdoAccessory {
     private readonly accessory;
@@ -38,7 +38,6 @@ export declare class RatgdoAccessory {
     private doorTargetStateBias;
     private lockTargetStateBias;
     private hasFeature;
-    private setServiceName;
     private get name();
     private get accessoryName();
     private set accessoryName(value);

package/dist/ratgdo-device.js

@@ -1,4 +1,5 @@
 import { FetchError, fetch } from "@adobe/fetch";
+import { acquireService, validService } from "homebridge-plugin-utils";
 import { RATGDO_MOTION_DURATION, RATGDO_OCCUPANCY_DURATION } from "./settings.js";
 import { RatgdoReservedNames, RatgdoVariant } from "./ratgdo-types.js";
 import util from "node:util";
@@ -161,136 +162,114 @@ export class RatgdoAccessory {
     }
     // Configure the garage door service for HomeKit.
     configureGarageDoor() {
-        let garageDoorService = this.accessory.getService(this.hap.Service.GarageDoorOpener);
-        // Add the garage door opener service to the accessory, if needed.
-        if (!garageDoorService) {
-            garageDoorService = new this.hap.Service.GarageDoorOpener(this.name);
-            garageDoorService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            this.accessory.addService(garageDoorService);
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.GarageDoorOpener, this.name);
+        if (!service) {
+            this.log.error("Unable to add the garage door.");
+            return false;
         }
         // Set the initial current and target door states to closed since ratgdo doesn't tell us initial state over MQTT on startup.
-        garageDoorService.updateCharacteristic(this.hap.Characteristic.CurrentDoorState, this.status.door);
-        garageDoorService.updateCharacteristic(this.hap.Characteristic.TargetDoorState, this.doorTargetStateBias(this.status.door));
+        service.updateCharacteristic(this.hap.Characteristic.CurrentDoorState, this.status.door);
+        service.updateCharacteristic(this.hap.Characteristic.TargetDoorState, this.doorTargetStateBias(this.status.door));
         // Handle HomeKit open and close events.
-        garageDoorService.getCharacteristic(this.hap.Characteristic.TargetDoorState).onSet((value) => {
+        service.getCharacteristic(this.hap.Characteristic.TargetDoorState).onSet((value) => {
             this.setDoorState(value);
         });
         // Inform HomeKit of our current state.
-        garageDoorService.getCharacteristic(this.hap.Characteristic.CurrentDoorState).onGet(() => this.status.door);
+        service.getCharacteristic(this.hap.Characteristic.CurrentDoorState).onGet(() => this.status.door);
         // Inform HomeKit of any obstructions.
-        garageDoorService.getCharacteristic(this.hap.Characteristic.ObstructionDetected).onGet(() => this.status.obstruction === true);
+        service.getCharacteristic(this.hap.Characteristic.ObstructionDetected).onGet(() => this.status.obstruction === true);
         // Configure the lock garage door lock current and target state characteristics.
-        garageDoorService.getCharacteristic(this.hap.Characteristic.LockTargetState).onSet(async (value) => {
+        service.getCharacteristic(this.hap.Characteristic.LockTargetState).onSet(async (value) => {
             if (!(await this.command("lock", (value === this.hap.Characteristic.LockTargetState.SECURED) ? "lock" : "unlock"))) {
                 // Something went wrong. Let's make sure we revert the lock to it's prior state.
                 setTimeout(() => {
-                    garageDoorService?.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.lockTargetStateBias(this.status.lock));
-                    garageDoorService?.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.status.lock);
+                    service?.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.lockTargetStateBias(this.status.lock));
+                    service?.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.status.lock);
                 }, 50);
             }
         });
-        garageDoorService.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.status.lock);
-        garageDoorService.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.lockTargetStateBias(this.status.lock));
-        garageDoorService.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => this.status.availability);
-        garageDoorService.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
+        service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.status.lock);
+        service.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.lockTargetStateBias(this.status.lock));
+        service.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => this.status.availability);
+        service.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
         // Let HomeKit know that this is the primary service on this accessory.
-        garageDoorService.setPrimaryService(true);
+        service.setPrimaryService(true);
         return true;
     }
     // Configure the light for HomeKit.
     configureLight() {
-        // Find the service, if it exists.
-        let lightService = this.accessory.getService(this.hap.Service.Lightbulb);
-        // Have we disabled the light?
-        if (!this.hints.light) {
-            if (lightService) {
-                this.accessory.removeService(lightService);
-                this.log.info("Disabling light.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.Lightbulb, () => {
+            // Have we disabled the light?
+            if (!this.hints.light) {
+                this.log.info("Disabling the light.");
+                return false;
             }
+            return true;
+        })) {
             return false;
         }
-        // Add the service to the accessory, if needed.
-        if (!lightService) {
-            lightService = new this.hap.Service.Lightbulb(this.name);
-            if (!lightService) {
-                this.log.error("Unable to add the light.");
-                return false;
-            }
-            lightService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            lightService.updateCharacteristic(this.hap.Characteristic.Name, this.name);
-            this.setServiceName(lightService, this.name);
-            this.accessory.addService(lightService);
-            this.log.info("Enabling light.");
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.Lightbulb, this.name, undefined, () => this.log.info("Enabling light."));
+        if (!service) {
+            this.log.error("Unable to add the light.");
+            return false;
         }
         // Initialize the light.
-        lightService.updateCharacteristic(this.hap.Characteristic.On, this.status.light);
+        service.updateCharacteristic(this.hap.Characteristic.On, this.status.light);
         // Turn the light on or off.
-        lightService.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => this.status.light);
-        lightService.getCharacteristic(this.hap.Characteristic.On)?.onSet((value) => {
-            void this.command("light", value === true ? "on" : "off");
-        });
+        service.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => this.status.light);
+        service.getCharacteristic(this.hap.Characteristic.On)?.onSet((value) => void this.command("light", value === true ? "on" : "off"));
         return true;
     }
     // Configure the motion sensor for HomeKit.
     configureMotionSensor() {
-        // Find the motion sensor service, if it exists.
-        let motionService = this.accessory.getService(this.hap.Service.MotionSensor);
-        // Have we disabled the motion sensor?
-        if (!this.hints.motionSensor) {
-            if (motionService) {
-                this.accessory.removeService(motionService);
-                this.log.info("Disabling motion sensor.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.MotionSensor, () => {
+            // Have we disabled the motion sensor?
+            if (!this.hints.motionSensor) {
+                this.log.info("Disabling the motion sensor.");
+                return false;
             }
+            return true;
+        })) {
             return false;
         }
-        // We don't have a motion sensor, let's add it to the device.
-        if (!motionService) {
-            // We don't have it, add the motion sensor to the device.
-            motionService = new this.hap.Service.MotionSensor(this.name);
-            if (!motionService) {
-                this.log.error("Unable to add the motion sensor.");
-                return false;
-            }
-            motionService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            motionService.updateCharacteristic(this.hap.Characteristic.Name, this.name);
-            this.setServiceName(motionService, this.name);
-            this.accessory.addService(motionService);
-            this.log.info("Enabling motion sensor.");
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.MotionSensor, this.name, undefined, () => this.log.info("Enabling motion sensor."));
+        if (!service) {
+            this.log.error("Unable to add the motion sensor.");
+            return false;
         }
         // Initialize the state of the motion sensor.
-        motionService.updateCharacteristic(this.hap.Characteristic.MotionDetected, false);
-        motionService.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
-        motionService.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => this.status.availability);
+        service.updateCharacteristic(this.hap.Characteristic.MotionDetected, false);
+        service.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
+        service.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => this.status.availability);
         return true;
     }
     // Configure a dimmer to automate open and close events in HomeKit beyond what HomeKit might allow for a garage opener service that gets treated as a secure service.
     configureAutomationDoorPositionDimmer() {
-        // Find the dimmer service, if it exists.
-        let dimmerService = this.accessory.getServiceById(this.hap.Service.Lightbulb, RatgdoReservedNames.DIMMER_OPENER_AUTOMATION);
-        // The switch is disabled by default and primarily exists for automation purposes.
-        if (!this.hints.automationDimmer) {
-            if (dimmerService) {
-                this.accessory.removeService(dimmerService);
-                this.log.info("Disabling automation door position dimmer.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.Lightbulb, () => {
+            // The door position dimmer is disabled by default and primarily exists for automation purposes.
+            if (!this.hints.automationDimmer) {
+                return false;
             }
+            return true;
+        }, RatgdoReservedNames.DIMMER_OPENER_AUTOMATION)) {
             return false;
         }
-        // Add the dimmer to the opener, if needed.
-        if (!dimmerService) {
-            dimmerService = new this.hap.Service.Lightbulb(this.name + " Automation Door Position", RatgdoReservedNames.DIMMER_OPENER_AUTOMATION);
-            if (!dimmerService) {
-                this.log.error("Unable to add automation door position dimmer.");
-                return false;
-            }
-            this.accessory.addService(dimmerService);
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.Lightbulb, this.name + " Automation Door Position", RatgdoReservedNames.DIMMER_OPENER_AUTOMATION);
+        if (!service) {
+            this.log.error("Unable to add the automation door position dimmer.");
+            return false;
         }
-        // Return the current state of the opener.
-        dimmerService.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => {
-            // We're on if we are in any state other than closed (specifically open or stopped).
-            return this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED;
-        });
+        // Return the current state of the opener. We're on if we are in any state other than closed (specifically open or stopped).
+        service.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED);
         // Close the opener. Opening is really handled in the brightness event.
-        dimmerService.getCharacteristic(this.hap.Characteristic.On)?.onSet((value) => {
+        service.getCharacteristic(this.hap.Characteristic.On)?.onSet((value) => {
             // We really only want to act when the opener is open. Otherwise, it's handled by the brightness event.
             if (value) {
                 return;
@@ -302,60 +281,47 @@ export class RatgdoAccessory {
             // Send the command.
             if (!this.setDoorState(this.hap.Characteristic.TargetDoorState.CLOSED)) {
                 // Something went wrong. Let's make sure we revert the dimmer to it's prior state.
-                setTimeout(() => {
-                    dimmerService?.updateCharacteristic(this.hap.Characteristic.On, !value);
-                }, 50);
+                setTimeout(() => service?.updateCharacteristic(this.hap.Characteristic.On, !value), 50);
             }
         });
         // Return the door position of the opener.
-        dimmerService.getCharacteristic(this.hap.Characteristic.Brightness)?.onGet(() => {
-            return this.status.doorPosition;
-        });
+        service.getCharacteristic(this.hap.Characteristic.Brightness)?.onGet(() => this.status.doorPosition);
         // Adjust the door position of the opener by adjusting brightness of the light.
-        dimmerService.getCharacteristic(this.hap.Characteristic.Brightness)?.onSet((value) => {
+        service.getCharacteristic(this.hap.Characteristic.Brightness)?.onSet((value) => {
             if (this.hints.logOpener) {
                 this.log.info("Automation door position dimmer: moving opener to %s%.", value.toFixed(0));
             }
             this.setDoorState(value > 0 ?
                 this.hap.Characteristic.TargetDoorState.OPEN : this.hap.Characteristic.TargetDoorState.CLOSED, value);
         });
-        // Initialize the switch.
-        dimmerService.displayName = this.name + " Automation Door Position";
-        dimmerService.updateCharacteristic(this.hap.Characteristic.Name, this.name + " Automation Door Position");
-        dimmerService.updateCharacteristic(this.hap.Characteristic.On, this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED);
-        dimmerService.updateCharacteristic(this.hap.Characteristic.Brightness, this.status.doorPosition);
-        this.log.info("Enabling automation door position dimmer.");
+        // Initialize the dimmer.
+        service.updateCharacteristic(this.hap.Characteristic.On, this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED);
+        service.updateCharacteristic(this.hap.Characteristic.Brightness, this.status.doorPosition);
+        this.log.info("Enabling the automation door position dimmer.");
         return true;
     }
     // Configure a switch to automate open and close events in HomeKit beyond what HomeKit might allow for a garage opener service that gets treated as a secure service.
     configureAutomationDoorSwitch() {
-        // Find the switch service, if it exists.
-        let switchService = this.accessory.getServiceById(this.hap.Service.Switch, RatgdoReservedNames.SWITCH_OPENER_AUTOMATION);
-        // The switch is disabled by default and primarily exists for automation purposes.
-        if (!this.hints.automationSwitch) {
-            if (switchService) {
-                this.accessory.removeService(switchService);
-                this.log.info("Disabling automation door opener switch.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.Switch, () => {
+            // Have we disabled the automation switch?
+            if (!this.hints.automationSwitch) {
+                return false;
             }
+            return true;
+        }, RatgdoReservedNames.SWITCH_OPENER_AUTOMATION)) {
             return false;
         }
-        // Add the switch to the opener, if needed.
-        if (!switchService) {
-            switchService = new this.hap.Service.Switch(this.name + " Automation Opener", RatgdoReservedNames.SWITCH_OPENER_AUTOMATION);
-            if (!switchService) {
-                this.log.error("Unable to add automation door opener switch.");
-                return false;
-            }
-            switchService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            this.accessory.addService(switchService);
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.Switch, this.name + " Automation Opener", RatgdoReservedNames.SWITCH_OPENER_AUTOMATION);
+        if (!service) {
+            this.log.error("Unable to add the automation door opener switch.");
+            return false;
         }
-        // Return the current state of the opener.
-        switchService.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => {
-            // We're on if we are in any state other than closed (specifically open or stopped).
-            return this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED;
-        });
+        // Return the current state of the opener. We're on if we are in any state other than closed (specifically open or stopped).
+        service.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED);
         // Open or close the opener.
-        switchService.getCharacteristic(this.hap.Characteristic.On)?.onSet((value) => {
+        service.getCharacteristic(this.hap.Characteristic.On)?.onSet((value) => {
             // Inform the user.
             if (this.hints.logOpener) {
                 this.log.info("Automation door opener switch: %s.", value ? "open" : "close");
@@ -363,128 +329,97 @@ export class RatgdoAccessory {
             // Send the command.
             if (!this.setDoorState(value ? this.hap.Characteristic.TargetDoorState.OPEN : this.hap.Characteristic.TargetDoorState.CLOSED)) {
                 // Something went wrong. Let's make sure we revert the switch to it's prior state.
-                setTimeout(() => {
-                    switchService?.updateCharacteristic(this.hap.Characteristic.On, !value);
-                }, 50);
+                setTimeout(() => service?.updateCharacteristic(this.hap.Characteristic.On, !value), 50);
             }
         });
         // Initialize the switch.
-        switchService.updateCharacteristic(this.hap.Characteristic.Name, this.name + " Automation Opener");
-        this.setServiceName(switchService, this.name + " Automation Opener");
-        switchService.updateCharacteristic(this.hap.Characteristic.On, this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED);
-        this.log.info("Enabling automation door opener switch.");
+        service.updateCharacteristic(this.hap.Characteristic.On, this.doorCurrentStateBias(this.status.door) !== this.hap.Characteristic.CurrentDoorState.CLOSED);
+        this.log.info("Enabling the automation door opener switch.");
         return true;
     }
     // Configure a switch to control the ability to lockout all wireless remotes for the garage door opener, if the feature exists.
     configureAutomationLockoutSwitch() {
-        // Find the switch service, if it exists.
-        let switchService = this.accessory.getServiceById(this.hap.Service.Switch, RatgdoReservedNames.SWITCH_LOCKOUT);
-        // The switch is disabled by default and primarily exists for automation purposes.
-        if (!this.hints.lockoutSwitch) {
-            if (switchService) {
-                this.accessory.removeService(switchService);
-                this.log.info("Disabling automation wireless remote lockout switch.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.Switch, () => {
+            // The wireless lockout switch is disabled by default and primarily exists for automation purposes.
+            if (!this.hints.lockoutSwitch) {
+                return false;
             }
+            return true;
+        }, RatgdoReservedNames.SWITCH_LOCKOUT)) {
             return false;
         }
-        // Add the switch to the opener, if needed.
-        if (!switchService) {
-            switchService = new this.hap.Service.Switch(this.name + " Lockout", RatgdoReservedNames.SWITCH_LOCKOUT);
-            if (!switchService) {
-                this.log.error("Unable to add automation wireless remote lockout switch.");
-                return false;
-            }
-            switchService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            this.accessory.addService(switchService);
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.Switch, this.name + " Lockout", RatgdoReservedNames.SWITCH_LOCKOUT);
+        if (!service) {
+            this.log.error("Unable to add the automation wireless remote lockout switch.");
+            return false;
         }
-        // Return the current state of the opener.
-        switchService.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => {
-            // We're on if we are in any state other than locked.
-            return this.status.lock === this.hap.Characteristic.LockCurrentState.SECURED;
-        });
-        // Open or close the opener.
-        switchService.getCharacteristic(this.hap.Characteristic.On)?.onSet(async (value) => {
+        // Return the current state of the opener. We're on if we are in any state other than locked.
+        service.getCharacteristic(this.hap.Characteristic.On)?.onGet(() => this.status.lock === this.hap.Characteristic.LockCurrentState.SECURED);
+        // Lock or unlock the wireless remotes.
+        service.getCharacteristic(this.hap.Characteristic.On)?.onSet(async (value) => {
             // Inform the user.
             this.log.info("Automation wireless remote lockout switch: remotes are %s.", value ? "locked out" : "permitted");
             // Send the command.
             if (!(await this.command("lock", value ? "lock" : "unlock"))) {
                 // Something went wrong. Let's make sure we revert the switch to it's prior state.
-                setTimeout(() => {
-                    switchService?.updateCharacteristic(this.hap.Characteristic.On, !value);
-                }, 50);
+                setTimeout(() => service?.updateCharacteristic(this.hap.Characteristic.On, !value), 50);
             }
         });
         // Initialize the switch.
-        switchService.updateCharacteristic(this.hap.Characteristic.Name, this.name + " Lockout");
-        this.setServiceName(switchService, this.name + " Lockout");
-        switchService.updateCharacteristic(this.hap.Characteristic.On, this.status.lock === this.hap.Characteristic.LockCurrentState.SECURED);
-        this.log.info("Enabling automation wireless remote lockout switch.");
+        service.updateCharacteristic(this.hap.Characteristic.On, this.status.lock === this.hap.Characteristic.LockCurrentState.SECURED);
+        this.log.info("Enabling the automation wireless remote lockout switch.");
         return true;
     }
     // Configure the door open occupancy sensor for HomeKit.
     configureDoorOpenOccupancySensor() {
-        // Find the occupancy sensor service, if it exists.
-        let occupancyService = this.accessory.getServiceById(this.hap.Service.OccupancySensor, RatgdoReservedNames.OCCUPANCY_SENSOR_DOOR_OPEN);
-        // The occupancy sensor is disabled by default and primarily exists for automation purposes.
-        if (!this.hints.doorOpenOccupancySensor) {
-            if (occupancyService) {
-                this.accessory.removeService(occupancyService);
-                this.log.info("Disabling door open indicator occupancy sensor.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.OccupancySensor, () => {
+            // The occupancy sensor is disabled by default and primarily exists for automation purposes.
+            if (!this.hints.doorOpenOccupancySensor) {
+                return false;
             }
+            return true;
+        }, RatgdoReservedNames.OCCUPANCY_SENSOR_DOOR_OPEN)) {
             return false;
         }
-        // We don't have an occupancy sensor, let's add it to the device.
-        if (!occupancyService) {
-            // We don't have it, add the occupancy sensor to the device.
-            occupancyService = new this.hap.Service.OccupancySensor(this.name + " Open", RatgdoReservedNames.OCCUPANCY_SENSOR_DOOR_OPEN);
-            if (!occupancyService) {
-                this.log.error("Unable to add door open occupancy sensor.");
-                return false;
-            }
-            occupancyService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            this.setServiceName(occupancyService, this.name + " Open");
-            this.accessory.addService(occupancyService);
-        }
-        // Initialize the state of the occupancy sensor.
-        occupancyService.updateCharacteristic(this.hap.Characteristic.OccupancyDetected, false);
-        occupancyService.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
-        occupancyService.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => {
-            return this.status.availability;
-        });
-        this.log.info("Enabling door open indicator occupancy sensor. Occupancy will be triggered when the opener has been continuously open for more than %s seconds.", this.hints.doorOpenOccupancyDuration);
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.OccupancySensor, this.name + " Open", RatgdoReservedNames.OCCUPANCY_SENSOR_DOOR_OPEN);
+        if (!service) {
+            this.log.error("Unable to add the door open occupancy sensor.");
+            return false;
+        }
+        // Initialize the occupancy sensor.
+        service.updateCharacteristic(this.hap.Characteristic.OccupancyDetected, false);
+        service.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
+        service.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => this.status.availability);
+        this.log.info("Enabling the door open indicator occupancy sensor. Occupancy will be triggered when the opener has been continuously open for more than %s seconds.", this.hints.doorOpenOccupancyDuration);
         return true;
     }
     // Configure the motion occupancy sensor for HomeKit.
     configureMotionOccupancySensor() {
-        // Find the occupancy sensor service, if it exists.
-        let occupancyService = this.accessory.getServiceById(this.hap.Service.OccupancySensor, RatgdoReservedNames.OCCUPANCY_SENSOR_MOTION);
-        // The occupancy sensor is disabled by default and primarily exists for automation purposes.
-        if (!this.hints.motionOccupancySensor) {
-            if (occupancyService) {
-                this.accessory.removeService(occupancyService);
-                this.log.info("Disabling occupancy sensor.");
+        // Validate whether we should have this service enabled.
+        if (!validService(this.accessory, this.hap.Service.OccupancySensor, () => {
+            // The occupancy sensor is disabled by default and primarily exists for automation purposes.
+            if (!this.hints.motionOccupancySensor) {
+                return false;
             }
+            return true;
+        }, RatgdoReservedNames.OCCUPANCY_SENSOR_MOTION)) {
             return false;
         }
-        // We don't have an occupancy sensor, let's add it to the device.
-        if (!occupancyService) {
-            // We don't have it, add the occupancy sensor to the device.
-            occupancyService = new this.hap.Service.OccupancySensor(this.name, RatgdoReservedNames.OCCUPANCY_SENSOR_MOTION);
-            if (!occupancyService) {
-                this.log.error("Unable to add occupancy sensor.");
-                return false;
-            }
-            occupancyService.addOptionalCharacteristic(this.hap.Characteristic.ConfiguredName);
-            this.setServiceName(occupancyService, this.name);
-            this.accessory.addService(occupancyService);
-        }
-        // Initialize the state of the occupancy sensor.
-        occupancyService.updateCharacteristic(this.hap.Characteristic.OccupancyDetected, false);
-        occupancyService.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
-        occupancyService.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => {
-            return this.status.availability;
-        });
-        this.log.info("Enabling occupancy sensor. Occupancy event duration set to %s seconds.", this.hints.motionOccupancyDuration);
+        // Acquire the service.
+        const service = acquireService(this.hap, this.accessory, this.hap.Service.OccupancySensor, this.name, RatgdoReservedNames.OCCUPANCY_SENSOR_MOTION);
+        if (!service) {
+            this.log.error("Unable to add the occupancy sensor.");
+            return false;
+        }
+        // Initialize the occupancy sensor.
+        service.updateCharacteristic(this.hap.Characteristic.OccupancyDetected, false);
+        service.updateCharacteristic(this.hap.Characteristic.StatusActive, this.status.availability);
+        service.getCharacteristic(this.hap.Characteristic.StatusActive).onGet(() => this.status.availability);
+        this.log.info("Enabling the occupancy sensor. Occupancy event duration set to %s seconds.", this.hints.motionOccupancyDuration);
         return true;
     }
     // Open or close the garage door.
@@ -884,14 +819,6 @@ export class RatgdoAccessory {
     hasFeature(option) {
         return this.platform.featureOptions.test(option, this.device.mac);
     }
-    // Utility function to set the name of a service.
-    setServiceName(service, name) {
-        if (!service) {
-            return;
-        }
-        service.displayName = name;
-        service.updateCharacteristic(this.hap.Characteristic.ConfiguredName, name);
-    }
     // Utility function to return the name of this device.
     get name() {
         // We use the garage door service as the natural proxy for the name.