homebridge-evohome-modern 0.0.1

package/.eslintrc

@@ -0,0 +1,31 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended", // uses the recommended rules from the @typescript-eslint/eslint-plugin
+      "plugin:jest/recommended" // enables eslint-plugin-jest
+    ],
+    "parserOptions": {
+      "ecmaVersion": 2018,
+      "sourceType": "module"
+    },
+    "ignorePatterns": ["bin/"],
+    "rules": {
+      "quotes": ["error", "double"],
+      "indent": ["error", 2, { "SwitchCase": 1 }],
+      "linebreak-style": ["error", "unix"],
+      "semi": ["error", "always"],
+  
+      "comma-dangle": ["error", "always-multiline"],
+      "dot-notation": "error",
+      "eqeqeq": "error",
+      "curly": ["error", "all"],
+      "brace-style": ["error"],
+  
+      "no-var": ["error"],
+      "no-extra-bind": ["error"],
+  
+      "@typescript-eslint/no-non-null-assertion": "off" // currently disabled, hap-nodejs has some bad typing (like getCharacteristic) for this to be enabled
+    }
+  }

package/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# 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 all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

package/.github/workflows/codeql.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '31 15 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,17 @@
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 12
+      - run: npm install
+      - run: npm test
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.tabSize": 2
+}

package/README.md

