You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/changelog.mdx
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,21 +23,21 @@ Feature development of the v1 API has been stopped. No new features will be adde
23
23
24
24
#### 2.0.0 - 21-01-2025
25
25
26
-
-Initial release of the v2 API.
26
+
- Initial release of the v2 API.
27
27
28
28
#### 2.0.1 - 30-01-2025
29
29
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.
31
31
32
32
#### 2.1.0 - 01-05-2025
33
33
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.
35
35
36
36
#### 2.2.0 - 01-12-2025 (in beta)
37
37
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.
Copy file name to clipboardExpand all lines: docs/getting-started.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,9 +29,9 @@ To access the data from an Energy device, you have to enable the API. You can do
29
29
30
30
After enabling the API, you can try to read some data from your device.
31
31
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 <Linkto="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 <Linkto="http://json.parser.online.fr">JSON Parser Online</Link> to get a structured version of the result.
35
35
36
36
To understand each value, please read [endpoints](/docs/category/api-v1/).
Copy file name to clipboardExpand all lines: docs/introduction.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,18 +16,18 @@ The HomeWizard P1 Meter, Energy Socket, kWh Meter, Watermeter, and Plug-In Batte
16
16
17
17
## Terms and Conditions.
18
18
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.
22
22
23
23
## API v2.
24
24
25
25
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:
26
26
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.
31
31
32
32
Read more about the [new version of the API here](/docs/category/api-v2).
Copy file name to clipboardExpand all lines: docs/v1/state.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,8 +24,8 @@ The `/api/v1/state` endpoint returns the actual state of the Energy Socket.
24
24
25
25
This endpoint accepts `GET` and `PUT` requests.
26
26
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.
29
29
30
30
## Parameters.
31
31
@@ -98,9 +98,9 @@ Content-Type: application/json
98
98
99
99
You can configure multiple parameters at the same time. In this example.
100
100
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%).
104
104
105
105
The order of a combined request does not matter, if `switch-lock` was on, the socket will still turn off.
106
106
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.
Copy file name to clipboardExpand all lines: docs/v2/authorization.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -208,11 +208,11 @@ Content-Length: 0
208
208
209
209
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.
210
210
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).
Copy file name to clipboardExpand all lines: docs/v2/batteries.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,26 +38,26 @@ The `/api/batteries` endpoint can be used to retrieve information about the cont
38
38
39
39
The group of connected batteries can be controlled in three different modes:
40
40
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._
44
44
45
45
## Permissions
46
46
47
47
The `permissions` field can be used to set specific permissions for charging and discharging the connected Plug-In Batteries. The possible values are:
48
48
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.
51
51
52
52
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 `[]`.
53
53
54
54
### Backwards compatibility with `standby` mode
55
55
56
56
Mode `standby` is exactly the same as mode `zero` with both charging and discharging disallowed, therefore the following rules apply for backwards compatibility:
57
57
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.
0 commit comments