mirror of
https://github.com/home-assistant/core.git
synced 2025-07-11 15:27:08 +00:00
Update docstrings
This commit is contained in:
parent
d8aefb5d55
commit
3b7f6d3b67
@ -1,26 +1,10 @@
|
|||||||
"""
|
"""
|
||||||
homeassistant.components.switch.rfxtrx
|
homeassistant.components.switch.rfxtrx
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
Support for Rfxtrx switch.
|
Support for RFXtrx switches.
|
||||||
|
|
||||||
Configuration:
|
|
||||||
|
|
||||||
To use Rfxtrx switchs you will need to add the following to your
|
|
||||||
configuration.yaml file.
|
|
||||||
|
|
||||||
switch:
|
|
||||||
platform: rfxtrx
|
|
||||||
|
|
||||||
devices:
|
|
||||||
ac09c4f1: Bedroom Door
|
|
||||||
ac09c4f2: Kitchen Door
|
|
||||||
ac09c4f3: Bathroom Door
|
|
||||||
|
|
||||||
*Optional*
|
|
||||||
|
|
||||||
# Automatic add new switch
|
|
||||||
automatic_add: True
|
|
||||||
|
|
||||||
|
For more details about this platform, please refer to the documentation at
|
||||||
|
https://home-assistant.io/components/switch.rfxtrx.html
|
||||||
"""
|
"""
|
||||||
import logging
|
import logging
|
||||||
import homeassistant.components.rfxtrx as rfxtrx
|
import homeassistant.components.rfxtrx as rfxtrx
|
||||||
@ -90,7 +74,7 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None):
|
|||||||
|
|
||||||
|
|
||||||
class RfxtrxSwitch(SwitchDevice):
|
class RfxtrxSwitch(SwitchDevice):
|
||||||
""" Provides a demo switch. """
|
""" Provides a RFXtrx switch. """
|
||||||
def __init__(self, name, event, state):
|
def __init__(self, name, event, state):
|
||||||
self._name = name
|
self._name = name
|
||||||
self._event = event
|
self._event = event
|
||||||
@ -98,7 +82,7 @@ class RfxtrxSwitch(SwitchDevice):
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def should_poll(self):
|
def should_poll(self):
|
||||||
""" No polling needed for a demo switch. """
|
""" No polling needed for a RFXtrx switch. """
|
||||||
return False
|
return False
|
||||||
|
|
||||||
@property
|
@property
|
||||||
|
Loading…
x
Reference in New Issue
Block a user