Skip to content

Commit

Permalink
Add support for customised Kankun SP3 Wifi switches. (home-assistant#…
Browse files Browse the repository at this point in the history
…5089)

* Add support for customised Kankun SP3 Wifi switches.

* Add config validation for Kankun SP3 wifi switch.

* Update kankun.py
  • Loading branch information
webworxshop authored and balloob committed Jan 5, 2017
1 parent 95ddef3 commit 51446e0
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 0 deletions.
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,7 @@ omit =
homeassistant/components/switch/edimax.py
homeassistant/components/switch/hikvisioncam.py
homeassistant/components/switch/hook.py
homeassistant/components/switch/kankun.py
homeassistant/components/switch/mystrom.py
homeassistant/components/switch/netio.py
homeassistant/components/switch/orvibo.py
Expand Down
120 changes: 120 additions & 0 deletions homeassistant/components/switch/kankun.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
"""
Support for customised Kankun SP3 wifi switch.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/switch.kankun/
"""
import logging
import requests
import voluptuous as vol

from homeassistant.components.switch import SwitchDevice, PLATFORM_SCHEMA
from homeassistant.const import (
CONF_HOST, CONF_NAME, CONF_PORT, CONF_PATH, CONF_USERNAME, CONF_PASSWORD,
CONF_SWITCHES)
import homeassistant.helpers.config_validation as cv

_LOGGER = logging.getLogger(__name__)

DEFAULT_PORT = 80
DEFAULT_PATH = "/cgi-bin/json.cgi"

SWITCH_SCHEMA = vol.Schema({
vol.Required(CONF_HOST): cv.string,
vol.Optional(CONF_NAME): cv.string,
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
vol.Optional(CONF_PATH, default=DEFAULT_PATH): cv.string,
vol.Optional(CONF_USERNAME): cv.string,
vol.Optional(CONF_PASSWORD): cv.string,
})

PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_SWITCHES): vol.Schema({cv.slug: SWITCH_SCHEMA}),
})


# pylint: disable=unused-argument
def setup_platform(hass, config, add_devices_callback, discovery_info=None):
"""Find and return kankun switches."""
switches = config.get('switches', {})
devices = []

for dev_name, properties in switches.items():
devices.append(
KankunSwitch(
hass,
properties.get(CONF_NAME, dev_name),
properties.get(CONF_HOST, None),
properties.get(CONF_PORT, DEFAULT_PORT),
properties.get(CONF_PATH, DEFAULT_PATH),
properties.get(CONF_USERNAME, None),
properties.get(CONF_PASSWORD)))

add_devices_callback(devices)


class KankunSwitch(SwitchDevice):
"""Represents a Kankun wifi switch."""

# pylint: disable=too-many-arguments
def __init__(self, hass, name, host, port, path, user, passwd):
"""Initialise device."""
self._hass = hass
self._name = name
self._state = False
self._url = "http://{}:{}{}".format(host, port, path)
if user is not None:
self._auth = (user, passwd)
else:
self._auth = None

def _switch(self, newstate):
"""Switch on or off."""
_LOGGER.info('Switching to state: %s', newstate)

try:
req = requests.get("{}?set={}".format(self._url, newstate),
auth=self._auth)
return req.json()['ok']
except requests.RequestException:
_LOGGER.error('Switching failed.')

def _query_state(self):
"""Query switch state."""
_LOGGER.info('Querying state from: %s', self._url)

try:
req = requests.get("{}?get=state".format(self._url),
auth=self._auth)
return req.json()['state'] == "on"
except requests.RequestException:
_LOGGER.error('State query failed.')

@property
def should_poll(self):
"""Switch should always be polled."""
return True

@property
def name(self):
"""The name of the switch."""
return self._name

@property
def is_on(self):
"""True if device is on."""
return self._state

def update(self):
"""Update device state."""
self._state = self._query_state()

def turn_on(self, **kwargs):
"""Turn the device on."""
if self._switch('on'):
self._state = True

def turn_off(self, **kwargs):
"""Turn the device off."""
if self._switch('off'):
self._state = False

0 comments on commit 51446e0

Please sign in to comment.