@@ -0,0 +1,103 @@
+<span align="center">
+
+![Honeywell Evohome Controller](assets/honeywell_round.png)&nbsp;&nbsp;
+![Honeywell Evohome Controller](assets/TCC_EMEA.png)&nbsp;&nbsp;
+![Honeywell Evohome Controller](assets/honeywell_evohome.png)
+
+# Honeywell Evohome support for Homebridge
+![npm](https://img.shields.io/npm/dt/homebridge-evohome?logo=npm)
+![npm](https://img.shields.io/npm/dw/homebridge-evohome?logo=npm)
+![npm](https://img.shields.io/npm/v/homebridge-evohome?logo=npm)
+[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+
+
+</span>
+
+This ia a plugin to integrate [Honeywell Evohome](https://getconnected.honeywellhome.com/de/thermostate/evohome) into Apple HomeKit. It is work in progress. Help is greatly appreciated!
+
+Up until now this plugin will only add your Thermostats and central functions (for example "ECO") to Homebridge. Other devices such as domestic hot water will probably follow in the future once we can wrap our heads arround it (and have someone to test it out).
+
+## 🚀 Getting Started
+
+**Homebridge with [Config UI X](https://github.com/oznu/homebridge-config-ui-x):**
+1. Go to the "Plugins" tab and search for `homebridge-evohome`
+2. Install the plugin and fill out the setup form
+
+**Terminal / NPM:**
+1. Install this plugin using `npm install -g homebridge-evohome@latest`
+2. Update your configuration file ([sample-config below](https://github.com/luc-ass/homebridge-evohome#%EF%B8%8F-configuration))
+
+## ⚙️ Configuration
+
+Configuration sample:
+
+```json
+"platforms": [
+        {
+            "platform": "Evohome",
+            "name" : "Evohome",
+            "username" : "username/email",
+            "password" : "password",
+            "temperatureUnit" : "Celsius",
+            "locationIndex" : "0"
+        }
+    ]
+```
+
+| Parameter          | optional | accepted values               | info |
+| :--                | :--      | :--                           | :-- |
+| `platform`         | no       | `Evohome`                       | |
+| `name`             | no       | *any Name you want*           | |
+| `username`         | no       | *your Honeywell email adress* | |
+| `password`         | no       | *your Honeywell password*     | |
+| `temperatureUnit`  | yes      | `Celsius`, `Fahrenheit`           | defaults to `Celsius` |
+| `locationIndex`    | yes      | `0`, `1`, `2`, etc.                 | only needed if you have multiple locations |
+| `switchAway`       | yes      | `true`,  `false`                   | creates a switch for away mode |
+| `switchDayOff`     | yes      | `true`,  `false`                   | creates a switch for day off mode |
+| `switchEco`        | yes      | `true`,  `false`                   | creates a switch for eco settings |
+| `switchHeatingOff` | yes      | `true`,  `false`                   | creates a switch to tur off the heating |
+| `switchCustom`     | yes      | `true`,  `false`                   | creates a switch for your custom mode |
+| `childBridge`     | yes      | `true`,  `false`                   | allows you to have persistent accessories, if plugin is run inside a child bridge |
+| `temperatureAboveAsOff`     | yes      | `true`,  `false`                   | allows you to displays thermostats as off, if room temperature is above target temperature |
+
+
+## 📝 Roadmap
+
+- [x] Get device names
+- [x] Read temperature
+- [x] Update temperature
+- [x] Set target temperature (credits to @zizzex)
+- [x] Change temperature until next scheduled event (credits to @fredericvl). This feature sets the temperature until the next scheduled event on the same day. If there is no event on the same day it will be scheduled until 00:00:00. As this is a new feature it contains advanced logging. Please post your log if you encounter any problems.
+- [x] Make use of Elgato Eve graphs (using fakegato-history) including automatic updating (credits to @rooi)
+- [x] Add "global device" to add Away/Energy saving etc. (credits to @fredericvl)
+- [x] Add support for multiple locations. (credits to @ebarnard)
+- [x] Add support for Honeywell Round Connected
+- [ ] Add "DOMESTIC_HOT_WATER" with matching characteristics. This device will now be ignored to prevent errors (credits to @sOckhamSter).
+
+## ⚠️ Known Issues & Notes
+
+- System time/time zone must be the same as the time on your evohome controller or else schedules will work in unexpected ways.
+- Your password may not contain `&` or else the login will fail.
+- Updating from `<0.5.1` to `>0.6.0` will create new devices and put them into the standard room of your home. They just need to be moved back to their rooms. This is expected behaviour as the UUID has changed. Historic data will be retained. This can also happen without a clear cause. It is under investigation here: [#61](../../issues/61).
+
+## 🧪 Beta Testing
+
+This part talks about testing pre-release version of the plugin. I strongly recommend, that you don't do this in your production environment. It will frequently reset accessories and break automations. If you still want to or have been asked to, this is my preferred way of installing from github:
+
+In Homebridge Config UI X Terminal:
+
+```sh
+# go to node module directory
+cd node_modules
+# remove homebridge-evohome and contents
+rm -r homebridge-evohome
+# recreate the folder
+mkdir homebridge-evohome
+# clone repo to folder
+git clone --single-branch --branch main https://github.com/luc-ass/homebridge-evohome.git ./homebridge-evohome
+# cd into folder
+cd homebridge-evohome
+# install plugin
+npm install
+```
+Now restart Homebridge

package/config.schema.json

@@ -0,0 +1,123 @@
+{
+	"pluginAlias": "Evohome",
+	"pluginType": "platform",
+	"singular": false,
+	"headerDisplay": "This Plugin integrates your Honeywell Evohome into Homebridge. Please use your credentials from https://getconnected.honeywellhome.com. You should consider running this plugin as a child bridge, as it allows for persistent accessories, thus prevent breaking your automations!",
+	"footerDisplay": "It is important, that your Homebridge time zone is set correct. Please double check this! If you encounter any problems don't hesitate to have a look at https://github.com/luc-ass/homebridge-evohome.",
+	"schema": {
+		"type": "object",
+		"properties": {
+			"name": {
+				"title": "Name",
+				"type": "string",
+				"default": "Evohome",
+				"minLength": 1,
+				"required": true,
+				"description": "Plugin name as displayed in the Homebridge log"
+			},
+			"username": {
+				"title": "Username/Email adress",
+				"type": "string",
+				"format": "email",
+				"required": true
+			},
+			"password": {
+				"title": "Password",
+				"type": "string",
+				"required": true
+			},
+			"temperatureUnit": {
+				"title": "Temperature Unit",
+				"type": "string",
+				"default": "Celsius",
+				"oneOf": [
+					{ "title": "Celsius", "enum": ["Celsius"] },
+					{ "title": "Fahrenheit", "enum": ["Fahrenheit"] }
+				],
+				"required": true
+			},
+			"locationIndex": {
+				"title": "Location Index",
+				"type": "integer",
+				"minimum": 0,
+				"default": 0,
+				"required": false,
+				"description": "This should only be changed if you have more than one location. The index starts with \"0\" and counts up for each added home."
+			},
+			"switchAway": {
+				"title": "Display \"Away Switch\"",
+				"type": "boolean",
+				"default": true,
+				"required": false
+			},
+			"switchDayOff": {
+				"title": "Display \"Day Off Switch\"",
+				"type": "boolean",
+				"default": true,
+				"required": false
+			},
+			"switchEco": {
+				"title": "Display \"Eco Mode Switch\"",
+				"type": "boolean",
+				"default": true,
+				"required": false
+			},
+			"switchHeatingOff": {
+				"title": "Display \"Heating Off Switch\"",
+				"type": "boolean",
+				"default": true,
+				"required": false
+			},
+			"switchCustom": {
+				"title": "Display \"Custom Mode Switch\"",
+				"type": "boolean",
+				"default": true,
+				"required": false
+			},
+			"childBridge": {
+				"title": "This accessory runs in a child bridge (recommended)",
+				"description": "This switch should be turned on, if the platform is run as a child bridge. This ensures, that accessories are not lost on error.",
+				"type": "boolean",
+				"default": false,
+				"required": false
+      },
+			"temperatureAboveAsOff": {
+				"title": "Represent room temperature above set temperature as off",
+				"type": "boolean",
+				"default": false,
+				"required": true
+			}
+		}
+	},
+	"layout": [
+		"name",
+		{
+			"type": "flex",
+			"flex-flow": "row wrap",
+			"items": [
+				"username",
+				{
+					"key": "password",
+					"type": "password"
+				}
+			]
+		},
+		{
+			"type": "fieldset",
+			"title": "Optional Settings",
+			"expandable": true,
+			"expanded": false,
+			"items": [
+				"temperatureUnit",
+				"locationIndex",
+				"switchAway",
+				"switchDayOff",
+				"switchEco",
+				"switchHeatingOff",
+				"switchCustom",
+				"childBridge",
+				"temperatureAboveAsOff"
+			]
+		}
+	]
+}