add initial NuHeat documentation

This commit is contained in:
Derek Brooks 2017-11-11 16:26:57 -06:00
parent 93cb701387
commit 34ec0f3c94
3 changed files with 212 additions and 0 deletions

View File

@ -0,0 +1,169 @@
---
layout: page
title: "NuHeat Thermostat"
description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant."
date: 2017-11-11 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: nuheat.png
ha_category: Climate
ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
<p class='note'>
To get your [NuHeat Signature](http://www.nuheat.com/products/thermostats/signature-thermostat) thermostats working within Home Assistant, please follow the instructions for the general [NuHeat component](/components/nuheat)
</p>
## {% linkable_title Concepts %}
The NuHeat Thermostat supports the following key concepts.
The _target temperature_ is the temperature that the device attempts to achieve. The target temperature is either determined by the schedule programmed into the thermostat (_auto mode_) or may be overridden. When the target temperature is set by home assistant, the thermostat will hold this temperature until the schedule is resumed.
When in _away mode_ the temperature is permanently overridden to the minimum temperature supported by the thermostat.
## {% linkable_title Attributes %}
The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `target_temperature_low`, `target_temperature_high`, `current_hold_mode`, `current_operation`, `operation_list`, `is_away_mode_on`, `min_temp`, `max_temp`
### {% linkable_title Attribute `name` %}
Returns the name of the NuHeat Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the thermostat
### {% linkable_title Attribute `temperature_unit` %}
Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
### {% linkable_title Attribute `current_temperature` %}
Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currently measured temperature
### {% linkable_title Attribute `target_temperature` %}
Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `target_temperature_low` %}
Returns the desired heating temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `target_temperature_high` %}
Returns the desired cooling temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `current_hold_mode` %}
Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'temperature', 'temporary_temperature', 'away', 'auto', etc.
### {% linkable_title Attribute `current_operation` %}
Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'heat', 'idle'
### {% linkable_title Attribute `operation_list` %}
Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
### {% linkable_title Attribute `is_away_mode_on` %}
Returns whether the thermostat is in away mode.
| Attribute type | Description |
| ---------------| ----------- |
| Boolean | True, False
### {% linkable_title Attribute `min_temp` %}
Returns the minimum supported temperature by the thermostat
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Minimum supported temperature
### {% linkable_title Attribute `max_temp` %}
Returns the maximum supported temperature by the thermostat
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Maximum supported temperature
## {% linkable_title Services %}
The following services are provided by the NuHeat Thermostat: `set_away_mode`, `set_temperature`, `resume_program`.
The services `fan_min_on_time`, `set_aux_heat`, `set_hold_mode`, `set_humidity`, `set_fan_mode`, `set_operation_mode`, and `set_swing_mode` offered by the [Climate component](/components/climate/) are not implemented for this thermostat.
### {% linkable_title Service `set_away_mode` %}
Turns the away mode on or off for the thermostat.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `away_mode` | no | 'on' or 'off'
### {% linkable_title Service `set_temperature` %}
Puts the thermostat into a temporary hold at the given temperature.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `target_temp_low` | no | Desired heating target temperature (when in auto mode)
| `target_temp_high` | no | Desired cooling target temperature (when in auto mode)
| `temperature` | no | Desired target temperature (when not in auto mode)
Only the target temperatures relevant for the current operation mode need to
be provided.
### {% linkable_title Service `resume_program` %}
Resumes the currently active schedule.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.

View File

@ -0,0 +1,43 @@
---
layout: page
title: "NuHeat"
description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant."
date: 2017-11-11 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: nuheat.png
ha_category: Hub
ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `nuheat` component lets you control connected floor heating thermostats from [NuHeat](http://www.nuheat.com/).
First, you will need to obtain your thermostat's numeric serial number or ID by logging into [MyNuHeat.com](https://mynuheat.com/) and selecting your thermostat(s).
Once you have the Thermostat ID(s), add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
nuheat:
username: you@example.com
password: very-secure-password
devices: 12345
# Example configuration.yaml entry with multiple thermostats
nuheat:
username: you@example.com
password: very-secure-password
devices:
- 12345
- 67890
```
Configuration variables:
- **username** (*Required*): The username for accessing your MyNuHeat account.
- **password** (*Required*): The password for accessing your MyNuHeat account.
- **devices** (*Required*): The serial number / ID of each thermostat you would like integrate with Home Assistant.

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.0 KiB