https://github.com/patrickvaler/dyson-cloud

JavaScript library to connect to the Dyson Cloud and fetch user account related information.
https://github.com/patrickvaler/dyson-cloud

Last synced: 17 days ago
JSON representation

JavaScript library to connect to the Dyson Cloud and fetch user account related information.

• Host: GitHub
• URL: https://github.com/patrickvaler/dyson-cloud
• Owner: patrickvaler
• License: mit
• Created: 2018-08-06T16:39:08.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-24T20:21:06.000Z (over 4 years ago)
• Last Synced: 2024-10-10T06:43:55.907Z (28 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.08 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

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

[![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/dyson-cloud.svg)](https://greenkeeper.io/)

# dyson-cloud

JavaScript library to connect to the Dyson Cloud and fetch user account related information.

## Installation

```

npm install --save dyson-cloud

```

## Usage

```javascript

const DysonCloud = require('dyson-cloud');

const myAccount = DysonCloud.build('[email protected]', 'myPassword123'); // or new DysonCloud('[email protected]', 'myPassword123');

```

## API

### getDevices()

Fetches user account related device information from Dyson Cloud. LocalCredentials can be used to authenticate with the Dyson Device in the local network via `mqtt`.

#### Examples

```javascript

myAccount.getDevices()

  .then(devices => /* do something with the devices */ });

```

#### Returns

`Promise>`

**DeviceManifest**

```javascript

{

  autoUpdate: true,

  localCredentials: {

    username: 'VS8-EU-KDA1234A',

    password: 'a7lbLMDkPs74LK7qfWnLV9AXhTYoj0uIpLlj5N+KZkLxtlKGhDBJsVe2KgX8UQpyXxXRDuIEShHZWkQe4j000w=='

  }

  name: 'Living room',

  newVersionAvailable: false,

  productType: '438',

  serial: 'VS8-EU-KDA1234A',

  version: 'ECG2PF.02.05.001.0006'

}

```

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [semantic-release](https://github.com/semantic-release/semantic-release) for versioning. For the versions available, see the [tags on this repository](https://github.com/patrickvaler/dyson-cloud/tags).

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details