Add documentation about updated kWh meter API #41
Conversation
This file contains 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 13b4d32): https://hw-api-documentation--pr41-dcsbl-2024-26-805qkdwv.web.app (expires Fri, 26 Jan 2024 10:40:17 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 4accc1c887f1346ec9c563d5645c74c94f610c07 |
DCSBL
added a commit
that referenced
this pull request
Nov 12, 2024
DCSBL
added a commit
that referenced
this pull request
Nov 12, 2024
* Very initial V2 documentation * More adjustments * More adjustments * More adjustments * Fix pre-commit issues * Add some todo's and resolve ISO8601 todo * Remove mark about old datapoints * Fix invalid name for monthy power peak * Fix timestamp examples * Fix details about absolute current values * Adjust Badge and add BadgeDetail to allow adding a nicer 'V1' sub-batch * Identify and reboot is implemented, remove TODO * Removed already completed TODO * Adjust some warnings * Add basic information about versioning in V2 * Add extra information about authentication process * Add labels * Add info about cloud generated users * Add details about GET and DELETE request in authorization * Improve flow description in authentication * Set telegram to v2 * Tell result can be 200 and 204 * Set correct error example * Adjust device list and mention API versions * Fix device->devices * Adjust 'capacity rate' explainer * Adjust cloud communication description * Adjust led brightness description * Adjust reboot description * Remove TODO in changelog, as they now live in GH issues * Remove TODO from category.json files * Remove last todo's * Remove incomplete information about semver * Adjust mDNS documentation with V2 * Fix issues in v2/system * Streamline v1 doc with new style from v2 (#29) * Add getting started guide for v2 (#30) * Add how-to-validate HTTPS (#31) * Remove references to 'purple blinking' (#32) * Add how to get the hostname (#33) * Add WebSocket documentation (#34) * Initial version of WebSocket documentation * Add Error handling and how to set parameter doc * Do not mix and match authorization and authentication (#35) * Add optional marker for api_v1_enabled (#36) * Add optional marker for v1_api_enabled * Fix formatting * Sytem responds with latest state (#38) * Remove 'v2' in URL's and examples (#40) * Set mDNS name for v2+ API to '_homewizard' (#41) * Improve button press time window behaviour (#42) * Correct order of device response (#43) * Set correct error code in example (#44) * Explain all errros (#45) * Remove Content-Length header from descriptions (#46) * Update mDNS documentation (#49) * Bumb docusaurus to 3.6.0 (#51) * Add firebase redirects (#55) * Spellcheck and typofixes (#50) * Correctly name P1 meter * Correctly name battery * Correctly name watermeter * Correctly name Wi-Fi and kWh Meter * Correctly name API * Yeah we are not talking Dutch over here * Correctly name LinkedIn * Apply suggestions from code review --------- Co-authored-by: Duco Sebel <[email protected]> * Update versioning doc (#47) * Make all 'V1' and 'V2' lowercase (#56) * Renamed badge.js to be compatible with capital sensitive OS (#57) * Streamlined v2 authorization (#59) * Streamlined v2 device information (#60) * Use correct error code in error handling example (#61) * Use correct error code in error handling example * Update docs/V2/error-handling.mdx --------- Co-authored-by: Duco Sebel <[email protected]> * Use correct api version in X-Api-Version (#62) * Streamlined v2 system (#63) * Use correct error body for response examples (#64) * Use correct error body for response examples * Update docs/V2/error-handling.mdx * Undo change --------- Co-authored-by: Duco Sebel <[email protected]> * Use correct error in websocket error example (#65) * Use correct error in websocket error example * Update docs/V2/websocket.mdx --------- Co-authored-by: Duco Sebel <[email protected]> * Get telegram expects Accept header (#68) * Improving documentation v2 (#66) * Renamed Us to About us * Fixed battery spelling * Fixed warning * Correctly name page * Added information about spelling mistake * Fixed mistake * Fixed Belgium (is that possible?) * Renamed v1/v2 * Backport renaming * Cleanup in tables * Fixed capital letters for Energy * Fixed capital letters * Made description a bit more clear * Fixed spelling mistake * Renamed data to device information and typofix * Fixed title names * Streamlined capital letters * Improved spelling * Fixed IP address and version naming * Removed not really needed links * Improved layout * Improved sentence * Renamed state * Fixed formatting * Streamlined v's * Fixed DSMR naming * Yeah we are not that lazy * Revert Git being a bitch * Fixed capital letter * Update docs/V1/recent_measurement.mdx * Feedback * Feedback --------- Co-authored-by: Duco Sebel <[email protected]> * Fix hyperlinks for documenation references (#69) * Clean up version supported batches (#70) * Clean up version supported batches * Extend badges to contain more info * Extend badges to contain more info * Fix formatting * Adjust badges in introduction * Final touches * Adjust supported batches (#71) * Clean up version supported batches * Extend badges to contain more info * Extend badges to contain more info * Fix formatting * Adjust badges in introduction * Final touches * Adjust formatting * Bumb docusaurus to 3.6.1 * Fix broken link * Rename 'V1' folder to 'v1' and 'V2' folder to 'v2' * Fix redirects * Fix redirects, again * Adjust deprecation policy documentation --------- Co-authored-by: Jochem <[email protected]> Co-authored-by: Mick <[email protected]>
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.
No description provided.