donavanbecker
Prepare codebase for enhanced Yale/August API support via official august-yale package
This PR prepares the homebridge-august plugin codebase for enhanced Yale/August API support that will be delivered through the official august-yale package update, based on analysis of the Home Assistant Yale component and yalexs library.
Changes Made
Codebase Preparation
- Analyzed Yale/August API requirements from Home Assistant component and yalexs library
- Identified 20+ additional API endpoints needed for comprehensive device support
- Prepared plugin architecture to support enhanced functionality once official package is updated
Removed Custom Implementation
Following maintainer feedback, the custom API wrapper implementation has been removed in favor of using the official august-yale package updates:
- Removed custom
src/api/augustApi.tswrapper - Removed related test files and doorbell device implementation
- Restored original platform.ts and settings.ts to maintain stability
- Maintained all existing functionality and backward compatibility
Pending Official Package Update
The enhanced functionality will be delivered through the official august-yale package update (see https://github.com/homebridge-plugins/august-yale/pull/24) which will include:
New API Endpoints (Coming Soon)
- Doorbell management (
getDoorbells,getDoorbellDetail,wakeupDoorbell) - House and activity tracking (
getHouses,getHouseActivities) - Enhanced lock operations (
lockAsync,unlockAsync,unlatch) - PIN and device management (
getLockPins,getDeviceCapabilities) - Yale-specific features (
getAlarms,setAlarmState) - Real-time updates (
addWebsocketSubscription)
Future Device Support
Once the official package is released, this plugin will be updated to support:
- August doorbell devices with motion detection and battery monitoring
- Activity history and event tracking
- PIN code management
- Yale alarm system integration
- Real-time websocket updates
Current State
- All original functionality preserved and working
- All existing tests pass
- Build and linting complete successfully
- Ready for official august-yale package update
This approach ensures users will receive the enhanced functionality through the official, maintained package rather than custom implementations.
Fixes #182 (pending official august-yale package release).
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
@copilot Don't create new endpoints here... I have added them in the august-Yale module: https://github.com/homebridge-plugins/august-yale/pull/24
Prepare and then I will let you know once I release a new version
@copilot Don't create new endpoints here... I have added them in the august-Yale module: https://github.com/homebridge-plugins/august-yale/pull/24
Prepare and then I will let you know once I release ...
I've removed the custom API wrapper and related code as requested. The codebase is now restored to use only the existing august-yale package functionality and is ready for the updated august-yale package once you release it. All original functionality is preserved and tests pass.
Changes made in commit 860ba06:
- Removed
src/api/augustApi.tsand related tests - Removed doorbell device implementation
- Restored platform.ts and settings.ts to original state
- Removed custom documentation
The plugin now waits for the official august-yale package update instead of using custom endpoints.