From 57bf5b5b9b1a1dcb821b65a142447521d24aac27 Mon Sep 17 00:00:00 2001
From: markbasgitaar <149250992+markbasgitaar@users.noreply.github.com>
Date: Tue, 30 Jan 2024 22:40:50 +0100
Subject: [PATCH 1/5] Create README.md
---
README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 58 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3a67cf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+ToonSoftwareCollective HomeAssistant
+
+This application is built to integrate some Home Assistant functionalities in Toon thermostat (available in The Netherlands).
+A rooted Toon is required to be able to use this application;
+
+An easy rooting method, by software with a USB stick:
+https://github.com/ToonSoftwareCollective/Root-A-Toon-USB-Stick
+
+An alternative rooting method, by hardware with a Raspberry Pi or USB Blaster:
+https://github.com/martenjacobs/ToonRooter
+
+
+This application enable some basic key features on the Toon thermostat.
+These integrations can be used;
+
+ 8 sensors
+ 4 scenes
+ 5 switches/input_booleans/lights
+ 1 input_number (max 6 options)
+ 1 custom alarm
+
+The HomeAssistant tile will show the first 3 configured sensors.
+
+If you don't enter an alarm object in the tile, this space will be left empty.
+
+
+How to install:
+
+Install the homeassistant app through the TSC appstore.
+
+
+How to use:
+
+You need to manually generate a long-lived access token from your HomeAssistant setup and add this token to the "homeassistant.token.txt" file on your Toon.
+This file is located at /mnt/data/tsc/homeassistant.token.txt.
+To generate a token navigate to your user profile in the HomeAssistant gui and scroll down to the bottom where you see "Long-Lived Access Tokens" (and press generate).
+The password textbox in the Toon HomeAssistant app can be left empty.
+
+If you still use a password to authenticate with Home Assistant choose 'Legacy pass' on the configuration page of the Toon app and enter your password in the textbox.
+
+If you use SSL and Home Assistant version 0.73.0 or higher make sure to set 'ssl_profile: intermediate' in your Home Assistants configuration.yaml
+(in the http section; https://www.home-assistant.io/components/http/). This is not needed when using the Long-Lived Access token authentication.
+
+
+Restart the GUI of the Toon using TSC Settings, or run this command by SSH to restart Toons user interface
+ killall qt-gui
+
+Add the app called "homeassistant" to a new tile
+
+When starting the app for the first time the screen will be pretty much empty, click on "Instellingen" to configure the app
+
+On the configuration page enter the Home Assistant connection info and entity_id's you want to be shown (press the left/right arrows to scroll through sensors/scenes/switches)
+Press "Opslaan" to save your configuration. If all is well the information will be retrieved from your Home Assistant system
+
+Friendly names configured in your Home Assistant config are used to show the objects on the Toon. So make sure all items you want Toon to show have a friendly name.
+
+All objects are refreshed every minute (because of the sensor info located on the tile)
+Upon opening the app, pressing the "Opslaan" button on the configuration screen and by pressing the Home Assistant image on the app home screen (top right).
From f1b262e7965603194efe08af54db9a70478b6708 Mon Sep 17 00:00:00 2001
From: markbasgitaar <149250992+markbasgitaar@users.noreply.github.com>
Date: Tue, 30 Jan 2024 22:45:29 +0100
Subject: [PATCH 2/5] Update README.md
---
README.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e3a67cf..1e7ac1c 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,7 @@ How to use:
You need to manually generate a long-lived access token from your HomeAssistant setup and add this token to the "homeassistant.token.txt" file on your Toon.
This file is located at /mnt/data/tsc/homeassistant.token.txt.
+
To generate a token navigate to your user profile in the HomeAssistant gui and scroll down to the bottom where you see "Long-Lived Access Tokens" (and press generate).
The password textbox in the Toon HomeAssistant app can be left empty.
@@ -43,7 +44,8 @@ If you use SSL and Home Assistant version 0.73.0 or higher make sure to set 'ssl
Restart the GUI of the Toon using TSC Settings, or run this command by SSH to restart Toons user interface
- killall qt-gui
+
+ killall qt-gui
Add the app called "homeassistant" to a new tile
From 793ae43e82283c60efe3ba9f3ef8e8fb6259d15e Mon Sep 17 00:00:00 2001
From: markbasgitaar <149250992+markbasgitaar@users.noreply.github.com>
Date: Wed, 31 Jan 2024 13:16:26 +0100
Subject: [PATCH 3/5] Update README.md
---
README.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 1e7ac1c..8aa91d5 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,9 @@ Install the homeassistant app through the TSC appstore.
How to use:
You need to manually generate a long-lived access token from your HomeAssistant setup and add this token to the "homeassistant.token.txt" file on your Toon.
-This file is located at /mnt/data/tsc/homeassistant.token.txt.
+This file is located at:
+
+ /mnt/data/tsc/homeassistant.token.txt.
To generate a token navigate to your user profile in the HomeAssistant gui and scroll down to the bottom where you see "Long-Lived Access Tokens" (and press generate).
The password textbox in the Toon HomeAssistant app can be left empty.
From 8114a78cd2731e315a7a61b74c84cb764de2a6d9 Mon Sep 17 00:00:00 2001
From: markbasgitaar <149250992+markbasgitaar@users.noreply.github.com>
Date: Wed, 31 Jan 2024 22:43:11 +0100
Subject: [PATCH 4/5] Update README.md
---
README.md | 70 +++++++++++++++++++++++++++++++++++++------------------
1 file changed, 47 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 8aa91d5..89d3732 100644
--- a/README.md
+++ b/README.md
@@ -1,54 +1,78 @@
-ToonSoftwareCollective HomeAssistant
+# ToonSoftwareCollective HomeAssistant
-This application is built to integrate some Home Assistant functionalities in Toon thermostat (available in The Netherlands).
-A rooted Toon is required to be able to use this application;
+This application is built to integrate some Home Assistant functionalities in Toon thermostat (available in The Netherlands).
-An easy rooting method, by software with a USB stick:
-https://github.com/ToonSoftwareCollective/Root-A-Toon-USB-Stick
+> [!NOTE]
+>**A rooted Toon is required to be able to use this application**
-An alternative rooting method, by hardware with a Raspberry Pi or USB Blaster:
-https://github.com/martenjacobs/ToonRooter
+>[!TIP]
+>*An easy rooting method, by software with a USB stick: [Root A Toon USB Stick](https://github.com/ToonSoftwareCollective/Root-A-Toon-USB-Stick)*
+>
+>*An easy rooting method, by software with a Raspberry Pi: [Root A Toon](https://github.com/ToonSoftwareCollective/Root-A-Toon)*
+>
+>*An alternative rooting method, by hardware with a Raspberry Pi or USB Blaster: [ToonRooter](https://github.com/martenjacobs/ToonRooter)*
+### Description
+
This application enable some basic key features on the Toon thermostat.
These integrations can be used;
- 8 sensors
- 4 scenes
- 5 switches/input_booleans/lights
- 1 input_number (max 6 options)
- 1 custom alarm
-
-The HomeAssistant tile will show the first 3 configured sensors.
+* 8 sensors
+* 4 scenes
+* 5 switches/input_booleans/lights
+* 1 input_number (max 6 options)
+* 1 custom alarm
-If you don't enter an alarm object in the tile, this space will be left empty.
+ *The HomeAssistant tile on your Toon will show the first 3 configured sensors. If you don't enter an alarm object in the tile, this space will be left empty.*
-How to install:
-Install the homeassistant app through the TSC appstore.
+## How to install
+Install the HomeAssistant app through the TSC appstore.
-How to use:
-You need to manually generate a long-lived access token from your HomeAssistant setup and add this token to the "homeassistant.token.txt" file on your Toon.
-This file is located at:
+## How to setup
- /mnt/data/tsc/homeassistant.token.txt.
+### * Long-Lived Access Token
+You need to manually generate a long-lived access token from your HomeAssistant system and add this token to the 'homeassistant.token.txt' file on your Toon.
+This file is located at:
+> /mnt/data/tsc/homeassistant.token.txt
To generate a token navigate to your user profile in the HomeAssistant gui and scroll down to the bottom where you see "Long-Lived Access Tokens" (and press generate).
-The password textbox in the Toon HomeAssistant app can be left empty.
+*The password textbox in the HomeAssistant app in Toon can be left empty.*
+
+SSH to Toon:
+ *(change [IP TOON] to the IP adress of your Toon)*
+```
+ssh -oHostKeyAlgorithms=+ssh-rsa root@[IP TOON]
+```
+Just type the following command at the terminal prompt, and then press Enter:
+```
+cat > /mnt/data/tsc/homeassistant.token.txt
+```
+
+After pressing Enter, you are not returned to the terminal prompt. Instead, the cursor is placed on the next line, and you can start pasting your long-lived access token directly into the file.
+When you are done, press Ctrl+D to exit the file and return to the prompt.
+
+### * Legacy pass
If you still use a password to authenticate with Home Assistant choose 'Legacy pass' on the configuration page of the Toon app and enter your password in the textbox.
+### * SSL
If you use SSL and Home Assistant version 0.73.0 or higher make sure to set 'ssl_profile: intermediate' in your Home Assistants configuration.yaml
(in the http section; https://www.home-assistant.io/components/http/). This is not needed when using the Long-Lived Access token authentication.
Restart the GUI of the Toon using TSC Settings, or run this command by SSH to restart Toons user interface
- killall qt-gui
+```
+killall qt-gui
+```
+## How to use
+
Add the app called "homeassistant" to a new tile
When starting the app for the first time the screen will be pretty much empty, click on "Instellingen" to configure the app
From a0f67cd2c6c5d7a1ec35ce1f1b6a9f616ac8e3f2 Mon Sep 17 00:00:00 2001
From: markbasgitaar <149250992+markbasgitaar@users.noreply.github.com>
Date: Thu, 1 Feb 2024 23:07:07 +0100
Subject: [PATCH 5/5] Update README.md
---
README.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/README.md b/README.md
index 89d3732..bff29e9 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ This application is built to integrate some Home Assistant functionalities in To
>
>*An alternative rooting method, by hardware with a Raspberry Pi or USB Blaster: [ToonRooter](https://github.com/martenjacobs/ToonRooter)*
+
### Description
@@ -27,11 +28,13 @@ These integrations can be used;
*The HomeAssistant tile on your Toon will show the first 3 configured sensors. If you don't enter an alarm object in the tile, this space will be left empty.*
+
## How to install
Install the HomeAssistant app through the TSC appstore.
+
## How to setup
@@ -70,6 +73,8 @@ Restart the GUI of the Toon using TSC Settings, or run this command by SSH to re
```
killall qt-gui
```
+
+
## How to use