GitLocker: The Coding Marketplace

Description:

pyvesyncapi 1.2.0

pyvesync
pyvesync is a library to manage VeSync compatible smart home devices
Table of Contents

Installation
Supported Devices
Usage
Configuration
Example Usage

Get electricity metrics of outlets

API Details

Manager API
Device API
Outlet Specific Energy Methods and Properties
Model ESW15-USA 15A/1800W Methods
Air Purifier LV-PUR131S Methods
Dimmable Smart Light Bulb Method and Properties
Tunable Smart Light Bulb Methods and Properties
Dimmable Switch Methods and Properties
JSON Output API

JSON Output for All Devices
JSON Output for Outlets
JSON Output for Dimmable Switch
JSON Output for Bulbs
JSON Output for Air Purifier

Notes
Integration with Home Assistant

Installation
Install the latest version from pip:
pip install pyvesync

Supported Devices

Etekcity Voltson Smart WiFi Outlet (7A model ESW01-USA)
Etekcity Voltson Smart WiFi Outlet (10A model ESW01-EU)
Etekcity Voltson Smart Wifi Outlet (10A model ESW03-USA)
Etekcity Voltson Smart WiFi Outlet (15A model ESW15-USA)
Etekcity Two Plug Outdoor Outlet (ESO15-TB) (Each plug is a separate object, energy readings are for both plugs combined)
Etekcity Smart WiFi Light Switch (model ESWL01)
Levoit Smart Wifi Air Purifier (LV-PUR131S)
Etekcity Soft White Dimmable Smart Bulb (ESL100)
Etekcity Cool to Soft White Tunable Dimmable Bulb (ESL100CW)
Etekcity Wifi Dimmer Switch (ESD16)

Usage
To start with the module:
from pyvesync import VeSync

manager = VeSync("EMAIL", "PASSWORD", time_zone=DEFAULT_TZ)
manager.login()

# Get/Update Devices from server - populate device lists
manager.update()

my_switch = manager.outlets[0]
# Turn on the first switch
my_switch.turn_on()
# Turn off the first switch
my_switch.turn_off()

# Get energy usage data
manager.update_energy()

# Display outlet device information
for device in manager.outlets:
device.display()

Configuration
The time_zone argument is optional but the specified time zone must match time zone in the tz database (IANNA Time Zone Database), see this link for reference:
tz database.
The time zone determines how the energy history is generated for the smart outlets, i.e. for the week starts at 12:01AM Sunday morning at the specified time zone. If no time zone or an invalid time zone is entered the default is America/New_York
#Devices are respectively located in their own lists that can be iterated over
manager.outlets = [VeSyncOutletObjects]
manager.switches = [VeSyncSwitchObjects]
manager.fans = [VeSyncFanObjects]
manger.bulbs = [VeSyncBulbObjects]

If outlets are going to be continuously polled, a custom energy update interval can be set - The default is 6 hours (21600 seconds)
manager.energy_update_interval = time # time in seconds

Example Usage
Get electricity metrics of outlets
for s in manager.outlets:
s.update_energy(check_bypass=False) # Get energy history for each device

