Fix August lock not appearing in HomeKit due to invisible error messages (#179)

Author: Copilot

README.md

@@ -40,6 +40,31 @@ plugin allows you to access your <a href="https://august.com">August</a> & <a hr
 - Yale Assure Lock 2 (YDR410)
 - Yale Assure Lock SL (YDR256)
 
+## Troubleshooting
+
+### Lock is detected but doesn't appear in HomeKit
+
+If you see "Total August Locks Found: 1" in the logs but your lock doesn't appear in HomeKit, it's likely because your August lock already has HomeKit enabled. Pro models often have this enabled by default.
+
+**Solution:** Add the following to your device configuration:
+```json
+{
+  "name": "August",
+  "platform": "August",
+  "credentials": { ... },
+  "options": {
+    "devices": [
+      {
+        "lockId": "YOUR_LOCK_ID",
+        "overrideHomeKitEnabled": true
+      }
+    ]
+  }
+}
+```
+
+You can find your lock ID in the Homebridge logs.
+
 ## Thanks
 
 Thank you to [hufftheweevil](https://github.com/hufftheweevil) for the [august-api](https://github.com/hufftheweevil/august-api) module.

src/platform.test.ts

@@ -498,4 +498,78 @@ describe('AugustPlatform', () => {
       expect(savedConfig.platforms[0].credentials.installId).toBeDefined()
     })
   })
+
+  describe('registerDevice', () => {
+    it('should register device when hide_device is false and homeKitEnabled is false', async () => {
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
+      
+      const mockDevice = {
+        LockName: 'Test Lock',
+        lockId: 'test-lock-id',
+        hide_device: false,
+        homeKitEnabled: false,
+        overrideHomeKitEnabled: false,
+      } as any
+
+      const result = await platform.registerDevice(mockDevice)
+      
+      expect(result).toBe(true)
+      expect(mockLog.info).toHaveBeenCalledWith('[DEBUG]', 'Device: Test Lock Enabled')
+    })
+
+    it('should register device when homeKitEnabled is true and overrideHomeKitEnabled is true', async () => {
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
+      
+      const mockDevice = {
+        LockName: 'Test Lock',
+        lockId: 'test-lock-id',
+        hide_device: false,
+        homeKitEnabled: true,
+        overrideHomeKitEnabled: true,
+      } as any
+
+      const result = await platform.registerDevice(mockDevice)
+      
+      expect(result).toBe(true)
+      expect(mockLog.warn).toHaveBeenCalledWith(
+        '[DEBUG]', 'Device: Test Lock HomeKit Enabled: true, Override HomeKit Enabled: true'
+      )
+    })
+
+    it('should NOT register device when homeKitEnabled is true and overrideHomeKitEnabled is false', async () => {
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
+      
+      const mockDevice = {
+        LockName: 'Test Lock',
+        lockId: 'test-lock-id',
+        hide_device: false,
+        homeKitEnabled: true,
+        overrideHomeKitEnabled: false,
+      } as any
+
+      const result = await platform.registerDevice(mockDevice)
+      
+      expect(result).toBe(false)
+      expect(mockLog.error).toHaveBeenCalledWith(
+        'Device: Test Lock already has HomeKit enabled. To register with Homebridge, add "overrideHomeKitEnabled": true to your device config.'
+      )
+    })
+
+    it('should NOT register device when hide_device is true', async () => {
+      platform = new AugustPlatform(mockLog, mockConfig, mockApi)
+      
+      const mockDevice = {
+        LockName: 'Test Lock',
+        lockId: 'test-lock-id',
+        hide_device: true,
+        homeKitEnabled: false,
+        overrideHomeKitEnabled: false,
+      } as any
+
+      const result = await platform.registerDevice(mockDevice)
+      
+      expect(result).toBe(false)
+      expect(mockLog.info).toHaveBeenCalledWith('[DEBUG]', 'Device: Test Lock is Hidden.')
+    })
+  })
 })

src/platform.ts

@@ -463,7 +463,7 @@ export class AugustPlatform implements DynamicPlatformPlugin {
       await this.externalOrPlatform(device, accessory)
       this.accessories.push(accessory)
     } else {
-      await this.debugErrorLog(`Unable to Register: ${device.LockName}, Lock ID: ${device.lockId} Check Config to see if is being Hidden.`)
+      await this.warnLog(`Unable to Register: ${device.LockName}, Lock ID: ${device.lockId}. Check device configuration.`)
     }
   }
 
@@ -477,8 +477,8 @@ export class AugustPlatform implements DynamicPlatformPlugin {
         + `Override HomeKit Enabled: ${device.overrideHomeKitEnabled}`)
     } else if (device.homeKitEnabled && !device.overrideHomeKitEnabled) {
       this.registeringDevice = false
-      await this.debugErrorLog(`Device: ${device.LockName} HomeKit Enabled: `
-        + `${device.homeKitEnabled}, device will not be registered. To enable, set overrideHomeKitEnabled to true.`)
+      await this.errorLog(`Device: ${device.LockName} already has HomeKit enabled. `
+        + `To register with Homebridge, add "overrideHomeKitEnabled": true to your device config.`)
     } else {
       this.registeringDevice = false
       await this.debugLog(`Device: ${device.LockName} is Hidden.`)