@oblongmedulla/homebridge-pawport 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.gitignore~ ADDED
File without changes
package/README.md CHANGED
@@ -1,120 +1,105 @@
1
- # homebridge-pawport
2
-
3
- [![npm](https://img.shields.io/npm/v/homebridge-pawport)](https://www.npmjs.com/package/homebridge-pawport)
4
- [![npm](https://img.shields.io/npm/dt/homebridge-pawport)](https://www.npmjs.com/package/homebridge-pawport)
5
-
6
- A [Homebridge](https://homebridge.io) plugin that exposes your [Pawport](https://pawport.com) smart pet door as a **Lock** in Apple Home. Lock and unlock your pet door from the Home app, Siri, or automations.
7
-
8
- Supports **multiple doors** on a single account.
9
-
10
- ---
11
-
12
- ## Installation
13
-
14
- ### Via Homebridge UI (recommended)
15
- Search for `homebridge-pawport` in the Homebridge plugin search and click Install.
16
-
17
- ### Manual
18
- ```bash
19
- npm install -g homebridge-pawport
20
- ```
21
-
22
- ---
23
-
24
- ## Configuration
25
-
26
- After installing, go to the **Plugins** tab in Homebridge UI, find `homebridge-pawport`, and click **Settings**. Add one entry per door with:
27
-
28
- | Field | Description |
29
- |-------|-------------|
30
- | **Door Name** | Whatever you want to call it in Apple Home (e.g. "Dog Door") |
31
- | **Auth Token** | Your `x-auth-token` from the Pawport app (see below) |
32
- | **Door ID** | The UUID of your door (see below) |
33
-
34
- ### Manual config.json example
35
-
36
- ```json
37
- {
38
- "platforms": [
39
- {
40
- "platform": "PawportPlatform",
41
- "name": "Pawport",
42
- "doors": [
43
- {
44
- "name": "Dog Door",
45
- "authToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
46
- "doorID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
47
- },
48
- {
49
- "name": "Cat Flap",
50
- "authToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
51
- "doorID": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
52
- }
53
- ]
54
- }
55
- ]
56
- }
57
- ```
58
-
59
- ---
60
-
61
- ## Finding Your Credentials
62
-
63
- You'll need to intercept your Pawport app's network traffic once to grab your `authToken` and `doorID`. Here's how:
64
-
65
- ### What you need
66
- - An iPhone with the Pawport app installed
67
- - [Proxyman](https://apps.apple.com/us/app/proxyman-network-debug-tool/id1551292695) (free) or [Stream](https://apps.apple.com/us/app/stream-http-debugging-proxy/id1312141691) (~$4.99) from the App Store
68
-
69
- ### Steps
70
-
71
- 1. Install Proxyman or Stream on your iPhone
72
- 2. Follow the in-app instructions to install the SSL certificate (Settings → trust the cert)
73
- 3. Start capturing traffic
74
- 4. Open the Pawport app, log in, and lock/unlock the door once
75
- 5. Stop capture and filter by `api.app.pawport.com`
76
- 6. Tap on a **sendDoorCommand** request
77
- 7. View the **Request** tab / Raw headers
78
-
79
- You're looking for:
80
- - **`x-auth-token`** header this is your `authToken`
81
- - **`doorID`** field in the request body → this is your `doorID`
82
-
83
- ---
84
-
85
- ## How It Works
86
-
87
- This plugin communicates with the Pawport cloud API using the same GraphQL endpoint as the official iOS app. The door appears as a **Lock Mechanism** in HomeKit, which means you can:
88
-
89
- - Lock / unlock from the Home app
90
- - Use Siri ("Hey Siri, lock the dog door")
91
- - Create automations (e.g. lock at sunset, unlock at 7am)
92
- - Include it in Home scenes
93
-
94
- > **Note:** This plugin is not affiliated with or endorsed by Pawport. Use at your own risk.
95
-
96
- ---
97
-
98
- ## Troubleshooting
99
-
100
- **Door shows as "No Response"**
101
- - Check that your `authToken` is correct and hasn't expired
102
- - Make sure your Homebridge server has internet access
103
-
104
- **Command fails silently**
105
- - Check the Homebridge logs for error details
106
- - Try locking/unlocking from the Pawport app to confirm the door is online
107
-
108
- ---
109
-
110
- ## Contributing
111
-
112
- Pull requests welcome! Please open an issue first to discuss what you'd like to change.
113
-
114
- [GitHub Repository](https://github.com/oblongmedulla/homebridge-pawport)
115
-
116
- ---
117
-
118
- ## License
119
-
120
- MIT © [oblongmedulla](https://github.com/oblongmedulla)
1
+ # homebridge-pawport
2
+ [![npm](https://img.shields.io/npm/v/%40oblongmedulla/homebridge-pawport)](https://www.npmjs.com/package/@oblongmedulla/homebridge-pawport)
3
+ [![npm](https://img.shields.io/npm/dt/%40oblongmedulla/homebridge-pawport)](https://www.npmjs.com/package/@oblongmedulla/homebridge-pawport)
4
+
5
+ A Homebridge plugin that exposes your Pawport smart pet door as a **Lock** in Apple Home. Lock and unlock your pet door from the Home app, Siri, or automations.
6
+
7
+ Supports **multiple doors** on a single account.
8
+
9
+ ---
10
+
11
+ ## Installation
12
+
13
+ ### Via Homebridge UI (Recommended)
14
+
15
+ Search for `homebridge-pawport` in the Homebridge plugin search and click **Install**.
16
+
17
+ ### Manual Installation
18
+
19
+ ```bash
20
+ npm install -g homebridge-pawport
21
+ ```
22
+
23
+ ## Configuration
24
+
25
+ After installing, go to the **Plugins** tab in Homebridge UI, find **homebridge-pawport**, and click **Settings**.
26
+
27
+ Add one entry per door with:
28
+
29
+ | Field | Description |
30
+ | ---------- | ------------------------------------------------------------ |
31
+ | Door Name | Whatever you want to call it in Apple Home (e.g. "Dog Door") |
32
+ | Auth Token | Your `x-auth-token` from the Pawport app (see below) |
33
+ | Door ID | The UUID of your door (see below) |
34
+
35
+ ### Manual `config.json` Example
36
+
37
+ ```json
38
+ {
39
+ "platforms": [
40
+ {
41
+ "platform": "PawportPlatform",
42
+ "name": "Pawport",
43
+ "doors": [
44
+ {
45
+ "name": "Dog Door",
46
+ "authToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
47
+ "doorID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
48
+ },
49
+ {
50
+ "name": "Cat Flap",
51
+ "authToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
52
+ "doorID": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
53
+ }
54
+ ]
55
+ }
56
+ ]
57
+ }
58
+ ```
59
+
60
+ ## Finding Your Credentials (Easy Mode)
61
+
62
+ You no longer need to proxy network traffic or capture SSL certificates to get your credentials.
63
+
64
+ You can use the built-in login tool right inside the settings layout:
65
+
66
+ 1. Open the plugin **Settings** modal in the Homebridge UI.
67
+ 2. Click the **Login to Pawport** helper button at the top of the interface.
68
+ 3. Enter your registered Pawport account email and password.
69
+ 4. The plugin will securely reach out to the API and automatically fill in your Auth Token and Door ID values directly into the configuration form.
70
+
71
+ ## How It Works
72
+
73
+ This plugin communicates with the Pawport cloud API using the same GraphQL endpoint as the official iOS app.
74
+
75
+ The door appears as a **Lock Mechanism** in HomeKit, which means you can:
76
+
77
+ * Lock and unlock from the Home app
78
+ * Use Siri ("Hey Siri, lock the dog door")
79
+ * Create automations (e.g. lock at sunset, unlock at 7am)
80
+ * Include it in Home scenes
81
+
82
+ > Note: This plugin is not affiliated with or endorsed by Pawport. Use at your own risk.
83
+
84
+ ## Troubleshooting
85
+
86
+ ### Door Shows as "No Response"
87
+
88
+ * Check that your `authToken` is correct and hasn't expired.
89
+ * Re-run the login helper button to refresh credentials.
90
+ * Make sure your Homebridge server has internet access.
91
+
92
+ ### Commands Fail Silently
93
+
94
+ * Check the Homebridge logs for error details.
95
+ * Try locking/unlocking from the Pawport app to confirm the door is online.
96
+
97
+ ## Contributing
98
+
99
+ Pull requests are welcome.
100
+
101
+ Please open an issue first to discuss what you'd like to change.
102
+
103
+ ## License
104
+
105
+ MIT © oblongmedulla
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@oblongmedulla/homebridge-pawport","version":"1.2.0","description":"Homebridge plugin for the Pawport smart pet door","license":"MIT","main":"index.js","keywords":["homebridge-plugin","pawport","pet door","smart lock","homebridge"],"engines":{"node":">=18.0.0","homebridge":">=1.3.0"},"author":"oblongmedulla","repository":{"type":"git","url":"git+https://github.com/oblongmedulla/homebridge-pawport.git"},"bugs":{"url":"https://github.com/oblongmedulla/homebridge-pawport/issues"},"homepage":"https://github.com/oblongmedulla/homebridge-pawport#readme","dependencies":{"@homebridge/plugin-ui-utils":"^2.2.4"},"devDependencies":{"homebridge":"^1.8.0"}}
1
+ {"name":"@oblongmedulla/homebridge-pawport","version":"1.2.1","description":"Homebridge plugin for the Pawport smart pet door","license":"MIT","main":"index.js","keywords":["homebridge-plugin","pawport","pet door","smart lock","homebridge"],"engines":{"node":">=18.0.0","homebridge":">=1.3.0"},"author":"oblongmedulla","repository":{"type":"git","url":"git+https://github.com/oblongmedulla/homebridge-pawport.git"},"bugs":{"url":"https://github.com/oblongmedulla/homebridge-pawport/issues"},"homepage":"https://github.com/oblongmedulla/homebridge-pawport#readme","dependencies":{"@homebridge/plugin-ui-utils":"^2.2.4"},"devDependencies":{"homebridge":"^1.8.0"}}
File without changes
File without changes