Update docstring (config file) and attempt to honor PEP0257
This commit is contained in:
parent
e824bc4c55
commit
f18928d85b
3 changed files with 3 additions and 6 deletions
|
@ -12,7 +12,7 @@ Example component to target an entity_id to:
|
||||||
Configuration:
|
Configuration:
|
||||||
|
|
||||||
To use the Example custom component you will need to add the following to
|
To use the Example custom component you will need to add the following to
|
||||||
your config/configuration.yaml
|
your configuration.yaml file.
|
||||||
|
|
||||||
example:
|
example:
|
||||||
target: TARGET_ENTITY
|
target: TARGET_ENTITY
|
||||||
|
|
|
@ -1,16 +1,14 @@
|
||||||
"""
|
"""
|
||||||
custom_components.hello_world
|
custom_components.hello_world
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Implements the bare minimum that a component should implement.
|
Implements the bare minimum that a component should implement.
|
||||||
|
|
||||||
Configuration:
|
Configuration:
|
||||||
|
|
||||||
To use the hello_word component you will need to add the following to your
|
To use the hello_word component you will need to add the following to your
|
||||||
config/configuration.yaml
|
configuration.yaml file.
|
||||||
|
|
||||||
hello_world:
|
hello_world:
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# The domain of your component. Should be equal to the name of your component
|
# The domain of your component. Should be equal to the name of your component
|
||||||
|
|
|
@ -1,7 +1,6 @@
|
||||||
"""
|
"""
|
||||||
custom_components.mqtt_example
|
custom_components.mqtt_example
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Shows how to communicate with MQTT. Follows a topic on MQTT and updates the
|
Shows how to communicate with MQTT. Follows a topic on MQTT and updates the
|
||||||
state of an entity to the last message received on that topic.
|
state of an entity to the last message received on that topic.
|
||||||
|
|
||||||
|
@ -12,7 +11,7 @@ example payload {"new_state": "some new state"}.
|
||||||
Configuration:
|
Configuration:
|
||||||
|
|
||||||
To use the mqtt_example component you will need to add the following to your
|
To use the mqtt_example component you will need to add the following to your
|
||||||
config/configuration.yaml
|
configuration.yaml file.
|
||||||
|
|
||||||
mqtt_example:
|
mqtt_example:
|
||||||
topic: home-assistant/mqtt_example
|
topic: home-assistant/mqtt_example
|
||||||
|
|
Loading…
Add table
Reference in a new issue