tushardhadiwal / homebridge-levoitcore-client

A Homebridge plugin to control Levoit Core Air Purifiers with via the Vesync Platform.
MIT License
10 stars 1 forks source link

homebridge-levoitcore-client

GitHub Workflow Status

A Homebridge plugin to control Levoit Air Purifiers with via the Vesync Platform.

NOTE: This plugin is developed to support my Levoit Core400S Air Purifier(tested). It may work for you as well. Some Basic Features may work for Core200S(untested).

Inspired from https://github.com/Kwintenvdb/homebridge-vesync-client which unfortunately does not support latest Levoit purifiers, so I had to make one for myself.

Installation

See the Homebridge documentation for how to install and run Homebridge.

To install the plugin, run the following on the command line on the machine where Homebridge is installed:

npm install -g homebridge-levoitcore-client

Configuration

This plugin requires your Vesync credentials as it communicates with the Vesync devices via Vesync's own API. Your credentials are only stored in the Homebridge config and not sent to any server except Vesync's.

You can also do this directly via the homebridge config by adding your credentials to the config file under platforms. Replace the values of username and password by your credentials.

"platforms": [
    {
        "platform": "VesyncPlatform",
        "username": "email@example.com",
        "password": "enter_your_password"
    }
]

Features

This plugin currently supports the following features.

Levoit Air Purifier

Local Development

If you want to develop and run the plugin locally, you can do the following:

  1. Clone the repository.
  2. Run the following scripts on the command line:
cd homebridge-levoitcore-client
npm install
npm run watch
npm link

Afterwards, restart Homebridge. Restart Homebridge whenever you have made changes to the code.