hap-nodejs 0.11.0-beta.12 → 0.11.0-beta.14

package/dist/lib/Characteristic.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Characteristic = exports.CharacteristicEventTypes = exports.ChangeReason = exports.Access = exports.Perms = exports.Units = exports.Formats = void 0;
 var tslib_1 = require("tslib");
-var assert_1 = (0, tslib_1.__importDefault)(require("assert"));
-var debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+var assert_1 = tslib_1.__importDefault(require("assert"));
+var debug_1 = tslib_1.__importDefault(require("debug"));
 var events_1 = require("events");
 var HAPServer_1 = require("./HAPServer");
 var clone_1 = require("./util/clone");
@@ -12,6 +12,9 @@ var once_1 = require("./util/once");
 var request_util_1 = require("./util/request-util");
 var uuid_1 = require("./util/uuid");
 var debug = (0, debug_1.default)("HAP-NodeJS:Characteristic");
+/**
+ * @group Characteristic
+ */
 var Formats;
 (function (Formats) {
     Formats["BOOL"] = "bool";
@@ -60,6 +63,9 @@ var Formats;
      */
     Formats["DICTIONARY"] = "dict";
 })(Formats = exports.Formats || (exports.Formats = {}));
+/**
+ * @group Characteristic
+ */
 var Units;
 (function (Units) {
     /**
@@ -73,6 +79,9 @@ var Units;
     Units["LUX"] = "lux";
     Units["SECONDS"] = "seconds";
 })(Units = exports.Units || (exports.Units = {}));
+/**
+ * @group Characteristic
+ */
 var Perms;
 (function (Perms) {
     // noinspection JSUnusedGlobalSymbols
@@ -93,12 +102,23 @@ var Perms;
     Perms["HIDDEN"] = "hd";
     Perms["WRITE_RESPONSE"] = "wr";
 })(Perms = exports.Perms || (exports.Perms = {}));
+/**
+ * Describes the abstract access to a {@link Characteristic}.
+ * It abstracts the more granular access described by {@link Perms}.
+ *
+ * It is used in {@link CharacteristicProps.adminOnlyAccess}.
+ *
+ * @group Characteristic
+ */
 var Access;
 (function (Access) {
     Access[Access["READ"] = 0] = "READ";
     Access[Access["WRITE"] = 1] = "WRITE";
     Access[Access["NOTIFY"] = 2] = "NOTIFY";
 })(Access = exports.Access || (exports.Access = {}));
+/**
+ * @group Characteristic
+ */
 var ChangeReason;
 (function (ChangeReason) {
     /**
@@ -110,7 +130,7 @@ var ChangeReason;
      */
     ChangeReason["UPDATE"] = "update";
     /**
-     * Used when HomeKit reads a value or the API user calls the deprecated method {@link Characteristic.getValue}.
+     * Used when HomeKit reads a value or the API user calls the deprecated method `Characteristic.getValue`.
      */
     ChangeReason["READ"] = "read";
     /**
@@ -118,6 +138,9 @@ var ChangeReason;
      */
     ChangeReason["EVENT"] = "event";
 })(ChangeReason = exports.ChangeReason || (exports.ChangeReason = {}));
+/**
+ * @group Characteristic
+ */
 var CharacteristicEventTypes;
 (function (CharacteristicEventTypes) {
     /**
@@ -152,6 +175,9 @@ var CharacteristicEventTypes;
      */
     CharacteristicEventTypes["CHARACTERISTIC_WARNING"] = "characteristic-warning";
 })(CharacteristicEventTypes = exports.CharacteristicEventTypes || (exports.CharacteristicEventTypes = {}));
+/**
+ * @group Characteristic
+ */
 var ValidValuesIterable = /** @class */ (function () {
     function ValidValuesIterable(props) {
         (0, assert_1.default)((0, request_util_1.isNumericFormat)(props.format), "Cannot instantiate valid values iterable when format is not numeric. Found " + props.format);
@@ -160,14 +186,14 @@ var ValidValuesIterable = /** @class */ (function () {
     ValidValuesIterable.prototype[Symbol.iterator] = function () {
         var _a, _b, value, e_1_1, min, max, stepValue, i;
         var e_1, _c;
-        return (0, tslib_1.__generator)(this, function (_d) {
+        return tslib_1.__generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
                     if (!this.props.validValues) return [3 /*break*/, 9];
                     _d.label = 1;
                 case 1:
                     _d.trys.push([1, 6, 7, 8]);
-                    _a = (0, tslib_1.__values)(this.props.validValues), _b = _a.next();
+                    _a = tslib_1.__values(this.props.validValues), _b = _a.next();
                     _d.label = 2;
                 case 2:
                     if (!!_b.done) return [3 /*break*/, 5];
@@ -231,7 +257,7 @@ var ValidValuesIterable = /** @class */ (function () {
 }());
 var numberPattern = /^-?\d+$/;
 function extractHAPStatusFromError(error) {
-    var errorValue = -70402 /* SERVICE_COMMUNICATION_FAILURE */;
+    var errorValue = -70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */;
     if (numberPattern.test(error.message)) {
         var value = parseInt(error.message, 10);
         if ((0, HAPServer_1.IsKnownHAPStatusError)(value)) {
@@ -271,9 +297,11 @@ function minWithUndefined(a, b) {
  *
  * You can also define custom Characteristics by providing your own UUID. Custom Characteristics can be added
  * to any native or custom Services, but Siri will likely not be able to work with these.
+ *
+ * @group Characteristic
  */
 var Characteristic = /** @class */ (function (_super) {
-    (0, tslib_1.__extends)(Characteristic, _super);
+    tslib_1.__extends(Characteristic, _super);
     function Characteristic(displayName, UUID, props) {
         var _this = _super.call(this) || this;
         _this.iid = null;
@@ -286,13 +314,13 @@ var Characteristic = /** @class */ (function (_super) {
         /**
          * @private
          */
-        _this.statusCode = 0 /* SUCCESS */;
+        _this.statusCode = 0 /* HAPStatus.SUCCESS */;
         _this.subscriptions = 0;
         _this.displayName = displayName;
         _this.UUID = UUID;
         _this.props = {
-            format: "int" /* INT */,
-            perms: ["ev" /* NOTIFY */],
+            format: "int" /* Formats.INT */,
+            perms: ["ev" /* Perms.NOTIFY */],
         };
         _this.setProps(props || {}); // ensure sanity checks are called
         return _this;
@@ -386,22 +414,22 @@ var Characteristic = /** @class */ (function (_super) {
                 props.minValue = undefined;
             }
             else if (!(0, request_util_1.isNumericFormat)(this.props.format)) {
-                this.characteristicWarning("Characteristic Property 'minValue' can only be set for characteristics with numeric format, but not for " + this.props.format, "error-message" /* ERROR_MESSAGE */);
+                this.characteristicWarning("Characteristic Property 'minValue' can only be set for characteristics with numeric format, but not for " + this.props.format, "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                 props.minValue = undefined;
             }
             else if (typeof props.minValue !== "number" || !Number.isFinite(props.minValue)) {
-                this.characteristicWarning("Characteristic Property 'minValue' must be a finite number, received \"".concat(props.minValue, "\" (").concat(typeof props.minValue, ")"), "error-message" /* ERROR_MESSAGE */);
+                this.characteristicWarning("Characteristic Property 'minValue' must be a finite number, received \"".concat(props.minValue, "\" (").concat(typeof props.minValue, ")"), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                 props.minValue = undefined;
             }
             else {
                 if (props.minValue < (0, request_util_1.numericLowerBound)(this.props.format)) {
                     this.characteristicWarning("Characteristic Property 'minValue' was set to " + props.minValue + ", but for numeric format " +
-                        this.props.format + " minimum possible is " + (0, request_util_1.numericLowerBound)(this.props.format), "error-message" /* ERROR_MESSAGE */);
+                        this.props.format + " minimum possible is " + (0, request_util_1.numericLowerBound)(this.props.format), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                     props.minValue = (0, request_util_1.numericLowerBound)(this.props.format);
                 }
                 else if (props.minValue > (0, request_util_1.numericUpperBound)(this.props.format)) {
                     this.characteristicWarning("Characteristic Property 'minValue' was set to " + props.minValue + ", but for numeric format " +
-                        this.props.format + " maximum possible is " + (0, request_util_1.numericUpperBound)(this.props.format), "error-message" /* ERROR_MESSAGE */);
+                        this.props.format + " maximum possible is " + (0, request_util_1.numericUpperBound)(this.props.format), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                     props.minValue = (0, request_util_1.numericLowerBound)(this.props.format);
                 }
             }
@@ -413,22 +441,22 @@ var Characteristic = /** @class */ (function (_super) {
                 props.maxValue = undefined;
             }
             else if (!(0, request_util_1.isNumericFormat)(this.props.format)) {
-                this.characteristicWarning("Characteristic Property 'maxValue' can only be set for characteristics with numeric format, but not for " + this.props.format, "error-message" /* ERROR_MESSAGE */);
+                this.characteristicWarning("Characteristic Property 'maxValue' can only be set for characteristics with numeric format, but not for " + this.props.format, "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                 props.maxValue = undefined;
             }
             else if (typeof props.maxValue !== "number" || !Number.isFinite(props.maxValue)) {
-                this.characteristicWarning("Characteristic Property 'maxValue' must be a finite number, received \"".concat(props.maxValue, "\" (").concat(typeof props.maxValue, ")"), "error-message" /* ERROR_MESSAGE */);
+                this.characteristicWarning("Characteristic Property 'maxValue' must be a finite number, received \"".concat(props.maxValue, "\" (").concat(typeof props.maxValue, ")"), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                 props.maxValue = undefined;
             }
             else {
                 if (props.maxValue > (0, request_util_1.numericUpperBound)(this.props.format)) {
                     this.characteristicWarning("Characteristic Property 'maxValue' was set to " + props.maxValue + ", but for numeric format " +
-                        this.props.format + " maximum possible is " + (0, request_util_1.numericUpperBound)(this.props.format), "error-message" /* ERROR_MESSAGE */);
+                        this.props.format + " maximum possible is " + (0, request_util_1.numericUpperBound)(this.props.format), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                     props.maxValue = (0, request_util_1.numericUpperBound)(this.props.format);
                 }
                 else if (props.maxValue < (0, request_util_1.numericLowerBound)(this.props.format)) {
                     this.characteristicWarning("Characteristic Property 'maxValue' was set to " + props.maxValue + ", but for numeric format " +
-                        this.props.format + " minimum possible is " + (0, request_util_1.numericLowerBound)(this.props.format), "error-message" /* ERROR_MESSAGE */);
+                        this.props.format + " minimum possible is " + (0, request_util_1.numericLowerBound)(this.props.format), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                     props.maxValue = (0, request_util_1.numericUpperBound)(this.props.format);
                 }
             }
@@ -439,7 +467,7 @@ var Characteristic = /** @class */ (function (_super) {
                 this.props.minStep = undefined;
             }
             else if (!(0, request_util_1.isNumericFormat)(this.props.format)) {
-                this.characteristicWarning("Characteristic Property `minStep` can only be set for characteristics with numeric format, but not for " + this.props.format, "error-message" /* ERROR_MESSAGE */);
+                this.characteristicWarning("Characteristic Property `minStep` can only be set for characteristics with numeric format, but not for " + this.props.format, "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
             }
             else {
                 if (props.minStep < 1 && (0, request_util_1.isIntegerNumericFormat)(this.props.format)) {
@@ -453,8 +481,8 @@ var Characteristic = /** @class */ (function (_super) {
             if (props.maxLen === null) {
                 this.props.maxLen = undefined;
             }
-            else if (this.props.format !== "string" /* STRING */) {
-                this.characteristicWarning("Characteristic Property `maxLen` can only be set for characteristics with format `STRING`, but not for " + this.props.format, "error-message" /* ERROR_MESSAGE */);
+            else if (this.props.format !== "string" /* Formats.STRING */) {
+                this.characteristicWarning("Characteristic Property `maxLen` can only be set for characteristics with format `STRING`, but not for " + this.props.format, "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
             }
             else {
                 if (props.maxLen > 256) {
@@ -468,8 +496,8 @@ var Characteristic = /** @class */ (function (_super) {
             if (props.maxDataLen === null) {
                 this.props.maxDataLen = undefined;
             }
-            else if (this.props.format !== "data" /* DATA */) {
-                this.characteristicWarning("Characteristic Property `maxDataLen` can only be set for characteristics with format `DATA`, but not for " + this.props.format, "error-message" /* ERROR_MESSAGE */);
+            else if (this.props.format !== "data" /* Formats.DATA */) {
+                this.characteristicWarning("Characteristic Property `maxDataLen` can only be set for characteristics with format `DATA`, but not for " + this.props.format, "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
             }
             else {
                 this.props.maxDataLen = props.maxDataLen;
@@ -509,10 +537,10 @@ var Characteristic = /** @class */ (function (_super) {
                 throw new Error("Error setting CharacteristicsProps for '" + this.displayName + "': 'minValue' cannot be greater or equal the 'maxValue'!");
             }
         }
-        if (((0, request_util_1.isNumericFormat)(this.props.format) || this.props.format === "string" /* STRING */)
+        if (((0, request_util_1.isNumericFormat)(this.props.format) || this.props.format === "string" /* Formats.STRING */)
             && this.value != null
             && !formatDidChange
-            && this.statusCode === 0 /* SUCCESS */
+            && this.statusCode === 0 /* HAPStatus.SUCCESS */
             && this.UUID !== Characteristic.ProgrammableSwitchEvent.UUID) {
             // explaining the if statement above:
             // - We only do a check for numeric and string formats as they are the only ones affected by characteristic property restrictions.
@@ -521,7 +549,7 @@ var Characteristic = /** @class */ (function (_super) {
             // - If the characteristic is marked as erroneous the value is not considered valid anyway, and we must not remove the `statusCode`.
             // - Special case for `ProgrammableSwitchEvent` where every change in value is considered an event which would result in ghost button presses
             // validateUserInput when called from setProps is intended to clamp value withing allowed range. It is why warnings should not be displayed.
-            var correctedValue = this.validateUserInput(this.value, "debug-message" /* DEBUG_MESSAGE */);
+            var correctedValue = this.validateUserInput(this.value, "debug-message" /* CharacteristicWarningType.DEBUG_MESSAGE */);
             if (correctedValue !== this.value) {
                 // we don't want to emit a CHANGE event if the value didn't change at all!
                 this.updateValue(correctedValue);
@@ -578,8 +606,8 @@ var Characteristic = /** @class */ (function (_super) {
      * @param handler - Handler called to check additional authorization data.
      */
     Characteristic.prototype.setupAdditionalAuthorization = function (handler) {
-        if (!this.props.perms.includes("aa" /* ADDITIONAL_AUTHORIZATION */)) {
-            this.props.perms.push("aa" /* ADDITIONAL_AUTHORIZATION */);
+        if (!this.props.perms.includes("aa" /* Perms.ADDITIONAL_AUTHORIZATION */)) {
+            this.props.perms.push("aa" /* Perms.ADDITIONAL_AUTHORIZATION */);
         }
         this.additionalAuthorizationHandler = handler;
     };
@@ -621,7 +649,7 @@ var Characteristic = /** @class */ (function (_super) {
             value = this.validateUserInput(value);
         }
         catch (error) {
-            this.characteristicWarning((error === null || error === void 0 ? void 0 : error.message) + "", "error-message" /* ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
+            this.characteristicWarning((error === null || error === void 0 ? void 0 : error.message) + "", "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
             if (callback) {
                 callback(error);
             }
@@ -661,13 +689,13 @@ var Characteristic = /** @class */ (function (_super) {
             value = this.validateUserInput(value);
         }
         catch (error) {
-            this.characteristicWarning((error === null || error === void 0 ? void 0 : error.message) + "", "error-message" /* ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
+            this.characteristicWarning((error === null || error === void 0 ? void 0 : error.message) + "", "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
             if (callback) {
                 callback();
             }
             return this;
         }
-        this.statusCode = 0 /* SUCCESS */;
+        this.statusCode = 0 /* HAPStatus.SUCCESS */;
         // noinspection JSDeprecatedSymbols
         this.status = null;
         var oldValue = this.value;
@@ -675,7 +703,7 @@ var Characteristic = /** @class */ (function (_super) {
         if (callback) {
             callback();
         }
-        this.emit("change" /* CHANGE */, { originator: undefined, oldValue: oldValue, newValue: value, reason: "update" /* UPDATE */, context: context });
+        this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: undefined, oldValue: oldValue, newValue: value, reason: "update" /* ChangeReason.UPDATE */, context: context });
         return this; // for chaining
     };
     /**
@@ -688,13 +716,13 @@ var Characteristic = /** @class */ (function (_super) {
      * @param context - Passed to the {@link CharacteristicEventTypes.CHANGE} event handler.
      */
     Characteristic.prototype.sendEventNotification = function (value, context) {
-        this.statusCode = 0 /* SUCCESS */;
+        this.statusCode = 0 /* HAPStatus.SUCCESS */;
         // noinspection JSDeprecatedSymbols
         this.status = null;
         value = this.validateUserInput(value);
         var oldValue = this.value;
         this.value = value;
-        this.emit("change" /* CHANGE */, { originator: undefined, oldValue: oldValue, newValue: value, reason: "event" /* EVENT */, context: context });
+        this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: undefined, oldValue: oldValue, newValue: value, reason: "event" /* ChangeReason.EVENT */, context: context });
         return this; // for chaining
     };
     /**
@@ -705,21 +733,21 @@ var Characteristic = /** @class */ (function (_super) {
      * @private Used by the Accessory to load the characteristic value
      */
     Characteristic.prototype.handleGetRequest = function (connection, context) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
             var value, oldValue, error_1, hapStatusError;
             var _this = this;
-            return (0, tslib_1.__generator)(this, function (_a) {
+            return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (!this.props.perms.includes("pr" /* PAIRED_READ */)) { // check if we are allowed to read from this characteristic
-                            throw -70405 /* WRITE_ONLY_CHARACTERISTIC */;
+                        if (!this.props.perms.includes("pr" /* Perms.PAIRED_READ */)) { // check if we are allowed to read from this characteristic
+                            throw -70405 /* HAPStatus.WRITE_ONLY_CHARACTERISTIC */;
                         }
                         if (this.UUID === Characteristic.ProgrammableSwitchEvent.UUID) {
                             // special workaround for event only programmable switch event, which must always return null
                             return [2 /*return*/, null];
                         }
                         if (!this.getHandler) return [3 /*break*/, 4];
-                        if (this.listeners("get" /* GET */).length > 0) {
+                        if (this.listeners("get" /* CharacteristicEventTypes.GET */).length > 0) {
                             this.characteristicWarning("Ignoring on('get') handler as onGet handler was defined instead");
                         }
                         _a.label = 1;
@@ -728,23 +756,23 @@ var Characteristic = /** @class */ (function (_super) {
                         return [4 /*yield*/, this.getHandler(context, connection)];
                     case 2:
                         value = _a.sent();
-                        this.statusCode = 0 /* SUCCESS */;
+                        this.statusCode = 0 /* HAPStatus.SUCCESS */;
                         // noinspection JSDeprecatedSymbols
                         this.status = null;
                         try {
                             value = this.validateUserInput(value);
                         }
                         catch (error) {
-                            this.characteristicWarning("An illegal value was supplied by the read handler for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "warn-message" /* WARN_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
-                            this.statusCode = -70402 /* SERVICE_COMMUNICATION_FAILURE */;
+                            this.characteristicWarning("An illegal value was supplied by the read handler for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "warn-message" /* CharacteristicWarningType.WARN_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
+                            this.statusCode = -70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */;
                             // noinspection JSDeprecatedSymbols
                             this.status = error;
-                            return [2 /*return*/, Promise.reject(-70402 /* SERVICE_COMMUNICATION_FAILURE */)];
+                            return [2 /*return*/, Promise.reject(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */)];
                         }
                         oldValue = this.value;
                         this.value = value;
                         if (oldValue !== value) { // emit a change event if necessary
-                            this.emit("change" /* CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "read" /* READ */, context: context });
+                            this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "read" /* ChangeReason.READ */, context: context });
                         }
                         return [2 /*return*/, value];
                     case 3:
@@ -761,14 +789,14 @@ var Characteristic = /** @class */ (function (_super) {
                             this.status = error_1;
                         }
                         else {
-                            this.characteristicWarning("Unhandled error thrown inside read handler for characteristic: ".concat(error_1 === null || error_1 === void 0 ? void 0 : error_1.message), "error-message" /* ERROR_MESSAGE */, error_1 === null || error_1 === void 0 ? void 0 : error_1.stack);
-                            this.statusCode = -70402 /* SERVICE_COMMUNICATION_FAILURE */;
+                            this.characteristicWarning("Unhandled error thrown inside read handler for characteristic: ".concat(error_1 === null || error_1 === void 0 ? void 0 : error_1.message), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */, error_1 === null || error_1 === void 0 ? void 0 : error_1.stack);
+                            this.statusCode = -70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */;
                             // noinspection JSDeprecatedSymbols
                             this.status = error_1;
                         }
                         throw this.statusCode;
                     case 4:
-                        if (this.listeners("get" /* GET */).length === 0) {
+                        if (this.listeners("get" /* CharacteristicEventTypes.GET */).length === 0) {
                             if (this.statusCode) {
                                 throw this.statusCode;
                             }
@@ -776,13 +804,13 @@ var Characteristic = /** @class */ (function (_super) {
                                 return [2 /*return*/, this.validateUserInput(this.value)];
                             }
                             catch (error) {
-                                this.characteristicWarning("An illegal value was supplied by setting `value` for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "warn-message" /* WARN_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
-                                return [2 /*return*/, Promise.reject(-70402 /* SERVICE_COMMUNICATION_FAILURE */)];
+                                this.characteristicWarning("An illegal value was supplied by setting `value` for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "warn-message" /* CharacteristicWarningType.WARN_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
+                                return [2 /*return*/, Promise.reject(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */)];
                             }
                         }
                         return [2 /*return*/, new Promise(function (resolve, reject) {
                                 try {
-                                    _this.emit("get" /* GET */, (0, once_1.once)(function (status, value) {
+                                    _this.emit("get" /* CharacteristicEventTypes.GET */, (0, once_1.once)(function (status, value) {
                                         if (status) {
                                             if (typeof status === "number") {
                                                 var hapStatusError = new hapStatusError_1.HapStatusError(status);
@@ -804,7 +832,7 @@ var Characteristic = /** @class */ (function (_super) {
                                             reject(_this.statusCode);
                                             return;
                                         }
-                                        _this.statusCode = 0 /* SUCCESS */;
+                                        _this.statusCode = 0 /* HAPStatus.SUCCESS */;
                                         // noinspection JSDeprecatedSymbols
                                         _this.status = null;
                                         value = _this.validateUserInput(value);
@@ -812,16 +840,16 @@ var Characteristic = /** @class */ (function (_super) {
                                         _this.value = value;
                                         resolve(value);
                                         if (oldValue !== value) { // emit a change event if necessary
-                                            _this.emit("change" /* CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "read" /* READ */, context: context });
+                                            _this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "read" /* ChangeReason.READ */, context: context });
                                         }
                                     }), context, connection);
                                 }
                                 catch (error) {
-                                    _this.characteristicWarning("Unhandled error thrown inside read handler for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "error-message" /* ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
-                                    _this.statusCode = -70402 /* SERVICE_COMMUNICATION_FAILURE */;
+                                    _this.characteristicWarning("Unhandled error thrown inside read handler for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
+                                    _this.statusCode = -70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */;
                                     // noinspection JSDeprecatedSymbols
                                     _this.status = error;
-                                    reject(-70402 /* SERVICE_COMMUNICATION_FAILURE */);
+                                    reject(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
                                 }
                             })];
                 }
@@ -840,13 +868,13 @@ var Characteristic = /** @class */ (function (_super) {
      * @private
      */
     Characteristic.prototype.handleSetRequest = function (value, connection, context) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
             var oldValue, writeResponse, error_2, hapStatusError;
             var _this = this;
-            return (0, tslib_1.__generator)(this, function (_a) {
+            return tslib_1.__generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        this.statusCode = 0 /* SUCCESS */;
+                        this.statusCode = 0 /* HAPStatus.SUCCESS */;
                         // noinspection JSDeprecatedSymbols
                         this.status = null;
                         if (connection !== undefined) {
@@ -857,12 +885,12 @@ var Characteristic = /** @class */ (function (_super) {
                             }
                             catch (e) {
                                 debug("[".concat(this.displayName, "]"), e.message);
-                                return [2 /*return*/, Promise.reject(-70410 /* INVALID_VALUE_IN_REQUEST */)];
+                                return [2 /*return*/, Promise.reject(-70410 /* HAPStatus.INVALID_VALUE_IN_REQUEST */)];
                             }
                         }
                         oldValue = this.value;
                         if (!this.setHandler) return [3 /*break*/, 4];
-                        if (this.listeners("set" /* SET */).length > 0) {
+                        if (this.listeners("set" /* CharacteristicEventTypes.SET */).length > 0) {
                             this.characteristicWarning("Ignoring on('set') handler as onSet handler was defined instead");
                         }
                         _a.label = 1;
@@ -871,19 +899,19 @@ var Characteristic = /** @class */ (function (_super) {
                         return [4 /*yield*/, this.setHandler(value, context, connection)];
                     case 2:
                         writeResponse = _a.sent();
-                        this.statusCode = 0 /* SUCCESS */;
+                        this.statusCode = 0 /* HAPStatus.SUCCESS */;
                         // noinspection JSDeprecatedSymbols
                         this.status = null;
-                        if (writeResponse != null && this.props.perms.includes("wr" /* WRITE_RESPONSE */)) {
+                        if (writeResponse != null && this.props.perms.includes("wr" /* Perms.WRITE_RESPONSE */)) {
                             this.value = this.validateUserInput(writeResponse);
                             return [2 /*return*/, this.value];
                         }
                         else {
                             if (writeResponse != null) {
-                                this.characteristicWarning("SET handler returned write response value, though the characteristic doesn't support write response", "debug-message" /* DEBUG_MESSAGE */);
+                                this.characteristicWarning("SET handler returned write response value, though the characteristic doesn't support write response", "debug-message" /* CharacteristicWarningType.DEBUG_MESSAGE */);
                             }
                             this.value = value;
-                            this.emit("change" /* CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "write" /* WRITE */, context: context });
+                            this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "write" /* ChangeReason.WRITE */, context: context });
                             return [2 /*return*/];
                         }
                         return [3 /*break*/, 4];
@@ -901,22 +929,22 @@ var Characteristic = /** @class */ (function (_super) {
                             this.status = error_2;
                         }
                         else {
-                            this.characteristicWarning("Unhandled error thrown inside write handler for characteristic: ".concat(error_2 === null || error_2 === void 0 ? void 0 : error_2.message), "error-message" /* ERROR_MESSAGE */, error_2 === null || error_2 === void 0 ? void 0 : error_2.stack);
-                            this.statusCode = -70402 /* SERVICE_COMMUNICATION_FAILURE */;
+                            this.characteristicWarning("Unhandled error thrown inside write handler for characteristic: ".concat(error_2 === null || error_2 === void 0 ? void 0 : error_2.message), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */, error_2 === null || error_2 === void 0 ? void 0 : error_2.stack);
+                            this.statusCode = -70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */;
                             // noinspection JSDeprecatedSymbols
                             this.status = error_2;
                         }
                         throw this.statusCode;
                     case 4:
-                        if (this.listeners("set" /* SET */).length === 0) {
+                        if (this.listeners("set" /* CharacteristicEventTypes.SET */).length === 0) {
                             this.value = value;
-                            this.emit("change" /* CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "write" /* WRITE */, context: context });
+                            this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "write" /* ChangeReason.WRITE */, context: context });
                             return [2 /*return*/, Promise.resolve()];
                         }
                         else {
                             return [2 /*return*/, new Promise(function (resolve, reject) {
                                     try {
-                                        _this.emit("set" /* SET */, value, (0, once_1.once)(function (status, writeResponse) {
+                                        _this.emit("set" /* CharacteristicEventTypes.SET */, value, (0, once_1.once)(function (status, writeResponse) {
                                             if (status) {
                                                 if (typeof status === "number") {
                                                     var hapStatusError = new hapStatusError_1.HapStatusError(status);
@@ -938,30 +966,30 @@ var Characteristic = /** @class */ (function (_super) {
                                                 reject(_this.statusCode);
                                                 return;
                                             }
-                                            _this.statusCode = 0 /* SUCCESS */;
+                                            _this.statusCode = 0 /* HAPStatus.SUCCESS */;
                                             // noinspection JSDeprecatedSymbols
                                             _this.status = null;
-                                            if (writeResponse != null && _this.props.perms.includes("wr" /* WRITE_RESPONSE */)) {
+                                            if (writeResponse != null && _this.props.perms.includes("wr" /* Perms.WRITE_RESPONSE */)) {
                                                 // support write response simply by letting the implementor pass the response as second argument to the callback
                                                 _this.value = _this.validateUserInput(writeResponse);
                                                 resolve(_this.value);
                                             }
                                             else {
                                                 if (writeResponse != null) {
-                                                    _this.characteristicWarning("SET handler returned write response value, though the characteristic doesn't support write response", "debug-message" /* DEBUG_MESSAGE */);
+                                                    _this.characteristicWarning("SET handler returned write response value, though the characteristic doesn't support write response", "debug-message" /* CharacteristicWarningType.DEBUG_MESSAGE */);
                                                 }
                                                 _this.value = value;
                                                 resolve();
-                                                _this.emit("change" /* CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "write" /* WRITE */, context: context });
+                                                _this.emit("change" /* CharacteristicEventTypes.CHANGE */, { originator: connection, oldValue: oldValue, newValue: value, reason: "write" /* ChangeReason.WRITE */, context: context });
                                             }
                                         }), context, connection);
                                     }
                                     catch (error) {
-                                        _this.characteristicWarning("Unhandled error thrown inside write handler for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "error-message" /* ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
-                                        _this.statusCode = -70402 /* SERVICE_COMMUNICATION_FAILURE */;
+                                        _this.characteristicWarning("Unhandled error thrown inside write handler for characteristic: ".concat(error === null || error === void 0 ? void 0 : error.message), "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */, error === null || error === void 0 ? void 0 : error.stack);
+                                        _this.statusCode = -70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */;
                                         // noinspection JSDeprecatedSymbols
                                         _this.status = error;
-                                        reject(-70402 /* SERVICE_COMMUNICATION_FAILURE */);
+                                        reject(-70402 /* HAPStatus.SERVICE_COMMUNICATION_FAILURE */);
                                     }
                                 })];
                         }
@@ -976,7 +1004,7 @@ var Characteristic = /** @class */ (function (_super) {
      */
     Characteristic.prototype.subscribe = function () {
         if (this.subscriptions === 0) {
-            this.emit("subscribe" /* SUBSCRIBE */);
+            this.emit("subscribe" /* CharacteristicEventTypes.SUBSCRIBE */);
         }
         this.subscriptions++;
     };
@@ -990,16 +1018,16 @@ var Characteristic = /** @class */ (function (_super) {
         this.subscriptions--;
         this.subscriptions = Math.max(this.subscriptions, 0);
         if (wasOne) {
-            this.emit("unsubscribe" /* UNSUBSCRIBE */);
+            this.emit("unsubscribe" /* CharacteristicEventTypes.UNSUBSCRIBE */);
         }
     };
     Characteristic.prototype.getDefaultValue = function () {
         var _a;
         // noinspection JSDeprecatedSymbols
         switch (this.props.format) {
-            case "bool" /* BOOL */:
+            case "bool" /* Formats.BOOL */:
                 return false;
-            case "string" /* STRING */:
+            case "string" /* Formats.STRING */:
                 switch (this.UUID) {
                     case Characteristic.Manufacturer.UUID:
                         return "Default-Manufacturer";
@@ -1012,20 +1040,20 @@ var Characteristic = /** @class */ (function (_super) {
                     default:
                         return "";
                 }
-            case "data" /* DATA */:
+            case "data" /* Formats.DATA */:
                 return ""; // who knows!
-            case "tlv8" /* TLV8 */:
+            case "tlv8" /* Formats.TLV8 */:
                 return ""; // who knows!
-            case "dict" /* DICTIONARY */:
+            case "dict" /* Formats.DICTIONARY */:
                 return {};
-            case "array" /* ARRAY */:
+            case "array" /* Formats.ARRAY */:
                 return [];
-            case "int" /* INT */:
-            case "float" /* FLOAT */:
-            case "uint8" /* UINT8 */:
-            case "uint16" /* UINT16 */:
-            case "uint32" /* UINT32 */:
-            case "uint64" /* UINT64 */:
+            case "int" /* Formats.INT */:
+            case "float" /* Formats.FLOAT */:
+            case "uint8" /* Formats.UINT8 */:
+            case "uint16" /* Formats.UINT16 */:
+            case "uint32" /* Formats.UINT32 */:
+            case "uint64" /* Formats.UINT64 */:
                 switch (this.UUID) {
                     case Characteristic.CurrentTemperature.UUID:
                         return 0; // some existing integrations expect this to be 0 by default
@@ -1054,7 +1082,7 @@ var Characteristic = /** @class */ (function (_super) {
             throw new Error("Client supplied invalid value for ".concat(this.props.format, ": ").concat(value));
         }
         switch (this.props.format) {
-            case "bool" /* BOOL */: {
+            case "bool" /* Formats.BOOL */: {
                 if (typeof value === "boolean") {
                     return value;
                 }
@@ -1063,12 +1091,12 @@ var Characteristic = /** @class */ (function (_super) {
                 }
                 throw new Error("Client supplied invalid type for ".concat(this.props.format, ": \"").concat(value, "\" (").concat(typeof value, ")"));
             }
-            case "int" /* INT */:
-            case "float" /* FLOAT */:
-            case "uint8" /* UINT8 */:
-            case "uint16" /* UINT16 */:
-            case "uint32" /* UINT32 */:
-            case "uint64" /* UINT64 */: {
+            case "int" /* Formats.INT */:
+            case "float" /* Formats.FLOAT */:
+            case "uint8" /* Formats.UINT8 */:
+            case "uint16" /* Formats.UINT16 */:
+            case "uint32" /* Formats.UINT32 */:
+            case "uint64" /* Formats.UINT64 */: {
                 if (typeof value === "boolean") {
                     value = value ? 1 : 0;
                 }
@@ -1096,7 +1124,7 @@ var Characteristic = /** @class */ (function (_super) {
                 }
                 return value;
             }
-            case "string" /* STRING */: {
+            case "string" /* Formats.STRING */: {
                 if (typeof value !== "string") {
                     throw new Error("Client supplied invalid type for ".concat(this.props.format, ": \"").concat(value, "\" (").concat(typeof value, ")"));
                 }
@@ -1106,7 +1134,7 @@ var Characteristic = /** @class */ (function (_super) {
                 }
                 return value;
             }
-            case "data" /* DATA */: {
+            case "data" /* Formats.DATA */: {
                 if (typeof value !== "string") {
                     throw new Error("Client supplied invalid type for ".concat(this.props.format, ": \"").concat(value, "\" (").concat(typeof value, ")"));
                 }
@@ -1117,7 +1145,7 @@ var Characteristic = /** @class */ (function (_super) {
                 }
                 return value;
             }
-            case "tlv8" /* TLV8 */:
+            case "tlv8" /* Formats.TLV8 */:
                 if (typeof value !== "string") {
                     throw new Error("Client supplied invalid type for ".concat(this.props.format, ": \"").concat(value, "\" (").concat(typeof value, ")"));
                 }
@@ -1135,13 +1163,13 @@ var Characteristic = /** @class */ (function (_super) {
      */
     Characteristic.prototype.validateUserInput = function (value, warningType) {
         var _a;
-        if (warningType === void 0) { warningType = "warn-message" /* WARN_MESSAGE */; }
+        if (warningType === void 0) { warningType = "warn-message" /* CharacteristicWarningType.WARN_MESSAGE */; }
         if (value === null) {
             if (this.UUID === Characteristic.Model.UUID || this.UUID === Characteristic.SerialNumber.UUID) { // mirrors the statement in case: Formats.STRING
-                this.characteristicWarning("characteristic must have a non null value otherwise HomeKit will reject this accessory, ignoring new value", "error-message" /* ERROR_MESSAGE */);
+                this.characteristicWarning("characteristic must have a non null value otherwise HomeKit will reject this accessory, ignoring new value", "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
                 return this.value; // don't change the value
             }
-            if (this.props.format === "data" /* DATA */ || this.props.format === "tlv8" /* TLV8 */) {
+            if (this.props.format === "data" /* Formats.DATA */ || this.props.format === "tlv8" /* Formats.TLV8 */) {
                 return value; // TLV8 and DATA formats are allowed to have null as a value
             }
             /**
@@ -1170,7 +1198,7 @@ var Characteristic = /** @class */ (function (_super) {
             }
         }
         switch (this.props.format) {
-            case "bool" /* BOOL */: {
+            case "bool" /* Formats.BOOL */: {
                 if (typeof value === "boolean") {
                     return value;
                 }
@@ -1183,17 +1211,17 @@ var Characteristic = /** @class */ (function (_super) {
                 this.characteristicWarning("characteristic value expected boolean and received " + typeof value, warningType);
                 return false;
             }
-            case "int" /* INT */:
-            case "float" /* FLOAT */:
-            case "uint8" /* UINT8 */:
-            case "uint16" /* UINT16 */:
-            case "uint32" /* UINT32 */:
-            case "uint64" /* UINT64 */: {
+            case "int" /* Formats.INT */:
+            case "float" /* Formats.FLOAT */:
+            case "uint8" /* Formats.UINT8 */:
+            case "uint16" /* Formats.UINT16 */:
+            case "uint32" /* Formats.UINT32 */:
+            case "uint64" /* Formats.UINT64 */: {
                 if (typeof value === "boolean") {
                     value = value ? 1 : 0;
                 }
                 if (typeof value === "string") {
-                    value = this.props.format === "float" /* FLOAT */ ? parseFloat(value) : parseInt(value, 10);
+                    value = this.props.format === "float" /* Formats.FLOAT */ ? parseFloat(value) : parseInt(value, 10);
                 }
                 if (typeof value !== "number" || !Number.isFinite(value)) {
                     this.characteristicWarning("characteristic value expected valid finite number and received \"".concat(value, "\" (").concat(typeof value, ")"), warningType);
@@ -1202,7 +1230,7 @@ var Characteristic = /** @class */ (function (_super) {
                 var numericMin = maxWithUndefined(this.props.minValue, (0, request_util_1.numericLowerBound)(this.props.format));
                 var numericMax = minWithUndefined(this.props.maxValue, (0, request_util_1.numericUpperBound)(this.props.format));
                 var stepValue = undefined;
-                if (this.props.format === "float" /* FLOAT */) {
+                if (this.props.format === "float" /* Formats.FLOAT */) {
                     stepValue = this.props.minStep;
                 }
                 else {
@@ -1236,7 +1264,7 @@ var Characteristic = /** @class */ (function (_super) {
                 }
                 return value;
             }
-            case "string" /* STRING */: {
+            case "string" /* Formats.STRING */: {
                 if (typeof value === "number") {
                     this.characteristicWarning("characteristic was supplied illegal value: number instead of string, " +
                         "supplying illegal values will throw errors in the future", warningType);
@@ -1258,7 +1286,7 @@ var Characteristic = /** @class */ (function (_super) {
                 }
                 return value;
             }
-            case "data" /* DATA */:
+            case "data" /* Formats.DATA */:
                 if (typeof value !== "string") {
                     throw new Error("characteristic with DATA format must have string value");
                 }
@@ -1267,7 +1295,7 @@ var Characteristic = /** @class */ (function (_super) {
                     throw new Error("characteristic with DATA format exceeds specified maxDataLen");
                 }
                 return value;
-            case "tlv8" /* TLV8 */:
+            case "tlv8" /* Formats.TLV8 */:
                 if (value === undefined) {
                     this.characteristicWarning("characteristic was supplied illegal value: undefined", warningType);
                     return this.value;
@@ -1276,7 +1304,7 @@ var Characteristic = /** @class */ (function (_super) {
         }
         // hopefully it shouldn't get to this point
         if (value === undefined) {
-            this.characteristicWarning("characteristic was supplied illegal value: undefined", "error-message" /* ERROR_MESSAGE */);
+            this.characteristicWarning("characteristic was supplied illegal value: undefined", "error-message" /* CharacteristicWarningType.ERROR_MESSAGE */);
             return this.value;
         }
         return value;
@@ -1289,9 +1317,9 @@ var Characteristic = /** @class */ (function (_super) {
         this.iid = identifierCache.getIID(accessoryName, serviceUUID, serviceSubtype, this.UUID);
     };
     Characteristic.prototype.characteristicWarning = function (message, type, stack) {
-        if (type === void 0) { type = "warn-message" /* WARN_MESSAGE */; }
+        if (type === void 0) { type = "warn-message" /* CharacteristicWarningType.WARN_MESSAGE */; }
         if (stack === void 0) { stack = new Error().stack; }
-        this.emit("characteristic-warning" /* CHARACTERISTIC_WARNING */, type, message, stack);
+        this.emit("characteristic-warning" /* CharacteristicEventTypes.CHARACTERISTIC_WARNING */, type, message, stack);
     };
     /**
      * @param event
@@ -1312,23 +1340,23 @@ var Characteristic = /** @class */ (function (_super) {
         var _this = this;
         this.props = characteristic.props;
         this.updateValue(characteristic.value);
-        var getListeners = characteristic.listeners("get" /* GET */);
+        var getListeners = characteristic.listeners("get" /* CharacteristicEventTypes.GET */);
         if (getListeners.length) {
             // the callback can only be called once, so we remove all old listeners
-            this.removeAllListeners("get" /* GET */);
+            this.removeAllListeners("get" /* CharacteristicEventTypes.GET */);
             // @ts-expect-error: force type
-            getListeners.forEach(function (listener) { return _this.addListener("get" /* GET */, listener); });
+            getListeners.forEach(function (listener) { return _this.addListener("get" /* CharacteristicEventTypes.GET */, listener); });
         }
         this.removeOnGet();
         if (characteristic.getHandler) {
             this.onGet(characteristic.getHandler);
         }
-        var setListeners = characteristic.listeners("set" /* SET */);
+        var setListeners = characteristic.listeners("set" /* CharacteristicEventTypes.SET */);
         if (setListeners.length) {
             // the callback can only be called once, so we remove all old listeners
-            this.removeAllListeners("set" /* SET */);
+            this.removeAllListeners("set" /* CharacteristicEventTypes.SET */);
             // @ts-expect-error: force type
-            setListeners.forEach(function (listener) { return _this.addListener("set" /* SET */, listener); });
+            setListeners.forEach(function (listener) { return _this.addListener("set" /* CharacteristicEventTypes.SET */, listener); });
         }
         this.removeOnSet();
         if (characteristic.setHandler) {
@@ -1341,14 +1369,14 @@ var Characteristic = /** @class */ (function (_super) {
      */
     Characteristic.prototype.toHAP = function (connection, contactGetHandlers) {
         if (contactGetHandlers === void 0) { contactGetHandlers = true; }
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
             var object, value, _a;
             var _this = this;
-            return (0, tslib_1.__generator)(this, function (_b) {
+            return tslib_1.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         object = this.internalHAPRepresentation();
-                        if (!!this.props.perms.includes("pr" /* PAIRED_READ */)) return [3 /*break*/, 1];
+                        if (!!this.props.perms.includes("pr" /* Perms.PAIRED_READ */)) return [3 /*break*/, 1];
                         object.value = undefined;
                         return [3 /*break*/, 6];
                     case 1: