Skip to content

Commit a135446

Browse files
authored
Bumb all dependencies to latest version (#221)
* Bumb dependencies * Bumb dependencies
1 parent 1d51f81 commit a135446

16 files changed

+4164
-4155
lines changed

docs/changelog.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ Feature development of the v1 API has been stopped. No new features will be adde
2323

2424
#### 2.0.0 - 21-01-2025
2525

26-
- Initial release of the v2 API.
26+
- Initial release of the v2 API.
2727

2828
#### 2.0.1 - 30-01-2025
2929

30-
- An issue has been resolved where `energy_import_kwh` and `energy_export_kwh` values in the Plug-In Battery [Measurement API](/docs/v2/measurement#plug-in-battery-hwe-bat) were returning invalid values. The values are now the same as those in the HomeWizard Energy app.
30+
- An issue has been resolved where `energy_import_kwh` and `energy_export_kwh` values in the Plug-In Battery [Measurement API](/docs/v2/measurement#plug-in-battery-hwe-bat) were returning invalid values. The values are now the same as those in the HomeWizard Energy app.
3131

3232
#### 2.1.0 - 01-05-2025
3333

34-
- Support has been added to the P1 Meter to control the Plug-In Battery group mode. See [Plug-In Battery API](/docs/v2/batteries) for more information.
34+
- Support has been added to the P1 Meter to control the Plug-In Battery group mode. See [Plug-In Battery API](/docs/v2/batteries) for more information.
3535

3636
#### 2.2.0 - 01-12-2025 (in beta)
3737

38-
- You can now set charge and discharge permissions for the Plug-In Battery group via the `permissions` field in the [Plug-In Battery API](/docs/v2/batteries). See the documentation for more information.
39-
- A new field has been added to `api/batteries`: `battery_count`, which indicates the number of connected Plug-In Batteries.
40-
- When `target_power_w` field in `api/batteries` is updated, it is now pushed over WebSocket connections as well.
38+
- You can now set charge and discharge permissions for the Plug-In Battery group via the `permissions` field in the [Plug-In Battery API](/docs/v2/batteries). See the documentation for more information.
39+
- A new field has been added to `api/batteries`: `battery_count`, which indicates the number of connected Plug-In Batteries.
40+
- When `target_power_w` field in `api/batteries` is updated, it is now pushed over WebSocket connections as well.
4141

4242
## Subscribe to Updates.
4343

docs/discovery.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Energy devices can be automatically discovered on your network using <Link to="h
1414

1515
Devices can broadcast one or two services on the network, depending on the available API version(s) of this device:
1616

17-
- `_hwenergy._tcp` - to discover devices that are using API v1 over HTTP
18-
- `_homewizard._tcp` - to discover devices that are using API v2 and later over HTTPS
17+
- `_hwenergy._tcp` - to discover devices that are using API v1 over HTTP
18+
- `_homewizard._tcp` - to discover devices that are using API v2 and later over HTTPS
1919

2020
## `_hwenergy._tcp`.
2121

docs/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ To access the data from an Energy device, you have to enable the API. You can do
2929

3030
After enabling the API, you can try to read some data from your device.
3131

32-
- Find the IP address of your meter. You can find this in your router or do this programmatically with [mDNS](/docs/discovery).
33-
- In your internet browser, open `http://<IP ADDRESS>/api/v1/data`.
34-
- If everything is set up correctly, you should now see some text. This is the most recent measurement formatted as JSON. You can use a tool such as <Link to="http://json.parser.online.fr">JSON Parser Online</Link> to get a structured version of the result.
32+
- Find the IP address of your meter. You can find this in your router or do this programmatically with [mDNS](/docs/discovery).
33+
- In your internet browser, open `http://<IP ADDRESS>/api/v1/data`.
34+
- If everything is set up correctly, you should now see some text. This is the most recent measurement formatted as JSON. You can use a tool such as <Link to="http://json.parser.online.fr">JSON Parser Online</Link> to get a structured version of the result.
3535

3636
To understand each value, please read [endpoints](/docs/category/api-v1/).
3737

docs/introduction.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ The HomeWizard P1 Meter, Energy Socket, kWh Meter, Watermeter, and Plug-In Batte
1616

1717
## Terms and Conditions.
1818

19-
- **License** - The HomeWizard Energy API is licensed, not sold. HomeWizard grants the user a non-exclusive license (with no right to sub-license) to the HomeWizard Energy API for personal, non-commercial use.
20-
- **Usage** - The user may not directly or indirectly use the HomeWizard Energy API to sell, lease, loan or generate a revenue from a product, system or software using the API
21-
- **Support** - The usage of the HomeWizard Energy API is officially supported by HomeWizard, however HomeWizard can not supply customer service regarding the implementation of the API in your own or third party applications.
19+
- **License** - The HomeWizard Energy API is licensed, not sold. HomeWizard grants the user a non-exclusive license (with no right to sub-license) to the HomeWizard Energy API for personal, non-commercial use.
20+
- **Usage** - The user may not directly or indirectly use the HomeWizard Energy API to sell, lease, loan or generate a revenue from a product, system or software using the API
21+
- **Support** - The usage of the HomeWizard Energy API is officially supported by HomeWizard, however HomeWizard can not supply customer service regarding the implementation of the API in your own or third party applications.
2222

2323
## API v2.
2424

2525
The HomeWizard Energy API is moving to v2, which is a more secure and feature-rich version of the API. In v2 of the API, we have added the following features:
2626

27-
- **HTTPS** - Your data is securely transmitted.
28-
- **Always available** - No need to turn on the API in the app.
29-
- **Authorization** - Only the devices you trust can access the API.
30-
- **WebSocket support** - Get real-time push-based updates.
27+
- **HTTPS** - Your data is securely transmitted.
28+
- **Always available** - No need to turn on the API in the app.
29+
- **Authorization** - Only the devices you trust can access the API.
30+
- **WebSocket support** - Get real-time push-based updates.
3131

3232
Read more about the [new version of the API here](/docs/category/api-v2).
3333

docs/v1/measurement.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,8 +260,8 @@ Content-Type: application/json
260260

261261
Each type of meter is available in two versions. The API and functionality is the same for both types.
262262

263-
- **1-phase**: HWE-KWH1 and SDM230-wifi
264-
- **3-phase**: HWE-KWH3 and SDM630-wifi
263+
- **1-phase**: HWE-KWH1 and SDM230-wifi
264+
- **3-phase**: HWE-KWH3 and SDM630-wifi
265265

266266
### Parameters
267267

docs/v1/state.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ The `/api/v1/state` endpoint returns the actual state of the Energy Socket.
2424

2525
This endpoint accepts `GET` and `PUT` requests.
2626

27-
- With `GET` you will receive the actual state
28-
- With `PUT` you can control the state.
27+
- With `GET` you will receive the actual state
28+
- With `PUT` you can control the state.
2929

3030
## Parameters.
3131

@@ -98,9 +98,9 @@ Content-Type: application/json
9898

9999
You can configure multiple parameters at the same time. In this example.
100100

101-
- Socket is turned off.
102-
- Switch-lock is turned off.
103-
- Brightness is set to 127 (50%).
101+
- Socket is turned off.
102+
- Switch-lock is turned off.
103+
- Brightness is set to 127 (50%).
104104

105105
The order of a combined request does not matter, if `switch-lock` was on, the socket will still turn off.
106106
The complete state has to make sense; It is not possible to set `power_on` to false and `switch_lock` to true. See [error handling](/docs/v1/error-handling) for more details.

docs/v1/system.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ You can solve this, for example, by adding clear documentation and/or by showing
3838

3939
This endpoint accepts `GET` and `PUT` requests.
4040

41-
- With `GET` will send the actual system state.
42-
- With `PUT` allows to set the system state.
41+
- With `GET` will send the actual system state.
42+
- With `PUT` allows to set the system state.
4343

4444
## Examples.
4545

docs/v1/telegram.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ import Badge from '@site/src/components/Badge.js'
2222

2323
The `/api/v1/telegram` endpoint returns the most recent, valid telegram that was given by the P1 Meter.
2424

25-
- The checksum is validated when present, telegrams with an invalid checksum are rejected.
26-
- The telegram is not processed in any other form, and can be used by other systems to process the data.
27-
- If you need parsed data, use the [measurement](/docs/v1/measurement) endpoint.
25+
- The checksum is validated when present, telegrams with an invalid checksum are rejected.
26+
- The telegram is not processed in any other form, and can be used by other systems to process the data.
27+
- If you need parsed data, use the [measurement](/docs/v1/measurement) endpoint.
2828

2929
## Example.
3030

docs/v2/authorization.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,11 @@ Content-Length: 0
208208

209209
The local API is used by HomeWizard to enable direct communication between HomeWizard devices on a local network. To simplify setup for non-technical users, tokens can also be generated via the HomeWizard Energy app or background process using the cloud.
210210

211-
- Cloud-generated users are prefixed with `cloud/`, local users are prefixed with `local/`.
212-
- These tokens are for local device communication only and do not provide access to the cloud nor can be used by the cloud itself.
213-
- All users, including cloud-generated ones can be viewed with the [`GET /api/user`](#list-users) endpoint.
214-
- Users created via the cloud can be revoked at any time, either by the cloud itself or through the [`DELETE /api/user`](#delete-user) endpoint.
215-
- Disabling the cloud prevents the generation of cloud-generated users. For more details, see [cloud communication](/docs/v2/system#cloud-communication).
211+
- Cloud-generated users are prefixed with `cloud/`, local users are prefixed with `local/`.
212+
- These tokens are for local device communication only and do not provide access to the cloud nor can be used by the cloud itself.
213+
- All users, including cloud-generated ones can be viewed with the [`GET /api/user`](#list-users) endpoint.
214+
- Users created via the cloud can be revoked at any time, either by the cloud itself or through the [`DELETE /api/user`](#delete-user) endpoint.
215+
- Disabling the cloud prevents the generation of cloud-generated users. For more details, see [cloud communication](/docs/v2/system#cloud-communication).
216216

217217
## SSL Certificate Validation (HTTPS) {#https}.
218218

docs/v2/batteries.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,26 +38,26 @@ The `/api/batteries` endpoint can be used to retrieve information about the cont
3838

3939
The group of connected batteries can be controlled in three different modes:
4040

41-
- `zero` - The Plug-In Battery will try to keep the power consumption/production of your home at zero. This means that the Plug-In Battery will charge or discharge to maintain a net-zero power balance. This is the default mode.
42-
- `to_full` - All connected Plug-In Batteries will be charged to 100%, regardless of the power consumption/production of your home. When all batteries are fully charged, the Plug-In Battery will switch to the **zero** mode.
43-
- `standby` - Batteries will enter standby mode. This means that the Plug-In Battery will neither charge nor discharge. _For new implementations we recommend to use the `permissions` field to disallow both charging and discharging instead of using this mode._
41+
- `zero` - The Plug-In Battery will try to keep the power consumption/production of your home at zero. This means that the Plug-In Battery will charge or discharge to maintain a net-zero power balance. This is the default mode.
42+
- `to_full` - All connected Plug-In Batteries will be charged to 100%, regardless of the power consumption/production of your home. When all batteries are fully charged, the Plug-In Battery will switch to the **zero** mode.
43+
- `standby` - Batteries will enter standby mode. This means that the Plug-In Battery will neither charge nor discharge. _For new implementations we recommend to use the `permissions` field to disallow both charging and discharging instead of using this mode._
4444

4545
## Permissions
4646

4747
The `permissions` field can be used to set specific permissions for charging and discharging the connected Plug-In Batteries. The possible values are:
4848

49-
- `charge_allowed` - Allow the Plug-In Battery to charge.
50-
- `discharge_allowed` - Allow the Plug-In Battery to discharge.
49+
- `charge_allowed` - Allow the Plug-In Battery to charge.
50+
- `discharge_allowed` - Allow the Plug-In Battery to discharge.
5151

5252
Provide these via an array when updating the `permissions` field. For example, to allow both charging and discharging, set `permissions` to `["charge_allowed", "discharge_allowed"]`. To disallow both, set it to an empty array `[]`.
5353

5454
### Backwards compatibility with `standby` mode
5555

5656
Mode `standby` is exactly the same as mode `zero` with both charging and discharging disallowed, therefore the following rules apply for backwards compatibility:
5757

58-
- When switching to `standby` mode, the `permissions` field will be set to an empty array `[]`.
59-
- When adding a permission to the `permissions` field while in `standby` mode, the mode will automatically switch to `zero`.
60-
- `zero` mode with both permissions allowed is the same as the default `zero` mode.
58+
- When switching to `standby` mode, the `permissions` field will be set to an empty array `[]`.
59+
- When adding a permission to the `permissions` field while in `standby` mode, the mode will automatically switch to `zero`.
60+
- `zero` mode with both permissions allowed is the same as the default `zero` mode.
6161

6262
## Examples
6363

0 commit comments

Comments
 (0)