homebridge-salus-cloud 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,112 @@
+# Homebridge Salus Cloud
+
+Cloud-only Homebridge dynamic platform for Salus Connect.
+
+This plugin authenticates with Salus cloud using the same modern Cognito + service-api flow used by the Salus mobile app, auto-discovers your devices, and exposes one HomeKit accessory per one Salus device.
+
+## Design goals
+
+- Cloud transport only (no local LAN gateway control).
+- Login with Salus email/password from Homebridge config.
+- Automatic device discovery and ongoing state sync.
+- One HomeKit accessory per one Salus device.
+- Reliable transport with retries, token refresh, endpoint fallback, and detailed logs.
+- Priority support for heating devices (including SQ610/SQ610RF family) while mapping all model categories from the Salus app catalog.
+
+## 2026 cloud flow implemented
+
+The plugin follows the app's modern cloud stack:
+
+- Cognito auth endpoint: `https://cognito-idp.<region>.amazonaws.com/`
+- Auth target: `AWSCognitoIdentityProviderService.InitiateAuth`
+- Login flow: `USER_PASSWORD_AUTH`
+- Refresh flow: `REFRESH_TOKEN_AUTH`
+- Service API base (EU default): `https://service-api.eu.premium.salusconnect.io/api/v1`
+- Service API fallback: `/api/v2`
+- Discovery endpoint: `GET /devices/`
+- Property shadow endpoint: `GET/POST /devices/device_shadows`
+- Control write endpoint (primary): `POST /devices/bulk` (with fallback payload shapes)
+
+## Install
+
+```bash
+npm install
+npm run build
+```
+
+For local Homebridge testing:
+
+```bash
+npm link
+homebridge -D
+```
+
+## Homebridge config
+
+```json
+{
+  "platform": "SalusCloud",
+  "name": "Salus Cloud",
+  "email": "your-salus-email@example.com",
+  "password": "your-salus-password",
+  "region": "eu",
+  "pollIntervalSeconds": 20,
+  "requestTimeoutSeconds": 30,
+  "maxRetries": 3,
+  "retryBaseDelayMs": 750,
+  "maxParallelPropertyRequests": 4,
+  "verboseLogging": false,
+  "allowInsecureTls": false,
+  "apiVersionPreference": "auto",
+  "cognitoRegion": "eu-central-1",
+  "cognitoClientId": "4pk5efh3v84g5dav43imsv4fbj"
+}
+```
+
+## Advanced options
+
+- `apiHost`: Override Salus service-api host (`https://...`) with optional `/api/v1` or `/api/v2` suffix.
+- `apiVersionPreference`: `auto`, `v1`, or `v2`.
+- `cognitoRegion`: Override AWS Cognito region.
+- `cognitoClientId`: Override Cognito app client ID.
+- `companyCode`: Optional `x-company-code` header for partner-brand tenants.
+- `allowInsecureTls`: Only for certificate troubleshooting (not recommended long-term).
+
+## Device mapping
+
+The plugin infers HomeKit service type from both:
+
+1. Salus app model catalog (included in source).
+2. Live property/shadow inspection from cloud.
+
+Examples:
+
+- Thermostats (including SQ610RF): `Thermostat`
+- Relays/plugs/receivers/hot-water timers: `Switch` or `Outlet`
+- Lights/dimmers: `Lightbulb`
+- Roller shutters: `WindowCovering`
+- Valves: `Valve`
+- Door locks: `LockMechanism`
+- Contact/motion/leak/smoke/CO/temperature/humidity/air-quality devices: matching sensor services where available
+
+## Reliability behavior
+
+- Automatic token refresh before expiry and on `401` responses.
+- Exponential backoff retries for transient network/API failures.
+- API base fallback between `/api/v1` and `/api/v2`.
+- Flexible shadow parser for multiple payload shapes.
+- Flexible write payload fallback for service-api compatibility changes.
+- Immediate short re-poll after write to keep HomeKit state aligned.
+- Detailed logs for auth, discovery, shadow sync, writes, retries, and failures.
+
+## Salus features not cleanly mappable to HomeKit
+
+These are intentionally not represented as extra virtual accessories:
+
+1. Full Salus schedule editors and rule-engine objects.
+2. Detailed hold-mode matrix (`follow`, `temp hold`, `perm hold`, `holiday`, `boost`) as first-class HomeKit concepts.
+3. Installer/expert parameters (algorithm tuning, floor limits, valve protection tuning).
+4. Firmware management, pairing/binding topology operations, provisioning workflows.
+5. Historical analytics dashboards and advanced alert configuration UI workflows.
+
+These remain available in the Salus app/cloud UI.

package/config.schema.json

