homebridge-tydom 0.30.1 → 0.31.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2020 Olivier Louvignes <olivier@mgcrea.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -4,7 +4,7 @@
 
 <p align="center">
   <a href="https://github.com/mgcrea/homebridge-tydom">
-    <img src="https://raw.githubusercontent.com/mgcrea/homebridge-tydom/master/docs/homebridge-tydom_small.png" height="320" alt="Homebridge Tydom Logo" />
+    <img src="https://raw.githubusercontent.com/mgcrea/homebridge-tydom/main/docs/homebridge-tydom_small.png" height="320" alt="Homebridge Tydom Logo" />
   </a>
 </p>
 
@@ -79,9 +79,59 @@ Then configure the platform, either in the Homebridge UI or directly in `config.
 
 ### Finding your credentials
 
-Your **username** is the MAC address of your gateway: `001A25` followed by the 6-character home ID shown in the mobile app.
+Your **username** is the MAC address of your gateway: `001A25` followed by the 6-character home ID shown in the mobile app. Separators and case do not matter — `00:1a:25:12:34:56` works too.
 
-Your **password** is the one for your Tydom account. Newer setups have it generated by the mobile app and never show it to you; the only known way to recover it is to inspect the app's traffic with an SSL proxy, following [this guide](https://github.com/mgcrea/homebridge-tydom/issues/72#issuecomment-1315036089) from @aure-olivier.
+Your **password** is the gateway's own, which is not the one you sign in to the Tydom app with. Newer setups have it generated by the app and never show it to you.
+
+Rather than extract it, add your account **e-mail** and let the plugin fetch it for you:
+
+```json
+{
+  "platform": "Tydom",
+  "hostname": "mediation.tydom.com",
+  "username": "001A25123456",
+  "email": "you@example.com",
+  "password": "YourDeltaDoreAccountPassw0rd"
+}
+```
+
+With `email` set, `password` is read as your **Delta Dore account** password: at startup the plugin signs in to Delta Dore, looks up the gateway named in `username`, and uses the gateway password it gets back. Nothing else changes, and your account password is never sent to the gateway. Leave `email` out — the default — and `password` keeps its old meaning of the gateway's own password.
+
+The account has to already own that gateway. To check a pair without waiting on Homebridge:
+
+```bash
+pnpm resolve-credentials you@example.com 'YourDeltaDoreAccountPassw0rd' 001A25123456
+```
+
+If you would rather extract the gateway password by hand, you still can, by inspecting the app's traffic with an SSL proxy following [this guide](https://github.com/mgcrea/homebridge-tydom/issues/72#issuecomment-1315036089) from @aure-olivier.
+
+### If your account has several houses
+
+`username` is what picks the house. One Delta Dore account can hold several — a home, a holiday flat, a relative's place — and each is one gateway with its own MAC. Point `username` at the MAC of the house you want this Homebridge instance to expose, and that is the one you get. Adding `email` does not change that: the account lookup is scoped to the MAC you named, and hands back that gateway's password specifically.
+
+To find the MAC of each house, open the Tydom app's home list and read the 6-character home ID next to each one; the MAC is `001A25` followed by that. An account holding three homes gives you three MACs, and each resolves to its own distinct gateway password:
+
+```text
+Maison            ->  001A25 AAAAAA
+Appartement       ->  001A25 BBBBBB
+Chalet            ->  001A25 CCCCCC
+```
+
+Pick the one you want and put it in `username`. Note that the account only ever *confirms* a gateway you name — there is no public Delta Dore API that lists the houses on an account, and the lookup carries no house name either, so the home ID from the app is how you tell them apart.
+
+A correct MAC is not the same as access to that house. The lookup resolves any real gateway by MAC, and only the *credentials* are gated on what your account may reach — so a house you have no access to still comes back, just stripped of its password. The plugin says so rather than pretending the MAC is wrong:
+
+```text
+Delta Dore returned no password for gateway 001A25XXXXXX. The gateway exists, but this
+account has no access to that house — sign in with an account that does, or set "password"
+to the gateway password directly and leave "email" out.
+```
+
+As that says, the fallback is to drop `email` and give that house's gateway password directly.
+
+Each house gets its own accessory namespace, derived from that home ID, so switching `username` from one house to another retires the first house's accessories and publishes the second's rather than mixing them up. Expect a batch of `Deleting missing accessory` lines in the log the first time you do it — that is the sweep clearing out the house you moved away from.
+
+A platform block is one house at a time; the plugin is declared `singular`, so the Homebridge UI allows a single Tydom block. To expose two houses at once you would need a second Homebridge instance, or a hand-written second platform block run as a child bridge.
 
 Both secrets can be supplied out of band instead, base64-encoded, which is usually what you want in a container:
 
@@ -97,8 +147,9 @@ They take precedence over the corresponding config fields.
 | Field | Type | Default | Description |
 | --- | --- | --- | --- |
 | `hostname` | `string` | — | `mediation.tydom.com` for the relay, or your gateway's LAN address (see [Connecting locally](#connecting-locally)). Required. |
-| `username` | `string` | — | Gateway MAC address, e.g. `001A25123456`. Required. |
-| `password` | `string` | — | Tydom account password. Required, unless supplied via the environment. |
+| `username` | `string` | — | Gateway MAC address, e.g. `001A25123456`. This is what selects the house — see [If your account has several houses](#if-your-account-has-several-houses). Required. |
+| `email` | `string` | — | Delta Dore account e-mail. Set it to have the gateway password fetched for you, which also changes what `password` below means. See [Finding your credentials](#finding-your-credentials). |
+| `password` | `string` | — | Your Delta Dore account password if `email` is set, otherwise the gateway's own password. Required, unless supplied via the environment. |
 | `pin` | `string` | — | TYXAL+ alarm PIN. Without it the alarm reports its state but cannot be armed or disarmed. |
 | `locale` | `"fr" \| "en"` | `"fr"` | Language of the labels Delta Dore supplies for zones, detectors and thermostat modes. |
 | `refreshInterval` | `number` | `14400` | Seconds between full state refreshes. The gateway pushes changes as they happen, so this is only a safety net; clamped to a minimum of 60. |
@@ -121,7 +172,8 @@ Environment variables:
 
 | Variable | Description |
 | --- | --- |
-| `HOMEBRIDGE_TYDOM_PASSWORD` | Tydom password, base64-encoded. Overrides `password`. |
+| `HOMEBRIDGE_TYDOM_PASSWORD` | Gateway or account password, base64-encoded. Overrides `password`. |
+| `HOMEBRIDGE_TYDOM_EMAIL` | Delta Dore account e-mail, in plain text. Overrides `email`. |
 | `HOMEBRIDGE_TYDOM_PIN` | TYXAL+ PIN, base64-encoded. Overrides `pin`. |
 | `HOMEBRIDGE_TYDOM_LOCALE` | `fr` or `en`. Overrides `locale`. |
 

package/config.schema.json

@@ -20,12 +20,17 @@
         "required": true,
         "description": "Your gateway's MAC address, uppercase and without separators — e.g. `001A25123456`. It is printed underneath the Tydom box."
       },
+      "email": {
+        "title": "Delta Dore account e-mail",
+        "type": "string",
+        "description": "Optional. The e-mail you sign in to the Tydom app with.\n\nFill it in and the password below is read as your **Delta Dore account** password: the plugin signs in at startup and fetches the gateway's own password for you. Leave it empty — the default — and the password below is the **gateway's** password, used as-is.\n\nThe account has to already own the gateway named above; this looks a password up, it cannot discover which gateways you have. Also accepted as a `HOMEBRIDGE_TYDOM_EMAIL` environment variable."
+      },
       "password": {
         "title": "Password",
         "type": "string",
         "required": true,
         "x-schema-form": { "type": "password" },
-        "description": "The password of your Tydom account. Can be supplied out of band instead, as a base64-encoded `HOMEBRIDGE_TYDOM_PASSWORD` environment variable, which takes precedence over this field."
+        "description": "Your Delta Dore account password if an e-mail is set above, otherwise the gateway's own password. Can be supplied out of band instead, as a base64-encoded `HOMEBRIDGE_TYDOM_PASSWORD` environment variable, which takes precedence over this field."
       },
       "pin": {
         "title": "Alarm PIN",
@@ -121,7 +126,11 @@
     }
   },
   "layout": [
-    { "type": "fieldset", "title": "Connection", "items": ["hostname", "username", "password"] },
+    {
+      "type": "fieldset",
+      "title": "Connection",
+      "items": ["hostname", "username", "email", "password"]
+    },
     {
       "type": "fieldset",
       "title": "Alarm",

package/dist/env-B2-Dw8C2.mjs

@@ -0,0 +1,18 @@
+//#region src/config/env.ts
+const PLUGIN_NAME = "homebridge-tydom";
+const PLATFORM_NAME = "Tydom";
+/**
+* The plugin and platform names.
+*
+* Both are frozen: PLATFORM_NAME is the `"platform"` key in every installed
+* user's config.json, and PLUGIN_NAME identifies cached accessories.
+*
+* The HOMEBRIDGE_TYDOM_* environment variables that used to be destructured
+* here are read by parseConfig instead, so they can be tested and so they are
+* resolved after Homebridge has read the config rather than at import time.
+*/
+const { DEBUG } = process.env;
+//#endregion
+export { PLUGIN_NAME as n, PLATFORM_NAME as t };
+
+//# sourceMappingURL=env-B2-Dw8C2.mjs.map

package/dist/env-B2-Dw8C2.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-B2-Dw8C2.mjs","names":[],"sources":["../src/config/env.ts"],"sourcesContent":["export const PLUGIN_NAME = \"homebridge-tydom\";\nexport const PLATFORM_NAME = \"Tydom\";\n/**\n * The plugin and platform names.\n *\n * Both are frozen: PLATFORM_NAME is the `\"platform\"` key in every installed\n * user's config.json, and PLUGIN_NAME identifies cached accessories.\n *\n * The HOMEBRIDGE_TYDOM_* environment variables that used to be destructured\n * here are read by parseConfig instead, so they can be tested and so they are\n * resolved after Homebridge has read the config rather than at import time.\n */\nexport const { DEBUG } = process.env;\n"],"mappings":";AAAA,MAAa,cAAc;AAC3B,MAAa,gBAAgB;;;;;;;;;;;AAW7B,MAAa,EAAE,UAAU,QAAQ"}

package/dist/index.d.mts

@@ -1,7 +1,6 @@
-import "source-map-support/register.js";
 import { API } from "homebridge";
 //#region src/index.d.ts
-declare const _default: (homebridge: API) => void;
+declare function _default(homebridge: API): void;
 //#endregion
 export { _default as default };
 //# sourceMappingURL=index.d.mts.map