Skip to content

Commit ae975df

Browse files
author
Markus Kling
committed
Updated: Documentation, release notes
1 parent 651e7aa commit ae975df

File tree

8 files changed

+30
-80
lines changed

8 files changed

+30
-80
lines changed

APPSTORE.md

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,12 @@ This app controls the target temperature if your thermostats based on (many) *he
88

99
A heating plan can be associated with either zones or devices. If a heating plan is associated with a zone, the heating plan is associated with all themorstats inside that zone. Child zones are not evaluated (yet).
1010

11-
## Example
12-
13-
For example, assume a heating plan for your living room with the following setup
14-
15-
* Monday ... Friday
16-
* 15:00, 18.5°
17-
* 18:00, 20.5°
18-
* 23:00, 16.0°
19-
* Saturday, Sunday
20-
* 09:00, 20.5°
21-
* 23:30, 16.0°
22-
23-
At each of the listed times, the target temperature is set to the given value. From Monday to Friday, you warmup the the living room starting 15:00. On weekends, the temperature is kept high all the time beginning 09:00.
24-
25-
## What happens on holidays? ... when I'm not at home?
26-
27-
The heating plans support exceptions for the following events:
28-
29-
* One day at home
30-
* One day not at home
31-
* Sleeping
32-
* Holiday
33-
34-
For each plan, you can define exceptional temperatures that are applied to all thermostats associated with your plan. When you define an exceptional temperature, and the event is active, the plan's schedules are paused.
35-
36-
The events *One day at home*, *One day not at home*, and *Sleeping* are reset every night at 00:00 and the normal *Automatic* schedule applies. The event *Holiday* is not automatically canceled and has to be reset manually using *Flows*.
37-
38-
## Live cylce
39-
40-
If the holiday "thing" is not your style, you can automate it yourself. Plans can be enabled and disabled manually or via *Flow*. If a heating plan is disabled, it is not applied.
41-
42-
## Flow activity cards
43-
44-
The follwing activity cards are provided
45-
46-
* Apply all active heating plans
47-
* Apply a specific heating plan, even when it is not activated
48-
* Set heating mode, see above
49-
* Enable/disable a specific plan
11+
You can find more details, a short manual, as well as release notes online [https://homey-heating.mskg.app](https://homey-heating.mskg.app).
5012

5113
## Supported languages
5214

5315
* English
16+
* Dutch - currently in progress
5417

5518
## Feedback
5619

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
Easily control the temperature of your thermostats.
44

55
## Known Issues
6-
7-
* Dialogs don't prompt if you exit without saving changes
8-
96
See [Issue Tracker](https://github.com/mskg/homey-heating/issues)
107

118
## Supported Languages
@@ -25,8 +22,8 @@ See [Issue Tracker](https://github.com/mskg/homey-heating/issues)
2522
* If you enable remote logging inside the app, you can watch the live trace of the application via [console.re/yourcategory](console.re)
2623

2724
## Change Log
28-
* **1.0.0** Initial release
29-
* **1.1.0** [Release notes](docs/release-notes/v01-01-00.md)
25+
* **1.0** Initial release
26+
* **1.1** [Release notes](docs/release-notes/v01-01.md)
3027

3128
## Feedback
3229

docs/package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"scripts": {
3+
"web": "bundle exec jekyll serve --incremental"
4+
}
5+
}

docs/pages/releasenotes.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,9 @@ layout: page
33
title: Release Notes
44
---
55

6-
* Initial release v1.0.0
7-
* [Version 1.1.0](/releasenotes/v01-01-00.md)
6+
The software is still work in progress, and all releases are currently beta. Please report issues at the [issues section on GitHub](https://github.com/mskg/homey-heating/issues) or contact me on [Slack](https://athomcommunity.slack.com/team/mskg).
7+
8+
## History
9+
10+
* Initial release v1.0
11+
* [Version 1.1](/releasenotes/v01-01)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: page
3-
title: Release Notes v1.1-beta
3+
title: Release Notes v1.1
44
---
55

66
## Major Changes and Improvements

package-lock.json

Lines changed: 12 additions & 31 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "homey-heating",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"description": "",
55
"main": "app.js",
66
"dependencies": {

src/app.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"id": "app.mskg.homey-heating",
3-
"version": "1.1.0",
3+
"version": "1.1.1",
44
"compatibility": ">= 2.0.0",
55
"sdk": 2,
66
"name": {

0 commit comments

Comments
 (0)