Skip to content

Commit eaadd0a

Browse files
DCSBLDCSBL
authored
Drop wi-fi from brand names (#158)
1 parent 444b9e7 commit eaadd0a

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

‎docs/introduction.mdx

+13-13
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ import Badge from '@site/src/components/Badge.js'
77

88
# Introduction
99

10-
With the HomeWizard Energy platform, you can get insights in your energy usage. Use the HomeWizard <Link to="https://www.homewizard.com/p1-meter/">Wi-Fi P1 Meter</Link> to access real-time data directly from your smart meter, the HomeWizard <Link to="https://www.homewizard.com/energy-socket">Wi-Fi Energy Socket</Link> to get energy insights from all your devices, the HomeWizard <Link to="https://www.homewizard.com/kwh-meter">Wi-Fi kWh Meter</Link> to measure devices such as solar panels and the HomeWizard <Link to="https://www.homewizard.com/watermeter">Wi-Fi Watermeter</Link> to get insight in your water usage. With the open API you can integrate the data directly into your system of choice.
10+
With the HomeWizard Energy platform, you can get insights in your energy usage. Use the HomeWizard <Link to="https://www.homewizard.com/p1-meter/">P1 Meter</Link> to access real-time data directly from your smart meter, the HomeWizard <Link to="https://www.homewizard.com/energy-socket">Energy Socket</Link> to get energy insights from all your devices, the HomeWizard <Link to="https://www.homewizard.com/kwh-meter">kWh Meter</Link> to measure devices such as solar panels and the HomeWizard <Link to="https://www.homewizard.com/watermeter">Watermeter</Link> to get insight in your water usage. With the open API you can integrate the data directly into your system of choice.
1111

1212
## HomeWizard Energy API
1313

14-
The HomeWizard Wi-Fi P1 Meter, Wi-Fi Energy Socket, Wi-Fi kWh Meter, and Wi-Fi Watermeter (referred to as "device") each have a local API that allows you to retrieve the latest measurements or control the device. You can access this API as long as you are connected to the same Wi-Fi network as the device and the API is enabled in the HomeWizard Energy app. This API is designed for integrating your device with personal automation, home automation, or data graphing systems. Note that it is not possible to retrieve historical data through the local API, as this data is not stored on the device itself.
14+
The HomeWizard P1 Meter, Energy Socket, kWh Meter, and Watermeter (referred to as "device") each have a local API that allows you to retrieve the latest measurements or control the device. You can access this API as long as you are connected to the same Wi-Fi network as the device and the API is enabled in the HomeWizard Energy app. This API is designed for integrating your device with personal automation, home automation, or data graphing systems. Note that it is not possible to retrieve historical data through the local API, as this data is not stored on the device itself.
1515

1616
## Terms and Conditions
1717

@@ -38,17 +38,17 @@ To understand the basics of the API, you can read the [getting-started](/docs/ge
3838

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

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
41+
| Device | Device type | API v1 | API v2 |
42+
| --------------------------------------- | ---------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
43+
| 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+
| 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+
| 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+
| 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+
| 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 P1 Meter
5252
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.
5353
:::
5454

‎docs/v2/system.mdx

+12-12
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,21 @@ The `/api/system` endpoint can be used to get and set some system information, l
2424

2525
## Parameters
2626

27-
| Data | Type | Access | Description | Availability |
28-
| --------------------------------------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
29-
| wifi_ssid | String | Read-only | The SSID of the Wi-Fi network. | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
30-
| wifi_rssi_db | Number | Read-only | The signal strength of the Wi-Fi network. | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
31-
| uptime_s | Number | Read-only | The uptime of the device in seconds. | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
32-
| [cloud_enabled](#cloud-communication) | Boolean | Read/Write | The state of the cloud communication. | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check" detail='read-only'>Plug-In Battery</Badge> |
33-
| [status_led_brightness_pct](#status-led-brightness) | Number | Read/Write | The brightness of the status LED in percent. | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
34-
| [api_v1_enabled](#enable-or-disable-the-v1-api) | Optional Boolean | Read/Write | The state of the v1 API, will be removed when API v1 is removed, so this parameter is optional. | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-grey' icon="mdi:close">Plug-In Battery</Badge> |
27+
| Data | Type | Access | Description | Availability |
28+
| --------------------------------------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
29+
| wifi_ssid | String | Read-only | The SSID of the Wi-Fi network. | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
30+
| wifi_rssi_db | Number | Read-only | The signal strength of the Wi-Fi network. | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
31+
| uptime_s | Number | Read-only | The uptime of the device in seconds. | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
32+
| [cloud_enabled](#cloud-communication) | Boolean | Read/Write | The state of the cloud communication. | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check" detail='read-only'>Plug-In Battery</Badge> |
33+
| [status_led_brightness_pct](#status-led-brightness) | Number | Read/Write | The brightness of the status LED in percent. | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
34+
| [api_v1_enabled](#enable-or-disable-the-v1-api) | Optional Boolean | Read/Write | The state of the v1 API, will be removed when API v1 is removed, so this parameter is optional. | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-grey' icon="mdi:close">Plug-In Battery</Badge> |
3535

3636
## Actions
3737

38-
| Action | Description | Availability |
39-
| --------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
40-
| [Reboot](#reboot) | Reboot the device | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-grey' icon="mdi:close">Plug-In Battery</Badge> |
41-
| [Identify](#identify) | Let the device identify itself by blinking the status LED | <Badge color='hw-green' icon="mdi:check">Wi-Fi P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
38+
| Action | Description | Availability |
39+
| --------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
40+
| [Reboot](#reboot) | Reboot the device | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-grey' icon="mdi:close">Plug-In Battery</Badge> |
41+
| [Identify](#identify) | Let the device identify itself by blinking the status LED | <Badge color='hw-green' icon="mdi:check">P1 Meter</Badge> <Badge color='hw-green' icon="mdi:check">Plug-In Battery</Badge> |
4242

4343
## Plug-In Battery exceptions
4444

0 commit comments

Comments
 (0)