More component doc tweaks

This commit is contained in:
Paulus Schoutsen 2015-10-25 01:43:49 -07:00
parent bc1be31de3
commit d1f12b4c2e
9 changed files with 18 additions and 35 deletions

View File

@ -300,7 +300,7 @@ p.note {
#componentContainer { #componentContainer {
a { a {
display: inline-block; display: inline-block;
width: 200px; width: 202px;
height: 142px; height: 142px;
background-color: #fefefe; background-color: #fefefe;
margin-right: 8px; margin-right: 8px;
@ -312,7 +312,7 @@ p.note {
.img-container { .img-container {
height: 50px; height: 50px;
margin-bottom: 8px; margin: 8px 0;
font: 0/0 a; font: 0/0 a;
&:before { /* create a full-height inline block pseudo=element */ &:before { /* create a full-height inline block pseudo=element */

View File

@ -1,6 +1,6 @@
--- ---
layout: component layout: component
title: "Alarm panel" title: "Alarm Control Panels"
description: "Instructions how to integrate Alarm Control Panels into Home Assistant." description: "Instructions how to integrate Alarm Control Panels into Home Assistant."
date: 2015-10-13 19:10 date: 2015-10-13 19:10
sidebar: true sidebar: true

View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: "Other"
--- ---

View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: "History"
--- ---

View File

@ -7,6 +7,7 @@ sidebar: true
comments: false comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: "History"
--- ---
<img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" /> <img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" />

View File

@ -8,6 +8,7 @@ comments: false
sharing: true sharing: true
footer: true footer: true
logo: mqtt.png logo: mqtt.png
ha_category: Hub
--- ---
MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport. MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport.

View File

@ -10,25 +10,15 @@ footer: true
ha_category: Thermostat ha_category: Thermostat
--- ---
Specify a start time, end time and a target temperature. If the current temperature is lower than the target temperature, Heat Control is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater under the hood. If the measured temperature is cooler then the target temperature, the heater will be turned on and turned off when required temperature is reached.
and the time is between start time and end time, the heater will be turned on. Opposite if the temperature is higher than the
target temperature the heater will be turned off.
If away mode is activated the target temperature is set to a minimal temperature (`min_temp` in configuration block). The minimal temperature is also used as target temperature when no other temperature is specified.
If the heater is manually turned on, the target temperature will be set to 100°C. Meaning the thermostat probably will never turn off the heater. If the heater is manually turned off, the target temperature will be set according to normal rules. Based on target temperature for given time intervals and the min temperature.
A target temperature set with the `set_temperature` function will override all other rules for the target temperature.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
thermostat: thermostat:
platform: heat_control platform: heat_control
name: Stue name: Study
heater: switch.Ovn_stue heater: switch.study_heater
target_sensor: tellstick_sensor.Stue_temperature target_sensor: sensor.study_temperature
time_temp: 0700-0745:17,1500-1850:20
min_temp: 10
``` ```
Configuration variables: Configuration variables:
@ -36,10 +26,3 @@ Configuration variables:
- **name** (*Required*): Name of thermostat - **name** (*Required*): Name of thermostat
- **heater** (*Required*: `entity_id` for heater switch, must be a toggle device. - **heater** (*Required*: `entity_id` for heater switch, must be a toggle device.
- **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature. - **target_sensor** (*Required*): `entity_id` for a temperature sensor, target_sensor.state must be temperature.
- **time_temp** (*Required*): TIme frames and temperature. Format: *start_time*-*end_time*:*target_temp*
- **min_temp** (*Required*): Minimum temperature, used when away mode is active or no other temperature specified.
For the example the heater will turn on at 07:00 if the temperature is lower than 17°C away mode is false. Between 07:00 and 07:45 the
target temperature will be 17°C. Between 07:45 and 15:00 no temperature is specified. So the min_temp of 10°C will be used. From 15:00 to 18:50 the target temperature is 20°C, but if away mode is true the target temperature will be set to 10°C.

View File

@ -1,6 +1,6 @@
--- ---
layout: component layout: component
title: "Adding thermostats" title: "Thermostats"
description: "Instructions how to setup thermostats tracking within Home Assistant." description: "Instructions how to setup thermostats tracking within Home Assistant."
date: 2015-01-20 22:36 date: 2015-01-20 22:36
sidebar: true sidebar: true
@ -9,7 +9,7 @@ sharing: true
footer: true footer: true
--- ---
Thermostats offer Home Assistant a peek into the current and target temperature in a house. Some thermostats will also offer an away mode that will lower use of heating/cooling. The only supported thermostat right now is the Nest thermostat. Thermostats offer Home Assistant a peek into the current and target temperature in a house. Some thermostats will also offer an away mode that will lower use of heating/cooling.
To set it up, add the following information to your `configuration.yaml` file: To set it up, add the following information to your `configuration.yaml` file:

View File

@ -11,15 +11,8 @@ is_homepage: true
body_id: components-page body_id: components-page
--- ---
Components add support for devices, automation, and much much more to Home Assistant. The following things are supported out-of-the-box.
## {% linkable_title Entities %}
Entities are things that you want to observe within Home Assistant. Support for these things are provided by the entity components [Light](/components/light.html), [Switch](/components/switch.html), [Thermostat](/components/thermostat.html), [Media player](/components/media_player.html), [Device tracker](/components/device_tracker.html), and [Sun](/components/sun.html).
<p class='note'> <p class='note'>
Support for these services is provided by the Home Assistant community and not the service providers. Support for these components is provided by the Home Assistant community.
</p> </p>
{% assign components = site.components | sort: 'title' %} {% assign components = site.components | sort: 'title' %}
@ -59,6 +52,7 @@ Support for these services is provided by the Home Assistant community and not t
{% endfor %} {% endfor %}
</div> </div>
{% comment %}
## Not done yet ## Not done yet
{% for component in components %} {% for component in components %}
@ -66,13 +60,14 @@ Support for these services is provided by the Home Assistant community and not t
<p>{{ component.title }}</p> <p>{{ component.title }}</p>
{% endunless %} {% endunless %}
{% endfor %} {% endfor %}
{% endcomment %}
## {% linkable_title Organization %} ## {% linkable_title Organization %}
| Type | Description | Type | Description
| ---- | ----------- | ---- | -----------
| [Group](/components/group.html) | Allows grouping of entities | [Group](/components/group.html) | Allows grouping of entities
| [Scene](/components/scene.html) | Allow defining preferred state of a set of entities | [Scene](/components/scene.html) | Allow defining preferred state of a set of entities
| [Zone](/components/zone.html) | Allow defining zones on the map
## {% linkable_title Automation %} ## {% linkable_title Automation %}
@ -89,6 +84,7 @@ Support for these services is provided by the Home Assistant community and not t
| Type | Description | Type | Description
| ---- | ----------- | ---- | -----------
| [Configurator](/components/configurator.html) | Component used by other components to get configuration from the user. | [Configurator](/components/configurator.html) | Component used by other components to get configuration from the user.
| [Discovery](/components/discovery.html) | Discover and configure new devices.
<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script> <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>