homebridge-tryfi 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.1.0] - 2026-01-21
+
+### Added
+- **Ignored Pets**: New `ignoredPets` configuration option to exclude specific pets from HomeKit
+  - Add pet names to the ignore list in config
+  - Case-insensitive matching
+  - Ignored pets won't create HomeKit accessories
+  - Polling skips ignored pets to reduce API calls
+  - Example: Add `"Charlie"` to `ignoredPets` array to exclude Charlie
+
+### Configuration Example
+```json
+{
+  "platform": "TryFi",
+  "username": "your@email.com",
+  "password": "your_password",
+  "pollingInterval": 60,
+  "escapeAlertType": "leak",
+  "ignoredPets": ["Charlie", "Max"]
+}
+```
+
+## [1.0.0] - 2026-01-21
+
+### Added
+- Initial release
+- TryFi GPS collar integration with HomeKit
+- Escape alert sensor (leak or motion sensor)
+- Battery monitoring with low battery warnings
+- LED light control
+- Lost Dog Mode switch
+- Automatic polling for updates
+- Session-based authentication with cookie persistence
+
+### Features
+- Per-dog HomeKit accessories
+- Safe zone detection (escape alerts when outside safe zones AND not with owner)
+- Configurable polling interval (30-300 seconds)
+- Configurable escape alert type (leak sensor for critical alerts, motion sensor for standard)

package/CHANGES-V3.md

