Comparing version 1.0.0 to 1.1.0
{ | ||
"name": "litra-glow", | ||
"version": "1.0.0", | ||
"description": "A JavaScript package, including TypeScript types, for programatically controlling your Logitech Litra Glow light", | ||
"version": "1.1.0", | ||
"description": "A driver for controlling your Logitech Litra Glow light from a CLI or your JavaScript code", | ||
"main": "./dist/commonjs/driver.js", | ||
@@ -16,3 +16,4 @@ "module": "./dist/esm/driver.js", | ||
"lint": "eslint . --ext .ts", | ||
"lint-and-fix": "eslint . --ext .ts --fix" | ||
"lint-and-fix": "eslint . --ext .ts --fix", | ||
"semantic-release": "semantic-release" | ||
}, | ||
@@ -36,4 +37,18 @@ "author": "Tim Rogers <me@timrogers.co.uk>", | ||
"ts-node": "^10.9.1", | ||
"typescript": "^4.8.3" | ||
"typescript": "^4.8.3", | ||
"semantic-release": "^19.0.5" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/timrogers/litra-glow.git" | ||
}, | ||
"release": { | ||
"branches": [ | ||
"main" | ||
] | ||
}, | ||
"bin": { | ||
"litra-on": "./dist/commonjs/cli/litra-on.js", | ||
"litra-off": "./dist/commonjs/cli/litra-off.js" | ||
} | ||
} |
# Logitech Litra Glow | ||
This JavaScript library allows you to control your [Logitech Litra Glow](https://www.logitech.com/en-gb/products/lighting/litra-glow.946-000002.html) light programatically. | ||
This JavaScript driver allows you to control your [Logitech Litra Glow](https://www.logitech.com/en-gb/products/lighting/litra-glow.946-000002.html) light using a CLI and from your JavaScript code. | ||
@@ -11,10 +11,18 @@ With this driver, you can: | ||
## Compatability | ||
## Compatibility | ||
This library is only tested on macOS Monterey (12.5). It's powered by [`node-hid`](https://github.com/node-hid/node-hid), which is compatible with other macOS versions, Windows and Linux, so it would be expected to work there too, but your milage may vary 🙏 | ||
## Installation | ||
## Using as a command line tool | ||
Simply add the `litra-glow` Node.js package to your `package.json`: | ||
Make sure you have Node.js available on your machine, and then install the package with `npm install -g litra-glow`. | ||
With the package installed, use the `litra-on` and `litra-off` commands to turn your light on and off. | ||
## Using as a JavaScript library | ||
### Installation | ||
Simply add the `litra-glow` Node.js package to your `package.json` and install it: | ||
```sh | ||
@@ -24,5 +32,5 @@ npm install --save litra-glow | ||
## Usage | ||
### Usage | ||
### Checking if a Litra Glow is plugged in | ||
#### Checking if a Litra Glow is plugged in | ||
@@ -41,3 +49,3 @@ The `findDevice` function checks your computer to find whether a Logitech Litra Glow is plugged in. | ||
### Turning your Litra Glow on or off | ||
#### Turning your Litra Glow on or off | ||
@@ -56,3 +64,3 @@ Find your device with `findDevice`, and then use the simple `turnOn` and `turnOff` functions. They just take one parameter: the device. | ||
### Setting the brightness of your Litra Glow | ||
#### Setting the brightness of your Litra Glow | ||
@@ -79,3 +87,3 @@ You can set the brightness of your Litra Glow, measured in Lumen, using the `setBrightnessInLumen` function. The Litra Glow supports brightness between 20 and 250 Lumen: | ||
### Setting the temperature of your Litra Glow | ||
#### Setting the temperature of your Litra Glow | ||
@@ -82,0 +90,0 @@ You can set the temperature of your Litra Glow, measured in Kelvin, using the `setTemperatureInKelvin` function. The Litra Glow supports temperature between 2700 and 6500 Kelvin: |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
29359
23
590
103
0
13