Add documentation for kWh Meter v2 API #192
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Visit the preview URL for this PR (updated for commit 9c09f48): https://hw-api-documentation--pr192-super-secret-new-fea-1e008wq2.web.app (expires Tue, 24 Jun 2025 11:00:13 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 4accc1c887f1346ec9c563d5645c74c94f610c07 |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for multiple API endpoints by revising and standardizing the badge components to clearly indicate firmware and API support statuses. In addition, new sections for kWh Meter parameters have been added and the device support table in the introduction has been updated.
- Updated badge texts and icons for firmware requirements and support statuses across v1 and v2 documentation files.
- Added new parameter documentation for kWh Meter endpoints in the v2 measurement docs.
- Revised the device support table in the introduction with updated badge information.
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/v2/websocket.mdx | Updated badge texts to reflect firmware requirements and development statuses. |
| docs/v2/telegram.mdx | Revised badge texts to standardize firmware version formatting. |
| docs/v2/system.mdx | Updated badges in endpoint docs and parameter tables for clarity. |
| docs/v2/measurement.mdx | Updated badges and added detailed parameter documentation for kWh Meter. |
| docs/v2/error-handling.mdx | Revised badge texts for consistency. |
| docs/v2/device_information.mdx | Updated badge texts to the new standard. |
| docs/v2/batteries.mdx | Updated badge icons and texts for labelling beta firmware requirements. |
| docs/v2/authorization.mdx | Revised badge texts for consistency. |
| docs/v1/system.mdx | Updated Plug-In Battery badge to match v2 updates. |
| docs/v1/measurement.mdx | Updated Plug-In Battery badge. |
| docs/v1/identify.mdx | Updated Plug-In Battery badge. |
| docs/v1/error-handling.mdx | Updated Plug-In Battery badge. |
| docs/v1/api.mdx | Updated Plug-In Battery badge. |
| docs/introduction.mdx | Revised device support table with updated badge texts and icons. |
| docs/discovery.mdx | Updated badge texts to reflect new development statuses. |
Comments suppressed due to low confidence (1)
docs/v2/measurement.mdx:268
- The HTTP response sample shows 'https/1.1 200 OK'; it may be a typo and should be updated to 'HTTP/1.1 200 OK'.
https/1.1 200 OK
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Duco Sebel <74970928+DCSBL@users.noreply.github.com>
DCSBL
commented
Jun 17, 2025
Signed-off-by: Duco Sebel <74970928+DCSBL@users.noreply.github.com>
DCSBL
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SSIA, don't look at the code please as it is secret.