fix: remove the setTemperaturePercentage function, because you can't

actually set a Litra's temperature to an arbitrary percentage BREAKING CHANGE: The `setTemperaturePercentage` function has been removed because it claims to allow users to set their Litra device's temperature toan arbitrary percentage value, but the device only allows a limited set of temperatures (multiples of 100 between the minimum and maximum) - see #92. The `setTemperatureInKelvin` function for setting the temperature to a value in Kelvin is still available.
timrogers · Feb 23, 2023 · deaa0d9 · deaa0d9
1 parent 17439b7
commit deaa0d9
Show file tree

Hide file tree

Showing 7 changed files with 1 addition and 137 deletions.
diff --git a/README.md b/README.md
@@ -155,18 +155,6 @@ if (device) {
 }
 ```
 
-You can also set temperature level to a percentage with `setTemperaturePercentage` if you don't want to think in Kelvin:
-
-```js
-import { findDevice, setTemperaturePercentage } from 'litra';
-
-const device = findDevice();
-
-if (device) {
-  setTemperaturePercentage(device, 75);
-}
-```
-
 ## Using with Oversight
 
 Litra integrates with [Oversight](https://objective-see.org/products/oversight.html) to allow you to automatically turn your Litra device on or off when your webcam turns on and off. This allows you to be illuminated every time you join a video call!

diff --git a/dist/commonjs/driver.d.ts b/dist/commonjs/driver.d.ts
@@ -50,14 +50,6 @@ export declare const turnOff: (device: Device) => void;
  *  functions to get the minimum and maximum temperature for your device.
  */
 export declare const setTemperatureInKelvin: (device: Device, temperatureInKelvin: number) => void;
-/**
- * Set the temperature of your Logitech Litra device to a percentage
- * of the device's maximum temperature
- *
- * @param {Device} device The device to set the temperature of
- * @param {number} temperaturePercentage The percentage to set the temperature to
- */
-export declare const setTemperaturePercentage: (device: Device, temperaturePercentage: number) => void;
 /**
  * Sets the brightness of your Logitech Litra device, measured in Lumen
  *

diff --git a/dist/commonjs/driver.js b/dist/commonjs/driver.js
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNameForDevice = exports.getMaximumTemperatureInKelvinForDevice = exports.getMinimumTemperatureInKelvinForDevice = exports.getMaximumBrightnessInLumenForDevice = exports.getMinimumBrightnessInLumenForDevice = exports.setBrightnessPercentage = exports.setBrightnessInLumen = exports.setTemperaturePercentage = exports.setTemperatureInKelvin = exports.turnOff = exports.turnOn = exports.findDevices = exports.findDevice = exports.DeviceType = void 0;
+exports.getNameForDevice = exports.getMaximumTemperatureInKelvinForDevice = exports.getMinimumTemperatureInKelvinForDevice = exports.getMaximumBrightnessInLumenForDevice = exports.getMinimumBrightnessInLumenForDevice = exports.setBrightnessPercentage = exports.setBrightnessInLumen = exports.setTemperatureInKelvin = exports.turnOff = exports.turnOn = exports.findDevices = exports.findDevice = exports.DeviceType = void 0;
 const node_hid_1 = __importDefault(require("node-hid"));
 const utils_1 = require("./utils");
 var DeviceType;
@@ -120,24 +120,6 @@ const setTemperatureInKelvin = (device, temperatureInKelvin) => {
     device.hid.write((0, utils_1.padRight)([0x11, 0xff, 0x04, 0x9c, ...(0, utils_1.integerToBytes)(temperatureInKelvin)], 20, 0x00));
 };
 exports.setTemperatureInKelvin = setTemperatureInKelvin;
-/**
- * Set the temperature of your Logitech Litra device to a percentage
- * of the device's maximum temperature
- *
- * @param {Device} device The device to set the temperature of
- * @param {number} temperaturePercentage The percentage to set the temperature to
- */
-const setTemperaturePercentage = (device, temperaturePercentage) => {
-    if (temperaturePercentage < 0 || temperaturePercentage > 100) {
-        throw 'Percentage must be between 0 and 100';
-    }
-    const minimumTemperature = (0, exports.getMinimumTemperatureInKelvinForDevice)(device);
-    const maximumTemperature = (0, exports.getMaximumTemperatureInKelvinForDevice)(device);
-    return (0, exports.setTemperatureInKelvin)(device, temperaturePercentage === 0
-        ? minimumTemperature
-        : (0, utils_1.percentageWithinRange)(temperaturePercentage, minimumTemperature, maximumTemperature));
-};
-exports.setTemperaturePercentage = setTemperaturePercentage;
 /**
  * Sets the brightness of your Logitech Litra device, measured in Lumen
  *

diff --git a/dist/esm/driver.d.ts b/dist/esm/driver.d.ts
@@ -50,14 +50,6 @@ export declare const turnOff: (device: Device) => void;
  *  functions to get the minimum and maximum temperature for your device.
  */
 export declare const setTemperatureInKelvin: (device: Device, temperatureInKelvin: number) => void;
-/**
- * Set the temperature of your Logitech Litra device to a percentage
- * of the device's maximum temperature
- *
- * @param {Device} device The device to set the temperature of
- * @param {number} temperaturePercentage The percentage to set the temperature to
- */
-export declare const setTemperaturePercentage: (device: Device, temperaturePercentage: number) => void;
 /**
  * Sets the brightness of your Logitech Litra device, measured in Lumen
  *

diff --git a/dist/esm/driver.js b/dist/esm/driver.js
@@ -109,23 +109,6 @@ export const setTemperatureInKelvin = (device, temperatureInKelvin) => {
     }
     device.hid.write(padRight([0x11, 0xff, 0x04, 0x9c, ...integerToBytes(temperatureInKelvin)], 20, 0x00));
 };
-/**
- * Set the temperature of your Logitech Litra device to a percentage
- * of the device's maximum temperature
- *
- * @param {Device} device The device to set the temperature of
- * @param {number} temperaturePercentage The percentage to set the temperature to
- */
-export const setTemperaturePercentage = (device, temperaturePercentage) => {
-    if (temperaturePercentage < 0 || temperaturePercentage > 100) {
-        throw 'Percentage must be between 0 and 100';
-    }
-    const minimumTemperature = getMinimumTemperatureInKelvinForDevice(device);
-    const maximumTemperature = getMaximumTemperatureInKelvinForDevice(device);
-    return setTemperatureInKelvin(device, temperaturePercentage === 0
-        ? minimumTemperature
-        : percentageWithinRange(temperaturePercentage, minimumTemperature, maximumTemperature));
-};
 /**
  * Sets the brightness of your Logitech Litra device, measured in Lumen
  *

diff --git a/src/driver.ts b/src/driver.ts
@@ -145,36 +145,6 @@ export const setTemperatureInKelvin = (
   );
 };
 
-/**
- * Set the temperature of your Logitech Litra device to a percentage
- * of the device's maximum temperature
- *
- * @param {Device} device The device to set the temperature of
- * @param {number} temperaturePercentage The percentage to set the temperature to
- */
-export const setTemperaturePercentage = (
-  device: Device,
-  temperaturePercentage: number,
-): void => {
-  if (temperaturePercentage < 0 || temperaturePercentage > 100) {
-    throw 'Percentage must be between 0 and 100';
-  }
-
-  const minimumTemperature = getMinimumTemperatureInKelvinForDevice(device);
-  const maximumTemperature = getMaximumTemperatureInKelvinForDevice(device);
-
-  return setTemperatureInKelvin(
-    device,
-    temperaturePercentage === 0
-      ? minimumTemperature
-      : percentageWithinRange(
-          temperaturePercentage,
-          minimumTemperature,
-          maximumTemperature,
-        ),
-  );
-};
-
 /**
  * Sets the brightness of your Logitech Litra device, measured in Lumen
  *

diff --git a/tests/driver.test.ts b/tests/driver.test.ts
@@ -8,7 +8,6 @@ import {
   setBrightnessInLumen,
   setBrightnessPercentage,
   setTemperatureInKelvin,
-  setTemperaturePercentage,
   turnOff,
   turnOn,
   Device,
@@ -96,48 +95,6 @@ describe('setTemperatureInKelvin', () => {
   });
 });
 
-describe('setTemperaturePercentage', () => {
-  it('sends the instruction to set the device temperature based on a percentage, ', () => {
-    setTemperaturePercentage(fakeLitraGlow, 100);
-
-    expect(fakeLitraGlow.hid.write).toBeCalledWith([
-      17, 255, 4, 156, 25, 100, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    ]);
-
-    setTemperaturePercentage(fakeLitraBeam, 100);
-
-    expect(fakeLitraBeam.hid.write).toBeCalledWith([
-      17, 255, 4, 156, 25, 100, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    ]);
-  });
-
-  it('sends the instruction to set the device temperature to the minimum temperature when set to 0%', () => {
-    setTemperaturePercentage(fakeLitraGlow, 0);
-
-    expect(fakeLitraGlow.hid.write).toBeCalledWith([
-      17, 255, 4, 156, 10, 140, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    ]);
-
-    setTemperaturePercentage(fakeLitraBeam, 0);
-
-    expect(fakeLitraBeam.hid.write).toBeCalledWith([
-      17, 255, 4, 156, 10, 140, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    ]);
-  });
-
-  it('throws an error if the provided percentage is less than 0', () => {
-    expect(() => setTemperaturePercentage(fakeDevice, -1)).toThrowError(
-      'Percentage must be between 0 and 100',
-    );
-  });
-
-  it('throws an error if the provided percentage is more than 100', () => {
-    expect(() => setTemperaturePercentage(fakeDevice, 101)).toThrowError(
-      'Percentage must be between 0 and 100',
-    );
-  });
-});
-
 describe('setBrightnessInLumen', () => {
   it('sends the instruction to set the device temperature', () => {
     setBrightnessInLumen(fakeDevice, 20);