jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-15 09:17:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docstrings

Browse Source
This commit is contained in:
Fabian Affolter 2015-09-17 08:34:10 +02:00
parent 8ec0c36457
commit e90dbad37e
1 changed files with 18 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
homeassistant/components/camera/foscam.py
View File

@ -1,41 +1,31 @@
""" """
Support for Foscam IP Cameras. homeassistant.components.camera.foscam
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This component provides basic support for Foscam IP cameras. This component provides basic support for Foscam IP cameras.
As part of the basic support the following features will be provided: As part of the basic support the following features will be provided:
-MJPEG video streaming -MJPEG video streaming
To use this component, add the following to your config/configuration.yaml: To use this component, add the following to your configuration.yaml file.
camera: camera:
platform: foscam platform: foscam
name: Door Camera name: Door Camera
ip: 192.168.0.123 ip: 192.168.0.123
port: 88 port: 88
username: visitor username: YOUR_USERNAME
password: password password: YOUR_PASSWORD
camera 2: Variables:
name: 'Second Camera'
...
camera 3:
name: 'Camera Three'
...
VARIABLES:
These are the variables for the device_data array:
ip ip
*Required *Required
The IP address of your foscam device The IP address of your Foscam device.
username username
*Required *Required
The username of a visitor or operator of your camera. The username of a visitor or operator of your camera. Oddly admin accounts
Oddly admin accounts don't seem to have access to take snapshots. don't seem to have access to take snapshots.
password password
*Required *Required
@ -49,6 +39,8 @@ port
*Optional *Optional
The port that the camera is running on. The default is 88. The port that the camera is running on. The default is 88.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/camera.foscam.html
""" """
import logging import logging
from homeassistant.helpers import validate_config from homeassistant.helpers import validate_config
@ -72,9 +64,7 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None):
# pylint: disable=too-many-instance-attributes # pylint: disable=too-many-instance-attributes
class FoscamCamera(Camera): class FoscamCamera(Camera):
""" """ An implementation of a Foscam IP camera. """
An implementation of a Foscam IP camera.
"""
def __init__(self, device_info): def __init__(self, device_info):
super(FoscamCamera, self).__init__() super(FoscamCamera, self).__init__()
@ -94,7 +84,7 @@ class FoscamCamera(Camera):
self._name, self._snap_picture_url) self._name, self._snap_picture_url)
def camera_image(self): def camera_image(self):
""" Return a still image reponse from the camera """ """ Return a still image reponse from the camera. """
# send the request to snap a picture # send the request to snap a picture
response = requests.get(self._snap_picture_url) response = requests.get(self._snap_picture_url)
@ -111,5 +101,5 @@ class FoscamCamera(Camera):
@property @property
def name(self): def name(self):
""" Return the name of this device """ """ Return the name of this device. """
return self._name return self._name