hap-nodejs 0.9.8-beta.0 → 0.10.0-beta.10

package/dist/lib/Accessory.js

@@ -21,7 +21,7 @@ var clone_1 = require("./util/clone");
 var request_util_1 = require("./util/request-util");
 var uuid = (0, tslib_1.__importStar)(require("./util/uuid"));
 var uuid_1 = require("./util/uuid");
-var debug = (0, debug_1.default)('HAP-NodeJS:Accessory');
+var debug = (0, debug_1.default)("HAP-NodeJS:Accessory");
 var MAX_ACCESSORIES = 149; // Maximum number of bridged accessories per bridge.
 var MAX_SERVICES = 100;
 // Known category values. Category is a hint to iOS clients about what "type" of Accessory this represents, for UI only.
@@ -87,6 +87,10 @@ var MDNSAdvertiser;
      * Use the `bonjour-hap` module as advertiser.
      */
     MDNSAdvertiser["BONJOUR"] = "bonjour-hap";
+    /**
+     * Use Avahi/D-Bus as advertiser.
+     */
+    MDNSAdvertiser["AVAHI"] = "avahi";
 })(MDNSAdvertiser = exports.MDNSAdvertiser || (exports.MDNSAdvertiser = {}));
 var WriteRequestState;
 (function (WriteRequestState) {
@@ -171,32 +175,14 @@ var Accessory = /** @class */ (function (_super) {
         _this.getPrimaryAccessory = function () {
             return _this.bridged ? _this.bridge : _this;
         };
-        _this.disableUnusedIDPurge = function () {
-            _this.shouldPurgeUnusedIDs = false;
-        };
-        _this.enableUnusedIDPurge = function () {
-            _this.shouldPurgeUnusedIDs = true;
-        };
-        /**
-         * Manually purge the unused ids if you like, comes handy
-         * when you have disabled auto purge so you can do it manually
-         */
-        _this.purgeUnusedIDs = function () {
-            //Cache the state of the purge mechanism and set it to true
-            var oldValue = _this.shouldPurgeUnusedIDs;
-            _this.shouldPurgeUnusedIDs = true;
-            //Reassign all ids
-            _this._assignIDs(_this._identifierCache);
-            //Revert back the purge mechanism state
-            _this.shouldPurgeUnusedIDs = oldValue;
-        };
         (0, assert_1.default)(displayName, "Accessories must be created with a non-empty displayName.");
         (0, assert_1.default)(UUID, "Accessories must be created with a valid UUID.");
-        (0, assert_1.default)(uuid.isValid(UUID), "UUID '" + UUID + "' is not a valid UUID. Try using the provided 'generateUUID' function to create a valid UUID from any arbitrary string, like a serial number.");
+        (0, assert_1.default)(uuid.isValid(UUID), "UUID '" + UUID + "' is not a valid UUID. Try using the provided 'generateUUID' function to create a " +
+            "valid UUID from any arbitrary string, like a serial number.");
         // create our initial "Accessory Information" Service that all Accessories are expected to have
         _this.addService(Service_1.Service.AccessoryInformation)
             .setCharacteristic(Characteristic_1.Characteristic.Name, displayName);
-        // sign up for when iOS attempts to "set" the Identify characteristic - this means a paired device wishes
+        // sign up for when iOS attempts to "set" the `Identify` characteristic - this means a paired device wishes
         // for us to identify ourselves (as opposed to an unpaired device - that case is handled by HAPServer 'identify' event)
         _this.getService(Service_1.Service.AccessoryInformation)
             .getCharacteristic(Characteristic_1.Characteristic.Identify)
@@ -220,6 +206,7 @@ var Accessory = /** @class */ (function (_super) {
             callback();
         }
     };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     Accessory.prototype.addService = function (serviceParam) {
         var e_1, _a;
         var constructorArgs = [];
@@ -228,7 +215,7 @@ var Accessory = /** @class */ (function (_super) {
         }
         // service might be a constructor like `Service.AccessoryInformation` instead of an instance
         // of Service. Coerce if necessary.
-        var service = typeof serviceParam === 'function'
+        var service = typeof serviceParam === "function"
             ? new serviceParam(constructorArgs[0], constructorArgs[1], constructorArgs[2])
             : serviceParam;
         try {
@@ -237,10 +224,14 @@ var Accessory = /** @class */ (function (_super) {
                 var existing = _c.value;
                 if (existing.UUID === service.UUID) {
                     // OK we have two Services with the same UUID. Check that each defines a `subtype` property and that each is unique.
-                    if (!service.subtype)
-                        throw new Error("Cannot add a Service with the same UUID '" + existing.UUID + "' as another Service in this Accessory without also defining a unique 'subtype' property.");
-                    if (service.subtype === existing.subtype)
-                        throw new Error("Cannot add a Service with the same UUID '" + existing.UUID + "' and subtype '" + existing.subtype + "' as another Service in this Accessory.");
+                    if (!service.subtype) {
+                        throw new Error("Cannot add a Service with the same UUID '" + existing.UUID +
+                            "' as another Service in this Accessory without also defining a unique 'subtype' property.");
+                    }
+                    if (service.subtype === existing.subtype) {
+                        throw new Error("Cannot add a Service with the same UUID '" + existing.UUID +
+                            "' and subtype '" + existing.subtype + "' as another Service in this Accessory.");
+                    }
                 }
             }
         }
@@ -314,11 +305,11 @@ var Accessory = /** @class */ (function (_super) {
         try {
             for (var _b = (0, tslib_1.__values)(this.services), _c = _b.next(); !_c.done; _c = _b.next()) {
                 var service = _c.value;
-                if (typeof name === 'string' && (service.displayName === name || service.name === name || service.subtype === name)) {
+                if (typeof name === "string" && (service.displayName === name || service.name === name || service.subtype === name)) {
                     return service;
-                    // @ts-expect-error
+                    // @ts-expect-error: UUID property
                 }
-                else if (typeof name === 'function' && ((service instanceof name) || (name.UUID === service.UUID))) {
+                else if (typeof name === "function" && ((service instanceof name) || (name.UUID === service.UUID))) {
                     return service;
                 }
             }
@@ -339,7 +330,7 @@ var Accessory = /** @class */ (function (_super) {
                 var service = _c.value;
                 if (typeof uuid === "string" && (service.displayName === uuid || service.name === uuid) && service.subtype === subType) {
                     return service;
-                    // @ts-expect-error
+                    // @ts-expect-error: UUID property
                 }
                 else if (typeof uuid === "function" && ((service instanceof uuid) || (uuid.UUID === service.UUID)) && service.subtype === subType) {
                     return service;
@@ -359,10 +350,11 @@ var Accessory = /** @class */ (function (_super) {
      * @deprecated Not supported anymore
      */
     Accessory.prototype.updateReachability = function (reachable) {
-        if (!this.bridged)
+        if (!this.bridged) {
             throw new Error("Cannot update reachability on non-bridged accessory!");
+        }
         this.reachable = reachable;
-        debug('Reachability update is no longer being supported.');
+        debug("Reachability update is no longer being supported.");
     };
     Accessory.prototype.addBridgedAccessory = function (accessory, deferUpdate) {
         var e_5, _a;
@@ -421,14 +413,16 @@ var Accessory = /** @class */ (function (_super) {
         this.enqueueConfigurationUpdate();
     };
     Accessory.prototype.removeBridgedAccessory = function (accessory, deferUpdate) {
-        if (accessory._isBridge)
+        if (accessory._isBridge) {
             throw new Error("Cannot Bridge another Bridge!");
+        }
         // check for UUID conflict
         var foundMatchAccessory = this.bridgedAccessories.findIndex(function (existing) {
             return existing.UUID === accessory.UUID;
         });
-        if (foundMatchAccessory === -1)
+        if (foundMatchAccessory === -1) {
             throw new Error("Cannot find the bridged Accessory to remove.");
+        }
         this.bridgedAccessories.splice(foundMatchAccessory, 1);
         accessory.removeAllListeners();
         if (!deferUpdate) {
@@ -546,7 +540,7 @@ var Accessory = /** @class */ (function (_super) {
                 return; // ignore those services, as they get replaced by the RTPStreamManagement
             }
             // all other services get added. We can't really control possibly linking to any of those ignored services
-            // so this is really only half baked stuff.
+            // so this is really only half-baked stuff.
             _this.addService(service);
         });
         // replace stream controllers; basically only to still support the "forceStop" call
@@ -575,15 +569,15 @@ var Accessory = /** @class */ (function (_super) {
             : controllerConstructor;
         var id = controller.controllerId();
         if (this.controllers[id]) {
-            throw new Error("A Controller with the type/id '" + id + "' was already added to the accessory " + this.displayName);
+            throw new Error("A Controller with the type/id '".concat(id, "' was already added to the accessory ").concat(this.displayName));
         }
         var savedServiceMap = this.serializedControllers && this.serializedControllers[id];
         var serviceMap;
         if (savedServiceMap) { // we found data to restore from
             var clonedServiceMap = (0, clone_1.clone)(savedServiceMap);
             var updatedServiceMap = controller.initWithServices(savedServiceMap); // init controller with existing services
-            serviceMap = updatedServiceMap || savedServiceMap; // initWithServices could return a updated serviceMap, otherwise just use the existing one
-            if (updatedServiceMap) { // controller returned a ServiceMap and thus signaled a updated set of services
+            serviceMap = updatedServiceMap || savedServiceMap; // initWithServices could return an updated serviceMap, otherwise just use the existing one
+            if (updatedServiceMap) { // controller returned a ServiceMap and thus signaled an updated set of services
                 // clonedServiceMap is altered by this method, should not be touched again after this call (for the future people)
                 this.handleUpdatedControllerServiceMap(clonedServiceMap, updatedServiceMap);
             }
@@ -629,7 +623,8 @@ var Accessory = /** @class */ (function (_super) {
         var storedController = this.controllers[id];
         if (storedController) {
             if (storedController.controller !== controller) {
-                throw new Error("[" + this.displayName + "] tried removing a controller with the id/type '" + id + "' though provided controller isn't the same which is registered!");
+                throw new Error("[" + this.displayName + "] tried removing a controller with the id/type '" + id +
+                    "' though provided controller isn't the same which is registered!");
             }
             if ((0, controller_1.isSerializableController)(controller)) {
                 // this will reset the state change delegate before we call handleControllerRemoved()
@@ -707,7 +702,7 @@ var Accessory = /** @class */ (function (_super) {
             return this._setupURI;
         }
         var buffer = Buffer.alloc(8);
-        var setupCode = this._accessoryInfo && parseInt(this._accessoryInfo.pincode.replace(/-/g, ''), 10);
+        var setupCode = this._accessoryInfo && parseInt(this._accessoryInfo.pincode.replace(/-/g, ""), 10);
         var value_low = setupCode;
         var value_high = this._accessoryInfo && this._accessoryInfo.category >> 1;
         value_low |= 1 << 28; // Supports IP;
@@ -717,7 +712,7 @@ var Accessory = /** @class */ (function (_super) {
         }
         buffer.writeUInt32BE(value_high, 0);
         var encodedPayload = (buffer.readUInt32BE(4) + (buffer.readUInt32BE(0) * Math.pow(2, 32))).toString(36).toUpperCase();
-        if (encodedPayload.length != 9) {
+        if (encodedPayload.length !== 9) {
             for (var i = 0; i <= 9 - encodedPayload.length; i++) {
                 encodedPayload = "0" + encodedPayload;
             }
@@ -738,6 +733,7 @@ var Accessory = /** @class */ (function (_super) {
                 "This might prevent the accessory from being added to the Home app or leading to the accessory being unresponsive!");
         }
         else {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             var checkValue = function (name, value) {
                 if (!value) {
                     console.log("HAP-NodeJS WARNING: The accessory '" + _this.displayName + "' is getting published with the characteristic '" + name + "'" +
@@ -819,12 +815,32 @@ var Accessory = /** @class */ (function (_super) {
         // that have been removed since the last call to assignIDs())
         if (this._identifierCache) {
             //Check weather we want to purge the unused ids
-            if (this.shouldPurgeUnusedIDs)
+            if (this.shouldPurgeUnusedIDs) {
                 this._identifierCache.stopTrackingUsageAndExpireUnused();
+            }
             //Save in case we have new ones
             this._identifierCache.save();
         }
     };
+    Accessory.prototype.disableUnusedIDPurge = function () {
+        this.shouldPurgeUnusedIDs = false;
+    };
+    Accessory.prototype.enableUnusedIDPurge = function () {
+        this.shouldPurgeUnusedIDs = true;
+    };
+    /**
+     * Manually purge the unused ids if you like, comes handy
+     * when you have disabled auto purge so you can do it manually
+     */
+    Accessory.prototype.purgeUnusedIDs = function () {
+        //Cache the state of the purge mechanism and set it to true
+        var oldValue = this.shouldPurgeUnusedIDs;
+        this.shouldPurgeUnusedIDs = true;
+        //Reassign all ids
+        this._assignIDs(this._identifierCache);
+        // Revert the purge mechanism state
+        this.shouldPurgeUnusedIDs = oldValue;
+    };
     /**
      * Returns a JSON representation of this accessory suitable for delivering to HAP clients.
      */
@@ -908,133 +924,151 @@ var Accessory = /** @class */ (function (_super) {
      *                                new Accessory.
      */
     Accessory.prototype.publish = function (info, allowInsecureRequest) {
-        var _this = this;
         var _a, _b;
-        // noinspection JSDeprecatedSymbols
-        if (!info.advertiser && info.useLegacyAdvertiser != null) {
-            // noinspection JSDeprecatedSymbols
-            info.advertiser = info.useLegacyAdvertiser ? "bonjour-hap" /* BONJOUR */ : "ciao" /* CIAO */;
-            console.warn('DEPRECATED The PublishInfo.useLegacyAdvertiser option has been removed. Please use the PublishInfo.advertiser property to enable "ciao" (useLegacyAdvertiser=false) ' +
-                'or "bonjour-hap" (useLegacyAdvertiser=true) mdns advertiser libraries!');
-        }
-        // noinspection JSDeprecatedSymbols
-        if (info.mdns && info.advertiser !== "bonjour-hap" /* BONJOUR */) {
-            console.log("DEPRECATED user supplied a custom 'mdns' option. This option is deprecated and ignored. " +
-                "Please move to the new 'bind' option.");
-        }
-        var service = this.getService(Service_1.Service.ProtocolInformation);
-        if (!service) {
-            service = this.addService(Service_1.Service.ProtocolInformation); // add the protocol information service to the primary accessory
-        }
-        service.setCharacteristic(Characteristic_1.Characteristic.Version, Advertiser_1.CiaoAdvertiser.protocolVersionService);
-        if (this.lastKnownUsername && this.lastKnownUsername !== info.username) { // username changed since last publish
-            Accessory.cleanupAccessoryData(this.lastKnownUsername); // delete old Accessory data
-        }
-        if (!this.initialized && ((_a = info.addIdentifyingMaterial) !== null && _a !== void 0 ? _a : true)) {
-            // adding some identifying material to our displayName if its our first publish() call
-            this.displayName = this.displayName + " " + crypto_1.default.createHash('sha512')
-                .update(info.username, 'utf8')
-                .digest('hex').slice(0, 4).toUpperCase();
-            this.getService(Service_1.Service.AccessoryInformation).updateCharacteristic(Characteristic_1.Characteristic.Name, this.displayName);
-        }
-        // attempt to load existing AccessoryInfo from disk
-        this._accessoryInfo = AccessoryInfo_1.AccessoryInfo.load(info.username);
-        // if we don't have one, create a new one.
-        if (!this._accessoryInfo) {
-            debug("[%s] Creating new AccessoryInfo for our HAP server", this.displayName);
-            this._accessoryInfo = AccessoryInfo_1.AccessoryInfo.create(info.username);
-        }
-        if (info.setupID) {
-            this._setupID = info.setupID;
-        }
-        else if (this._accessoryInfo.setupID === undefined || this._accessoryInfo.setupID === "") {
-            this._setupID = Accessory._generateSetupID();
-        }
-        else {
-            this._setupID = this._accessoryInfo.setupID;
-        }
-        this._accessoryInfo.setupID = this._setupID;
-        // make sure we have up-to-date values in AccessoryInfo, then save it in case they changed (or if we just created it)
-        this._accessoryInfo.displayName = this.displayName;
-        this._accessoryInfo.model = this.getService(Service_1.Service.AccessoryInformation).getCharacteristic(Characteristic_1.Characteristic.Model).value;
-        this._accessoryInfo.category = info.category || 1 /* OTHER */;
-        this._accessoryInfo.pincode = info.pincode;
-        this._accessoryInfo.save();
-        // create our IdentifierCache so we can provide clients with stable aid/iid's
-        this._identifierCache = IdentifierCache_1.IdentifierCache.load(info.username);
-        // if we don't have one, create a new one.
-        if (!this._identifierCache) {
-            debug("[%s] Creating new IdentifierCache", this.displayName);
-            this._identifierCache = new IdentifierCache_1.IdentifierCache(info.username);
-        }
-        //If it's bridge and there are not accessories already assigned to the bridge
-        //probably purge is not needed since it's going to delete all the ids
-        //of accessories that might be added later. Useful when dynamically adding
-        //accessories.
-        if (this._isBridge && this.bridgedAccessories.length == 0) {
-            this.disableUnusedIDPurge();
-            this.controllerStorage.purgeUnidentifiedAccessoryData = false;
-        }
-        if (!this.initialized) { // controller storage is only loaded from disk the first time we publish!
-            this.controllerStorage.load(info.username); // initializing controller data
-        }
-        // assign aid/iid
-        this._assignIDs(this._identifierCache);
-        // get our accessory information in HAP format and determine if our configuration (that is, our
-        // Accessories/Services/Characteristics) has changed since the last time we were published. make
-        // sure to omit actual values since these are not part of the "configuration".
-        var config = this.internalHAPRepresentation(false); // TODO ensure this stuff is ordered
-        // TODO queue this check until about 5 seconds after startup, allowing some last changes after the publish call
-        //   without constantly incrementing the current config number
-        this._accessoryInfo.checkForCurrentConfigurationNumberIncrement(config, true);
-        this.validateAccessory(true);
-        // create our Advertiser which broadcasts our presence over mdns
-        var parsed = Accessory.parseBindOption(info);
-        switch ((_b = info.advertiser) !== null && _b !== void 0 ? _b : "bonjour-hap" /* BONJOUR */) {
-            case "ciao" /* CIAO */:
-                this._advertiser = new Advertiser_1.CiaoAdvertiser(this._accessoryInfo, {
-                    interface: parsed.advertiserAddress
-                }, {
-                    restrictedAddresses: parsed.serviceRestrictedAddress,
-                    disabledIpv6: parsed.serviceDisableIpv6,
-                });
-                break;
-            case "bonjour-hap" /* BONJOUR */:
-                // noinspection JSDeprecatedSymbols
-                this._advertiser = new Advertiser_1.BonjourHAPAdvertiser(this._accessoryInfo, info.mdns, {
-                    restrictedAddresses: parsed.serviceRestrictedAddress,
-                    disabledIpv6: parsed.serviceDisableIpv6,
-                });
-                break;
-            default:
-                throw new Error("Unsupported advertiser setting: '" + info.advertiser + "'");
-        }
-        this._advertiser.on("updated-name" /* UPDATED_NAME */, function (name) {
-            _this.displayName = name;
-            if (_this._accessoryInfo) {
-                _this._accessoryInfo.displayName = name;
-                _this._accessoryInfo.save();
-            }
-            // bonjour service name MUST match the name in the accessory information service
-            _this.getService(Service_1.Service.AccessoryInformation)
-                .updateCharacteristic(Characteristic_1.Characteristic.Name, name);
+        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+            var service, config, parsed, defaultAdvertiser, _c;
+            var _this = this;
+            return (0, tslib_1.__generator)(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        // noinspection JSDeprecatedSymbols
+                        if (!info.advertiser && info.useLegacyAdvertiser != null) {
+                            // noinspection JSDeprecatedSymbols
+                            info.advertiser = info.useLegacyAdvertiser ? "bonjour-hap" /* BONJOUR */ : "ciao" /* CIAO */;
+                            console.warn("DEPRECATED The PublishInfo.useLegacyAdvertiser option has been removed. " +
+                                "Please use the PublishInfo.advertiser property to enable \"ciao\" (useLegacyAdvertiser=false) " +
+                                "or \"bonjour-hap\" (useLegacyAdvertiser=true) mdns advertiser libraries!");
+                        }
+                        // noinspection JSDeprecatedSymbols
+                        if (info.mdns && info.advertiser !== "bonjour-hap" /* BONJOUR */) {
+                            console.log("DEPRECATED user supplied a custom 'mdns' option. This option is deprecated and ignored. " +
+                                "Please move to the new 'bind' option.");
+                        }
+                        service = this.getService(Service_1.Service.ProtocolInformation);
+                        if (!service) {
+                            service = this.addService(Service_1.Service.ProtocolInformation); // add the protocol information service to the primary accessory
+                        }
+                        service.setCharacteristic(Characteristic_1.Characteristic.Version, Advertiser_1.CiaoAdvertiser.protocolVersionService);
+                        if (this.lastKnownUsername && this.lastKnownUsername !== info.username) { // username changed since last publish
+                            Accessory.cleanupAccessoryData(this.lastKnownUsername); // delete old Accessory data
+                        }
+                        if (!this.initialized && ((_a = info.addIdentifyingMaterial) !== null && _a !== void 0 ? _a : true)) {
+                            // adding some identifying material to our displayName if its our first publish() call
+                            this.displayName = this.displayName + " " + crypto_1.default.createHash("sha512")
+                                .update(info.username, "utf8")
+                                .digest("hex").slice(0, 4).toUpperCase();
+                            this.getService(Service_1.Service.AccessoryInformation).updateCharacteristic(Characteristic_1.Characteristic.Name, this.displayName);
+                        }
+                        // attempt to load existing AccessoryInfo from disk
+                        this._accessoryInfo = AccessoryInfo_1.AccessoryInfo.load(info.username);
+                        // if we don't have one, create a new one.
+                        if (!this._accessoryInfo) {
+                            debug("[%s] Creating new AccessoryInfo for our HAP server", this.displayName);
+                            this._accessoryInfo = AccessoryInfo_1.AccessoryInfo.create(info.username);
+                        }
+                        if (info.setupID) {
+                            this._setupID = info.setupID;
+                        }
+                        else if (this._accessoryInfo.setupID === undefined || this._accessoryInfo.setupID === "") {
+                            this._setupID = Accessory._generateSetupID();
+                        }
+                        else {
+                            this._setupID = this._accessoryInfo.setupID;
+                        }
+                        this._accessoryInfo.setupID = this._setupID;
+                        // make sure we have up-to-date values in AccessoryInfo, then save it in case they changed (or if we just created it)
+                        this._accessoryInfo.displayName = this.displayName;
+                        this._accessoryInfo.model = this.getService(Service_1.Service.AccessoryInformation).getCharacteristic(Characteristic_1.Characteristic.Model).value;
+                        this._accessoryInfo.category = info.category || 1 /* OTHER */;
+                        this._accessoryInfo.pincode = info.pincode;
+                        this._accessoryInfo.save();
+                        // create our IdentifierCache so we can provide clients with stable aid/iid's
+                        this._identifierCache = IdentifierCache_1.IdentifierCache.load(info.username);
+                        // if we don't have one, create a new one.
+                        if (!this._identifierCache) {
+                            debug("[%s] Creating new IdentifierCache", this.displayName);
+                            this._identifierCache = new IdentifierCache_1.IdentifierCache(info.username);
+                        }
+                        //If it's bridge and there are not accessories already assigned to the bridge
+                        //probably purge is not needed since it's going to delete all the ids
+                        //of accessories that might be added later. Useful when dynamically adding
+                        //accessories.
+                        if (this._isBridge && this.bridgedAccessories.length === 0) {
+                            this.disableUnusedIDPurge();
+                            this.controllerStorage.purgeUnidentifiedAccessoryData = false;
+                        }
+                        if (!this.initialized) { // controller storage is only loaded from disk the first time we publish!
+                            this.controllerStorage.load(info.username); // initializing controller data
+                        }
+                        // assign aid/iid
+                        this._assignIDs(this._identifierCache);
+                        config = this.internalHAPRepresentation(false);
+                        // TODO queue this check until about 5 seconds after startup, allowing some last changes after the publish call
+                        //   without constantly incrementing the current config number
+                        this._accessoryInfo.checkForCurrentConfigurationNumberIncrement(config, true);
+                        this.validateAccessory(true);
+                        parsed = Accessory.parseBindOption(info);
+                        if (!((_b = info.advertiser) !== null && _b !== void 0)) return [3 /*break*/, 1];
+                        _c = _b;
+                        return [3 /*break*/, 3];
+                    case 1: return [4 /*yield*/, Advertiser_1.AvahiAdvertiser.isAvailable()];
+                    case 2:
+                        _c = ((_d.sent()) ? "avahi" /* AVAHI */ : "bonjour-hap" /* BONJOUR */);
+                        _d.label = 3;
+                    case 3:
+                        defaultAdvertiser = _c;
+                        switch (defaultAdvertiser) {
+                            case "ciao" /* CIAO */:
+                                this._advertiser = new Advertiser_1.CiaoAdvertiser(this._accessoryInfo, {
+                                    interface: parsed.advertiserAddress,
+                                }, {
+                                    restrictedAddresses: parsed.serviceRestrictedAddress,
+                                    disabledIpv6: parsed.serviceDisableIpv6,
+                                });
+                                break;
+                            case "bonjour-hap" /* BONJOUR */:
+                                // noinspection JSDeprecatedSymbols
+                                this._advertiser = new Advertiser_1.BonjourHAPAdvertiser(this._accessoryInfo, info.mdns, {
+                                    restrictedAddresses: parsed.serviceRestrictedAddress,
+                                    disabledIpv6: parsed.serviceDisableIpv6,
+                                });
+                                break;
+                            case "avahi" /* AVAHI */:
+                                this._advertiser = new Advertiser_1.AvahiAdvertiser(this._accessoryInfo);
+                                break;
+                            default:
+                                throw new Error("Unsupported advertiser setting: '" + info.advertiser + "'");
+                        }
+                        this._advertiser.on("updated-name" /* UPDATED_NAME */, function (name) {
+                            _this.displayName = name;
+                            if (_this._accessoryInfo) {
+                                _this._accessoryInfo.displayName = name;
+                                _this._accessoryInfo.save();
+                            }
+                            // bonjour service name MUST match the name in the accessory information service
+                            _this.getService(Service_1.Service.AccessoryInformation)
+                                .updateCharacteristic(Characteristic_1.Characteristic.Name, name);
+                        });
+                        // create our HAP server which handles all communication between iOS devices and us
+                        this._server = new HAPServer_1.HAPServer(this._accessoryInfo);
+                        this._server.allowInsecureRequest = !!allowInsecureRequest;
+                        this._server.on("listening" /* LISTENING */, this.onListening.bind(this));
+                        this._server.on("identify" /* IDENTIFY */, this.identificationRequest.bind(this, false));
+                        this._server.on("pair" /* PAIR */, this.handleInitialPairSetupFinished.bind(this));
+                        this._server.on("add-pairing" /* ADD_PAIRING */, this.handleAddPairing.bind(this));
+                        this._server.on("remove-pairing" /* REMOVE_PAIRING */, this.handleRemovePairing.bind(this));
+                        this._server.on("list-pairings" /* LIST_PAIRINGS */, this.handleListPairings.bind(this));
+                        this._server.on("accessories" /* ACCESSORIES */, this.handleAccessories.bind(this));
+                        this._server.on("get-characteristics" /* GET_CHARACTERISTICS */, this.handleGetCharacteristics.bind(this));
+                        this._server.on("set-characteristics" /* SET_CHARACTERISTICS */, this.handleSetCharacteristics.bind(this));
+                        this._server.on("connection-closed" /* CONNECTION_CLOSED */, this.handleHAPConnectionClosed.bind(this));
+                        this._server.on("request-resource" /* REQUEST_RESOURCE */, this.handleResource.bind(this));
+                        this._server.listen(info.port, parsed.serverAddress);
+                        this.initialized = true;
+                        return [2 /*return*/];
+                }
+            });
         });
-        // create our HAP server which handles all communication between iOS devices and us
-        this._server = new HAPServer_1.HAPServer(this._accessoryInfo);
-        this._server.allowInsecureRequest = !!allowInsecureRequest;
-        this._server.on("listening" /* LISTENING */, this.onListening.bind(this));
-        this._server.on("identify" /* IDENTIFY */, this.identificationRequest.bind(this, false));
-        this._server.on("pair" /* PAIR */, this.handleInitialPairSetupFinished.bind(this));
-        this._server.on("add-pairing" /* ADD_PAIRING */, this.handleAddPairing.bind(this));
-        this._server.on("remove-pairing" /* REMOVE_PAIRING */, this.handleRemovePairing.bind(this));
-        this._server.on("list-pairings" /* LIST_PAIRINGS */, this.handleListPairings.bind(this));
-        this._server.on("accessories" /* ACCESSORIES */, this.handleAccessories.bind(this));
-        this._server.on("get-characteristics" /* GET_CHARACTERISTICS */, this.handleGetCharacteristics.bind(this));
-        this._server.on("set-characteristics" /* SET_CHARACTERISTICS */, this.handleSetCharacteristics.bind(this));
-        this._server.on("connection-closed" /* CONNECTION_CLOSED */, this.handleHAPConnectionClosed.bind(this));
-        this._server.on("request-resource" /* REQUEST_RESOURCE */, this.handleResource.bind(this));
-        this._server.listen(info.port, parsed.serverAddress);
-        this.initialized = true;
     };
     /**
      * Removes this Accessory from the local network
@@ -1103,7 +1137,8 @@ var Accessory = /** @class */ (function (_super) {
         // the HAP server is listening, so we can now start advertising our presence.
         this._advertiser.initPort(port);
         this._advertiser.startAdvertising()
-            .then(function () { return _this.emit("advertised" /* ADVERTISED */); });
+            .then(function () { return _this.emit("advertised" /* ADVERTISED */); })
+            .catch(function (reason) { return console.error("Could not create mDNS advertisement. The HAP-Server won't be discoverable: " + reason); });
         this.emit("listening" /* LISTENING */, port, hostname);
     };
     Accessory.prototype.handleInitialPairSetupFinished = function (username, publicKey, callback) {
@@ -1242,7 +1277,8 @@ var Accessory = /** @class */ (function (_super) {
                         var accessory = _this.getAccessoryByAID(aid);
                         var characteristic = accessory.getCharacteristicByIID(iid);
                         _this.sendCharacteristicWarning(characteristic, "timeout-read" /* TIMEOUT_READ */, "The read handler for the characteristic '" +
-                            characteristic.displayName + "' on the accessory '" + accessory.displayName + "' didn't respond at all!. Please check that you properly call the callback!");
+                            characteristic.displayName + "' on the accessory '" + accessory.displayName + "' didn't respond at all!. " +
+                            "Please check that you properly call the callback!");
                         characteristics.push({
                             aid: aid,
                             iid: iid,
@@ -1268,7 +1304,7 @@ var Accessory = /** @class */ (function (_super) {
             this_1.handleCharacteristicRead(connection, id, request).then(function (value) {
                 return (0, tslib_1.__assign)({ aid: id.aid, iid: id.iid }, value);
             }, function (reason) {
-                console.error("[" + _this.displayName + "] Read request for characteristic " + name + " encountered an error: " + reason.stack);
+                console.error("[".concat(_this.displayName, "] Read request for characteristic ").concat(name, " encountered an error: ").concat(reason.stack));
                 return {
                     aid: id.aid,
                     iid: id.iid,
@@ -1311,18 +1347,18 @@ var Accessory = /** @class */ (function (_super) {
             return (0, tslib_1.__generator)(this, function (_a) {
                 characteristic = this.findCharacteristic(id.aid, id.iid);
                 if (!characteristic) {
-                    debug('[%s] Could not find a Characteristic with aid of %s and iid of %s', this.displayName, id.aid, id.iid);
+                    debug("[%s] Could not find a Characteristic with aid of %s and iid of %s", this.displayName, id.aid, id.iid);
                     return [2 /*return*/, { status: -70410 /* INVALID_VALUE_IN_REQUEST */ }];
                 }
                 if (!characteristic.props.perms.includes("pr" /* PAIRED_READ */)) { // check if read is allowed for this characteristic
-                    debug('[%s] Tried reading from characteristic which does not allow reading (aid of %s and iid of %s)', this.displayName, id.aid, id.iid);
+                    debug("[%s] Tried reading from characteristic which does not allow reading (aid of %s and iid of %s)", this.displayName, id.aid, id.iid);
                     return [2 /*return*/, { status: -70405 /* WRITE_ONLY_CHARACTERISTIC */ }];
                 }
                 if (characteristic.props.adminOnlyAccess && characteristic.props.adminOnlyAccess.includes(0 /* READ */)) {
                     verifiable = true;
                     if (!connection.username || !this._accessoryInfo) {
                         verifiable = false;
-                        debug('[%s] Could not verify admin permissions for Characteristic which requires admin permissions for reading (aid of %s and iid of %s)', this.displayName, id.aid, id.iid);
+                        debug("[%s] Could not verify admin permissions for Characteristic which requires admin permissions for reading (aid of %s and iid of %s)", this.displayName, id.aid, id.iid);
                     }
                     if (!verifiable || !this._accessoryInfo.hasAdminPermissions(connection.username)) {
                         return [2 /*return*/, { status: -70401 /* INSUFFICIENT_PRIVILEGES */ }];
@@ -1330,9 +1366,9 @@ var Accessory = /** @class */ (function (_super) {
                 }
                 return [2 /*return*/, characteristic.handleGetRequest(connection).then(function (value) {
                         value = (0, request_util_1.formatOutgoingCharacteristicValue)(value, characteristic.props);
-                        debug('[%s] Got Characteristic "%s" value: "%s"', _this.displayName, characteristic.displayName, value);
+                        debug("[%s] Got Characteristic \"%s\" value: \"%s\"", _this.displayName, characteristic.displayName, value);
                         var data = {
-                            value: value == undefined ? null : value,
+                            value: value == null ? null : value,
                         };
                         if (request.includeMeta) {
                             data.format = characteristic.props.format;
@@ -1353,8 +1389,8 @@ var Accessory = /** @class */ (function (_super) {
                         }
                         return data;
                     }, function (reason) {
-                        // @ts-expect-error
-                        debug('[%s] Error getting value for characteristic "%s": %s', _this.displayName, characteristic.displayName, HAPServer_1.HAPStatus[reason]);
+                        // @ts-expect-error: forceConsistentCasingInFileNames compiler option
+                        debug("[%s] Error getting value for characteristic \"%s\": %s", _this.displayName, characteristic.displayName, HAPServer_1.HAPStatus[reason]);
                         return { status: reason };
                     })];
             });
@@ -1421,7 +1457,8 @@ var Accessory = /** @class */ (function (_super) {
                         var accessory = _this.getAccessoryByAID(aid);
                         var characteristic = accessory.getCharacteristicByIID(iid);
                         _this.sendCharacteristicWarning(characteristic, "timeout-write" /* TIMEOUT_WRITE */, "The write handler for the characteristic '" +
-                            characteristic.displayName + "' on the accessory '" + accessory.displayName + "' didn't respond at all!. Please check that you properly call the callback!");
+                            characteristic.displayName + "' on the accessory '" + accessory.displayName + "' didn't respond at all!. " +
+                            "Please check that you properly call the callback!");
                         characteristics.push({
                             aid: aid,
                             iid: iid,
@@ -1447,7 +1484,7 @@ var Accessory = /** @class */ (function (_super) {
             this_2.handleCharacteristicWrite(connection, data, writeState).then(function (value) {
                 return (0, tslib_1.__assign)({ aid: data.aid, iid: data.iid }, value);
             }, function (reason) {
-                console.error("[" + _this.displayName + "] Write request for characteristic " + name + " encountered an error: " + reason.stack);
+                console.error("[".concat(_this.displayName, "] Write request for characteristic ").concat(name, " encountered an error: ").concat(reason.stack));
                 return {
                     aid: data.aid,
                     iid: data.iid,
@@ -1491,26 +1528,26 @@ var Accessory = /** @class */ (function (_super) {
                 characteristic = this.findCharacteristic(data.aid, data.iid);
                 evResponse = undefined;
                 if (!characteristic) {
-                    debug('[%s] Could not find a Characteristic with aid of %s and iid of %s', this.displayName, data.aid, data.iid);
+                    debug("[%s] Could not find a Characteristic with aid of %s and iid of %s", this.displayName, data.aid, data.iid);
                     return [2 /*return*/, { status: -70410 /* INVALID_VALUE_IN_REQUEST */ }];
                 }
                 if (writeState === 2 /* TIMED_WRITE_REJECTED */) {
                     return [2 /*return*/, { status: -70410 /* INVALID_VALUE_IN_REQUEST */ }];
                 }
-                if (data.ev != undefined) { // register/unregister event notifications
+                if (data.ev != null) { // register/unregister event notifications
                     notificationsEnabled = connection.hasEventNotifications(data.aid, data.iid);
                     // it seems like the Home App sends unregister requests for characteristics which don't have notify permissions
                     // see https://github.com/homebridge/HAP-NodeJS/issues/868
-                    if (notificationsEnabled != data.ev) {
+                    if (notificationsEnabled !== data.ev) {
                         if (!characteristic.props.perms.includes("ev" /* NOTIFY */)) { // check if notify is allowed for this characteristic
-                            debug('[%s] Tried %s notifications for Characteristic which does not allow notify (aid of %s and iid of %s)', this.displayName, data.ev ? "enabling" : "disabling", data.aid, data.iid);
+                            debug("[%s] Tried %s notifications for Characteristic which does not allow notify (aid of %s and iid of %s)", this.displayName, data.ev ? "enabling" : "disabling", data.aid, data.iid);
                             return [2 /*return*/, { status: -70406 /* NOTIFICATION_NOT_SUPPORTED */ }];
                         }
                         if (characteristic.props.adminOnlyAccess && characteristic.props.adminOnlyAccess.includes(2 /* NOTIFY */)) {
                             verifiable = true;
                             if (!connection.username || !this._accessoryInfo) {
                                 verifiable = false;
-                                debug('[%s] Could not verify admin permissions for Characteristic which requires admin permissions for notify (aid of %s and iid of %s)', this.displayName, data.aid, data.iid);
+                                debug("[%s] Could not verify admin permissions for Characteristic which requires admin permissions for notify (aid of %s and iid of %s)", this.displayName, data.aid, data.iid);
                             }
                             if (!verifiable || !this._accessoryInfo.hasAdminPermissions(connection.username)) {
                                 return [2 /*return*/, { status: -70401 /* INSUFFICIENT_PRIVILEGES */ }];
@@ -1521,27 +1558,27 @@ var Accessory = /** @class */ (function (_super) {
                             connection.enableEventNotifications(data.aid, data.iid);
                             characteristic.subscribe();
                             evResponse = true;
-                            debug('[%s] Registered Characteristic "%s" on "%s" for events', connection.remoteAddress, characteristic.displayName, this.displayName);
+                            debug("[%s] Registered Characteristic \"%s\" on \"%s\" for events", connection.remoteAddress, characteristic.displayName, this.displayName);
                         }
                         else {
                             characteristic.unsubscribe();
                             connection.disableEventNotifications(data.aid, data.iid);
                             evResponse = false;
-                            debug('[%s] Unregistered Characteristic "%s" on "%s" for events', connection.remoteAddress, characteristic.displayName, this.displayName);
+                            debug("[%s] Unregistered Characteristic \"%s\" on \"%s\" for events", connection.remoteAddress, characteristic.displayName, this.displayName);
                         }
                     }
                     // response is returned below in the else block
                 }
-                if (data.value != undefined) {
+                if (data.value != null) {
                     if (!characteristic.props.perms.includes("pw" /* PAIRED_WRITE */)) { // check if write is allowed for this characteristic
-                        debug('[%s] Tried writing to Characteristic which does not allow writing (aid of %s and iid of %s)', this.displayName, data.aid, data.iid);
+                        debug("[%s] Tried writing to Characteristic which does not allow writing (aid of %s and iid of %s)", this.displayName, data.aid, data.iid);
                         return [2 /*return*/, { status: -70404 /* READ_ONLY_CHARACTERISTIC */ }];
                     }
                     if (characteristic.props.adminOnlyAccess && characteristic.props.adminOnlyAccess.includes(1 /* WRITE */)) {
                         verifiable = true;
                         if (!connection.username || !this._accessoryInfo) {
                             verifiable = false;
-                            debug('[%s] Could not verify admin permissions for Characteristic which requires admin permissions for write (aid of %s and iid of %s)', this.displayName, data.aid, data.iid);
+                            debug("[%s] Could not verify admin permissions for Characteristic which requires admin permissions for write (aid of %s and iid of %s)", this.displayName, data.aid, data.iid);
                         }
                         if (!verifiable || !this._accessoryInfo.hasAdminPermissions(connection.username)) {
                             return [2 /*return*/, { status: -70401 /* INSUFFICIENT_PRIVILEGES */ }];
@@ -1561,18 +1598,19 @@ var Accessory = /** @class */ (function (_super) {
                         }
                     }
                     if (characteristic.props.perms.includes("tw" /* TIMED_WRITE */) && writeState !== 1 /* TIMED_WRITE_AUTHENTICATED */) {
-                        debug('[%s] Tried writing to a timed write only Characteristic without properly preparing (iid of %s and aid of %s)', this.displayName, data.aid, data.iid);
+                        debug("[%s] Tried writing to a timed write only Characteristic without properly preparing (iid of %s and aid of %s)", this.displayName, data.aid, data.iid);
                         return [2 /*return*/, { status: -70410 /* INVALID_VALUE_IN_REQUEST */ }];
                     }
                     return [2 /*return*/, characteristic.handleSetRequest(data.value, connection).then(function (value) {
-                            debug('[%s] Setting Characteristic "%s" to value %s', _this.displayName, characteristic.displayName, data.value);
+                            debug("[%s] Setting Characteristic \"%s\" to value %s", _this.displayName, characteristic.displayName, data.value);
                             return {
+                                // if write response is requests and value is provided, return that
                                 value: data.r && value ? (0, request_util_1.formatOutgoingCharacteristicValue)(value, characteristic.props) : undefined,
                                 ev: evResponse,
                             };
                         }, function (status) {
-                            // @ts-expect-error
-                            debug('[%s] Error setting Characteristic "%s" to value %s: ', _this.displayName, characteristic.displayName, data.value, HAPServer_1.HAPStatus[status]);
+                            // @ts-expect-error: forceConsistentCasingInFileNames compiler option
+                            debug("[%s] Error setting Characteristic \"%s\" to value %s: ", _this.displayName, characteristic.displayName, data.value, HAPServer_1.HAPStatus[status]);
                             return { status: status };
                         })];
                 }
@@ -1604,10 +1642,11 @@ var Accessory = /** @class */ (function (_super) {
                 callback({ httpCode: 404 /* NOT_FOUND */, status: -70409 /* RESOURCE_DOES_NOT_EXIST */ });
                 return;
             }
-            controller.handleSnapshotRequest(data["image-height"], data["image-width"], accessory === null || accessory === void 0 ? void 0 : accessory.displayName).then(function (buffer) {
+            controller.handleSnapshotRequest(data["image-height"], data["image-width"], accessory === null || accessory === void 0 ? void 0 : accessory.displayName, data.reason)
+                .then(function (buffer) {
                 callback(undefined, buffer);
             }, function (status) {
-                callback({ httpCode: 200 /* OK */, status: status });
+                callback({ httpCode: 207 /* MULTI_STATUS */, status: status });
             });
             return;
         }
@@ -1667,11 +1706,11 @@ var Accessory = /** @class */ (function (_super) {
             if (!this._server) {
                 return; // we're not running a HAPServer, so there's no one to notify about this event
             }
-            if (accessory.aid == undefined || change.characteristic.iid == undefined) {
+            if (accessory.aid == null || change.characteristic.iid == null) {
                 debug("[%s] Muting event notification for %s as ids aren't yet assigned!", accessory.displayName, change.characteristic.displayName);
                 return;
             }
-            if (change.context != undefined && typeof change.context === "object" && change.context.omitEventUpdate) {
+            if (change.context != null && typeof change.context === "object" && change.context.omitEventUpdate) {
                 debug("[%s] Omitting event updates for %s as specified in the context object!", accessory.displayName, change.characteristic.displayName);
                 return;
             }
@@ -1705,7 +1744,7 @@ var Accessory = /** @class */ (function (_super) {
         warning.originatorChain = (0, tslib_1.__spreadArray)([this.displayName], (0, tslib_1.__read)(warning.originatorChain), false);
         var emitted = this.emit("characteristic-warning" /* CHARACTERISTIC_WARNING */, warning);
         if (!emitted) {
-            var message = "[" + warning.originatorChain.join("@") + "] " + warning.message;
+            var message = "[".concat(warning.originatorChain.join("@"), "] ").concat(warning.message);
             if (warning.type === "error-message" /* ERROR_MESSAGE */
                 || warning.type === "timeout-read" /* TIMEOUT_READ */ || warning.type === "timeout-write" /* TIMEOUT_WRITE */) {
                 console.error(message);
@@ -1750,9 +1789,9 @@ var Accessory = /** @class */ (function (_super) {
         });
     };
     Accessory._generateSetupID = function () {
-        var chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+        var chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
         var max = chars.length;
-        var setupID = '';
+        var setupID = "";
         for (var i = 0; i < 4; i++) {
             var index = Math.floor(Math.random() * max);
             setupID += chars.charAt(index);
@@ -1949,9 +1988,9 @@ var Accessory = /** @class */ (function (_super) {
         };
     };
     /**
-     * @deprecated Please use the Categories const enum above. Scheduled to be removed in 2021-06.
+     * @deprecated Please use the Categories const enum above.
      */
-    // @ts-ignore
+    // @ts-expect-error: forceConsistentCasingInFileNames compiler option
     Accessory.Categories = Categories;
     return Accessory;
 }(events_1.EventEmitter));