From 61e1f56922749f63dafcef53014f7ceec9059952 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 11 May 2015 18:05:58 +0200 Subject: [PATCH] update header --- .../components/device_tracker/netgear.py | 35 +++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/homeassistant/components/device_tracker/netgear.py b/homeassistant/components/device_tracker/netgear.py index aac09536746..102bc78ff47 100644 --- a/homeassistant/components/device_tracker/netgear.py +++ b/homeassistant/components/device_tracker/netgear.py @@ -1,4 +1,35 @@ -""" Supports scanning a Netgear router. """ +""" +homeassistant.components.device_tracker.netgear +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Device tracker platform that supports scanning a Netgear router for device +presence. + +Configuration: + +To use the Netgear tracker you will need to add something like the following +to your config/configuration.yaml + +device_tracker: + platform: netgear + host: YOUR_ROUTER_IP + username: YOUR_ADMIN_USERNAME + password: YOUR_ADMIN_PASSWORD + +Variables: + +host +*Required +The IP address of your router, e.g. 192.168.1.1. + +username +*Required +The username of an user with administrative privileges, usually 'admin'. + +password +*Required +The password for your given admin account. +""" import logging from datetime import timedelta import threading @@ -30,7 +61,7 @@ def get_scanner(hass, config): class NetgearDeviceScanner(object): - """ This class queries a Netgear wireless router using the SOAP-api. """ + """ This class queries a Netgear wireless router using the SOAP-API. """ def __init__(self, host, username, password): self.last_results = []