This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Luxio

Luxio.js is a JavaScript library to find and control Luxio Wi-Fi LED strips.

This module can be used:

• In the browser
• In a Node.js or React project
• As a Command-Line tool ($ luxio effect -i rainbow)

Node.js

Installation

In your project's folder:

$ npm install luxio

Then include it in your project:

const { Discovery } = require('luxio');

Usage

const { Discovery } = require('luxio');
const discovery = new Discovery();

discovery.getDevices()
  .then( devices => {
    devices.forEach( async device => {
      
      await device.sync();
      
      // print the state
      console.log('ID:', device.id);
      console.log('-- Name:', device.name);
      console.log('-- Version:', device.version);
      console.log('-- Pixels:', device.pixels);
      console.log('-- On:', device.on);
      console.log('-- Brightness:', device.brightness);
      console.log('-- Effect:', device.effect);
      console.log('-- Gradient:', device.gradient);
      console.log('-- Mode:', device.mode);
      console.log('');
      
      // set on, brightness and a gradient
      device.on = true;
      device.brightness = 1;
      device.gradient = [ '#FF0000', '#0000FF' ];
      //device.effect = 'rainbow';
      
      await device.sync();
      
    });
  })
  .catch( console.error );

Browser

Installation

By using a <script> tag:

<script type="text/javascript" src="./dist/web/luxio.min.js"></script>

Or use a CDN:

<script type="text/javascript" src="https://unpkg.com/luxio@latest/dist/web/luxio.min.js"></script>

Or when you're using a pre-compiler such as webpack:

import { Discovery } from 'luxio';

Usage

<script type="text/javascript">
var Discovery = Luxio.Discovery;
var discovery = new Discovery();
  
discovery.getDevices()
  .then( devices => {
    devices.forEach( device => {
      
      device.sync().then(() => {
      
        // print the state
        console.log('ID:', device.id);
        console.log('-- Name:', device.name);
        console.log('-- Version:', device.version);
        console.log('-- Pixels:', device.pixels);
        console.log('-- On:', device.on);
        console.log('-- Brightness:', device.brightness);
        console.log('-- Effect:', device.effect);
        console.log('-- Gradient:', device.gradient);
        console.log('-- Mode:', device.mode);
        console.log('');
        
        // set on, brightness and a gradient
        device.on = true;
        device.brightness = 1;
        device.gradient = [ '#FF0000', '#0000FF' ];
        //device.effect = 'rainbow';
        
        device.sync()
          .then( console.log )
          .catch( console.error )
      
      })
      .catch( console.error )
      
    });
  })
  .catch( console.error )
</script>

Note: Luxio commands are sent to a local IP address over HTTP. When visiting an HTTPS website, this is not allowed due to security risks.

Command line

Installation

$ npm install -g luxio

Usage

$ luxio --help

  Usage: luxio [options] [command]


  Options:

    -V, --version  output the version number
    -h, --help     output usage information


  Commands:

    devices      List Luxio devices on your network
    on           Turn on
    off          Turn off
    brightness   Set the brightness
    gradient     Set a gradient
    effect       Set an effect
    temperature  Set a color temperature
    set-name     Set the name
    set-pixels   Set the pixel count
    get-wifi     Get a list of Wi-Fi networks
    set-wifi     Set the Wi-Fi network
    state        Get the state
    restart      Restart a Luxio device
    help [cmd]   display help for [cmd]

Examples

$ luxio devices
$ luxio on
$ luxio effect --id "rainbow"
$ luxio gradient --colors "#FF0000,#0000FF" --device "Living Room"

Notes

• Device discovery by default finds devices using two strategies: Cloud discovery (https://nupnp.luxio.lighting) and by trying to connect to http://192.168.4.1 (the Access Point default IP Address).

Documentation

Available at https://luxio-lighting.github.io/luxio.js/