Skip to content

Add Readme file #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markbasgitaar wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add Readme file #3

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57bf5b5
Create README.md
markbasgitaar Jan 30, 2024
f1b262e
Update README.md
markbasgitaar Jan 30, 2024
793ae43
Update README.md
markbasgitaar Jan 31, 2024
8114a78
Update README.md
markbasgitaar Jan 31, 2024
a0f67cd
Update README.md
markbasgitaar Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# ToonSoftwareCollective HomeAssistant

This application is built to integrate some Home Assistant functionalities in Toon thermostat (available in The Netherlands).

> [!NOTE]
>**A rooted Toon is required to be able to use this application**

>[!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)*

<br>

### 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 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.*

<br>

## How to install

Install the HomeAssistant app through the TSC appstore.

<br>

## How to setup

### * 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 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
```

<br>

## 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

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).