Skip to content
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

Update instructions to reference hacs #33

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Update instructions to reference hacs #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 15 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,40 @@ My device is RT301i, it is working with it500 thermostat, the idea is simple if
## Component to interface with the salus-it500.com.
It reads the Current Temperature, Set Temperature, Current HVAC Mode, Current Relay Mode.

Keep in mind this is my first custom component and this is also the first version of this Salusfy so it can have bugs. Sorry for that.

**** This is not an official integration.

### Installation
1. Clone the repo into the `home_assistant` directory
1. Change directory into the `salusfy` directory
1. Run install.sh (you may need to fix the line endings)
1. Configure with config below
1. Add the repository in HACS:
1. Repository: matthewturner/salusfy
1. Type: Integration
1. Configure with config below through a text editor
1. Restart Home Assistant

### Usage
To use this component in your installation, add the following to your configuration.yaml file:

#### Example configuration.yaml entry

```
```yaml
climate:
- platform: salusfy
username: "EMAIL"
password: "PASSWORD"
id: "DEVICE_ID"
```

Or add to a `climate.yaml` file and reference that file in configuration.yaml:

```yaml
climate: !include climate.yaml
```

![image](https://user-images.githubusercontent.com/33951255/140300295-4915a18f-f5d4-4957-b513-59d7736cc52a.png)
![image](https://user-images.githubusercontent.com/33951255/140303472-fd38b9e4-5c33-408f-afef-25547c39551c.png)


### Getting the DEVICE_ID
1. Loggin to https://salus-it500.com with email and password used in the mobile app (in my case RT301i)
1. Login to `https://salus-it500.com` with email and password used in the mobile app (in my case RT301i)
2. Click on the device
3. In the next page you will be able to see the device ID in the page URL
4. Copy the device ID from the URL
Expand All @@ -55,7 +60,7 @@ The effect of this is that the target temperature/mode values may be out of date

To enable the `TemperatureClient`, set the following settings in `climate.yaml`:

```
```yaml
climate:
- platform: salusfy
username: "EMAIL"
Expand Down Expand Up @@ -86,4 +91,4 @@ ENABLE_TEMPERATURE_CLIENT = True
HOST = "your-home-assistant-ip-address"
ENTITY_ID = "sensor.your-temperature-sensor"
ACCESS_TOKEN = "your-HA-access-token"
```
```
Loading