@@ -0,0 +1,103 @@
+# V3 Changes - Copied EXACT pytryfi Implementation
+
+## Why V3 Was Needed
+Previous versions guessed at the GraphQL API structure. This version copies pytryfi's implementation exactly.
+
+## Critical Changes from V2
+
+### 1. REST Login (CORRECT)
+- Endpoint: `POST /auth/login`
+- Content-Type: `application/x-www-form-urlencoded`
+- Body: `email=xxx&password=yyy` (form data, NOT JSON)
+- Returns: `userId` and `sessionId`
+- Auth: Session cookies managed by axios
+
+### 2. GraphQL Query Structure (COPIED FROM PYTRYFI)
+**Query:** Uses `currentUser` (no parameters) with exact fragment structure:
+```graphql
+query {
+  currentUser {
+    userHouseholds {
+      household {
+        pets {
+          id
+          name
+          breed { name }
+          device {
+            id
+            moduleId
+            info  # JSON object with batteryPercent, isCharging
+            operationParams {
+              mode       # "NORMAL" or "LOST_DOG"
+              ledEnabled
+              ledOffAt
+            }
+            lastConnectionState {
+              # Union type: ConnectedToUser, ConnectedToBase, ConnectedToCellular
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+### 3. Separate Location Query (MATCHES PYTRYFI)
+```graphql
+query {
+  pet(id: "petId") {
+    ongoingActivity {
+      areaName
+      ... on OngoingRest {
+        position { latitude longitude }
+        place { name address }  # Safe zone, null when not in zone
+      }
+      ... on OngoingWalk {
+        positions { position { latitude longitude } }
+      }
+    }
+  }
+}
+```
+
+### 4. Mutations (EXACT PYTRYFI STRUCTURE)
+```graphql
+mutation UpdateDeviceOperationParams($input: UpdateDeviceOperationParamsInput!) {
+  updateDeviceOperationParams(input: $input) {
+    id
+    moduleId
+    operationParams { mode ledEnabled ledOffAt }
+  }
+}
+```
+
+Variables for LED:
+```json
+{ "input": { "moduleId": "xxx", "ledEnabled": true } }
+```
+
+Variables for Lost Dog Mode:
+```json
+{ "input": { "moduleId": "xxx", "mode": "LOST_DOG" } }
+```
+
+## Key Field Mappings
+- `device.info.batteryPercent` → battery level (parsed from JSON)
+- `device.info.isCharging` → charging status
+- `device.operationParams.ledEnabled` → LED on/off
+- `device.operationParams.mode` → "NORMAL" or "LOST_DOG"
+- `ongoingActivity.place.name` → safe zone name (null when not in zone)
+- `lastConnectionState.__typename === "ConnectedToUser"` → with owner
+- `lastConnectionState.__typename === "ConnectedToBase"` → charging
+
+## Escape Alert Logic
+```
+isEscaped = (placeName === null) && (connectedToUser === null)
+```
+Dog is "escaped" when:
+- NOT in any safe zone (place.name is null)
+- AND NOT with owner (not ConnectedToUser)
+
+## No More Guessing
+This version uses ONLY what pytryfi uses. No assumptions.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,139 @@
+# homebridge-tryfi
+
+Homebridge plugin for TryFi Dog GPS Collars
+
+[![npm version](https://badge.fury.io/js/homebridge-tryfi.svg)](https://badge.fury.io/js/homebridge-tryfi)
+
+## Features
+
+This plugin exposes your TryFi dog collars to HomeKit with the following accessories per dog:
+
+- **Battery Service** - Shows battery level and charging status
+- **Lightbulb** - Control the collar's LED light (on/off)
+- **Switch** - Toggle Lost Dog Mode (triggers high-frequency GPS updates)
+- **Escape Alert** - Configurable sensor (Leak or Motion) that triggers when your dog is:
+  - Outside ALL safe zones, AND
+  - Not connected to any owner via Bluetooth
+
+### Escape Alert Logic
+
+The escape alert only triggers when BOTH conditions are true:
+1. `currPlaceName` is `null` (not in any defined safe zone)
+2. `connectedTo` is `null` (not with an owner)
+
+This means:
+- ✅ Dog at home alone → No alert (in safe zone)
+- ✅ Dog at dog park alone → No alert (in safe zone)  
+- ✅ Dog on a walk with you → No alert (with owner)
+- 🚨 **Dog escaped alone** → ALERT! (outside zones + alone)
+
+## Installation
+
+### Option 1: Homebridge Config UI X (Recommended)
+
+1. Search for "TryFi" in the Homebridge Config UI X plugin marketplace
+2. Click Install
+3. Configure with your TryFi credentials
+
+### Option 2: Manual Installation
+
+```bash
+npm install -g homebridge-tryfi
+```
+
+## Configuration
+
+Add this to your Homebridge `config.json`:
+
+```json
+{
+  "platforms": [
+    {
+      "platform": "TryFi",
+      "name": "TryFi",
+      "username": "your@email.com",
+      "password": "yourpassword",
+      "pollingInterval": 60,
+      "escapeAlertType": "leak"
+    }
+  ]
+}
+```
+
+### Configuration Options
+
+| Option | Required | Default | Description |
+|--------|----------|---------|-------------|
+| `platform` | Yes | - | Must be `"TryFi"` |
+| `name` | Yes | - | Platform name (can be anything) |
+| `username` | Yes | - | Your TryFi email address |
+| `password` | Yes | - | Your TryFi password |
+| `pollingInterval` | No | `60` | Seconds between API polls (10-300) |
+| `escapeAlertType` | No | `"leak"` | `"leak"` for critical alerts, `"motion"` for standard alerts |
+
+### Escape Alert Types
+
+**Leak Sensor** (default):
+- Triggers **critical** HomeKit notifications
+- Shows "Leak Detected" when dog escapes
+- Best for: Maximum urgency
+
+**Motion Sensor**:
+- Triggers **standard** HomeKit notifications  
+- Shows "Motion Detected" when dog escapes
+- Best for: Less alarming notifications, still useful for automations
+
+## Usage
+
+### Automations
+
+Example automations you can create:
+
+**Critical Escape Alert:**
+```
+When [Dog Name] Escape Alert detects leak
+  → Send notification "🚨 [Dog] has escaped!"
+  → Turn on [Dog Name] Lost Mode
+  → Flash living room lights
+```
+
+**Low Battery Warning:**
+```
+When [Dog Name] Battery drops below 20%
+  → Send notification "🔋 [Dog]'s collar battery is low"
+```
+
+**Auto Lost Mode on Escape:**
+```
+When [Dog Name] Escape Alert detects leak
+  → Turn on [Dog Name] Lost Mode
+```
+
+## Development
+
+### Building
+
+```bash
+npm install
+npm run build
+```
+
+### Linking for Development
+
+```bash
+npm link
+```
+
+Then restart Homebridge.
+
+## Credits
+
+Based on the excellent [pytryfi](https://github.com/sbabcock23/pytryfi) library and [hass-tryfi](https://github.com/sbabcock23/hass-tryfi) Home Assistant integration.
+
+## License
+
+Apache-2.0
+
+## Disclaimer
+
+This is an unofficial plugin and is not affiliated with or endorsed by TryFi.