diff --git a/homeassistant/components/device_tracker/tomato.py b/homeassistant/components/device_tracker/tomato.py index 265dcf84b57..1a189a08396 100644 --- a/homeassistant/components/device_tracker/tomato.py +++ b/homeassistant/components/device_tracker/tomato.py @@ -1,4 +1,41 @@ -""" Supports scanning a Tomato router. """ +""" +homeassistant.components.device_tracker.tomato +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Device tracker platform that supports scanning a Tomato router for device +presence. + +Configuration: + +To use the Tomato tracker you will need to add something like the following +to your config/configuration.yaml + +device_tracker: + platform: tomato + host: YOUR_ROUTER_IP + username: YOUR_ADMIN_USERNAME + password: YOUR_ADMIN_PASSWORD + http_id: ABCDEFG + +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. + +http_id +*Required +The value can be obtained by logging in to the Tomato admin interface and +search for http_id in the page source code. +""" import logging import json from datetime import timedelta