@homebridge-plugins/homebridge-august 3.3.0 → 3.4.0-beta.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v3.3.1 (2026-07-20)
+
+### Changed
+
+- fix(schema): give the logging levels clear, distinct names
+- chore(deps): dependency updates
+
 ## v3.3.0 (2026-07-18)
 
 ### Changed

package/README.md

@@ -24,14 +24,18 @@ Homebridge plugin to integrate August and Yale locks into HomeKit
 > [!IMPORTANT]
 > **Yale Home accounts (common outside North America) can no longer sign in through this plugin.** Yale has switched off password-based login on its servers (verified July 2026) and now requires an OAuth sign-in that is only available to officially registered partners. If you have a Yale Home account: check whether your lock supports **native HomeKit** (many Yale Home locks do — look for a HomeKit option in the Yale Home app), or use Home Assistant's official Yale integration with its HomeKit Bridge.
 
+### Prerequisites
+
+- To use this plugin, you will need to already have:
+  - [Node](https://nodejs.org): latest version of `v22` or `v24` - any other major version is not supported.
+  - [Homebridge](https://homebridge.io): `v2` - refer to link for more information and installation instructions.
+
 ### Setup
 
-- Installation
-  - Search for "August" on the plugin screen of the [Homebridge UI](https://github.com/homebridge/homebridge-config-ui-x) and click **Install**.
-- Configuration
-  1. Enter your August account e-mail or phone number in the plugin settings and restart Homebridge.
-  2. August will send you a verification code - enter this code in the plugin settings.
-  3. Restart Homebridge once more and your locks will appear.
+- [Installation](https://github.com/homebridge-plugins/homebridge-august/wiki/Installation)
+- [Configuration](https://github.com/homebridge-plugins/homebridge-august/wiki/Configuration)
+- [Beta Version](https://github.com/homebridge-plugins/homebridge-august/wiki/Beta-Version)
+- [Node Version](https://github.com/homebridge-plugins/homebridge-august/wiki/Node-Version)
 
 ### Supported Devices
 
@@ -44,6 +48,7 @@ Homebridge plugin to integrate August and Yale locks into HomeKit
 
 ### Help/About
 
+- [Common Errors](https://github.com/homebridge-plugins/homebridge-august/wiki/Common-Errors)
 - [Support Request](https://github.com/homebridge-plugins/homebridge-august/issues/new/choose)
 - [Changelog](https://github.com/homebridge-plugins/homebridge-august/blob/latest/CHANGELOG.md)
 - [About Me](https://github.com/sponsors/bwp91)

package/config.schema.json

@@ -352,31 +352,32 @@
                   }
                 },
                 "logging": {
-                  "title": "Device Logging Override Setting",
+                  "title": "Device Logging Level Override",
+                  "description": "Overrides the plugin logging level for this device only. None turns off all messages from this plugin. Standard shows normal activity, warnings and errors. Debug adds detailed messages, and is what to use when reporting a problem. Default behaves the same as Standard.",
                   "type": "string",
                   "required": true,
                   "default": "",
                   "oneOf": [
                     {
-                      "title": "Default Logging",
+                      "title": "Default (same as Standard)",
                       "enum": [
                         ""
                       ]
                     },
                     {
-                      "title": "Standard Logging",
+                      "title": "None",
                       "enum": [
-                        "standard"
+                        "none"
                       ]
                     },
                     {
-                      "title": "No Logging",
+                      "title": "Standard",
                       "enum": [
-                        "none"
+                        "standard"
                       ]
                     },
                     {
-                      "title": "Debug Logging",
+                      "title": "Debug",
                       "enum": [
                         "debug"
                       ]
@@ -418,31 +419,32 @@
             "description": "Indicates the number of seconds between pushes to August API."
           },
           "logging": {
-            "title": "Logging Setting",
+            "title": "Plugin Logging Level",
+            "description": "None turns off all messages from this plugin. Standard shows normal activity, warnings and errors. Debug adds detailed messages, and is what to use when reporting a problem. Default behaves the same as Standard.",
             "type": "string",
             "required": true,
             "default": "",
             "oneOf": [
               {
-                "title": "Default Logging",
+                "title": "Default (same as Standard)",
                 "enum": [
                   ""
                 ]
               },
               {
-                "title": "Standard Logging",
+                "title": "None",
                 "enum": [
-                  "standard"
+                  "none"
                 ]
               },
               {
-                "title": "No Logging",
+                "title": "Standard",
                 "enum": [
-                  "none"
+                  "standard"
                 ]
               },
               {
-                "title": "Debug Logging",
+                "title": "Debug",
                 "enum": [
                   "debug"
                 ]

package/package.json

@@ -2,7 +2,7 @@
   "name": "@homebridge-plugins/homebridge-august",
   "displayName": "August",
   "type": "module",
-  "version": "3.3.0",
+  "version": "3.4.0-beta.0",
   "description": "The August plugin allows you to access your August & Yale device(s) from HomeKit.",
   "author": {
     "name": "bwp91",
@@ -69,14 +69,14 @@
   },
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^2.2.5",
-    "august-yale": "^1.2.3",
+    "august-yale": "^1.2.4",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^9.1.0",
     "@types/node": "^26.1.1",
     "@vitest/coverage-v8": "^4.1.10",
-    "homebridge": "^2.2.0",
+    "homebridge": "^2.2.1",
     "nodemon": "^3.1.14",
     "rimraf": "^6.1.3",
     "ts-node": "^10.9.2",