From 57446cfb08d4d5255d3f137f3455a836b4913fc3 Mon Sep 17 00:00:00 2001
From: Fabian Affolter <fabian@affolter-engineering.ch>
Date: Fri, 12 Feb 2016 07:54:25 +0100
Subject: [PATCH] Add link to docs
---
homeassistant/components/apcupsd.py | 4 +++-
homeassistant/components/binary_sensor/apcupsd.py | 5 +++--
homeassistant/components/sensor/apcupsd.py | 11 +++++++----
3 files changed, 13 insertions(+), 7 deletions(-)
diff --git a/homeassistant/components/apcupsd.py b/homeassistant/components/apcupsd.py
index 8abb06b54ea..b7c22b3a7d9 100644
--- a/homeassistant/components/apcupsd.py
+++ b/homeassistant/components/apcupsd.py
@@ -3,13 +3,15 @@ homeassistant.components.apcupsd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets up and provides access to the status output of APCUPSd via its Network
Information Server (NIS).
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/apcupsd/
"""
import logging
from datetime import timedelta
from homeassistant.util import Throttle
-
DOMAIN = "apcupsd"
REQUIREMENTS = ("apcaccess==0.0.4",)
diff --git a/homeassistant/components/binary_sensor/apcupsd.py b/homeassistant/components/binary_sensor/apcupsd.py
index 8524b06e4ba..796a2a0df70 100644
--- a/homeassistant/components/binary_sensor/apcupsd.py
+++ b/homeassistant/components/binary_sensor/apcupsd.py
@@ -2,13 +2,14 @@
homeassistant.components.binary_sensor.apcupsd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Provides a binary sensor to track online status of a UPS.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.apcupsd/
"""
from homeassistant.components.binary_sensor import BinarySensorDevice
from homeassistant.components import apcupsd
-
DEPENDENCIES = [apcupsd.DOMAIN]
-
DEFAULT_NAME = "UPS Online Status"
diff --git a/homeassistant/components/sensor/apcupsd.py b/homeassistant/components/sensor/apcupsd.py
index d72dc4ae4b9..8a566225438 100644
--- a/homeassistant/components/sensor/apcupsd.py
+++ b/homeassistant/components/sensor/apcupsd.py
@@ -1,7 +1,10 @@
"""
homeassistant.components.sensor.apcupsd
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Provides a sensor to track various status aspects of a UPS.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.apcupsd/
"""
import logging
@@ -9,11 +12,8 @@ from homeassistant.const import TEMP_CELCIUS
from homeassistant.helpers.entity import Entity
from homeassistant.components import apcupsd
-
DEPENDENCIES = [apcupsd.DOMAIN]
-
DEFAULT_NAME = "UPS Status"
-
SPECIFIC_UNITS = {
"ITEMP": TEMP_CELCIUS
}
@@ -69,14 +69,17 @@ class Sensor(Entity):
@property
def name(self):
+ """ The name of the UPS sensor. """
return self._config.get("name", DEFAULT_NAME)
@property
def state(self):
+ """ True if the UPS is online, else False. """
return self._state
@property
def unit_of_measurement(self):
+ """ Unit of measurement of this entity, if any. """
if self._unit is None:
return self._inferred_unit
return self._unit
--
GitLab