Skip to content

Commit f945537

Browse files
tinloaftinloaf
authored
Merge pull request home-assistant#3962 from broox/nuheat
add initial NuHeat documentation
2 parents 6817c7f + 245cdec commit f945537

File tree

3 files changed

+199
-0
lines changed

3 files changed

+199
-0
lines changed

‎source/_components/climate.nuheat.markdown

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
layout: page
3+
title: "NuHeat Thermostat"
4+
description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant."
5+
date: 2017-11-11 18:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: nuheat.png
11+
ha_category: Climate
12+
ha_release: 0.58
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
<p class='note'>
17+
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)
18+
</p>
19+
20+
## {% linkable_title Concepts %}
21+
22+
The NuHeat Thermostat supports the following key concepts.
23+
24+
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.
25+
26+
27+
## {% linkable_title Attributes %}
28+
29+
The following attributes are provided by the NuHeat thermostat: `name`, `temperature_unit`, `current_temperature`, `target_temperature`, `current_hold_mode`, `current_operation`, `operation_list`, `min_temp`, `max_temp`
30+
31+
32+
### {% linkable_title Attribute `name` %}
33+
34+
Returns the name of the NuHeat Thermostat.
35+
36+
| Attribute type | Description |
37+
| ---------------| ----------- |
38+
| String | Name of the thermostat
39+
40+
### {% linkable_title Attribute `temperature_unit` %}
41+
42+
Returns the unit of measurement used for temperature by the thermostat.
43+
44+
| Attribute type | Description |
45+
| ---------------| ----------- |
46+
| String | Name of the temperature unit
47+
48+
### {% linkable_title Attribute `current_temperature` %}
49+
50+
Returns the current temperature measured by the thermostat.
51+
52+
| Attribute type | Description |
53+
| ---------------| ----------- |
54+
| Integer | Currently measured temperature
55+
56+
### {% linkable_title Attribute `target_temperature` %}
57+
58+
Returns the target temperature of the thermostat, when the thermostat is
59+
not in auto operation mode.
60+
61+
| Attribute type | Description |
62+
| ---------------| ----------- |
63+
| Integer | Target temperature
64+
65+
### {% linkable_title Attribute `target_temperature_low` %}
66+
67+
Returns the desired heating temperature set in the thermostat when in
68+
auto operation mode.
69+
70+
| Attribute type | Description |
71+
| ---------------| ----------- |
72+
| Integer | Target temperature
73+
74+
### {% linkable_title Attribute `target_temperature_high` %}
75+
76+
Returns the desired cooling temperature set in the thermostat when in
77+
auto operation mode.
78+
79+
| Attribute type | Description |
80+
| ---------------| ----------- |
81+
| Integer | Target temperature
82+
83+
### {% linkable_title Attribute `current_hold_mode` %}
84+
85+
Returns the current temperature hold, if any.
86+
87+
| Attribute type | Description |
88+
| ---------------| ----------- |
89+
| String | 'temperature', 'temporary_temperature', 'auto', etc.
90+
91+
### {% linkable_title Attribute `current_operation` %}
92+
93+
Returns the current operation of the thermostat.
94+
95+
| Attribute type | Description |
96+
| ---------------| ----------- |
97+
| String | 'heat', 'idle'
98+
99+
### {% linkable_title Attribute `operation_list` %}
100+
101+
Returns the list of available operation modes.
102+
103+
| Attribute type | Description |
104+
| ---------------| ----------- |
105+
| List of String | Available operation modes
106+
107+
### {% linkable_title Attribute `min_temp` %}
108+
109+
Returns the minimum supported temperature by the thermostat
110+
111+
| Attribute type | Description |
112+
| ---------------| ----------- |
113+
| Integer | Minimum supported temperature
114+
115+
### {% linkable_title Attribute `max_temp` %}
116+
117+
Returns the maximum supported temperature by the thermostat
118+
119+
| Attribute type | Description |
120+
| ---------------| ----------- |
121+
| Integer | Maximum supported temperature
122+
123+
124+
## {% linkable_title Services %}
125+
126+
The following services are provided by the NuHeat Thermostat: `set_temperature`, `resume_program`.
127+
128+
The services `fan_min_on_time`, `set_aux_heat`, `set_away_mode`, `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.
129+
130+
### {% linkable_title Service `set_temperature` %}
131+
132+
Puts the thermostat into a temporary hold at the given temperature.
133+
134+
| Service data attribute | Optional | Description |
135+
| ---------------------- | -------- | ----------- |
136+
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
137+
| `temperature` | no | Desired target temperature (when not in auto mode)
138+
139+
Only the target temperatures relevant for the current operation mode need to
140+
be provided.
141+
142+
### {% linkable_title Service `resume_program` %}
143+
144+
Resumes the currently active schedule.
145+
146+
| Service data attribute | Optional | Description |
147+
| ---------------------- | -------- | ----------- |
148+
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.

‎source/_components/nuheat.markdown

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: page
3+
title: "NuHeat"
4+
description: "Instructions how to integrate your NuHeat Signature thermostats within Home Assistant."
5+
date: 2017-11-11 18:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: nuheat.png
11+
ha_category: Hub
12+
ha_release: 0.58
13+
ha_iot_class: "Cloud Polling"
14+
---
15+
16+
The `nuheat` component lets you control connected floor heating thermostats from [NuHeat](http://www.nuheat.com/).
17+
18+
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).
19+
20+
Once you have the Thermostat ID(s), add the following information to your `configuration.yaml` file:
21+
22+
```yaml
23+
# Example configuration.yaml entry
24+
nuheat:
25+
username: you@example.com
26+
password: very-secure-password
27+
devices: 12345
28+
29+
# Example configuration.yaml entry with multiple thermostats
30+
nuheat:
31+
username: you@example.com
32+
password: very-secure-password
33+
devices:
34+
- 12345
35+
- 67890
36+
```
37+
38+
{% configuration %}
39+
username:
40+
description: The username for accessing your MyNuHeat account.
41+
required: true
42+
type: string
43+
password:
44+
description: The password for accessing your MyNuHeat account.
45+
required: true
46+
type: string
47+
devices:
48+
description: The serial number / ID of each thermostat you would like to integrate with Home Assistant.
49+
required: true
50+
type: [string, int]
51+
{% endconfiguration %}

‎source/images/supported_brands/nuheat.png

3.97 KB
Loading

0 commit comments

Comments
 (0)