Optional TemperatureClient to redirect temperature readings another HA entity

,gitattributes

@@ -0,0 +1,3 @@
+* text=auto eol=lf
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf

.devcontainer/devcontainer.json

@@ -0,0 +1,17 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "pip3 install --user -r requirements.txt -r requirements.test.txt"
+	// Configure tool-specific properties.
+	// "customizations": {},
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
+
+version: 2
+updates:
+ - package-ecosystem: "devcontainers"
+   directory: "/"
+   schedule:
+     interval: weekly

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements.ci.txt ]; then pip install -r requirements.ci.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -0,0 +1,4 @@
+config.py
+*.pyc
+__pycache__
+.pytest_cache/

.pylintrc

@@ -0,0 +1,6 @@
+ [MAIN]
+ ignore-paths=
+    config.py
+
+disable=
+    missing-module-docstring

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "."
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

README.md

@@ -1,43 +1,89 @@
-# Home-Assistant Custom Components
-Custom Components for Home-Assistant (http://www.home-assistant.io)
-
-# Salus Thermostat Climate Component
-My device is RT301i, it is working with it500 thermostat, the ideea is simple if you have a Salus Thermostat and you are able to login to salus-it500.com and controll it from this page, this custom component should work.
-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
-* If not exist, in config/custom_components/ create a directory called salusfy 
-* Copy all files in salusfy to your config/custom_components/salusfy/ directory.
-* Configure with config below.
-* Restart Home-Assistant.
-
-### Usage
-To use this component in your installation, add the following to your configuration.yaml file:
-
-### Example configuration.yaml entry
-
-```
-climate:
-  - platform: salusfy
-    username: "EMAIL"
-    password: "PASSWORD"
-    id: "DEVICEID"
-```
-![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 DEVICEID
-1. Loggin 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
-![image](https://user-images.githubusercontent.com/33951255/140301260-151b6af9-dbc4-4e90-a14e-29018fe2e482.png)
-
-
-### Known issues
-salus-it500.com server is bloking the IP of the host, in our case the HA external IP. This can be fixed with router restart in case of PPOE connection or you can try to send a mail to salus support...
+# Home-Assistant Custom Components
+
+[![CI](https://github.com/matthewturner/salusfy/actions/workflows/ci.yml/badge.svg)](https://github.com/matthewturner/salusfy/actions/workflows/ci.yml)
+
+Custom Components for Home-Assistant (http://www.home-assistant.io)
+
+# Salus Thermostat Climate Component
+My device is RT301i, it is working with it500 thermostat, the idea is simple if you have a Salus Thermostat and you are able to login to salus-it500.com and control it from this page, this custom component should work.
+
+## 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. Restart Home Assistant
+
+### Usage
+To use this component in your installation, add the following to your configuration.yaml file:
+
+#### Example configuration.yaml entry
+
+```
+climate:
+  - platform: salusfy
+    username: "EMAIL"
+    password: "PASSWORD"
+    id: "DEVICE_ID"
+```
+![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)
+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
+![image](https://user-images.githubusercontent.com/33951255/140301260-151b6af9-dbc4-4e90-a14e-29018fe2e482.png)
+
+
+### Separate Temperature Client
+Due to how chatty Home Assistant integrations are, the salus-it500.com server may start blocking your public IP address. This will prevent the gateway and mobile client from connecting. To resolve this, you can use the `TemperatureClient` which:
+
+* suppresses requests to Salus for reading the current temperature
+* queries another Home Assistant entity for current temperature via the HA API
+
+The effect of this is that the target temperature/mode values may be out of date **if they have been updated outside of HA**, but the main control features (target temperature, set mode etc) will still work.
+
+To enable the `TemperatureClient`, set the following settings in `climate.yaml`:
+
+```
+climate:
+  - platform: salusfy
+    username: "EMAIL"
+    password: "PASSWORD"
+    id: "DEVICE_ID"
+    enable_temperature_client: True
+    host: "your-home-assistant-ip-address"
+    entity_id: "sensor.your-temperature-sensor"
+    access_token: "your-HA-access-token"
+```
+
+### Running Locally
+
+You can exercise the integration locally using the `run.py` which calls the code on your local machine as if it was being run within Home Assistant. This can help debug any issues you may be having without waiting for multiple Home Assistant restarts.
+
+To get going:
+
+1. Copy `config.sample.py` to `config.py`
+1. Replace the config (below) with the appropriate values for your installation
+1. Run `python ./run.py`
+
+Feel free to change the code to exercise different methods and configuration.
+
+#### Example config.py
+
+```
+ENABLE_TEMPERATURE_CLIENT = True
+HOST = "your-home-assistant-ip-address"
+ENTITY_ID = "sensor.your-temperature-sensor"
+ACCESS_TOKEN = "your-HA-access-token"
+```

config.sample.py

@@ -0,0 +1,14 @@
+# this file is used by the run.py test script
+# it is not required by the custom component
+
+# copy this file to config.py and replace the values
+
+USERNAME = "replace"
+PASSWORD = "replace"
+DEVICE_ID = "replace"
+
+SIMULATOR = False
+ENABLE_TEMPERATURE_CLIENT = False
+HOST = "your-home-assistant-ip-address"
+ENTITY_ID = "sensor.your-temperature-sensor"
+ACCESS_TOKEN = "your-HA-access-token"