@@ -0,0 +1,148 @@
+{
+  "pluginAlias": "SalusCloud",
+  "pluginType": "platform",
+  "singular": true,
+  "schema": {
+    "type": "object",
+    "required": [
+      "name",
+      "email",
+      "password"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "default": "Salus Cloud"
+      },
+      "email": {
+        "title": "Salus Email",
+        "type": "string",
+        "format": "email",
+        "placeholder": "name@example.com"
+      },
+      "password": {
+        "title": "Salus Password",
+        "type": "string"
+      },
+      "region": {
+        "title": "Region",
+        "type": "string",
+        "default": "eu",
+        "oneOf": [
+          {
+            "title": "Europe (service-api.eu.premium.salusconnect.io)",
+            "enum": [
+              "eu"
+            ]
+          },
+          {
+            "title": "United States (service-api.us.premium.salusconnect.io)",
+            "enum": [
+              "us"
+            ]
+          }
+        ]
+      },
+      "apiHost": {
+        "title": "Advanced: Custom API Host",
+        "type": "string",
+        "description": "Optional override for Salus service-api host. Use full URL with optional /api/v1 or /api/v2 suffix."
+      },
+      "apiVersionPreference": {
+        "title": "Advanced: API Version Preference",
+        "type": "string",
+        "default": "auto",
+        "oneOf": [
+          {
+            "title": "Auto (try v1 then v2)",
+            "enum": [
+              "auto"
+            ]
+          },
+          {
+            "title": "Prefer v1",
+            "enum": [
+              "v1"
+            ]
+          },
+          {
+            "title": "Prefer v2",
+            "enum": [
+              "v2"
+            ]
+          }
+        ]
+      },
+      "cognitoRegion": {
+        "title": "Advanced: Cognito Region",
+        "type": "string",
+        "default": "eu-central-1",
+        "description": "AWS region used by Salus Cognito authentication endpoint."
+      },
+      "cognitoClientId": {
+        "title": "Advanced: Cognito Client ID",
+        "type": "string",
+        "default": "4pk5efh3v84g5dav43imsv4fbj",
+        "description": "Salus mobile-app Cognito client ID. Change only if Salus changes authentication configuration."
+      },
+      "cognitoUserPoolId": {
+        "title": "Advanced: Cognito User Pool ID",
+        "type": "string",
+        "description": "Optional reference value for diagnostics only."
+      },
+      "companyCode": {
+        "title": "Advanced: Company Code Header",
+        "type": "string",
+        "description": "Optional x-company-code header for partner-branded Salus tenants."
+      },
+      "pollIntervalSeconds": {
+        "title": "Polling Interval (seconds)",
+        "type": "integer",
+        "default": 20,
+        "minimum": 10,
+        "maximum": 300
+      },
+      "requestTimeoutSeconds": {
+        "title": "HTTP Timeout (seconds)",
+        "type": "integer",
+        "default": 30,
+        "minimum": 5,
+        "maximum": 120
+      },
+      "maxRetries": {
+        "title": "HTTP Retries",
+        "type": "integer",
+        "default": 3,
+        "minimum": 0,
+        "maximum": 10
+      },
+      "retryBaseDelayMs": {
+        "title": "Retry Base Delay (milliseconds)",
+        "type": "integer",
+        "default": 750,
+        "minimum": 250,
+        "maximum": 10000
+      },
+      "maxParallelPropertyRequests": {
+        "title": "Parallel Device Property Requests",
+        "type": "integer",
+        "default": 4,
+        "minimum": 1,
+        "maximum": 10
+      },
+      "verboseLogging": {
+        "title": "Verbose Logging",
+        "type": "boolean",
+        "default": false
+      },
+      "allowInsecureTls": {
+        "title": "Allow Insecure TLS",
+        "type": "boolean",
+        "default": false,
+        "description": "Only enable if Salus cloud certificate validation fails (for example CERT_HAS_EXPIRED)."
+      }
+    }
+  }
+}

package/dist/deviceCatalog.d.ts

@@ -0,0 +1,10 @@
+export type HomeKitDeviceKind = 'thermostat' | 'switch' | 'outlet' | 'lightbulb' | 'windowCovering' | 'valve' | 'lock' | 'motionSensor' | 'contactSensor' | 'leakSensor' | 'smokeSensor' | 'carbonMonoxideSensor' | 'temperatureSensor' | 'humiditySensor' | 'airQualitySensor' | 'occupancySensor';
+export interface ModelCatalogEntry {
+    model: string;
+    layout: string;
+    categoryId: string;
+    categoryName: string;
+}
+export declare const MODEL_CATALOG: Record<string, ModelCatalogEntry>;
+export declare function inferKindFromCatalog(model: string): HomeKitDeviceKind | undefined;
+export declare function getCatalogEntry(model: string): ModelCatalogEntry | undefined;