/xled-js

A port of the XLED library to typescript (JS)

Primary LanguageTypeScriptMIT LicenseMIT

xled-js

A NodeJS/typescript library similar to scrool/XLED to control Twinkly LED lights.

API Docs

Installation

Via npm

npm install xled2

From source

  • git clone https://github.com/aeroniemi/xled-js.git
  • cd ./xled-js/
  • npm install

Usage

import { Light, rgbColour } from "xled";

async function run() {
	// instantiate the device
	device = new Light("192.168.0.22");
	// get the device name
	console.log(`This device is called ${await device.getName()}`);

	// set device to red, full brightness
	await device.setBrightness(100);

	let red: rgbColour = {
		red: 255,
		green: 0,
		blue: 0,
	};
	await device.setMode("color");
	await device.setRGBColour(red);
}
run();