diff --git a/01_config.md b/01_config.md index 22b8df2..55884df 100644 --- a/01_config.md +++ b/01_config.md @@ -16,4 +16,4 @@ Configuring the app is pretty straightforward. Just click the settings icon in t * **Thermostat Name**: The name that you want to display at the top of the main screen in the app. This will also be the title for push notifications, if you have those enabled. * **Theme**: *Dracula* is the same regardless of whether your phone is on light or dark mode. *System* follows your phone's light/dark mode settings. * **Refresh Button Position**: How big is your phone, and how long is your thumb? You can also pull to refresh, so just do that instead. -* **API Key**: In order to connect the phone app to the computer companion app, you’ll need to use an API key. You must generate the API key yourself, and it must be in valid UUIDv4 format. If it isn’t in this format, it will be rejected and you won’t receive push notifications. There are may places that you can generate a UUIDv4 key. For example: [https://generate-uuid.com](https://generate-uuid.com) \ No newline at end of file +* **API Key**: In order to connect the phone app to the computer companion app, you’ll need to use an API key. You must generate the API key yourself, and it must be in valid UUIDv4 format. If it isn’t in this format, it will be rejected and you won’t receive push notifications. There are many places that you can generate a UUIDv4 key. For example: [https://generate-uuid.com](https://generate-uuid.com) \ No newline at end of file diff --git a/02_using.md b/02_using.md index d084cce..1cbf61f 100644 --- a/02_using.md +++ b/02_using.md @@ -16,6 +16,8 @@ In the area under the thermostat name, you will see four pieces of data. The top The temperature inside the circle is the current set temperature of the thermostat. If you have your thermostat on auto mode, then you can see the current set heat temp by pressing the **H** button and the current set cool temp by pressing the **C** button. +When the system is heating, the circle will be red. When it is cooling, the circle will be blue. When it is idle, the circle will be a faint colour, closer to the background colour. + The button under the plus and minus buttons shows the current mode. The time readout at the bottom shows the time of the last refresh. It is also occasionally used to read out messages (e.g. please refresh or update failed, etc.). diff --git a/03_push.md b/03_push.md index 1be12ef..131a564 100644 --- a/03_push.md +++ b/03_push.md @@ -8,6 +8,16 @@ permalink: push You can enable push notifications that get triggered any time the state of your thermostat changes. i.e. When it goes from idle to active (heating or cooling), or vice versa. +Since these push notifications are triggered by the companion app running on your computer at home (see below), they will actually still be sent to your phone even if you're out and don't currently have your phone on the same network as your thermostat. So, even though you won't be able to see the current thermostat data when you're away from your home network, you can still get notifications when the system becomes active or idle. + +## Enabling/allowing push notifications + +When you launch the app for the first time, it will ask for permission to send push notifications. You need to allow this in order to get push notifications. + +If you did not initially allow it, you can easily do so at any time by going to **Settings > Notifications > Thermostat Controller** on your phone and enabling it there. + +## Companion app + In order for push notifications to work, you need to be running our companion app on a computer, as it's this app that will monitor your thermostat locally and actually trigger the notification. Since the app needs to be running in order to trigger notifications, you'll want to install it on a computer that you have running all the time (e.g. the computer you use for other home automation tasks). This companion app, as well as instructions for how to install, configure and run it, are available here: @@ -16,10 +26,17 @@ This companion app, as well as instructions for how to install, configure and ru ## API key -In order to connect the phone app to the computer app, you'll need to use an API key. You must generate the API key yourself, and it must be in valid **UUIDv4** format. If it isn't in this format, it will be rejected and you won't receive push notifications. There are may places that you can generate a UUIDv4 key. For example: +In order to connect the phone app to the computer app, you'll need to use an API key. You must generate the API key yourself, and it must be in valid **UUIDv4** format. If it isn't in this format, it will be rejected and you won't receive push notifications. There are many places that you can generate a UUIDv4 key. For example: [https://generate-uuid.com](https://generate-uuid.com) For info on how to add this key to the iPhone app, see the [Config]({{ 'config' | relative_url }}) section. For info on how we store and use this key, see the [Security]({{ 'security' | relative_url }}) section. + +## Disable push notifications + +To disable push notifications, you can do one or both of the following: + +* Clear the **API Key** field on the settings screen in the app. +* Go to **Settings > Notifications > Thermostat Controller** on your phone and disallow notifications from the app there. \ No newline at end of file diff --git a/README.md b/README.md index 830524b..638b9aa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Thermostat Controller -Thermostat Controller is an iPhone app that lets you view data from and control your Venstar thermostat locally. +Thermostat Controller is an iPhone app that lets you view data from and control your **Venstar** thermostat locally. It's available in the App Store here: -This repo is for the GitHub Pages site for the app and will also be used for support/issues for the app. \ No newline at end of file +This repo is used for the GitHub Pages site for the app and will also be used for support/issues for the app. \ No newline at end of file diff --git a/index.md b/index.md index a1361e3..66d4016 100644 --- a/index.md +++ b/index.md @@ -1,12 +1,14 @@ --- layout: default -title: Home +title: Thermostat Controller iPhone app for Venstar --- # About **Thermostat Controller** is an iPhone app that lets you view the data from and control your **Venstar** thermostat locally. +*Note: Locally means while your phone is on the same network as your thermostat. If your phone is not connected to the same network as your thermostat, you will not be able to see/control thermostat data. However, you will still get [push notifications]({{ 'push' | relative_url }}) if those are enabled.* + ## Data you can view * Current temperature