home-assistant.io/source/_components/switch.kankun.markdown
webworxshop 51eaf0be19 Add documentation for Kankun wifi switch. (#1665)
* Add documentation for Kankun wifi switch.

* Add documentation for missing configuration options.
2017-01-06 09:27:42 +01:00

1.5 KiB

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer ha_category ha_release ha_iot_class
page Kankun SP3 Wifi Switch Instructions for the Kankun SP3 wifi switch 2016-12-28 01:50 true false true true Switch 0.36 Local Polling

The kankun switch platform allows you to toggle customised Kankun SP3 wifi switches. Switches are modified to include the json.cgi script to provide a HTTP API. Details of the necessary modifications can be found here (be sure to install the JSON version of the script as linked above).

To enable it, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
switch:
  platform: kankun
    switches:
      bedroom_heating:
        host: hostname_or_ipaddr

Configuration variables:

  • switches (Required): The array that contains all Kankun switches.
    • identifier (Required): Name of the Kankun switch as slug. Multiple entries are possible.
      • host (Required): Hostname or IP address of the switch on the local network.
      • name (Optional): Friendly name of the switch.
      • port (Optional): HTTP connection port, defaults to 80.
      • path (Optional): Path of CGI script, defaults to /cgi-bin/json.cgi.
      • username (Optional): Username for basic authentication.
      • password (Optional): Password for basic authentication.