Skip to content

kbariotis/yeelight.js

Repository files navigation

Yeelight.js Build Status

Control all of your Yeelight Devices with Node.js

  • Control device
  • Discovery of near connected devices
  • Watching for new devices

Yeelight products

Docs

BEFORE ANYTHING: You will have to connect your device to your local network using the Yeelight app. From there enable the Third Party Control mode in orde for the device to be discoverable.

  • Check the examples in examples/ folder.
  • Read the generated documentation here.
  • Find the API documentation of the Yeelight devices here.

Contributing

Read this first

Big thanks to Travelport-Ukraine/npm-module-boilerplate for their great boilerplate.

  • npm run clean - Remove lib/ directory
  • npm test - Run tests.
  • npm test:watch - You can even re-run tests on file changes.
  • npm run cover - Yes. You can even cover ES6 code.
  • npm run lint - Lint your code using Airbnb's style.
  • npm run flow - Check using Flow.
  • npm run test:examples - Write your examples on pure JS for better understanding module usage.
  • npm run build - Build.
  • npm run build-docs - Build documentation using Documentation.
  • npm run prepublish - Hook for npm. Do all the checks before publishing you module.

License

MIT Licence