* added a way to fix bugged properties from the gateway reports

AlCalzone · AlCalzone · commit 98fbb79ebdff · 2018-03-09T18:21:46.000+01:00
* fix minimum brightness when lights are off
* added tests for that and repaired other ones
diff --git a/build/lib/accessory.d.ts b/build/lib/accessory.d.ts
@@ -18,4 +18,8 @@ export declare class Accessory extends IPSODevice {
     sensorList: Sensor[];
     switchList: IPSODevice[];
     otaUpdateState: number;
+    /**
+     * Fixes property values that are known to be bugged
+     */
+    fixBuggedProperties(): this;
 }
diff --git a/build/lib/accessory.js b/build/lib/accessory.js
@@ -63,6 +63,28 @@ class Accessory extends ipsoDevice_1.IPSODevice {
         }
         return this;
     }
+    /**
+     * Fixes property values that are known to be bugged
+     */
+    fixBuggedProperties() {
+        super.fixBuggedProperties();
+        if (this.lightList != null) {
+            this.lightList = this.lightList.map(light => light.fixBuggedProperties());
+        }
+        /* istanbul ignore next */
+        if (this.plugList != null) {
+            this.plugList = this.plugList.map(plug => plug.fixBuggedProperties());
+        }
+        /* istanbul ignore next */
+        if (this.sensorList != null) {
+            this.sensorList = this.sensorList.map(sensor => sensor.fixBuggedProperties());
+        }
+        /* istanbul ignore next */
+        if (this.switchList != null) {
+            this.switchList = this.switchList.map(swtch => swtch.fixBuggedProperties());
+        }
+        return this;
+    }
 }
 __decorate([
     ipsoObject_1.ipsoKey("5750"),
diff --git a/build/lib/conversions.js b/build/lib/conversions.js
@@ -216,9 +216,6 @@ const brightness_in = (value) => {
     if (value === 0)
         return 0;
     value = value / 254 * 100;
-    // Any value > 0 should equal at least 1% brightness
-    if (value < 1)
-        return 1;
     return math_1.roundTo(value, 1);
 };
 exports.serializers = {
diff --git a/build/lib/ipsoObject.d.ts b/build/lib/ipsoObject.d.ts
@@ -77,4 +77,8 @@ export declare class IPSOObject {
      */
     createProxy(get?: (me: this, key: PropertyKey) => any, set?: (me: this, key: PropertyKey, value: any, receiver: any) => boolean): this;
     protected client: OperationProvider;
+    /**
+     * Fixes property values that are known to be bugged
+     */
+    fixBuggedProperties(): this;
 }
diff --git a/build/lib/ipsoObject.js b/build/lib/ipsoObject.js
@@ -472,6 +472,13 @@ class IPSOObject {
         this.client = client;
         return this;
     }
+    /**
+     * Fixes property values that are known to be bugged
+     */
+    fixBuggedProperties() {
+        // IPSOObject has none
+        return this;
+    }
 }
 __decorate([
     exports.doNotSerialize,
diff --git a/build/lib/light.d.ts b/build/lib/light.d.ts
@@ -78,5 +78,9 @@ export declare class Light extends IPSODevice {
     setSaturation(value: number, transitionTime?: number): Promise<boolean>;
     /** Turns this object into JSON while leaving out the potential circular reference */
     toJSON(): {};
+    /**
+     * Fixes property values that are known to be bugged
+     */
+    fixBuggedProperties(): this;
 }
 export declare type Spectrum = "none" | "white" | "rgb";
diff --git a/build/lib/light.js b/build/lib/light.js
@@ -220,6 +220,16 @@ class Light extends ipsoDevice_1.IPSODevice {
             transitionTime: this.transitionTime,
         };
     }
+    /**
+     * Fixes property values that are known to be bugged
+     */
+    fixBuggedProperties() {
+        super.fixBuggedProperties();
+        // For some reason the gateway reports lights with brightness 1 after turning off
+        if (this.onOff === false && this.dimmer === MIN_BRIGHTNESS)
+            this.dimmer = 0;
+        return this;
+    }
 }
 __decorate([
     ipsoObject_1.doNotSerialize,
@@ -305,6 +315,8 @@ __decorate([
     __metadata("design:type", String)
 ], Light.prototype, "unit", void 0);
 exports.Light = Light;
+// remember the minimum possible non-zero brightness to fix the bugged properties;
+const MIN_BRIGHTNESS = conversions_1.deserializers.brightness(1);
 const rgbRegex = /^[0-9A-Fa-f]{6}$/;
 /**
  * Creates a proxy for an RGB lamp,
diff --git a/build/tradfri-client.js b/build/tradfri-client.js
@@ -255,7 +255,10 @@ class TradfriClient extends events_1.EventEmitter {
         const result = parsePayload(response);
         logger_1.log(`observeDevice > ` + JSON.stringify(result), "debug");
         // parse device info
-        const accessory = new accessory_1.Accessory(this.ipsoOptions).parse(result).createProxy();
+        const accessory = new accessory_1.Accessory(this.ipsoOptions)
+            .parse(result)
+            .fixBuggedProperties()
+            .createProxy();
         // remember the device object, so we can later use it as a reference for updates
         // store a clone, so we don't have to care what the calling library does
         this.devices[instanceId] = accessory.clone();
@@ -370,7 +373,10 @@ class TradfriClient extends events_1.EventEmitter {
         }
         const result = parsePayload(response);
         // parse group info
-        const group = (new group_1.Group(this.ipsoOptions)).parse(result).createProxy();
+        const group = new group_1.Group(this.ipsoOptions)
+            .parse(result)
+            .fixBuggedProperties()
+            .createProxy();
         // remember the group object, so we can later use it as a reference for updates
         let groupInfo;
         if (!(instanceId in this.groups)) {
@@ -450,7 +456,10 @@ class TradfriClient extends events_1.EventEmitter {
         }
         const result = parsePayload(response);
         // parse scene info
-        const scene = (new scene_1.Scene(this.ipsoOptions)).parse(result).createProxy();
+        const scene = new scene_1.Scene(this.ipsoOptions)
+            .parse(result)
+            .fixBuggedProperties()
+            .createProxy();
         // remember the scene object, so we can later use it as a reference for updates
         // store a clone, so we don't have to care what the calling library does
         this.groups[groupId].scenes[instanceId] = scene.clone();
diff --git a/src/lib/accessory.ts b/src/lib/accessory.ts
@@ -81,4 +81,27 @@ export class Accessory extends IPSODevice {
 		return this;
 	}
 
+	/**
+	 * Fixes property values that are known to be bugged
+	 */
+	public fixBuggedProperties(): this {
+		super.fixBuggedProperties();
+		if (this.lightList != null) {
+			this.lightList = this.lightList.map(light => light.fixBuggedProperties());
+		}
+		/* istanbul ignore next */
+		if (this.plugList != null) {
+			this.plugList = this.plugList.map(plug => plug.fixBuggedProperties());
+		}
+		/* istanbul ignore next */
+		if (this.sensorList != null) {
+			this.sensorList = this.sensorList.map(sensor => sensor.fixBuggedProperties());
+		}
+		/* istanbul ignore next */
+		if (this.switchList != null) {
+			this.switchList = this.switchList.map(swtch => swtch.fixBuggedProperties());
+		}
+		return this;
+	}
+
 }
diff --git a/src/lib/conversions.test.ts b/src/lib/conversions.test.ts
@@ -35,7 +35,7 @@ describe("tradfri/conversions => brightness() =>", () => {
 	// tslint:disable-next-line:variable-name
 	const testSets_in = [
 		{coap: 0, tradfri: 0},
-		{coap: 1, tradfri: 1},
+		{coap: 1, tradfri: 0.4},
 		{coap: 68, tradfri: 26.8},
 		{coap: 128, tradfri: 50.4},
 		{coap: 254, tradfri: 100},
diff --git a/src/lib/conversions.ts b/src/lib/conversions.ts
@@ -217,8 +217,6 @@ const brightness_in: PropertyTransformKernel = (value) => {
 	value = clamp(value, 0, 254);
 	if (value === 0) return 0;
 	value = value / 254 * 100;
-	// Any value > 0 should equal at least 1% brightness
-	if (value < 1) return 1;
 	return roundTo(value, 1);
 };
 
diff --git a/src/lib/ipsoObject.ts b/src/lib/ipsoObject.ts
@@ -535,4 +535,12 @@ export class IPSOObject {
 		return this;
 	}
 
+	/**
+	 * Fixes property values that are known to be bugged
+	 */
+	public fixBuggedProperties(): this {
+		// IPSOObject has none
+		return this;
+	}
+
 }
diff --git a/src/lib/light.ts b/src/lib/light.ts
@@ -307,8 +307,21 @@ export class Light extends IPSODevice {
 			transitionTime: this.transitionTime,
 		};
 	}
+
+	/**
+	 * Fixes property values that are known to be bugged
+	 */
+	public fixBuggedProperties(): this {
+		super.fixBuggedProperties();
+		// For some reason the gateway reports lights with brightness 1 after turning off
+		if (this.onOff === false && this.dimmer === MIN_BRIGHTNESS) this.dimmer = 0;
+		return this;
+	}
 }
 
+// remember the minimum possible non-zero brightness to fix the bugged properties;
+const MIN_BRIGHTNESS = deserializers.brightness(1);
+
 export type Spectrum = "none" | "white" | "rgb";
 
 const rgbRegex = /^[0-9A-Fa-f]{6}$/;
diff --git a/src/tradfri-client.test.ts b/src/tradfri-client.test.ts
@@ -386,6 +386,70 @@ describe("tradfri-client => observing devices => ", () => {
 
 });
 
+describe("tradfri-client => fixing properties => ", () => {
+
+	// Setup the mock
+	const {
+		tradfri,
+		devicesUrl,
+		fakeCoap,
+		callbacks,
+		createStubs,
+		restoreStubs,
+		resetStubHistory,
+	} = createNetworkMock();
+	before(createStubs);
+	after(restoreStubs);
+	afterEach(resetStubHistory);
+
+	it("when the gateway reports minimum brightness on a turned-off light, set it to zero instead", async () => {
+		// remember the deferred promise as this only resolves after all responses have been received
+		const devicesPromise = tradfri.observeDevices();
+		let theLight: Light;
+		tradfri.on("device updated", (acc) => theLight = acc.lightList[0]);
+
+		const devices = [65536];
+		await callbacks.observeDevices(createResponse(devices));
+
+		const respAccessory = createRGBBulb(65536);
+		respAccessory["3311"][0]["5850"] = 0;
+		respAccessory["3311"][0]["5851"] = 1;
+		await callbacks.observeDevice[65536](createResponse(respAccessory));
+
+		// now the deferred promise should have resolved
+		await devicesPromise;
+
+		theLight.onOff.should.equal(false);
+		theLight.dimmer.should.equal(0);
+
+		tradfri.removeAllListeners();
+	});
+
+	it("when the gateway reports some other brightness on a turned-off light, keep it as-is", async () => {
+		// remember the deferred promise as this only resolves after all responses have been received
+		let theLight: Light;
+		const lightUpdatedPromise = createDeferredPromise();
+		tradfri.on("device updated", (acc) => {
+			theLight = acc.lightList[0];
+			lightUpdatedPromise.resolve();
+		});
+
+		const respAccessory = createRGBBulb(65536);
+		respAccessory["3311"][0]["5850"] = 0;
+		respAccessory["3311"][0]["5851"] = 2;
+		await callbacks.observeDevice[65536](createResponse(respAccessory));
+
+		// now the deferred promise should have resolved
+		await lightUpdatedPromise;
+
+		theLight.onOff.should.equal(false);
+		theLight.dimmer.should.not.equal(0);
+
+		tradfri.removeAllListeners();
+	});
+
+});
+
 describe("tradfri-client => updating resources => ", () => {
 
 	// Setup a fresh mock
diff --git a/src/tradfri-client.ts b/src/tradfri-client.ts
@@ -339,7 +339,11 @@ export class TradfriClient extends EventEmitter implements OperationProvider {
 		const result = parsePayload(response);
 		log(`observeDevice > ` + JSON.stringify(result), "debug");
 		// parse device info
-		const accessory = new Accessory(this.ipsoOptions).parse(result).createProxy();
+		const accessory = new Accessory(this.ipsoOptions)
+			.parse(result)
+			.fixBuggedProperties()
+			.createProxy()
+		;
 		// remember the device object, so we can later use it as a reference for updates
 		// store a clone, so we don't have to care what the calling library does
 		this.devices[instanceId] = accessory.clone();
@@ -475,7 +479,11 @@ export class TradfriClient extends EventEmitter implements OperationProvider {
 
 		const result = parsePayload(response);
 		// parse group info
-		const group = (new Group(this.ipsoOptions)).parse(result).createProxy();
+		const group = new Group(this.ipsoOptions)
+			.parse(result)
+			.fixBuggedProperties()
+			.createProxy()
+		;
 		// remember the group object, so we can later use it as a reference for updates
 		let groupInfo: GroupInfo;
 		if (!(instanceId in this.groups)) {
@@ -573,7 +581,11 @@ export class TradfriClient extends EventEmitter implements OperationProvider {
 
 		const result = parsePayload(response);
 		// parse scene info
-		const scene = (new Scene(this.ipsoOptions)).parse(result).createProxy();
+		const scene = new Scene(this.ipsoOptions)
+			.parse(result)
+			.fixBuggedProperties()
+			.createProxy()
+		;
 		// remember the scene object, so we can later use it as a reference for updates
 		// store a clone, so we don't have to care what the calling library does
 		this.groups[groupId].scenes[instanceId] = scene.clone();

Original file line number	Diff line number	Diff line change
`@@ -18,4 +18,8 @@ export declare class Accessory extends IPSODevice {`
`18`	`18`	`sensorList: Sensor[];`
`19`	`19`	`switchList: IPSODevice[];`
`20`	`20`	`otaUpdateState: number;`
	`21`	`+ /**`
	`22`	`+ * Fixes property values that are known to be bugged`
	`23`	`+ */`
	`24`	`+ fixBuggedProperties(): this;`
`21`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,4 +77,8 @@ export declare class IPSOObject {`
`77`	`77`	`*/`
`78`	`78`	`createProxy(get?: (me: this, key: PropertyKey) => any, set?: (me: this, key: PropertyKey, value: any, receiver: any) => boolean): this;`
`79`	`79`	`protected client: OperationProvider;`
	`80`	`+ /**`
	`81`	`+ * Fixes property values that are known to be bugged`
	`82`	`+ */`
	`83`	`+ fixBuggedProperties(): this;`
`80`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -472,6 +472,13 @@ class IPSOObject {`
`472`	`472`	`this.client = client;`
`473`	`473`	`return this;`
`474`	`474`	`}`
	`475`	`+ /**`
	`476`	`+ * Fixes property values that are known to be bugged`
	`477`	`+ */`
	`478`	`+ fixBuggedProperties() {`
	`479`	`+ // IPSOObject has none`
	`480`	`+ return this;`
	`481`	`+ }`
`475`	`482`	`}`
`476`	`483`	`__decorate([`
`477`	`484`	`exports.doNotSerialize,`