Skip to content

Commit f88096c

Browse files
DCSBLDCSBL
authored
Remove beta-label for v2 API (#156)
1 parent 77ebdaf commit f88096c

13 files changed

+26
-68
lines changed

‎docs/changelog.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import Link from '@docusaurus/Link'
44

55
The API Changelog is available on GitHub. For every important change in the API or its documentation, we make a new GitHub 'release'.
66

7+
See [Devices and API Versions](/docs/introduction#devices) to read more about the API versions and the devices that are supported.
8+
79
{/* prettier-ignore */}
810
<Link className='button button--primary' to='https://github.com/homewizard/api-documentation/releases'>Open Changelog</Link>
911

‎docs/discovery.mdx‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ sidebar_position: 3
44

55
import Link from '@docusaurus/Link'
66
import Badge from '@site/src/components/Badge.js'
7-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
87

98
# Discovery
109

@@ -46,12 +45,12 @@ A discovery response contains additional data to enhance the setup in your appli
4645
## `_homewizard._tcp`
4746

4847
{/* prettier-ignore */}
49-
<Badge color='hw-green' icon="mdi:check" subtext="Supported">P1 Meter</Badge>
48+
<Badge color='hw-green' icon="mdi:check" subtext="Requires Firmware 6.00">P1 Meter</Badge>
5049
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Energy Socket</Badge>
5150
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Energy Display</Badge>
5251
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">kWh Meter</Badge>
5352
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Watermeter</Badge>
54-
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Plug-In Battery</Badge>
53+
<Badge color='hw-green' icon="mdi:check" subtext="Supported">Plug-In Battery</Badge>
5554

5655
---
5756

‎docs/getting-started.mdx‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ sidebar_position: 2
33
---
44

55
import Link from '@docusaurus/Link'
6-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
76

87
# Getting Started
98

@@ -35,8 +34,6 @@ To understand each value, please read [endpoints](/docs/category/api-v1/).
3534

3635
## Getting Started with v2
3736

38-
<PreliminaryWarning />
39-
4037
In contrast to v1, the v2 API is based on HTTPS and uses authorization to access the data. This means you don't need to enable the local API in the app, but you have to obtain a token.
4138

4239
The following example will show you can use the API to get basic information from a P1 Meter.

‎docs/introduction.mdx‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ sidebar_position: 1
44

55
import Link from '@docusaurus/Link'
66
import Badge from '@site/src/components/Badge.js'
7-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
87

98
# Introduction
109

@@ -35,21 +34,23 @@ Read more about the [new version of the API here](/docs/category/api-v2).
3534

3635
To understand the basics of the API, you can read the [getting-started](/docs/getting-started) guide, and read [v1](/docs/category/api-v1) or [v2](/docs/category/api-v2) to know all about the available features.
3736

38-
## Devices and API versions {#devices}
39-
40-
<PreliminaryWarning />
37+
## Devices and API Versions {#devices}
4138

4239
The following table shows which devices are supported by the API and which API version they support.
4340

44-
| Device | Device type | API v1 | API v2 |
45-
| --------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------- |
46-
| Wi-Fi P1 Meter | `HWE-P1` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-orange' icon="mdi:test-tube" detail='2.0.0'>Beta</Badge> |
47-
| Wi-Fi Energy Socket | `HWE-SKT` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
48-
| Wi-Fi Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
49-
| Wi-Fi kWh Meter (1 phase) | `HWE-KWH1` and `SDM230-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
50-
| Wi-Fi kWh Meter (3 phase) | `HWE-KWH3` and `SDM630-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
51-
| Energy Display | `HWE-DSP` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
52-
| Plug-In Battery | `HWE-BAT` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-orange' icon="mdi:test-tube" detail='2.0.0'>Beta</Badge> |
41+
| Device | Device type | API v1 | API v2 |
42+
| --------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
43+
| Wi-Fi P1 Meter | `HWE-P1` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-green' icon="mdi:check" detail='2.0.0'>Requires Firmware 6.00</Badge> |
44+
| Wi-Fi Energy Socket | `HWE-SKT` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
45+
| Wi-Fi Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
46+
| Wi-Fi kWh Meter (1 phase) | `HWE-KWH1` and `SDM230-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
47+
| Wi-Fi kWh Meter (3 phase) | `HWE-KWH3` and `SDM630-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
48+
| Energy Display | `HWE-DSP` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
49+
| Plug-In Battery | `HWE-BAT` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-green' icon="mdi:check" detail='2.0.0'>Supported</Badge> |
50+
51+
:::tip Wi-Fi P1 Meter
52+
The v2 API is available for P1 Meter devices with firmware version 6.00 and higher. This version is currently only available for owners of the Plug-In Battery.
53+
:::
5354

5455
## We are Hiring
5556

‎docs/v2/authorization.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ description: Get a token to authenticate requests to the HomeWizard Energy API.
55
---
66

77
import Badge from '@site/src/components/Badge.js'
8-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
98

109
# Authorization `/api/user`
1110

1211
{/* prettier-ignore */}
13-
<Badge color='hw-green' icon='mdi:test-tube' subtext='Requires Firmware 6.00, Currently in Beta'>P1 Meter</Badge>
12+
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
1413
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Socket</Badge>
1514
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
1615
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>kWh Meter</Badge>
@@ -21,8 +20,6 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2120

2221
---
2322

24-
<PreliminaryWarning />
25-
2623
The HomeWizard Energy API requires a Bearer token to authorize requests. This token should be included in the `Authorization` header of each request. To get a token you must create a user on the device.
2724

2825
## Create User and get Token

‎docs/v2/device_information.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ description: Get information like serial and version number from the device.
55
---
66

77
import Badge from '@site/src/components/Badge.js'
8-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
98

109
# Device Information `/api`
1110

1211
{/* prettier-ignore */}
13-
<Badge color='hw-green' icon='mdi:test-tube' subtext='Requires Firmware 6.00, Currently in Beta'>P1 Meter</Badge>
12+
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
1413
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
1514
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
1615
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>kWh Meter</Badge>
@@ -21,8 +20,6 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2120

2221
---
2322

24-
<PreliminaryWarning />
25-
2623
The `/api` endpoint allows you to get basic information from the device.
2724

2825
Your application can use this endpoint to see if your integration is designed to work with this version of the API. You can validate your support based on the combination of `product_type` and `api_version`. Data points in this endpoint that are currently available won't change, but make sure your application can accept new data points for future updates.

‎docs/v2/error-handling.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ description: Learn how to handle errors when using the HomeWizard Energy API.
44
---
55

66
import Badge from '@site/src/components/Badge.js'
7-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
87

98
# Error Handling
109

1110
{/* prettier-ignore */}
12-
<Badge color='hw-green' icon='mdi:test-tube' subtext='Requires Firmware 6.00, Currently in Beta'>P1 Meter</Badge>
11+
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
1312
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
1413
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
1514
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>kWh Meter</Badge>
@@ -20,8 +19,6 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2019

2120
---
2221

23-
<PreliminaryWarning />
24-
2522
When you perform an invalid request or something went wrong, the API will respond with an error message. You have to check if the HTTP status code returns `200 OK` before parsing the result or `204 No Content` if you expect no content (actions and set requests).
2623
If you use an endpoint that returns JSON, you also will receive an object with some error information.
2724

‎docs/v2/measurement.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@ description: Get the most recent measurement from the device.
66

77
import Link from '@docusaurus/Link'
88
import Badge from '@site/src/components/Badge.js'
9-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
109

1110
# Recent Measurement `/api/measurement`
1211

1312
{/* prettier-ignore */}
14-
<Badge color='hw-green' icon='mdi:test-tube' subtext='Requires Firmware 6.00, Currently in Beta'>P1 Meter</Badge>
13+
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
1514
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
1615
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
1716
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>kWh Meter</Badge>
@@ -22,8 +21,6 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2221

2322
---
2423

25-
<PreliminaryWarning />
26-
2724
The `/api/measurement` endpoint allows you to get the most recent measurement from the device.
2825

2926
## P1 Meter (HWE-P1)

‎docs/v2/system.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ description: Enable and disable cloud communication.
55
---
66

77
import Badge from '@site/src/components/Badge.js'
8-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
98

109
# System `/api/system`
1110

1211
{/* prettier-ignore */}
13-
<Badge color='hw-green' icon='mdi:test-tube' subtext='Requires Firmware 6.00, Currently in Beta'>P1 Meter</Badge>
12+
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
1413
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
1514
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
1615
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>kWh Meter</Badge>
@@ -21,8 +20,6 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2120

2221
---
2322

24-
<PreliminaryWarning />
25-
2623
The `/api/system` endpoint can be used to get and set some system information, like the state of the cloud communication and the uptime of the device.
2724

2825
## Parameters

‎docs/v2/telegram.mdx‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@ toc_min_heading_level: 3
66
---
77

88
import Badge from '@site/src/components/Badge.js'
9-
import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
109

1110
# Telegram `/api/telegram`
1211

1312
{/* prettier-ignore */}
14-
<Badge color='hw-green' icon='mdi:test-tube' subtext='Requires Firmware 6.00, Currently in Beta'>P1 Meter</Badge>
13+
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
1514
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Socket</Badge>
1615
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
1716
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>kWh Meter</Badge>
@@ -22,8 +21,6 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2221

2322
---
2423

25-
<PreliminaryWarning />
26-
2724
The `/api/telegram` endpoint returns the most recent, valid telegram that was given by the P1 Meter.
2825

2926
- The checksum is validated when present, telegrams with an invalid checksum are rejected.

0 commit comments

Comments
 (0)