dyson-cloud v2.0.0

dyson-cloud

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

Installation

npm install --save dyson-cloud

Usage

const DysonCloud = require('dyson-cloud');
const myAccount = DysonCloud.build('example@email.com', 'myPassword123'); // or new DysonCloud('example@email.com', '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

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

Returns

Promise<Array<DeviceManifest>>

DeviceManifest

{
  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 for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use semantic-release for versioning. For the versions available, see the tags on this repository.

License

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