https://github.com/patrickvaler/neeo-driver-dyson

⚡️Dyson device driver for NEEO Remote
https://github.com/patrickvaler/neeo-driver-dyson

Last synced: 17 days ago
JSON representation

⚡️Dyson device driver for NEEO Remote

• Host: GitHub
• URL: https://github.com/patrickvaler/neeo-driver-dyson
• Owner: patrickvaler
• Created: 2018-08-04T23:22:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-29T04:26:03.000Z (over 4 years ago)
• Last Synced: 2024-10-10T06:44:06.945Z (28 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.33 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# neeo-driver-dyson

[![npm version](https://badge.fury.io/js/neeo-driver-dyson.svg)](http://badge.fury.io/js/neeo-driver-dyson) [![Build Status](https://travis-ci.org/patrickvaler/neeo-driver-dyson.svg?branch=master)](https://travis-ci.org/patrickvaler/neeo-driver-dyson) [![Dependency Status](https://david-dm.org/patrickvaler/neeo-driver-dyson/status.svg?style=flat)](https://david-dm.org/patrickvaler/neeo-driver-dyson)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![Greenkeeper badge](https://badges.greenkeeper.io/patrickvaler/neeo-driver-dyson.svg)](https://greenkeeper.io/)

⚠️️ **This driver gets extended during the next couple of days/weeks**

## Supported Models

- Dyson Pure Cool Tower TP04 (2018)

- Dyson Pure Cool Desk DP04 (2018)

More Dyson Link devices are coming soon. You're Dyson Link device is missing? Please open an

[Issue](https://github.com/patrickvaler/neeo-driver-dyson/issues) to get it supported faster.

## Supported Components

### Buttons

- POWER ON

- POWER OFF

- AUTO ON

- AUTO OFF

- CHANNEL UP - _Increase Fan Speed_

- CHANNEL DOWN - _Decrease Fan Speed_

- NIGHT MODE ON

- NIGHT MODE OFF

### Switches

- POWER SWITCH

- AUTO SWITCH

- NIGHT MODE SWITCH

### Widgets

- CHANNEL ZAPPER - _Increase/Decrease Fan Speed_

More components are coming soon.

## How to install

Drivers for NEEO can be manged with `@neeo/cli`:

```

npm install -g @neeo/cli

```

Create a directory for your NEEO drivers. One directory can contain multiple drivers.

The `@neeo/cli` utility will automatically find the installed drivers and start them.

```

mkdir my-neeo-drivers

cd my-neeo-drivers

npm init -y

```

Configuration options like the IP address of the NEEO Brain will be configured in the `package.json` file in the created drivers directory.

```

{

  [...]

  "neeoSdkOptions": {

    "serverName": "neeo-server",

    "serverPort": 6336,

    "brainHost": ""

  }

}

```

You can find more info about the neeeo-cli utility at: https://github.com/NEEOInc/neeo-sdk-toolkit/tree/master/cli

Install this driver into the new NEEO drivers directory:

```

npm install --save neeo-driver-dyson

```

Start the installed drivers using the neeo-cli utility with:

```

neeo-cli start

```

## Configuration

**IMPORTANT:** At the moment this driver supports just one device and the password for the device has been set as `DYSON_FAN_PASSWORD` environment variable. You can use [dyson-cloud](https://github.com/patrickvaler/dyson-cloud) library to get the local credentials of your Dyson device.

It is planned to get rid of this limitation as soon as possible.