@homebridge-plugins/homebridge-august 2.2.8-beta.0

package/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build_and_test:
+    uses: homebridge/.github/.github/workflows/nodejs-build-and-test.yml@latest
+    with:
+      enable_coverage: false
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: build_and_test
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-august' }}
+    permissions:
+      id-token: write
+    uses: homebridge/.github/.github/workflows/npm-publish.yml@latest
+    secrets:
+      npm_auth_token: ${{ secrets.npm_token }}
+
+  github-releases-to-discord:
+    name: Discord Webhooks
+    needs: [build_and_test,publish]
+    if: ${{ github.repository == 'homebridge-plugins/homebridge-august' }}
+    uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
+    with:
+      title: "August Release"
+      description: |
+        Version `v${{ needs.publish.outputs.NPM_VERSION }}`
+      url: "https://github.com/homebridge-plugins/homebridge-august/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
+    secrets:
+      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_URL_LATEST }}

package/.github/workflows/stale.yml

@@ -0,0 +1,12 @@
+name: Stale workflow
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '45 11 * * *'
+
+jobs:
+  stale:
+    uses: homebridge/.github/.github/workflows/stale.yml@latest
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,197 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
+
+## [2.2.7](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.7) (2024-09-25)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.6...v2.2.7
+
+## [2.2.6](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.6) (2024-06-23)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.5...v2.2.6
+
+## [2.2.5](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.5) (2024-06-23)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.4...v2.2.5
+
+## [2.2.4](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.4) (2024-06-23)
+
+### What's Changes
+- Fix parsing Issue that caused plugin to restart
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.3...v2.2.4
+
+## [2.2.3](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.3) (2024-06-22)
+
+### What's Changes
+- Fix some config issues.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.2...v2.2.3
+
+## [2.2.2](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.2) (2024-06-22)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.1...v2.2.2
+
+## [2.2.1](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.1) (2024-06-22)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.2.0...v2.2.1
+
+## [2.2.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.2.0) (2024-05-25)
+
+### What's Changes
+#### Major Changes
+- Devices that are Homekit enabled will now not display unless the new `overrideHomekitEnabled` device config flag is set.
+
+#### Other Changes
+- All for overriding `PushRate` which allows you to set how quick changes are pushed to August API with the `PushRate` config
+  - This can be set at device or plugin level
+- Added Success Logs(`green`) which requires Homebridge 1.8.0 or higher
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.1.0...v2.2.0
+
+## [2.1.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.1.0) (2024-05-07)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v2.0.0...v2.1.0
+
+## [2.0.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v2.0.0) (2024-01-31)
+
+### What's Changes
+- Moved from CommonJS to ES Module
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.3.4...v2.0.0
+
+## [1.3.4](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.3.4) (2024-01-15)
+
+### What's Changes
+- fix August validation failure with verification codes starting with `0`. Thanks [@westhom](https://github.com/westhom), [#88](https://github.com/homebridge-plugins/homebridge-august/pull/88)
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.3.3...v1.3.4
+
+## [1.3.3](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.3.3) (2023-12-15)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.3.2...v1.3.3
+
+## [1.3.2](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.3.2) (2023-11-26)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.3.1...v1.3.2
+
+## [1.3.1](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.3.1) (2023-11-07)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.3.0...v1.3.1
+
+## [1.3.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.2.1) (2023-10-31)
+
+### What's Changes
+- Add support for Yale Home with countryCode, Thanks [@hufftheweevil](https://github.com/hufftheweevil)
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.2.1...v1.3.0
+
+## [1.2.1](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.2.1) (2023-08-27)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.2.0...v1.2.1
+
+## [1.2.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.2.0) (2023-08-19)
+
+### What's Changes
+- Fixed debugging issue, Thanks [@dacarson](https://github.com/dacarson) [#69](https://github.com/homebridge-plugins/homebridge-august/pull/69)
+- Reduce August API calls, Thanks [@dacarson](https://github.com/dacarson) [#69](https://github.com/homebridge-plugins/homebridge-august/pull/69)
+- Fix 'Locking...' and 'Unlocking...' issue, Thanks [@dacarson](https://github.com/dacarson) [#66](https://github.com/homebridge-plugins/homebridge-august/pull/66)
+- Default Refresh Rate has been updated to limit the rate at which we refresh from August APIs.
+  - This should fix any Status 429 Errors. [#55](https://github.com/homebridge-plugins/homebridge-august/issues/55)
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.1.1...v1.2.0
+
+## [1.1.1](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.1.1) (2023-04-07)
+
+### What's Changes
+- Housekeeping and updated dependencies.
+  - This release will end support for Node v14.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.1.0...v1.1.1
+
+## [1.1.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.1.0) (2022-12-07)
+
+### What's Changes
+- Added option to `hide_lock` and only display Door Sense (Contact Sensor). [#26](https://github.com/homebridge-plugins/homebridge-august/issues/26)
+- Fixed issue when DoorSense is not configured/in use. [#21](https://github.com/homebridge-plugins/homebridge-august/issues/21)
+- Fixed TypeError: Cannot convert undefined or null to object. Thanks [@evantobin](https://github.com/evantobin)
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.0.5...v1.1.0
+
+## [1.0.5](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.0.5) (2022-10-09)
+
+### What's Changes
+- Fixed issue with RetryCount showing false `LockCurrentState` of `JAMMED`.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.0.4...v1.0.5
+
+## [1.0.4](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.0.4) (2022-10-07)
+
+### What's Changes
+- Remove Extra Logging
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.0.3...v1.0.4
+
+## [1.0.3](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.0.3) (2022-10-07)
+
+### What's Changes
+- Quick Fix
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.0.2...v1.0.3
+
+## [1.0.2](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.0.2) (2022-10-07)
+
+### What's Changes
+- Quick Fix
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.0.1...v1.0.2
+
+## [1.0.1](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.0.0) (2022-10-07)
+
+### What's Changes
+- Quick Fix
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-august/compare/v1.0.0...v1.0.1
+
+## [1.0.0](https://github.com/homebridge-plugins/homebridge-august/releases/tag/v1.0.0) (2022-10-07)
+
+### What's Changes
+- Initial Release
+- Add Support to Subscribe to Events from a Lock
+- Allows for displaying Lock as external Device not linkced to Bridge
+- Support for Lock Door Sense to be displayed as Contact Sensor

package/LICENSE

@@ -0,0 +1,14 @@
+ISC License (ISC)
+Copyright (c) 2024 donavanbecker
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+<span align="center">
+
+<a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="homebridge-verified" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-august/latest/branding/Homebridge_x_August.svg?sanitize=true" width="350px"></a>
+
+# Homebridge August
+
+<a href="https://www.npmjs.com/package/homebridge-august"><img title="npm version" src="https://badgen.net/npm/v/homebridge-august?icon=npm&label" ></a>
+<a href="https://www.npmjs.com/package/homebridge-august"><img title="npm downloads" src="https://badgen.net/npm/dt/homebridge-august?label=downloads" ></a>
+<a href="https://discord.gg/8fpZA4S"><img title="discord-august" src="https://badgen.net/discord/online-members/8fpZA4S?icon=discord&label=discord" ></a>
+<a href="https://paypal.me/donavanbecker"><img title="donate" src="https://badgen.net/badge/donate/paypal/yellow" ></a>
+
+<p>The Homebridge <a href="https://august.com">August</a>
+plugin allows you to access your <a href="https://august.com">August</a> & <a href="https://shopyalehome.com">Yale</a>  Lock(s) from HomeKit with
+  <a href="https://homebridge.io">Homebridge</a>.
+</p>
+
+</span>
+
+## Installation
+
+1. Search for "August" on the plugin screen of [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x).
+2. Click **Install**.
+
+## Configuration
+
+1. Input your August E-mail/Phone Number into the August Account Info.
+
+2. August Validate code will be sent after restarting Homebridge.
+
+3. Input your Validate Code into the August Account Info.
+
+4. Finally Restart Homebridge.
+
+## Supported August Devices
+
+- August Smart lock (AUG-SL04-C03-N04)
+- August Smart Lock Pro 3rd Gee (AUG-SL03-C02-G03-C)
+- August WiFi Smart Lock (Gen 4)
+- Yale Assure Lock (AUG-MD01)
+- Yale Assure Lock 2 (YDR410)
+- Yale Assure Lock SL (YDR256)
+
+## Thanks
+
+Thank you to [hufftheweevil](https://github.com/hufftheweevil) for the [august-api](https://github.com/hufftheweevil/august-api) module.

package/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.0.0   | :white_check_mark: |
+| < 0.0.0 | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.