Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for VeSync Fans #13590

Merged
merged 4 commits into from
Sep 4, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Adds documentation to support new Fan capabilities
  • Loading branch information
TheGardenMonkey committed Jun 2, 2020
commit 4c3f9f889337e8af72e681fe412a5a19b701ad0c
22 changes: 21 additions & 1 deletion source/_integrations/vesync.markdown
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Etekcity VeSync
description: Instructions on how to set up Etekcity VeSync switches and outlets within Home Assistant.
description: Instructions on how to set up Etekcity VeSync switches, outlets, and fans within Home Assistant.
ha_category:
- Switch
- Fan
ha_release: 0.66
ha_config_flow: true
ha_codeowners:
Expand All @@ -18,6 +19,7 @@ The devices must be added to the VeSync App before this integration can discover
The following platforms are supported:

- **switch**
- **fan**

## Supported Devices

Expand All @@ -35,6 +37,10 @@ This integration supports devices controllable by the VeSync App. The following

- Etekcity In Wall Smart Switch (EWSL01-USA)

### Fans

- LEVOIT Smart Wifi Air Purifier (LV-PUR131S)

## Configuration

To use this integration, all devices must be registered with the VeSync App. Once registration is complete, you can add the VeSync integration by adding the VeSync integration in the configuration section of the frontend and entering your username and password. You can also use the traditional configuration method by adding the following to your `configuration.yaml` file:
Expand Down Expand Up @@ -76,6 +82,20 @@ VeSync outlets will expose the following details for only the smart outlets. Ene
| `monthly_energy_total` | Total energy usage for month starting from 12:01AM on the first in kWh | 52.30 |
| `yearly_energy_total` | Total energy usage for year start from 12:01AM on Jan 1 in kWh | 105.25 |

## Fan Exposed Attributes

VeSync air purifiers will expose the following details.

| Attribute | Description | Example |
| ----------------------- | ----------------------------------------------------------------------- | --------------- |
| `mode` | The current mode the device is in. | auto |
| `speed` | The current speed setting of the device. | auto |
| `speed_list` | The available list of speeds supported by the device. | high |
| `active_time` | The number of seconds since the device has been in a non-off mode. | 1598 |
| `filter_life` | Remaining precentage of the filter. | 142 |
| `air_quality` | The current air quality reading. | excellent |
| `screen_status` | The current status of the screen. | on |

## Extracting Attribute data

In order to get the attributes readings from supported devices, such as energy from outlets or fan attributes, you'll have to create a [template sensor](/integrations/switch.template/).
Expand Down