homebridge-nest-accfactory 0.0.4-a

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+All notable changes to `homebridge-nest-accfactory` will be documented in this file. This project tries to adhere to [Semantic Versioning](http://semver.org/).
+
+### alpha
+
+Currently all releases are considered 'alpha' status, where things may or may not be working. Use at your own risk :-)
+
+## v0.0.4 (2024-09-07)
+
+- Camera/Doorbell support for snapshots and live video re-introduced
+- HomeKit Secure Video recording support re-introduced
+- Should support Nest Thermostat 4th Gen (untested)
+- *might* have finally resolved audio sync issues for both live and recording
+- Depending on the libraries present in ffmpeg binary, we limit functionality for camera/doorbells
+    - missing libspeex = no two-way audio
+    - missing libfdk_aac = no audio
+    - missing libx264 = no streaming/recording
+- Cleanup fix for when removing a camera/doorbell from Nest/Google
+- Fix for virtual weather device when missing configured city and/or state details
+- Fix for retrieving data from Nest systems when using both a Nest and Google accounts
+- Initial support newer Nest/Google camera/doorbell devices (streaming/recording - coming)
+
+## v0.0.1 (2024-08-27)
+
+- Inital re-coding from Nest_accfactory code base. These projects will now share a common code base
+- Camera/Doorbell support currently removed will re-worked

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,121 @@
+<p align="center">
+  <a href="https://homebridge.io"><img src="https://raw.githubusercontent.com/homebridge/branding/latest/logos/homebridge-color-round-stylized.png" height="140"></a>
+</p>
+<span align="center">
+
+# Homebridge Nest Accfactory
+
+[![npm](https://badgen.net/npm/v/homebridge-nest-accfactory/latest)](https://www.npmjs.com/package/homebridge-nest-accfactory)
+[![npm](https://badgen.net/npm/dt/homebridge-nest-accfactory?label=downloads)](https://www.npmjs.com/package/homebridge-nest-accfactory)
+[![Donate](https://badgen.net/badge/donate/paypal/yellow)](https://paypal.me/n0rt0nthec4t)
+
+</span>
+
+Formally known as [Nest_accfactory](https://github.com/n0rt0nthec4t/Nest_accfactory), this is a Homebridge plugin I have developed to allow Nest devices to be used with HomeKit including having support for HomeKit Secure Video on doorbells and camera devices
+
+## Supported Devices
+
+The following Nest devices are supported
+
+* Nest Thermostats (Gen 1, Gen 2, Gen 3, E, 2020, Gen 4)
+* Nest Protects (Gen 1, Gen 2)
+* Nest Temp Sensors (Gen 1)
+* Nest Cameras (Cam Indoor, IQ Indoor, Outdoor, IQ Outdoor)
+* Nest Doorbells (Gen 1)
+
+The accessory supports connection to Nest using a Nest account OR a Google (migrated Nest account) account.
+
+## Configuration
+
+### Nest Account
+
+If you have a Nest account, you will need to obtain an access token from the Nest web app. Simply go to https://home.nest.com in your browser and log in. Once that's done, go to https://home.nest.com/session in your browser, and you will see a long string that looks like this:
+
+{"2fa_state":"enrolled","access_token":"XXX", ...}
+
+The value of "access_token" near the start of the string (the XXX) (a long sequence of letters, numbers and punctuation beginning with b) can be entered into the plugin-configuration within Homebridge
+
+There may be other keys labelled access_token further along in the string - please ignore these.
+
+**Do not log out of home.nest.com, as this will invalidate your credentials. Just close the browser tab**
+
+### Obtaining a Google cookie token for a Google Account
+
+Google Accounts require an "issueToken" and "cookie". The values of "issueToken" and "cookies" are specific to your Google Account. To get them, follow these steps (only needs to be done once, as long as you stay logged into your Google Account).
+
+1. Open a Chrome browser tab in Incognito Mode (or clear your cache).
+2. Open Developer Tools (View/Developer/Developer Tools).
+3. Click on 'Network' tab. Make sure 'Preserve Log' is checked.
+4. In the 'Filter' box, enter issueToken
+5. Go to home.nest.com, and click 'Sign in with Google'. Log into your account.
+6. One network call (beginning with iframerpc) will appear in the Dev Tools window. Click on it.
+7. In the Headers tab, under General, copy the entire Request URL (beginning with https://accounts.google.com). This is your "Issue Token" which can be entered into the plugin-configuration within Homebridge.
+9. In the 'Filter' box, enter oauth2/iframe
+10. Several network calls will appear in the Dev Tools window. Click on the last iframe call.
+11. In the Headers tab, under Request Headers, copy the entire cookie (include the whole string which is several lines long and has many field/value pairs - do not include the cookie: name). This is your "Cookie" which can be entered into the plugin-configuration within Homebridge.
+
+**Do not log out of home.nest.com, as this will invalidate your credentials. Just close the browser tab**
+
+## config.json configuration
+
+When using the plugin configuration using [homebridge-config-ui-x](https://github.com/homebridge/homebridge-config-ui-x), the config.json will be updated/generated with the configuration options available via the web-form. Additional options can be specified in the config.json directly.
+
+Sample config.json entries below
+```
+{
+    "nest": {
+        "access_token": "<nest access token>",
+        "fieldTest": false
+    },
+    "google": {
+        "issuetoken": "<google issue token>",
+        "cookie": "<google cookie>",
+        "fieldTest": false
+    },
+    "options": {
+        "eveHistory": true,
+        "weather": true,
+        "elevation": 600,
+        "hksv": false
+    },
+    "devices": {
+        "XXXXXXXX": {
+            "exclude": false
+        },
+    },
+    "platform": "NestAccfactory"
+}
+```
+
+#### options
+
+The following options are available in the config.json options object. These apply to all discovered devices.
+
+| Name              | Description                                                                                   | Default   |
+|-------------------|-----------------------------------------------------------------------------------------------|-----------|
+| elevation         | Height above sea level for the weather station                                                | 0         |
+| eveHistory        | Provide history in EveHome application where applicable                                       | true      |
+| ffmegPath         | Path to an ffmpeg binary for us to use. Will look in current directory by default             |           |
+| hksv              | Enable HomeKit Secure Video for supported camera(s) and doorbell(s)                           | false     |
+| maxStreams        | Maximum number of concurrent video streams in HomeKit for supported camera(s) and doorbell(s) | 2         |
+| weather           | Virtual weather station for each Nest/Google home we discover                                 | false     |
+
+#### devices
+
+The following options are available on a per-device level in the config.json devices object. The device is specified by using its serial number (in uppercase)
+
+| Name              | Description                                                                                   | Default   |
+|-------------------|-----------------------------------------------------------------------------------------------|-----------|
+| chimeSwitch       | Create a switch for supported doorbell(s) which allows the indoor chime to be turned on/off   | false     |
+| doorbellCooldown  | Time in seconds between doorbell press events                                                 | 60        | 
+| elevation         | Height above sea level for the specific weather station                                       | 0         |
+| eveHistory        | Provide history in EveHome application where applicable for the specific device               | true      |
+| exclude           | Exclude the device                                                                            | false     |
+| humiditySensor    | Create a seperate humidity sensor for supported thermostat(s)                                 | false     |
+| localAccess       | Enable local video streaming for supported supported camera(s) and doorbell(s)                | false     |    
+| motionCooldown    | Time in seconds between detected motion events                                                | 60        |
+| personCooldown    | Time in seconds between detected person events                                                | 120       |
+
+## Caveats
+
+Nest_accfactory is a hobby project of mine, provided as-is, with no warranty whatsoever. I've been running it successfully at my home, but your mileage might vary.

package/config.schema.json

@@ -0,0 +1,107 @@
+{
+    "pluginAlias": "NestAccfactory",
+    "pluginType": "platform",
+    "singular": true,
+    "schema": {
+        "type": "object",
+        "properties": {
+            "nest": {
+                "title": "Nest Account",
+                "type": "object",
+                "expandable": true,
+                "properties": {
+                    "access_token": {
+                        "title": "Access Token",
+                        "type": "string",
+                        "placeholder": "See https://github.com/n0rt0nthec4t/homebridge-nest-accfactory/#nest-account"
+                    },
+                    "fieldTest" : {
+                        "title": "Field Test",
+                        "type": "boolean",
+                        "description": "Use field test API endpoints",
+                        "default": false,
+                        "condition": {
+                            "functionBody": "return model.nest.access_token"
+                        }
+                    }
+                } 
+            },
+            "google": {
+                "title": "Google Account",
+                "type": "object",
+                "expandable": true,
+                "properties": {
+                    "issuetoken": {
+                        "title": "Issue Token",
+                        "type": "string",
+                        "placeholder": "See https://github.com/n0rt0nthec4t/homebridge-nest-accfactory/#google-account"
+                    },
+                    "cookie": {
+                        "title": "Cookie",
+                        "type": "string",
+                        "placeholder": "See https://github.com/n0rt0nthec4t/homebridge-nest-accfactory/#google-account"
+
+                    },
+                    "fieldTest" : {
+                        "title": "Field Test",
+                        "type": "boolean",
+                        "description": "Use field test API endpoints",
+                        "default": false,
+                        "condition": {
+                            "functionBody": "return model.google.issuetoken && model.google.cookie"
+                        }
+                    }
+                }   
+            },
+            "options": {
+                "title": "Options",
+                "type": "object",
+                "expandable": true,
+                "properties": {
+                    "eveHistory": {
+                        "title": "EveHome History",
+                        "description": "Provide history in EveHome application where applicable",
+                        "type": "boolean",
+                        "default": true
+                    },
+                    "weather": {
+                        "title": "Virtual Weather",
+                        "description": "Virtual weather station",
+                        "type": "boolean",
+                        "default": false
+                    },
+                    "elevation": {
+                        "title": "Elevation",
+                        "description": "Height above sea level for the weather station",
+                        "type": "integer",
+                        "default": 0,
+                        "minimum": 0,
+                        "maximum": 8848,
+                        "condition": {
+                            "functionBody": "return model.options.weather"
+                        }
+                    },
+                    "hksv": {
+                        "title": "HomeKit Secure Video",
+                        "description": "Enable HomeKit Secure Video for supported camera(s) and doorbell(s)",
+                        "type": "boolean",
+                        "default": false
+                    },
+                    "ffmpegPath": {
+                        "title": "Path to ffmpeg binary",
+                        "type": "string",
+                        "placeholder": "Path to an ffmpeg binary. By default, we look in HomeBridge user path"
+                    }
+                }
+            }
+        }
+    },
+    "oneOf": [
+        {
+            "required": ["nest"]
+        },
+        {
+            "required": ["google"]
+        }
+    ]
+}