# iwy_master

> Controls IWY Light Master via TCP scocket

Latest version **0.2.3** (published 2015-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install iwy_master
pnpm add iwy_master
yarn add iwy_master
bun add iwy_master
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2015-12-20 |
| First published | 2014-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Philip Patzer |
| Maintainers | philip1986 |
| Keywords | iwy, light, tcp, home, automation, smart, home, led |

## Links

- npm: https://www.npmjs.com/package/iwy_master
- Repository: https://github.com/philip1986/iwy_master
- Issues: https://github.com/philip1986/iwy_master/issues
- npm.io page: https://npm.io/package/iwy_master

## Dependencies (1)

- [color](https://npm.io/package/color.md) ^0.10.1

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 0.2.3 (latest) — 2015-12-20
- 0.2.2 — 2015-04-21
- 0.2.1 — 2015-04-21
- 0.2.0 — 2015-04-12
- 0.1.3 — 2015-03-21
- 0.1.2 — 2015-02-22
- 0.1.1 — 2015-02-22
- 0.0.3 — 2014-12-29
- 0.0.2 — 2014-12-29
- 0.0.1 — 2014-12-28

## README

# IWY Master

The [IWY Master light] (http://iwy-light.de/gb/iwy-starter-sets/iwy-color-single-set-9w.html) can be controlled via WIFI. The manufacturer provides apps for Android and iOS which allows to:
 - switch on and off
 - change color
 - change brightness

This node module can be used to control the light device from any computing unit which is able to run Node.js or IO.js (e.g. a Raspberry Pi).

# Install

`npm install iwy_master`

# Usage

[Here](examples/on_off.js) you can find a 'Hello Word' example.

## Import and instantiate
```
IwyMaster = require('iwy_master');

iwy = new IwyMaster(HOST, [PORT]);

```
You should know the IP of your light device, if not use an IP scanner and figure it out. The port and callbak are optional. If you don`t set a port it will take the default one (5577), which should be fine for almost every case.

## Commands
All commands can be called with an optional. This callback will yield an possible error and the device state after the change. E.g:
```
command(function(err, state) {...});
```
The state object will look like:
```
    power: true|false,
    mode: 'WHITE'|'COLOR',
    brightness: between 0 and 100,
    color: {
        r: between 0 and 255,
        g: between 0 and 255,
        b: between 0 and 255
    }
```

`switchOn([callback])`

*Should be obvious.*

`switchOff([callback])`

*Should be obvious.*

`setWhite([callback])`

*Switchs the light dievice into warm white mode.*

`setColor(red, green, blue, [callback])`

*Switchs the light dievice into color mode and applies the defined color.
The parameter `red`, `green` and `blue` must be set and btween 0 and 255.*

`setBrightness(value, [callback])`

*Set the brightness of the light in both modes. The value must be between 0 and 100.
__Note:__ In color mode the color itself will be adjust to a lighter or darker version of it.*

---
_Source: https://npm.io/package/iwy_master · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._