Update documentation for API 2.2.0 #219
Conversation
|
Visit the preview URL for this PR (updated for commit 35085c6): https://hw-api-documentation--pr219-api-2-2-0-088w5bug.web.app (expires Thu, 11 Dec 2025 10:27:40 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 4accc1c887f1346ec9c563d5645c74c94f610c07 |
There was a problem hiding this comment.
Pull request overview
This pull request updates the documentation for API version 2.2.0, introducing new functionality for the Plug-In Battery API. The update adds the ability to control charge and discharge permissions through a new permissions field, introduces a battery_count field to indicate the number of connected batteries, and documents that target_power_w is now pushed over WebSocket connections.
Key Changes
- Added
permissionsfield to allow granular control of battery charging and discharging behavior - Added
battery_countfield to track the number of connected Plug-In Batteries - Updated WebSocket documentation to reflect that
permissionsandtarget_power_ware now pushed in real-time
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/v2/websocket.mdx | Updated to document that permissions and target_power_w are now pushed in real-time for battery updates |
| docs/v2/batteries.mdx | Major update to document the new permissions field, battery_count field, and backwards compatibility with standby mode; includes new examples |
| docs/introduction.mdx | Updated device support table to reflect API 2.2.0 beta availability for P1 Meter and kWh Meter devices |
| docs/changelog.mdx | Added version 2.2.0 changelog entry with the new features |
| .cspell.yml | Added 'bèta' to spell checker dictionary (though this should use standard 'beta' spelling) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 8 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Duco Sebel <74970928+DCSBL@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Duco Sebel <74970928+DCSBL@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Duco Sebel <74970928+DCSBL@users.noreply.github.com>
Co-authored-by: RonvanderPlas <36153505+RonvanderPlas@users.noreply.github.com> Signed-off-by: Duco Sebel <74970928+DCSBL@users.noreply.github.com>
2 participants
permissionsfield in the Plug-In Battery API. See the documentation for more information.api/batteries:battery_count, which indicates the number of connected Plug-In Batteries.target_power_wfield inapi/batteriesis updated, it is now pushed over WebSocket connections as well.