Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceejbot/nanoleaves
CLI and api client for the Nanoleaf Aurora light panels.
https://github.com/ceejbot/nanoleaves
aurora iot javascript lights nanoleaf nodejs
Last synced: 3 days ago
JSON representation
CLI and api client for the Nanoleaf Aurora light panels.
- Host: GitHub
- URL: https://github.com/ceejbot/nanoleaves
- Owner: ceejbot
- License: isc
- Created: 2017-06-10T00:18:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-30T23:57:12.000Z (almost 6 years ago)
- Last Synced: 2024-10-11T19:22:03.207Z (about 1 month ago)
- Topics: aurora, iot, javascript, lights, nanoleaf, nodejs
- Language: JavaScript
- Homepage:
- Size: 101 KB
- Stars: 27
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nanoleaves
A command-line tool for interacting with your Nanoleaf Aurora. Also includes a full API client for the Aurora!
[](https://travis-ci.org/ceejbot/nanoleaves) [](https://coveralls.io/github/ceejbot/nanoleaves?branch=master) [](https://www.npmjs.org/package/nanoleaves)
## CLI usage
Provide the IP address of your Aurora in the environment variable `AURORA_HOST` and your API access token in `AURORA_TOKEN`. If your AURORA is listening on an unusual port, use `AURORA_PORT`.
To generate a token, hold the power key until the light starts flashing, then run `nanoleaves token`.
```
$ nanoleaves --help
Commands:
animation get details about the given animation effect
brightness [number] get or set the overall brightness
effect [name] get or set the current effect
effects list available effects
hsb set the hue, sat, and brightness for all panels
hue [number] get or set the hue for all panels
info get all available info about your Aurora
layout show the panel layout
mode get the current color mode for the Aurora
off turn your Aurora off
on turn your Aurora on
panels show the panel ids
random run a randomly-chosen effect
saturation [number] get or set the overall saturation
temp [number] get or set the overall color temperature
token generate a new API access token
upload upload a json file containing a new animation effect
Options:
--version Show version number [boolean]
--help Show help [boolean]
```
## API usage
```js
const AuroraAPI = require('nanoleaves');
const aurora = new AuroraAPI({
host: '10.0.0.2',
token: 'your-api-token'
});
aurora.info().then(info =>
{
console.log(info);
});
```
The constructor will default to the values in the above-mentioned environment variables if present.
All API functions return promises.
* `newToken()` - generate a new API token
* `info()` - return all info about the Aurora
* `identify()` - flash panels
* `animation(name)` - get detailed information about a specific animation effect
* `brightness()` - get the brightness for all panels
* `setBrightness(v)` - set the brightness for all panels; 0-100
* `effect()` - get the name of the current effect
* `effects()` - return a list of the names of all effects
* `setEffect(name)` - set the active effect by name
* `hue()` - get the hue for all panels
* `setHue(v)` - set the hue for all panels; 0-360
* `layout()` - get panel layout data
* `mode()` - get the Aurora's current color mode
* `off()` - turn the Aurora off
* `on()` - turn the Aurora on
* `orientation()` - get the global orientation; 0-360
* `saturation()` - get the saturation for all panels
* `setSaturation(v)` - set the saturation for all panels; 0-100
* `temperature()` - get the color temperature for all panels
* `setTemperature(v)` - set the color temperature for all panels; 1200-6500
* `addAnimation(json)` - store a new animation effect on the Aurora
* `setStaticPanel(data)` - set a panel or a list of panels to a static color; see below
## Static panel structure
The `setStaticPanel()` function pokes a single color into a specific panel. It is only useful for single frame static displays. You can call this a couple of ways. This snippet sets panel id 100 to black:
```js
const panel = { id: '100', r: 0, g: 0, b: 0 };
aurora.setStaticPanel(panel);
```
This code does the equivalent with a full panel object:
```js
const Aurora = require('nanoleaves');
const aurora = new Aurora();
const panel = new Aurora.Panel('100');
panel.frames = [{ r: 0, g: 0, b: 0, w: 0, transition: 50}];
aurora.setStaticPanel(panel);
```
You can also send a list of panels to `setStaticPanel()`:
```js
const list = [
{ id: 71, r: 255, g: 0, b: 0, transition: 50 },
{ id: 26, r: 255, g: 51, b: 17, transition: 50 },
{ id: 72, r: 255, g: 102, b: 68, transition: 50 },
{ id: 167, r: 255, g: 153, b: 51, transition: 50 },
];
aurora.setStaticPanel(list);
```
There's an example of setting an entire static animation display in [examples/static-display.js](examples/static-display.js). Use `nanoleaves panels` to get a list of valid panel ids for your setup.
## License
ISC