API Details
Manager API
VeSync.get_devices() - Returns a list of devices
VeSync.login() - Uses class username and password to login to VeSync
VeSync.update() - Fetch updated information about devices
VeSync.update_all_devices() - Fetch details for all devices (run VeSyncDevice.update())
VeSync.update_energy(bypass_check=False) - Get energy history for all outlets - Builds week, month and year nested energy dictionary. Set bypass_check=True to disable the library from checking the update interval
Device API
VeSyncDevice.turn_on() - Turn on the device
VeSyncDevice.turn_off() - Turn off the device
VeSyncDevice.update() - Fetch updated information about device
VeSyncDevice.active_time - Return active time of the device in minutes
VeSyncDevice.get_config() - Retrieve Configuration data such as firmware version for device and store in the VeSyncDevice.config dictionary
VeSyncDevice.firmware_update - Return true if Firmware has update available. VeSyncDevice.get_config() must be called first
Outlet Specific Energy Methods and Properties
VeSyncOutlet.update_energy(bypass_check=False) - Get outlet energy history - Builds week, month and year nested energy dictionary. Set bypass_check=True to disable the library from checking the update interval
VeSyncOutlet.energy_today - Return current energy usage in kWh
VeSyncOutlet.power - Return current power in watts of the device
VeSyncOutlet.voltage - Return current voltage reading
VesyncOutlet.weekly_energy_total - Return total energy reading for the past week in kWh, starts 12:01AM Sunday morning
VesyncOutlet.monthly_energy_total - Return total energy reading for the past month in kWh
VesyncOutlet.yearly_energy_total - Return total energy reading for the past year in kWh
Model ESW15-USA 15A/1800W Methods
The rectangular smart switch model supports some additional functionality on top of the regular api call
VeSyncOutlet.turn_on_nightlight() - Turn on the nightlight
VeSyncOutlet.turn_off_nightlight() - Turn off the nightlight
Air Purifier LV-PUR131S Methods
VeSyncFan.fan_level - Return the level of the fan (1-3) or 0 for off
VeSyncFan.filter_life - Return the percentage of filter life remaining
VeSyncFan.air_quality - Return air quality reading
VeSyncFan.auto_mode() - Change mode to auto
VeSyncFan.manual_mode() - Change fan mode to manual with fan level 1
VeSyncFan.sleep_mode() - Change fan mode to sleep
VeSyncFan.change_fan_speed(speed) - Change fan speed with level 1, 2 or 3
VeSyncFan.screen_status - Get Status of screen on/off
Dimmable Smart Light Bulb Method and Properties
VeSyncBulb.brightness - Return brightness in percentage (1 - 100)
VeSyncBulb.set_brightness(brightness) - Set bulb brightness values from 1 - 100
Tunable Smart Light Bulb Methods and Properties
VeSyncBulb.color_temp_pct - Return color temperature in percentage (0 - 100)
VeSyncBulb.color_temp_kelvin - Return brightness in Kelvin
VeSyncBulb.set_color_temp(color_temp) - Set color temperature in percentage (0 - 100)
Dimmable Switch Methods and Properties
VeSyncSwitch.brightness - Return brightness of switch in percentage (1 - 100)
VeSyncSwitch.indicator_light_status - return status of indicator light on switch
VeSyncSwitch.rgb_light_status - return status of rgb light on faceplate
VeSyncSwitch.rgb_light_value - return dictionary of rgb light color (0 - 255)
VeSyncSwitch.set_brightness(brightness) - Set brightness of switch (1 - 100)
VeSyncSwitch.indicator_light_on() - Turn indicator light on
VeSyncSwitch.indicator_light_off() - Turn indicator light off
VeSyncSwitch.rgb_color_on() - Turn rgb light on
VeSyncSwitch.rgb_color_off() - Turn rgb light off
VeSyncSwitch.rgb_color_set(red, green, blue) - Set color of rgb light (0 - 255)
JSON Output API
The device.displayJSON() method outputs properties and status of the device
JSON Output for All Devices
device.displayJSON()

#Returns:

{
'Device Name': 'Device 1',
'Model': 'Device Model',
'Subdevice No': '1',
'Status': 'on',
'Online': 'online',
'Type': 'Device Type',
'CID': 'DEVICE-CID'
}

JSON Output for Outlets
{
'Active Time': '1', # in minutes
'Energy': '2.4', # today's energy in kWh
'Power': '12', # current power in W
'Voltage': '120', # current voltage
'Energy Week': '12', # totaly energy of week in kWh
'Energy Month': '50', # total energy of month in kWh
'Energy Year': '89', # total energy of year in kWh
}

JSON Output for Dimmable Switch
This output only applies to dimmable switch. The standard switch has the default device JSON output shown above
{
'Indicator Light': 'on', # status of indicator light
'Brightness': '50', # percent brightness
'RGB Light': 'on' # status of RGB Light on faceplate
}

JSON Output for Bulbs
# output for dimmable bulb
{
'Brightness': '50' # brightness in percent
}

# output for tunable bulb
{
'Kelvin': '5400' # color temperature in Kelvin
}

JSON Output for Air Purifier
{
'Active Time': '50', # minutes
'Fan Level': '2', # fan level 1-3
'Air Quality': '95', # air quality in percent
'Mode': 'auto',
'Screen Status': 'on',
'Filter Life': '99' # remaining filter life in percent
}

Notes
More detailed data is available within the VesyncOutlet by inspecting the VesyncOutlet.energy dictionary.
The VesyncOutlet.energy object includes 3 nested dictionaries week, month, and year that contain detailed weekly, monthly and yearly data
VesyncOutlet.energy['week']['energy_consumption_of_today']
VesyncOutlet.energy['week']['cost_per_kwh']
VesyncOutlet.energy['week']['max_energy']
VesyncOutlet.energy['week']['total_energy']
VesyncOutlet.energy['week']['data'] # which itself is a list of values

Integration with Home Assistant
This library is integrated with Home Assistant and documentation can be found at https://www.home-assistant.io/components/vesync/. The library version included with Home Assistant may lag behind development compared to this repository so those wanting to use the latest version can do the following to integrate with HA.

Add a custom_components directory to your Home Assistant configuration directory
Add a vesync directory as a directory within custom_components
Add switch.py to the vesync directory
Add __init__.py to the vesync directory
Add manifest.json to the vesync directory
Add the following config to your Home Assistant configuration.yaml file:

vesync:
username: VESYNC_USERNAME
password: VESYNC_PASSWORD

Restart Home Assistant

The custom_components directory should include the following files:
custom_components/vesync/__init__.py
custom_components/vesync/switch.py
custom_components/vesync/fan.py
custom_components/vesync/manifest.json

The version of the library defined in manifest.json should now get loaded within Home Assistant.