Skip to content

Add documentation for the beta version of APIv2 for Energy Socket - #303

Open
xlenstra wants to merge 3 commits into
mainfrom
add-api-v2-for-socket
Open

xlenstra wants to merge 3 commits into
mainfrom
add-api-v2-for-socket

Conversation

@xlenstra

Copy link
Copy Markdown
Member

This PR adds documentation for the beta version of the APIv2 for the Energy Socket. The firmware for this will be released in a future version, and this PR should not be merged until that is the case. This new version will include only the https part of the API and not the ws. This will be added in a future release.

This PR was tested by locally running the website and looking at all the changed pages. They correctly identified which parts of the API were included (in beta) for the socket and which aren't.

This commit adds documentation describing the functionality of the V2 version of the API for the Energy Socket. In many cases, this just amounts to setting the 'in development' badge to 'Supported'. In some cases more documentation is added. The measurement file is updated to document the values that are returned when querying a socket for its most recent measurements. The system file is updated to include the new socket-specific properties (switch lock & power state).
This commit marks the API v2 of the socket as being in beta in all relevant places. Additionally, the changelog was updated to reflect the changes made to the protocol to support the Energy Socket.
@xlenstra
xlenstra requested review from a team and lexpostma and a balanced review from Copilot November 17, 2026 14:32
@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit c405eed):

https://hw-api-documentation--pr303-add-api-v2-for-socke-tpr7etam.web.app

(expires Tue, 24 Nov 2026 15:47:49 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 4accc1c887f1346ec9c563d5645c74c94f610c07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The discovery badge still says “In development,” conflicting with the v2 endpoint pages’ “Supported” beta status and leaving availability unclear.

1 open issue
What changed in this PR

This PR documents beta API v2 support for Energy Socket over HTTPS, with WebSocket support planned for a later release. Publication is intended to wait for the corresponding firmware release.

Changes:

  • Updates device availability and endpoint support badges for the beta.
  • Documents Energy Socket measurements, a response example, and socket-specific system controls.
  • Adds a firmware 2.3.1 changelog entry.
File Description
docs/​v2/​system.mdx Adds socket support, switch_lock, and power_on.
docs/​v2/​measurement.mdx Adds socket measurements and an HTTPS example.
docs/​v2/​error-handling.mdx Marks socket error handling as supported in beta.
docs/​v2/​device_information.mdx Marks socket device information as supported in beta.
docs/​v2/​authorization.mdx Marks socket authorization as supported in beta.
docs/​introduction.mdx Lists beta availability and planned WebSocket support.
docs/​discovery.mdx Updates the socket discovery badge for beta support.
docs/​changelog.mdx Records socket API v2 support and new system fields.

Review effort: Balanced

Comment thread docs/discovery.mdx Resolved
Accidentally forgot to change this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants